mirror of
https://github.com/CCOSTAN/Home-AssistantConfig.git
synced 2025-12-03 11:31:42 +00:00
100 lines
11 KiB
Markdown
Executable File
100 lines
11 KiB
Markdown
Executable File
<h1 align="center">
|
|
<a name="logo" href="https://www.vCloudInfo.com/tag/iot"><img src="https://raw.githubusercontent.com/CCOSTAN/Home-AssistantConfig/master/x_profile.png" alt="Bear Stone Smart Home" width="200"></a>
|
|
<br>
|
|
Bear Stone Smart Home Documentation
|
|
</h1>
|
|
<h4 align="center">Be sure to :star: my configuration repo so you can keep up to date on any daily progress!</h4>
|
|
|
|
<div align="center">
|
|
|
|
[](https://x.com/ccostan)
|
|
[](https://www.youtube.com/vCloudInfo?sub_confirmation=1)
|
|
[](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)
|
|
|
|
</div>
|
|
|
|
Live collection of plug-and-play Home Assistant packages. Each YAML file in this folder bundles sensors, helpers, automations, scripts, and Lovelace assets needed for a specific subsystem so you can drop it into `configuration.yaml` with a single `packages:` include.
|
|
|
|
### Quick navigation
|
|
- [Repo overview](../../README.md) | [Config index](../README.md) | [Automations](../automation) | [Scripts](../script) | [Scenes](../scene) | [Templates](../templates) | [Package triggers](triggers) | [YouTube](https://youtube.com/vCloudInfo) | [Blog](https://www.vcloudinfo.com)
|
|
- Disabled/staging packages follow the `.disabled` or `.NOTWORKING` suffix; remove it after you update credentials or hardware.
|
|
- Looking for the full gear list? See [../docs/legacy-readme.md](../../docs/legacy-readme.md).
|
|
|
|
|
|
|
|
### Why packages exist
|
|
- Keep everything for a subsystem (alarm, garage, water shutoff, etc.) in one file, which makes versioning, troubleshooting, and sharing dramatically easier.
|
|
- Encapsulate helpers (input_booleans, sensors, scripts) so enabling/disabling a capability is as simple as moving one file in or out of the `packages/` include.
|
|
- Document hardware dependencies right next to the logic so you remember which gear keeps each automation alive.
|
|
|
|
### How to adapt a package quickly
|
|
- Enable `packages:` under `homeassistant:` in your `configuration.yaml`, then drop any of these YAML files into the folder with your own entity IDs/secrets.
|
|
- Scan the comments at the top of each package for credential requirements, MQTT topics, or REST endpoints that need to be swapped.
|
|
- Need reusable triggers or button automations? Check the companion [triggers](triggers) subfolder for examples before rolling your own.
|
|
|
|
### Featured packages (live today)
|
|
| Package | What it unlocks | Notable entities / services |
|
|
| --- | --- | --- |
|
|
| [alarm.yaml](alarm.yaml) | NodeMCU-powered perimeter monitoring with arm/disarm helpers and rich notifications. | `binary_sensor.mcu*_gpio*`, `group.family`, notify + siren scripts |
|
|
| [garadget.yaml](garadget.yaml) | MQTT-based control + status for both garage doors, feeding entry/exit lighting routines. | `cover.large_garage_door`, `cover.small_garage_door`, `sensor.garadget_reflection` |
|
|
| [august.yaml](august.yaml) | Front-door August smart lock with Alexa Show camera pop-up when unlocked. | `lock.front_door`, media_player actions for front doorbell camera |
|
|
| [holiday.yaml](holiday.yaml) | REST-driven US holiday + flag sensors that color scenes and exterior lighting. | `sensor.holiday`, `sensor.flag`, JSON feed at `config/json_data/holidays.json` |
|
|
| [lightning.yaml](lightning.yaml) | Blitzortung lightning counter monitoring with snoozeable push actions. | `sensor.blitzortung_lightning_counter`, `input_boolean.snooze_lightning`, notify engine actions |
|
|
| [phynplus.yaml](phynplus.yaml) | Tie the Phyn Plus smart shutoff into HA notifications, automations, and valve overrides. | `valve.phyn_shutoff_valve`, `binary_sensor.phyn_leak_test_running`, `script.notify_engine_two_button` |
|
|
| [powerwall.yaml](powerwall.yaml) | Track Tesla Powerwall grid status and shed loads automatically when off-grid. | `binary_sensor.powerwall_grid_status`, `sensor.powerwall_*`, `script.notify_engine` |
|
|
| [vacuum.yaml](vacuum.yaml) | Dreame (ex-Neato) vacuum orchestration with maintenance reminders and reset helpers. | `sensor.l10s_vacuum_task_status`, `sensor.l10s_vacuum_sensor_dirty_left`, `button.l10s_vacuum_reset_sensor` |
|
|
| [finance.yaml](finance.yaml) | Yahoo Finance sensor bundle for portfolio glances and Lovelace cards. | `sensor.tsla`, `sensor.aapl`, `sensor.amzn`, `sensor.msft` |
|
|
|
|
### Blog & video deep dives
|
|
When a package has a dedicated blog post or video, I link it right inside the YAML comments. Here are the same references for quick browsing:
|
|
|
|
| Package | Why read/watch | Deep dive links |
|
|
| --- | --- | --- |
|
|
| [finance.yaml](finance.yaml) | Custom Yahoo Finance integration overview and setup notes. | [Blog](https://www.vcloudinfo.com/2020/10/how-to-track-stocks-in-home-assistant-using-a-custom-component.html) |
|
|
| [garadget.yaml](garadget.yaml) | MQTT garage door setup plus the follow-up on the access token change. | [Blog: Integration guide](https://www.vcloudinfo.com/2019/03/how-to-add-garadget-to-home-assistant.html) · [Blog: Token fix](https://www.vcloudinfo.com/2020/05/fixing-garadget-in-home-assistant.html) |
|
|
| [holiday.yaml](holiday.yaml) | How the holiday/flag sensor works and drives lighting playlists. | [Blog + video breakdown](https://www.vcloudinfo.com/2019/02/breaking-down-the-flag-sensor-in-home-assistant.html) |
|
|
| [lightning.yaml](lightning.yaml) | Blitzortung detector wiring, strike alerts, and snooze workflow. | [Blog](https://www.vcloudinfo.com/2020/08/adding-a-lightning-sensor-to-home-assistant.html) |
|
|
| [phynplus.yaml](phynplus.yaml) | Installing Phyn Plus and wiring its leak events into HA automations. | [Blog](https://www.vcloudinfo.com/2020/05/phyn-plus-smart-water-shutoff-device.html) |
|
|
| [powerwall.yaml](powerwall.yaml) | Monitoring Tesla Powerwall health + what to automate when the grid drops. | [Blog](https://www.vcloudinfo.com/2018/01/going-green-to-save-some-green-in-2018.html) |
|
|
| [vacuum.yaml](vacuum.yaml) | Keeping Neato/Dreame bots smart with HA scenes and maintenance timers. | [Blog](https://www.vcloudinfo.com/2020/05/home-assistant-neato-vacuum-automation.html) |
|
|
| [grafana.yaml.disabled](grafana.yaml.disabled) | Rendering Grafana dashboards to images for Lovelace and social posts. | [Blog](https://www.vcloudinfo.com/2018/01/going-green-to-save-some-green-in-2018.html) · [Blog](https://www.vcloudinfo.com/2018/09/re-installing-tesla-solar-panels-again.html) · [Video](https://youtu.be/BartadUzGOA) |
|
|
| [august.yaml](august.yaml) | Smart lock control and status from HA. | [YouTube short](https://youtu.be/UdcCeAyo9Ak?si=O-f607NHbRLKZxao) |
|
|
|
|
### Hardware referenced in packages (affiliate links)
|
|
These are the devices that power the packages above. Affiliate links never change the price but they do help fund more tinkering—thanks!
|
|
|
|
| Device | Package(s) | Automation tie-in | Buy |
|
|
| --- | --- | --- | --- |
|
|
| Garadget garage door controller | [garadget.yaml](garadget.yaml) | MQTT covers feed entry lighting, notifications, and security checks. | [](https://amzn.to/2jQLpVQ) |
|
|
| August smart lock | [august.yaml](august.yaml) | Front-door lock/unlock + status for routines and alerts. | [](https://amzn.to/48jVzZ3) |
|
|
| Amazon Echo Show | Pops up the front doorbell camera when the August lock unlocks. | [august.yaml](august.yaml) | [](https://amzn.to/4ptA3YO) |
|
|
| Phyn Plus water shutoff | [phynplus.yaml](phynplus.yaml) | Leak events trigger valve closes + critical push notifications. | [](https://amzn.to/2Zy3sbJ) |
|
|
| Rachio sprinkler controller | [rachio.yaml](rachio.yaml) | Rain skips and seasonal watering adjustments happen automatically. | [](https://amzn.to/2eoPKBW) |
|
|
| Tesla Powerwall 2 | [powerwall.yaml](powerwall.yaml) | Grid outages kick off load-shed scripts and status pings. | [](https://amzn.to/3UM4BZ5) |
|
|
| Dreame/Neato vacuum | [vacuum.yaml](vacuum.yaml) | Scheduled cleaning, maintenance reminders, and voice callouts. | [](https://amzn.to/4f7NpFP) |
|
|
| NodeMCU motion/contact sensor | [alarm.yaml](alarm.yaml), [office_motion.yaml](office_motion.yaml) | ESP8266 nodes feed the alarm matrix and room-aware lighting. | [](https://amzn.to/2oUgj5i) |
|
|
| Roku streaming device | [roku.yaml](roku.yaml) | Media presence drives lighting, announcements, and scenes. | [](https://amzn.to/2Ctp8cr) |
|
|
|
|
### Tips for extending these packages
|
|
- Most packages expose booleans or helpers that you can hook into with your own automations; keep using those entities instead of editing the package so upgrades stay clean.
|
|
- If you clone a package, rename the `id:` fields inside the automations to avoid duplicate UUIDs.
|
|
- Document your own blog or video resources at the top of each file—the README table above will make it easy to find them later.
|
|
|
|
**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)
|
|
|
|
<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 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>
|