Skip to content

Commit 2f57c65

Browse files
authored
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.
2 parents 0a99895 + dbd612a commit 2f57c65

7 files changed

Lines changed: 79 additions & 20 deletions

File tree

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919
Live, personal Home Assistant configuration shared for **browsing and inspiration**. This is not a turnkey clone-and-run setup; borrow ideas, adapt entity IDs/secrets, and test in your own environment.
2020

2121
### Quick navigation
22-
- [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)
22+
- [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)
2323
- Config highlights: `config/packages`, `config/automation`, `config/script`, `config/scene`, `config/templates`, `config/www`
24-
- Gear & affiliate catalog: see `docs/legacy-readme.md` (full device list with links)
24+
- Gear & affiliate catalog: see `legacy-readme.md` (full device list with links)
2525

2626
![Home Assistant header](https://i.imgur.com/vjDH1LJ.png)
2727

@@ -42,32 +42,35 @@ Live, personal Home Assistant configuration shared for **browsing and inspiratio
4242
- Garage routines and entry lighting: [config/packages/garadget.yaml](config/packages/garadget.yaml), [config/automation/garage_entry_light.yaml](config/automation/garage_entry_light.yaml)
4343
- Holiday/front-of-house color scenes: [config/scene/monthly_colors.yaml](config/scene/monthly_colors.yaml), [config/script/monthly_color_scene.yaml](config/script/monthly_color_scene.yaml)
4444
- Dash-button triggers for quick actions: [config/automation/dash_buttons.yaml](config/automation/dash_buttons.yaml)
45+
- PC lock/unlock-driven lighting via HASS.Agent: [config/packages/hass_agent_homepc.yaml](config/packages/hass_agent_homepc.yaml)
4546
- Battery and solar awareness: [config/packages/powerwall.yaml](config/packages/powerwall.yaml)
4647
- Presence-aware office comfort: [config/packages/office_motion.yaml](config/packages/office_motion.yaml)
4748
- Weather-aware lighting: [config/automation/dark_rainy_day.yaml](config/automation/dark_rainy_day.yaml)
4849

4950
### Network diagram
50-
![Smart Home Diagram](https://raw.githubusercontent.com/CCOSTAN/Home-AssistantConfig/master/config/www/custom_ui/floorplan/images/branding/bearstoneflow.png)
51+
![Smart Home Diagram](config/www/custom_ui/floorplan/images/branding/Bear-Stone-Docker-Diagram.jpg)
5152

5253
### Gear tied to real automations (affiliate links)
53-
Only listing hardware that appears in active packages/automations here. The full catalog (including older gear) remains in `docs/legacy-readme.md`.
54-
54+
Only listing hardware that appears in active packages/automations here. The full catalog (including older gear) remains in `legacy-readme.md`.
55+
https://amzn.to/48jVzZ3
5556
| Device | What it drives (friendly name -> file) | Buy |
5657
| --- | --- | --- |
5758
| Garadget garage door controller | Garage doors: open/close, reflection alerts - [garadget package](config/packages/garadget.yaml) | [![Buy](https://img.shields.io/badge/Buy-Garadget-orange?logo=amazon)](https://amzn.to/2jQLpVQ) |
59+
| August smart lock | Front-door lock control + status - [august package](config/packages/august.yaml) | [![Buy](https://img.shields.io/badge/Buy-August%20Lock-orange?logo=amazon)](https://amzn.to/48jVzZ3) |
5860
| Phyn Plus water shutoff | Leak detection + auto shutoff - [phynplus package](config/packages/phynplus.yaml) | [![Buy](https://img.shields.io/badge/Buy-Phyn%20Plus-orange?logo=amazon)](https://amzn.to/2Zy3sbJ) |
5961
| Rachio sprinkler controller | Rain-skips and seasonal watering - [rachio package](config/packages/rachio.yaml) | [![Buy](https://img.shields.io/badge/Buy-Rachio-orange?logo=amazon)](https://amzn.to/2eoPKBW) |
6062
| Tesla Powerwall 2 | Grid-outage alerts + load-shed automations - [powerwall package](config/packages/powerwall.yaml) | [![Buy](https://img.shields.io/badge/Buy-Powerwall-orange?logo=tesla)](https://amzn.to/3UM4BZ5) |
6163
| NodeMCU motion sensor | Office motion lighting - [office_motion package](config/packages/office_motion.yaml) | [![Buy](https://img.shields.io/badge/Buy-Motion%20Node-orange?logo=amazon)](https://amzn.to/2oUgj5i) |
6264
| Raspberry Pi 3 + Aeon Z-Wave stick | Z-Wave backbone for door/hall sensors - [garage entry helper](config/automation/garage_entry_light.yaml) | [![Pi](https://img.shields.io/badge/Buy-Pi%203-orange?logo=raspberrypi)](https://amzn.to/2e3DOBY) [![Z-Wave](https://img.shields.io/badge/Buy-Z--Wave%20Stick-orange?logo=zwave)](https://amzn.to/2eAiAP0) |
6365
| Roku streaming device | TV presence -> scenes/lighting - [roku package](config/packages/roku.yaml) | [![Buy](https://img.shields.io/badge/Buy-Roku-orange?logo=roku)](https://amzn.to/2Ctp8cr) |
6466
| Amazon Dash Button | Quick actions (office lamp toggle) - [dash buttons automation](config/automation/dash_buttons.yaml) | [![Buy](https://img.shields.io/badge/Buy-Dash%20Button-orange?logo=amazon)](https://amzn.to/2dPKZhM) |
67+
| Amazon Echo Show | Front door camera pop-up when the August lock unlocks - [august package](config/packages/august.yaml) | [![Buy](https://img.shields.io/badge/Buy-Echo%20Show-orange?logo=amazon)](https://amzn.to/4ptA3YO) |
6568
| Dreame/Neato vacuum | Cleaning schedules + notifications - [vacuum package](config/packages/vacuum.yaml) | [![Buy](https://img.shields.io/badge/Buy-Vacuum-orange?logo=amazon)](https://amzn.to/4f7NpFP) |
6669
| Flux/LED strip controller | Monthly color scenes for exterior - [monthly color scene](config/script/monthly_color_scene.yaml) | [![Buy](https://img.shields.io/badge/Buy-LED%20Controller-orange?logo=amazon)](https://amzn.to/2jUBSBE) |
6770
| Etekcity/433MHz outlet | Accent lighting relays - [garage entry helper](config/automation/garage_entry_light.yaml) | [![Buy](https://img.shields.io/badge/Buy-433MHz%20Outlet-orange?logo=amazon)](https://amzn.to/2efNoBP) |
6871

6972
### Gear and affiliate links
70-
- I keep a detailed, affiliate-supported gear list in `docs/legacy-readme.md`. Browsing or purchasing through those links helps support this project; thanks!
73+
- I keep a detailed, affiliate-supported gear list in `legacy-readme.md`. Browsing or purchasing through those links helps support this project; thanks!
7174

7275
**All of my configuration files are tested against the most stable version of home-assistant.**
7376

config/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919
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.
2020

2121
### Quick navigation
22-
- [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)
22+
- [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)
2323
- Directory highlights: [packages](packages), [automation](automation), [script](script), [scene](scene), [templates](templates), [www](www), [custom_components](custom_components)
24-
- Gear & affiliate catalog: see [../docs/legacy-readme.md](../docs/legacy-readme.md) for the complete shopping list
24+
- Gear & affiliate catalog: see [../legacy-readme.md](../legacy-readme.md) for the complete shopping list
2525

2626
![Home Assistant header](https://i.imgur.com/vjDH1LJ.png)
2727

@@ -45,14 +45,16 @@ Live view of the `config/` directory my production Home Assistant instance loads
4545
| 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) |
4646
| 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) |
4747
| Templates & Speech | Human-friendly voice briefings and templated responses. | [templates/speech/briefing.yaml](templates/speech/briefing.yaml) |
48-
| 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) |
48+
| 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) |
4949

5050
### Gear tied to these automations (affiliate links)
51-
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).
51+
Only including devices that have active references in the files above. Want the legacy list? Jump to [../legacy-readme.md](../legacy-readme.md).
5252

5353
| Device | What it drives (friendly name -> file) | Buy |
5454
| --- | --- | --- |
5555
| 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) |
56+
| 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) |
57+
| 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) |
5658
| 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) |
5759
| 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) |
5860
| 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) |

config/packages/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Live collection of plug-and-play Home Assistant packages. Each YAML file in this
2121
### Quick navigation
2222
- [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)
2323
- Disabled/staging packages follow the `.disabled` or `.NOTWORKING` suffix; remove it after you update credentials or hardware.
24-
- Looking for the full gear list? See [../docs/legacy-readme.md](../../docs/legacy-readme.md).
24+
- Looking for the full gear list? See [../legacy-readme.md](../../legacy-readme.md).
2525

2626
![Home Assistant header](https://i.imgur.com/vjDH1LJ.png)
2727

@@ -40,11 +40,13 @@ Live collection of plug-and-play Home Assistant packages. Each YAML file in this
4040
| --- | --- | --- |
4141
| [alarm.yaml](alarm.yaml) | NodeMCU-powered perimeter monitoring with arm/disarm helpers and rich notifications. | `binary_sensor.mcu*_gpio*`, `group.family`, notify + siren scripts |
4242
| [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` |
43+
| [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 |
4344
| [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` |
4445
| [lightning.yaml](lightning.yaml) | Blitzortung lightning counter monitoring with snoozeable push actions. | `sensor.blitzortung_lightning_counter`, `input_boolean.snooze_lightning`, notify engine actions |
4546
| [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` |
4647
| [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` |
4748
| [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` |
49+
| [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` |
4850
| [finance.yaml](finance.yaml) | Yahoo Finance sensor bundle for portfolio glances and Lovelace cards. | `sensor.tsla`, `sensor.aapl`, `sensor.amzn`, `sensor.msft` |
4951

5052
### Blog & video deep dives
@@ -60,13 +62,16 @@ When a package has a dedicated blog post or video, I link it right inside the YA
6062
| [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) |
6163
| [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) |
6264
| [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) |
65+
| [august.yaml](august.yaml) | Smart lock control and status from HA. | [YouTube short](https://youtu.be/UdcCeAyo9Ak?si=O-f607NHbRLKZxao) |
6366

6467
### Hardware referenced in packages (affiliate links)
6568
These are the devices that power the packages above. Affiliate links never change the price but they do help fund more tinkering—thanks!
6669

6770
| Device | Package(s) | Automation tie-in | Buy |
6871
| --- | --- | --- | --- |
6972
| 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) |
73+
| 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) |
74+
| 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) |
7075
| 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) |
7176
| 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) |
7277
| 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) |
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
#-------------------------------------------
2+
# Control the office lamp based on CARLO-HOMEPC session state via HASS.Agent.
3+
# Sleep Number bed-triggered PC lock/monitor sleep lives in config/packages/sleepiq.yaml.
4+
# Docs: https://hassagent.readthedocs.io/en/latest/
5+
#-------------------------------------------
6+
7+
automation:
8+
- alias: "Office Lamp - Follow CARLO-HOMEPC Session"
9+
id: 7b3f9e14-55b1-44aa-a6eb-2e0873a4c2bb
10+
mode: single
11+
trigger:
12+
- platform: state
13+
entity_id: sensor.carlo_homepc_carlo_homepc_sessionstate
14+
to: 'Locked'
15+
id: locked
16+
- platform: state
17+
entity_id: sensor.carlo_homepc_carlo_homepc_sessionstate
18+
to: 'Unlocked'
19+
id: unlocked
20+
action:
21+
- choose:
22+
- conditions:
23+
- condition: trigger
24+
id: locked
25+
sequence:
26+
- service: switch.turn_off
27+
target:
28+
entity_id: switch.office_lamp_switch
29+
- conditions:
30+
- condition: trigger
31+
id: unlocked
32+
sequence:
33+
- service: switch.turn_on
34+
target:
35+
entity_id: switch.office_lamp_switch

config/packages/sleepiq.yaml

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,19 @@ group:
4949
- sensor.sleepnumber_carlo_stacey_sleepnumber
5050
# - sensor.Stacey_sleep_hours
5151

52-
##############################################################################
53-
### Automations - Detect when things are not right. Like any Good Watchdog.
54-
##############################################################################
52+
automation:
53+
- alias: "CARLO-HOMEPC - Lock PC and Sleep Monitors When Carlo Is in Bed"
54+
id: 25c69640-4c38-46a2-82ae-5a32c3c6f1b4
55+
mode: single
56+
trigger:
57+
- platform: state
58+
entity_id: binary_sensor.sleepnumber_carlo_carlo_is_in_bed
59+
from: 'off'
60+
to: 'on'
61+
action:
62+
- service: button.press
63+
target:
64+
entity_id: button.carlo_homepc_carlo_homepc_lock
65+
- service: button.press
66+
target:
67+
entity_id: button.carlo_homepc_carlo_homepc_monitorsleep
160 KB
Loading

0 commit comments

Comments
 (0)