kenmirrors/Home-AssistantConfig
1
0
Fork 0
mirror of https://github.com/CCOSTAN/Home-AssistantConfig.git synced 2026-06-10 20:30:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
4457dc0bcdfb1eb13676ea0cbf2ba3fcdcbfa7a6
Home-AssistantConfig/config/script/README.md

72 lines
5.4 KiB
Markdown
Raw Normal View History

Possibly the best documented Repo on the internet. Maybe. #314
2018-02-28 23:31:46 -05:00
<h1 align="center">
Whoops.
2024-11-11 05:08:41 +00:00
<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>
Possibly the best documented Repo on the internet. Maybe. #314
2018-02-28 23:31:46 -05:00
<br>
Updated with all new Merch Links - https://amzn.to/2HXSx2M
2019-04-03 13:06:56 -04:00
Bear Stone Smart Home Documentation
Possibly the best documented Repo on the internet. Maybe. #314
2018-02-28 23:31:46 -05:00
</h1>
Updated with all new Merch Links - https://amzn.to/2HXSx2M
2019-04-03 13:06:56 -04:00
<h4 align="center">Be sure to :star: my configuration repo so you can keep up to date on any daily progress!</h4>
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.
2025-11-23 16:46:06 -05:00
Possibly the best documented Repo on the internet. Maybe. #314
2018-02-28 23:31:46 -05:00
<div align="center">
Update README.md
2022-12-22 10:10:02 -05:00
Update to better reflect the X follow count since the API is now closed off.
2025-01-24 18:02:23 +00:00
[![X Follow](https://img.shields.io/static/v1?label=talk&message=3k&color=blue&logo=twitter&style=for-the-badge)](https://x.com/ccostan)
Update README.md
2022-12-22 10:10:02 -05:00
[![YouTube Subscribe](https://img.shields.io/youtube/channel/subscribers/UC301G8JJFzY0BZ_0lshpKpQ?label=VIEW&logo=Youtube&logoColor=%23DF5D44&style=for-the-badge)](https://www.youtube.com/vCloudInfo?sub_confirmation=1)
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.
2025-11-23 16:46:06 -05:00
[![GitHub Stars](https://img.shields.io/github/stars/CCOSTAN/Home-AssistantConfig?label=STARS&logo=Github&style=for-the-badge)](https://github.com/CCOSTAN) <br>
Add working HA version to Menu Badges in ReADmeS
2024-12-24 16:58:25 +00:00
[![HA Version Badge](https://raw.githubusercontent.com/ccostan/home-assistantconfig/master/ha-version-badge.svg)](https://github.com/CCOSTAN/Home-AssistantConfig/blob/master/config/.HA_VERSION)
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.
2025-11-23 16:46:06 -05:00
[![Last Commit](https://img.shields.io/github/last-commit/CCOSTAN/Home-AssistantConfig.svg?style=plastic)](https://github.com/CCOSTAN/Home-AssistantConfig/commits/master)
[![Commit Activity](https://img.shields.io/github/commit-activity/y/CCOSTAN/Home-AssistantConfig.svg?style=plastic)](https://github.com/CCOSTAN/Home-AssistantConfig/commits/master)
Update README.md
2022-12-22 10:10:02 -05:00
Possibly the best documented Repo on the internet. Maybe. #314
2018-02-28 23:31:46 -05:00
</div>
#452 - https://www.vcloudinfo.com/2018/12/breaking-down-my-home-assistant-volume.html
2018-12-01 19:26:51 -05: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.
2025-11-23 16:46:06 -05:00
Reusable scripts that other automations call for notifications, lighting, and safety responses. Pass variables in; let the script do the heavy lifting.
### Quick navigation
Update README files across configuration directories to enhance navigation and clarity - Added "You are here" sections to various README files in the config directory, improving user orientation. - Updated links in the main README to reflect new structure and provide direct access to configuration readmes. - Enhanced descriptions in the automation, packages, scenes, scripts, and sounds directories for better usability. https://github.com/CCOSTAN/Home-AssistantConfig/pull/1535
2025-11-27 13:45:16 -05:00
- You are here: `config/script/` (scripts library)
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.
2025-11-23 16:46:06 -05:00
- [Repo overview](../../README.md) | [Config index](../README.md) | [Automations](../automation) | [Scenes](../scene) | [Blog: Speech engine video](https://www.vcloudinfo.com/2018/12/breaking-down-my-home-assistant-volume.html)
![Home Assistant header](https://i.imgur.com/vjDH1LJ.png)
### Featured files to browse
| File | Why it matters |
| --- | --- |
| [notify_engine.yaml](notify_engine.yaml) | Single entrypoint for rich push notifications. |
Refactor automation scripts to log significant events to the Activity feed using `script.send_to_logbook`. This includes updates to high wind speed notifications, bad login attempts, trigger dumps, startup notifications, and various other automations across multiple packages, enhancing visibility and tracking of system activities.
2025-12-12 16:38:24 -05:00
| [send_to_logbook.yaml](send_to_logbook.yaml) | Generic `logbook.log` helper for Activity feed entries (Issue #1550). |
Enhance Home Assistant YAML Dry Verifier and related automations - Added a mandatory resolution policy to the YAML verifier documentation, emphasizing the need for immediate resolution of findings. - Introduced a new `CENTRAL_SCRIPT` finding type to identify scripts defined in `config/packages` but called from multiple YAML files. - Updated the verifier script to collect and report on central script usage, including recommendations for moving definitions to appropriate locations. - Refactored various automations to utilize the new `script.joanna_dispatch` for improved context handling and remediation requests. - Enhanced existing automations with additional conditions and variables for better control and monitoring of actions. - Updated README files to reflect new features and improvements across packages.
2026-03-04 16:16:40 -05:00
| [joanna_dispatch.yaml](joanna_dispatch.yaml) | Shared BearClaw/Joanna dispatch schema for automation remediation requests. |
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.
2025-11-23 16:46:06 -05:00
| [speech_engine.yaml](speech_engine.yaml) | TTS/announcement orchestration with templated speech. |
| [monthly_color_scene.yaml](monthly_color_scene.yaml) | Seasonal lighting scenes used across automations. |
Update README files across configuration directories to enhance navigation and clarity - Added "You are here" sections to various README files in the config directory, improving user orientation. - Updated links in the main README to reflect new structure and provide direct access to configuration readmes. - Enhanced descriptions in the automation, packages, scenes, scripts, and sounds directories for better usability. https://github.com/CCOSTAN/Home-AssistantConfig/pull/1535
2025-11-27 13:45:16 -05:00
| [interior_off.yaml](interior_off.yaml) | One-call <20>all interior lights off<66> helper. |
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.
2025-11-23 16:46:06 -05:00
Enhance Home Assistant YAML Dry Verifier and related automations - Added a mandatory resolution policy to the YAML verifier documentation, emphasizing the need for immediate resolution of findings. - Introduced a new `CENTRAL_SCRIPT` finding type to identify scripts defined in `config/packages` but called from multiple YAML files. - Updated the verifier script to collect and report on central script usage, including recommendations for moving definitions to appropriate locations. - Refactored various automations to utilize the new `script.joanna_dispatch` for improved context handling and remediation requests. - Enhanced existing automations with additional conditions and variables for better control and monitoring of actions. - Updated README files to reflect new features and improvements across packages.
2026-03-04 16:16:40 -05:00
### Joanna + BearClaw automated resolution flow
`script.joanna_dispatch` is the shared handoff contract from Home Assistant automations to BearClaw/Joanna.
Why we use it:
- Keeps one message schema for remediation context (`trigger_context`, `source`, `summary`, `entity_ids`, `diagnostics`, `request`).
- Avoids repeating direct `rest_command.bearclaw_command` payload formatting in multiple packages.
- Makes resolution-trigger automations easier to review, update, and audit.
Current automations that kick off automated resolutions (via `script.joanna_dispatch`):
| Automation ID | Alias | File |
| --- | --- | --- |
| `mqtt_open_repair_on_failure` | MQTT - Open Repair On Failure | [../packages/mqtt_status.yaml](../packages/mqtt_status.yaml) |
| `onenote_indexer_daily_delete_maintenance` | OneNote Indexer - Daily Delete Maintenance Request | [../packages/onenote_indexer.yaml](../packages/onenote_indexer.yaml) |
| `onenote_indexer_failure_open_repair` | OneNote Indexer - Open Repair On Failure | [../packages/onenote_indexer.yaml](../packages/onenote_indexer.yaml) |
Enhance automation configurations and documentation - Updated dark_rainy_day.yaml to improve weather-related light automation with a more robust trigger mapping. - Refined docker_infrastructure.yaml to include a 20-minute escalation for persistent container outages and updated related documentation. - Revised onenote_indexer.yaml to clarify daily maintenance request details and improve communication style. - Enhanced space.yaml to track SpaceX launches with improved trigger logic and messaging. - Updated README.md and script documentation to reflect new features and automation enhancements.
2026-03-18 10:47:14 -04:00
| `docker_state_sync_repairs_dynamic` | Docker State Sync - Repairs (Dynamic) | [../packages/docker_infrastructure.yaml](../packages/docker_infrastructure.yaml) |
Enhance Home Assistant YAML Dry Verifier and related automations - Added a mandatory resolution policy to the YAML verifier documentation, emphasizing the need for immediate resolution of findings. - Introduced a new `CENTRAL_SCRIPT` finding type to identify scripts defined in `config/packages` but called from multiple YAML files. - Updated the verifier script to collect and report on central script usage, including recommendations for moving definitions to appropriate locations. - Refactored various automations to utilize the new `script.joanna_dispatch` for improved context handling and remediation requests. - Enhanced existing automations with additional conditions and variables for better control and monitoring of actions. - Updated README files to reflect new features and improvements across packages.
2026-03-04 16:16:40 -05:00
| `unifi_ap_no_clients_repair_combined` | Unifi AP Create Repair Issue after 5m of 0 Clients | [../packages/wireless.yaml](../packages/wireless.yaml) |
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.
2025-11-23 16:46:06 -05:00
### Tips
Update README files across configuration directories to enhance navigation and clarity - Added "You are here" sections to various README files in the config directory, improving user orientation. - Updated links in the main README to reflect new structure and provide direct access to configuration readmes. - Enhanced descriptions in the automation, packages, scenes, scripts, and sounds directories for better usability. https://github.com/CCOSTAN/Home-AssistantConfig/pull/1535
2025-11-27 13:45:16 -05:00
- Keep scripts generic<69>route data via `data:`/`variables:` and reuse everywhere.
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.
2025-11-23 16:46:06 -05:00
- If you copy a script, rename any `alias` and `id` fields to avoid duplicates.
**All of my configuration files are tested against the most stable version of home-assistant.**
#452 - https://www.vcloudinfo.com/2018/12/breaking-down-my-home-assistant-volume.html
2018-12-01 19:26:51 -05:00
Closes #339 - Added a Crap ton of imaging into the twitter feed.
2018-03-17 00:56:57 -04:00
<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>
Massive Migration! #292
2018-01-01 19:00:45 -05:00
Clean up the Formatting a Bit
2019-08-26 11:08:54 -04:00
**Still have questions on my Config?** <br>
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.
2025-11-23 16:46:06 -05:00
**Message me on X :** [![Follow CCostan](https://img.shields.io/twitter/follow/CCostan)](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>
Reference in New Issue Copy Permalink