mirror of
https://github.com/CCOSTAN/Home-AssistantConfig.git
synced 2025-12-03 11:31:42 +00:00
MAJOR Update of README files across all directories to enhance link formatting, improve layout consistency, and remove outdated sections. Changed GitHub Stars badge for better visibility and streamlined user engagement options. Added affiliate links and updated support messaging for clarity.
This commit is contained in:
Carlo Costanzo
109
config/README.md
109
config/README.md
@@ -9,72 +9,77 @@
|
||||
|
||||
[](https://x.com/ccostan)
|
||||
[](https://www.youtube.com/vCloudInfo?sub_confirmation=1)
|
||||
[](https://github.com/CCOSTAN) <br>
|
||||
[](https://github.com/CCOSTAN) <br>
|
||||
[](https://github.com/CCOSTAN/Home-AssistantConfig/blob/master/config/.HA_VERSION)
|
||||
[](https://github.com/CCOSTAN/Home-AssistantConfig/commits/master)
|
||||
[](https://github.com/CCOSTAN/Home-AssistantConfig/commits/master)
|
||||
|
||||
<h4>
|
||||
<a href="https://github.com/CCOSTAN/Home-AssistantConfig/commits/master"><img src="https://img.shields.io/github/last-commit/CCOSTAN/Home-AssistantConfig.svg?style=plasticr"/></a>
|
||||
<a href="https://github.com/CCOSTAN/Home-AssistantConfig/commits/master"><img src="https://img.shields.io/github/commit-activity/y/CCOSTAN/Home-AssistantConfig.svg?style=plasticr"/></a>
|
||||
</div>
|
||||
|
||||
</h4>
|
||||
</div>
|
||||
<p><font size="3">
|
||||
This is the main directory of the Repo. You will find more helpful ReadMe files in the directories as you browse them. Not all but each day I add more. I use a configuration type called split configuration. So my main configuration.yaml file is broken out into many different files located in the directories. Be sure to visit the package directory where practically self contained YAML files exist that you can easily drop into your configurations to be up and running fast with various automations and components. You can also subscribe via RSS to every commit I make in this repo by clicking the Feed icon on the bottom of this page. </p>
|
||||
<div align="center"><a name="menu"></a>
|
||||
<h4>
|
||||
<a href="https://www.vCloudInfo.com/tag/iot">
|
||||
Blog
|
||||
</a>
|
||||
<span> | </span>
|
||||
<a href="https://github.com/CCOSTAN/Home-AssistantConfig#devices">
|
||||
Devices
|
||||
</a>
|
||||
<span> | </span>
|
||||
<a href="https://github.com/CCOSTAN/Home-AssistantConfig/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">
|
||||
Todo List
|
||||
</a>
|
||||
<span> | </span>
|
||||
<a href="https://x.com/BearStoneHA">
|
||||
Smart Home Stats
|
||||
</a>
|
||||
<span> | </span>
|
||||
<a href="https://www.vcloudinfo.com/click-here">
|
||||
Follow Me
|
||||
</a>
|
||||
<span> | </span>
|
||||
<a href="https://github.com/CCOSTAN/Home-AssistantConfig/tree/master/config">
|
||||
Code
|
||||
</a>
|
||||
<span> | </span>
|
||||
<a href="https://github.com/CCOSTAN/Home-AssistantConfig#diagram">
|
||||
Diagram
|
||||
</a>
|
||||
<span> | </span>
|
||||
<a href="https://youtube.com/vCloudInfo">
|
||||
Youtube
|
||||
</a>
|
||||
<span> | </span>
|
||||
<a href="https://amzn.to/2HXSx2M">
|
||||
Support
|
||||
</a>
|
||||
</h4>
|
||||
</div>
|
||||
Live view of the `config/` directory my production Home Assistant instance loads every night. Use this README as a map when you want to jump directly into the most interesting packages, automations, and supporting assets.
|
||||
|
||||
### Quick navigation
|
||||
- [Repo overview](../README.md) | [Blog](https://www.vcloudinfo.com) | [Issues](https://github.com/CCOSTAN/Home-AssistantConfig/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) | [Diagram](https://raw.githubusercontent.com/CCOSTAN/Home-AssistantConfig/master/config/www/custom_ui/floorplan/images/branding/bearstoneflow.png) | [YouTube](https://youtube.com/vCloudInfo)
|
||||
- Directory highlights: [packages](packages), [automation](automation), [script](script), [scene](scene), [templates](templates), [www](www), [custom_components](custom_components)
|
||||
- Gear & affiliate catalog: see [../docs/legacy-readme.md](../docs/legacy-readme.md) for the complete shopping list
|
||||
|
||||
|
||||
|
||||
### What this folder is (and isn't)
|
||||
- Every YAML file here is live and version-controlled; anything missing is intentionally ignored via `.gitignore` (databases, logs, caches, etc.).
|
||||
- This is a split-configuration layout: `configuration.yaml` simply includes the files and directories documented here so changes are easy to isolate.
|
||||
- Nothing in this folder is a drop-in template—borrow ideas, but adjust entity IDs, helpers, and secrets to match your home before reloading HA.
|
||||
|
||||
### How the config is organized
|
||||
- **Packages (`packages/`)** – complete subsystems that bundle sensors, switches, automations, scripts, and lovelace assets for a single feature (alarm, garage, water shutoff, etc.).
|
||||
- **Automations (`automation/`)** – event-driven YAML broken out by area or device; the legacy `automations.yaml` remains for UI-created flows.
|
||||
- **Scripts & scenes (`script/`, `scene/`)** – curated lighting and ambiance logic used by presence, holiday, and seasonal routines.
|
||||
- **Templates (`templates/`)** – Jinja helpers and speech templates reused by the notify/speech engines.
|
||||
- **www/ + custom components** – branding assets, floorplans, and any custom components the core install depends on.
|
||||
|
||||
### Featured automations by section
|
||||
| Section | Why start here | Featured automation(s) |
|
||||
| --- | --- | --- |
|
||||
| Packages | Self-contained subsystems that highlight patterns like combined alerts + actions. | [packages/alarm.yaml](packages/alarm.yaml), [packages/garadget.yaml](packages/garadget.yaml), [packages/powerwall.yaml](packages/powerwall.yaml) |
|
||||
| Automations | Real-world triggers that tie Zwave, MQTT, and REST sensors into the rest of the house. | [automation/garage_entry_light.yaml](automation/garage_entry_light.yaml), [automation/dark_rainy_day.yaml](automation/dark_rainy_day.yaml), [automation/dash_buttons.yaml](automation/dash_buttons.yaml) |
|
||||
| Scripts | Reusable building blocks for lighting, notifications, and safety responses. | [script/monthly_color_scene.yaml](script/monthly_color_scene.yaml), [script/notify_engine.yaml](script/notify_engine.yaml), [script/speech_engine.yaml](script/speech_engine.yaml) |
|
||||
| Scenes | Seasonal and ambiance presets that the scripts and automations call into. | [scene/monthly_colors.yaml](scene/monthly_colors.yaml), [scene/living_room.yaml](scene/living_room.yaml) |
|
||||
| Templates & Speech | Human-friendly voice briefings and templated responses. | [templates/speech/briefing.yaml](templates/speech/briefing.yaml) |
|
||||
| Dashboards & Media | UI chrome, floorplans, sound bites, and automation assets. | [www/custom_ui/floorplan/images/branding/bearstoneflow.png](www/custom_ui/floorplan/images/branding/bearstoneflow.png), [media/](media) |
|
||||
|
||||
### Gear tied to these automations (affiliate links)
|
||||
Only including devices that have active references in the files above. Want the legacy list? Jump to [../docs/legacy-readme.md](../docs/legacy-readme.md).
|
||||
|
||||
| Device | What it drives (friendly name -> file) | Buy |
|
||||
| --- | --- | --- |
|
||||
| Garadget garage door controller | Garage doors: open/close, reflection alerts – [garadget package](packages/garadget.yaml) + [garage entry helper](automation/garage_entry_light.yaml) | [](https://amzn.to/2jQLpVQ) |
|
||||
| Phyn Plus water shutoff | Leak detection + auto shutoff – [phynplus package](packages/phynplus.yaml) | [](https://amzn.to/2Zy3sbJ) |
|
||||
| Rachio sprinkler controller | Rain-skips and seasonal watering – [rachio package](packages/rachio.yaml) | [](https://amzn.to/2eoPKBW) |
|
||||
| Tesla Powerwall 2 | Grid-outage alerts + load-shed automations – [powerwall package](packages/powerwall.yaml) | [](https://amzn.to/3UM4BZ5) |
|
||||
| NodeMCU motion sensor | Office motion lighting + comfort scenes – [office_motion package](packages/office_motion.yaml) | [](https://amzn.to/2oUgj5i) |
|
||||
| Raspberry Pi 3 + Aeon Z-Wave stick | Z-Wave backbone for door/hall sensors – [garage entry helper](automation/garage_entry_light.yaml) | [](https://amzn.to/2e3DOBY) [](https://amzn.to/2eAiAP0) |
|
||||
| Roku streaming device | TV presence -> scenes/lighting – [roku package](packages/roku.yaml) | [](https://amzn.to/2Ctp8cr) |
|
||||
| Amazon Dash Button | Quick actions (office lamp toggle) – [dash buttons automation](automation/dash_buttons.yaml) | [](https://amzn.to/2dPKZhM) |
|
||||
| Dreame/Neato vacuum | Cleaning schedules + notifications – [vacuum package](packages/vacuum.yaml) | [](https://amzn.to/4f7NpFP) |
|
||||
| Flux/LED strip controller | Monthly color scenes for exterior – [monthly color scene script](script/monthly_color_scene.yaml) | [](https://amzn.to/2jUBSBE) |
|
||||
| Etekcity/433MHz outlet | Accent lighting relays – [garage entry helper](automation/garage_entry_light.yaml) | [](https://amzn.to/2efNoBP) |
|
||||
|
||||
### Tips for re-use
|
||||
- Copy a package folder and adjust entity IDs in one place instead of hunting through automations.
|
||||
- Use the scripts and scenes as examples of how to break complicated flows into composable blocks.
|
||||
- The `www/` assets are ideal references when building your own Lovelace floorplans or dashboards.
|
||||
|
||||
**All of my configuration files are tested against the most stable version of home-assistant.**
|
||||
|
||||
<a name="bottom" href="https://github.com/CCOSTAN/Home-AssistantConfig#logo"><img align="right" border="0" src="https://raw.githubusercontent.com/CCOSTAN/Home-AssistantConfig/master/config/www/custom_ui/floorplan/images/branding/up_arrow.png" width="25" ></a>
|
||||
|
||||
**Still have questions on my Config?** <br>
|
||||
**Message me on X :** [](https://www.x.com/ccostan) or [](https://www.x.com/BearStoneHA)
|
||||
**Message me on X :** [](https://www.x.com/ccostan)
|
||||
|
||||
<p align="center">
|
||||
<a target="_blank" href="https://www.buymeacoffee.com/vCloudInfo"><img src="https://www.buymeacoffee.com/assets/img/BMC-btn-logo.svg" alt="Buy me a coffee"><span style="margin-left:5px">You can buy me a coffee</span></a><a target="_blank" href="https://www.buymeacoffee.com/vCloudInfo"><img src="https://www.buymeacoffee.com/assets/img/BMC-btn-logo.svg" alt="Buy me a coffee"></a>
|
||||
<br>
|
||||
<a align="center" target="_blank" href="https://vcloudinfo.us12.list-manage.com/subscribe?u=45cab4343ffdbeb9667c28a26&id=e01847e94f"><img src="https://feeds.feedburner.com/RecentCommitsToBearStoneHA.1.gif" alt="Recent Commits to Bear Stone Smart Home" style="border:0"></a>
|
||||
<br>
|
||||
<a href="https://eepurl.com/dmXFYz"><img align="center" border="0" src="https://raw.githubusercontent.com/CCOSTAN/Home-AssistantConfig/master/config/www/custom_ui/floorplan/images/branding/email_link.png" height="50" ></a><br>
|
||||
<a href="https://www.vCloudInfo.com/p/affiliate-disclosure.html">
|
||||
Affiliate Disclosure
|
||||
</a></p>
|
||||
|
||||
</p>
|
||||
|
||||
Reference in New Issue
Block a user