Merge pull request #1536 from CCOSTAN/Readme-Refactoring

Update README files to include August smart lock and Amazon Echo Show details, enhancing device listings with affiliate links and descriptions for improved user engagement.
This commit is contained in:
Carlo Costanzo
2025-11-24 12:02:23 -05:00
committed by GitHub
7 changed files with 79 additions and 20 deletions

View File

@@ -19,9 +19,9 @@
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)
- [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](config/www/custom_ui/floorplan/images/branding/Bear-Stone-Docker-Diagram.jpg) | [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
- Gear & affiliate catalog: see [../legacy-readme.md](../legacy-readme.md) for the complete shopping list
![Home Assistant header](https://i.imgur.com/vjDH1LJ.png)
@@ -45,14 +45,16 @@ Live view of the `config/` directory my production Home Assistant instance loads
| 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) |
| Dashboards & Media | UI chrome, floorplans, sound bites, and automation assets. | [www/custom_ui/floorplan/images/branding/Bear-Stone-Docker-Diagram.jpg](www/custom_ui/floorplan/images/branding/Bear-Stone-Docker-Diagram.jpg), [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).
Only including devices that have active references in the files above. Want the legacy list? Jump to [../legacy-readme.md](../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) | [![Buy](https://img.shields.io/badge/Buy-Garadget-orange?logo=amazon)](https://amzn.to/2jQLpVQ) |
| August smart lock | Front-door lock status + remote control [august package](packages/august.yaml) | [![Buy](https://img.shields.io/badge/Buy-August%20Lock-orange?logo=amazon)](https://amzn.to/48jVzZ3) |
| Amazon Echo Show | Pops up the front doorbell camera when the August lock unlocks [august package](packages/august.yaml) | [![Buy](https://img.shields.io/badge/Buy-Echo%20Show-orange?logo=amazon)](https://amzn.to/4ptA3YO) |
| Phyn Plus water shutoff | Leak detection + auto shutoff [phynplus package](packages/phynplus.yaml) | [![Buy](https://img.shields.io/badge/Buy-Phyn%20Plus-orange?logo=amazon)](https://amzn.to/2Zy3sbJ) |
| Rachio sprinkler controller | Rain-skips and seasonal watering [rachio package](packages/rachio.yaml) | [![Buy](https://img.shields.io/badge/Buy-Rachio-orange?logo=amazon)](https://amzn.to/2eoPKBW) |
| Tesla Powerwall 2 | Grid-outage alerts + load-shed automations [powerwall package](packages/powerwall.yaml) | [![Buy](https://img.shields.io/badge/Buy-Powerwall-orange?logo=tesla)](https://amzn.to/3UM4BZ5) |

View File

@@ -21,7 +21,7 @@ Live collection of plug-and-play Home Assistant packages. Each YAML file in this
### 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).
- Looking for the full gear list? See [../legacy-readme.md](../../legacy-readme.md).
![Home Assistant header](https://i.imgur.com/vjDH1LJ.png)
@@ -40,11 +40,13 @@ Live collection of plug-and-play Home Assistant packages. Each YAML file in this
| --- | --- | --- |
| [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` |
| [hass_agent_homepc.yaml](hass_agent_homepc.yaml) | Mirrors PC lock/unlock state from HASS.Agent to the office lamp for instant desk presence cues. | `sensor.carlo_homepc_carlo_homepc_sessionstate`, `switch.office_lamp_switch` |
| [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
@@ -60,6 +62,7 @@ When a package has a dedicated blog post or video, I link it right inside the YA
| [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!
@@ -67,6 +70,8 @@ These are the devices that power the packages above. Affiliate links never chang
| Device | Package(s) | Automation tie-in | Buy |
| --- | --- | --- | --- |
| Garadget garage door controller | [garadget.yaml](garadget.yaml) | MQTT covers feed entry lighting, notifications, and security checks. | [![Buy](https://img.shields.io/badge/Buy-Garadget-orange?logo=amazon)](https://amzn.to/2jQLpVQ) |
| August smart lock | [august.yaml](august.yaml) | Front-door lock/unlock + status for routines and alerts. | [![Buy](https://img.shields.io/badge/Buy-August%20Lock-orange?logo=amazon)](https://amzn.to/48jVzZ3) |
| Amazon Echo Show | Pops up the front doorbell camera when the August lock unlocks. | [august.yaml](august.yaml) | [![Buy](https://img.shields.io/badge/Buy-Echo%20Show-orange?logo=amazon)](https://amzn.to/4ptA3YO) |
| Phyn Plus water shutoff | [phynplus.yaml](phynplus.yaml) | Leak events trigger valve closes + critical push notifications. | [![Buy](https://img.shields.io/badge/Buy-Phyn%20Plus-orange?logo=amazon)](https://amzn.to/2Zy3sbJ) |
| Rachio sprinkler controller | [rachio.yaml](rachio.yaml) | Rain skips and seasonal watering adjustments happen automatically. | [![Buy](https://img.shields.io/badge/Buy-Rachio-orange?logo=amazon)](https://amzn.to/2eoPKBW) |
| Tesla Powerwall 2 | [powerwall.yaml](powerwall.yaml) | Grid outages kick off load-shed scripts and status pings. | [![Buy](https://img.shields.io/badge/Buy-Powerwall-orange?logo=tesla)](https://amzn.to/3UM4BZ5) |

View File

@@ -0,0 +1,35 @@
#-------------------------------------------
# Control the office lamp based on CARLO-HOMEPC session state via HASS.Agent.
# Sleep Number bed-triggered PC lock/monitor sleep lives in config/packages/sleepiq.yaml.
# Docs: https://hassagent.readthedocs.io/en/latest/
#-------------------------------------------
automation:
- alias: "Office Lamp - Follow CARLO-HOMEPC Session"
id: 7b3f9e14-55b1-44aa-a6eb-2e0873a4c2bb
mode: single
trigger:
- platform: state
entity_id: sensor.carlo_homepc_carlo_homepc_sessionstate
to: 'Locked'
id: locked
- platform: state
entity_id: sensor.carlo_homepc_carlo_homepc_sessionstate
to: 'Unlocked'
id: unlocked
action:
- choose:
- conditions:
- condition: trigger
id: locked
sequence:
- service: switch.turn_off
target:
entity_id: switch.office_lamp_switch
- conditions:
- condition: trigger
id: unlocked
sequence:
- service: switch.turn_on
target:
entity_id: switch.office_lamp_switch

View File

@@ -49,6 +49,19 @@ group:
- sensor.sleepnumber_carlo_stacey_sleepnumber
# - sensor.Stacey_sleep_hours
##############################################################################
### Automations - Detect when things are not right. Like any Good Watchdog.
##############################################################################
automation:
- alias: "CARLO-HOMEPC - Lock PC and Sleep Monitors When Carlo Is in Bed"
id: 25c69640-4c38-46a2-82ae-5a32c3c6f1b4
mode: single
trigger:
- platform: state
entity_id: binary_sensor.sleepnumber_carlo_carlo_is_in_bed
from: 'off'
to: 'on'
action:
- service: button.press
target:
entity_id: button.carlo_homepc_carlo_homepc_lock
- service: button.press
target:
entity_id: button.carlo_homepc_carlo_homepc_monitorsleep

Binary file not shown.

After

Width:  |  Height:  |  Size: 160 KiB