From c464073a0d012164cab25b84d551b23b35ccbbc6 Mon Sep 17 00:00:00 2001 From: Carlo Costanzo Date: Sat, 29 Nov 2025 13:17:00 -0500 Subject: [PATCH] Standardizing on Headers for all YAML files. - Updated comments in various YAML configuration files to provide clearer descriptions of functionalities and integrations. - Improved documentation for alarm, alexa_media_player, backups, blink, cbyge, climate, finance, fridge, garadget, glances, hass_agent_homepc, holiday, ios, landscape_lighting, lightning, logger, medicine, nfc_tags, noonhome, office_motion, phynplus, powerwall, printer, processmonitor, proxmox, rachio, rheem_econet, roku, sleepiq, space, speedtest, stats, superbowl, vacuum, wireless, and youtube packages. - Added relevant links and issue references where applicable to enhance user guidance and support. --- config/packages/alarm.yaml | 5 +++- config/packages/alexa_media_player.yaml | 6 +++-- config/packages/backups.yaml | 6 +++-- config/packages/blink.yaml | 8 +++--- config/packages/cbyge.yaml | 9 ++++--- config/packages/climate.yaml | 12 ++++++--- config/packages/finance.yaml | 14 +++++----- config/packages/fridge.yaml | 7 ++--- config/packages/garadget.yaml | 34 +++++++------------------ config/packages/glances.yaml | 7 ++--- config/packages/hass_agent_homepc.yaml | 11 +++++--- config/packages/holiday.yaml | 12 +++++---- config/packages/ios.yaml | 9 ++++--- config/packages/landscape_lighting.yaml | 9 ++++--- config/packages/lightning.yaml | 12 +++++---- config/packages/logger.yaml | 5 +++- config/packages/medicine.yaml | 5 ++-- config/packages/nfc_tags.yaml | 7 ++--- config/packages/noonhome.yaml | 9 ++++--- config/packages/office_motion.yaml | 10 +++++--- config/packages/phynplus.yaml | 8 +++--- config/packages/powerwall.yaml | 26 ++++++++++--------- config/packages/printer.yaml | 7 +++-- config/packages/processmonitor.yaml | 4 +++ config/packages/proxmox.yaml | 10 +++++--- config/packages/rachio.yaml | 5 ++-- config/packages/rheem_econet.yaml | 8 +++--- config/packages/roku.yaml | 6 +++-- config/packages/sleepiq.yaml | 4 +++ config/packages/space.yaml | 8 +++--- config/packages/speedtest.yaml | 9 ++++++- config/packages/stats.yaml | 8 ++++-- config/packages/superbowl.yaml | 8 +++--- config/packages/vacuum.yaml | 8 +++--- config/packages/wireless.yaml | 13 +++++++--- config/packages/youtube.yaml | 14 +++++----- 36 files changed, 200 insertions(+), 143 deletions(-) diff --git a/config/packages/alarm.yaml b/config/packages/alarm.yaml index f56e4343..5f762242 100755 --- a/config/packages/alarm.yaml +++ b/config/packages/alarm.yaml @@ -1,8 +1,11 @@ #------------------------------------------- -# ALarm Related Packages # @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig +# Alarm Package - Arming helpers, sensors, and alerting. #------------------------------------------- +###################################################################### +## Alarm sensors, customization, and automations for home security. +###################################################################### homeassistant: customize_glob: "device_tracker.nodemcu*": diff --git a/config/packages/alexa_media_player.yaml b/config/packages/alexa_media_player.yaml index fea8f4ca..231cd218 100755 --- a/config/packages/alexa_media_player.yaml +++ b/config/packages/alexa_media_player.yaml @@ -1,9 +1,11 @@ #------------------------------------------- # @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig -# Alexa Media Sensor Support - Relies on Custom Component +# Alexa Media Player - Sensors and notifications via Alexa Media integration. #------------------------------------------- - +###################################################################### +## Track Alexa media state and expose routine/command triggers. +###################################################################### sensor: - platform: template sensors: diff --git a/config/packages/backups.yaml b/config/packages/backups.yaml index 1ce137c0..bc73ffb6 100755 --- a/config/packages/backups.yaml +++ b/config/packages/backups.yaml @@ -1,10 +1,12 @@ #------------------------------------------- # @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig +# Backups - Monitor backup jobs and alert on failures. #------------------------------------------- +###################################################################### +## Duplicati/backup status sensors and notifications. +###################################################################### # Added Duplicati to HA - https://github.com/CCOSTAN/Home-AssistantConfig/issues/1498 - -#------------------------------------------- automation: - alias: 'Backup Job Failed Notification' id: 5b3a4c89-1234-4567-8901-23456789abcf diff --git a/config/packages/blink.yaml b/config/packages/blink.yaml index c448c961..5e07f53a 100755 --- a/config/packages/blink.yaml +++ b/config/packages/blink.yaml @@ -1,11 +1,11 @@ #------------------------------------------- # @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig -# Support for Blink Cameras (https://amzn.to/3lOYTCv) -# Added ThinLg HACS integration for Fridge sensors - https://github.com/ollo69/ha-smartthinq-sensors +# Blink Cameras - Motion snapshots and alerts via Blink integration. #------------------------------------------- - -############################################################################## +###################################################################### +## Blink camera monitoring and notifications. https://amzn.to/3lOYTCv +###################################################################### ### Automations ############################################################################## automation: diff --git a/config/packages/cbyge.yaml b/config/packages/cbyge.yaml index 357b96a0..61a43900 100755 --- a/config/packages/cbyge.yaml +++ b/config/packages/cbyge.yaml @@ -1,11 +1,12 @@ -# https://www.vcloudinfo.com/click-here #------------------------------------------- -# C by GE Lights - https://amzn.to/30w3UWy # @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig -# Changing the way we call these routines.. no longer using routines.. using custom commands via ALEXA Media Player. -# https://github.com/CCOSTAN/Home-AssistantConfig/issues/812 +# C by GE Lights - Voice control routines via Alexa Media Player. #------------------------------------------- +###################################################################### +## Manage C by GE/GE Cync lights/outlets. https://amzn.to/30w3UWy +###################################################################### +# Moving routines to custom Alexa commands (see issue #812). ################################################## ## Scripts diff --git a/config/packages/climate.yaml b/config/packages/climate.yaml index 249a88cd..a8721748 100644 --- a/config/packages/climate.yaml +++ b/config/packages/climate.yaml @@ -1,8 +1,12 @@ +#------------------------------------------- +# @CCOSTAN +# Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig +# Climate Control - Seasonal HVAC automations and sensors. +#------------------------------------------- ###################################################################### -## AC related automations -## For more info visit https://www.vcloudinfo.com/click-here -## Contact: @CCOSTAN -# -------------------------------------------------------------- +## Thermostat helpers for upstairs/downstairs comfort. +###################################################################### +# For more info visit https://www.vcloudinfo.com/click-here | Contact: @CCOSTAN # Entity reference and attribute summaries: # # Entity ID: climate.downstairs diff --git a/config/packages/finance.yaml b/config/packages/finance.yaml index 6e8aeabd..b32ae5ba 100755 --- a/config/packages/finance.yaml +++ b/config/packages/finance.yaml @@ -1,11 +1,11 @@ #------------------------------------------- -# Finance Package Configuration -# Description: Tracks stock prices using Yahoo Finance integration -# Last Updated: 2023-11-15 -# -# Integration: Yahoo Finance -# Documentation: https://www.home-assistant.io/integrations/yahoofinance/ -# +# @CCOSTAN +# Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig +# Finance - Track stock prices via Yahoo Finance. +#------------------------------------------- +###################################################################### +## Finance tickers via yahoofinance. Docs: https://www.home-assistant.io/integrations/yahoofinance/ +###################################################################### # Stocks Tracked: # - Tesla (TSLA) # - Apple (AAPL) diff --git a/config/packages/fridge.yaml b/config/packages/fridge.yaml index a0dee2b4..fc241acb 100644 --- a/config/packages/fridge.yaml +++ b/config/packages/fridge.yaml @@ -1,10 +1,11 @@ #------------------------------------------- # @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig -# Support for LG Fridges (https://amzn.to/3lOYTCv) -# Added ThinLg HACS integration for Fridge sensors - https://github.com/ollo69/ha-smartthinq-sensors +# LG Fridge - SmartThinQ appliance monitoring. #------------------------------------------- - +###################################################################### +## Fridge/freezer sensors via ThinQ integration. https://amzn.to/3lOYTCv +###################################################################### automation: - alias: 'Fridge Door Open' id: 2346efcd-e8a8-4e86-b5b6-43eBl1nkFr1dge95D00r0pen diff --git a/config/packages/garadget.yaml b/config/packages/garadget.yaml index c479cd07..69ac3713 100755 --- a/config/packages/garadget.yaml +++ b/config/packages/garadget.yaml @@ -1,30 +1,14 @@ #------------------------------------------- -# Garadget Configuration for Home Assistant -# -# This package sets up the Garadget garage doors using MQTT cover and sensor platforms. -# -# Automation Integration: -# - Fully supports Home Assistant automation for notifications, -# remote control, and state monitoring. -# - Works seamlessly with notification engines (see `script.notify_engine`) -# for actionable alerts when garage state changes or manual intervention is required. -# -# Features: -# - Garage door status monitoring (open/close state, time since change) -# - Remote open, close, and stop actions -# - Door brightness sensing (helps detect obstacles or sunlight conditions) -# -# Integration/Setup Guides: -# - Setup: https://www.vcloudinfo.com/2019/03/how-to-add-garadget-to-home-assistant.html -# - Token Fix: https://www.vcloudinfo.com/2020/05/fixing-garadget-in-home-assistant.html -# -# Hardware: -# - Garadget unit (https://amzn.to/2jQLpVQ) -# -# Repository & Author: -# - https://github.com/CCOSTAN/Home-AssistantConfig -# - @CCOSTAN | More info: https://www.vcloudinfo.com/click-here +# @CCOSTAN +# Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig +# Garadget Garage Doors - MQTT cover control and monitoring. #------------------------------------------- +###################################################################### +## Open/close commands, reflection alerts, and actionable notifications. +###################################################################### +# Setup: https://www.vcloudinfo.com/2019/03/how-to-add-garadget-to-home-assistant.html +# Token fix: https://www.vcloudinfo.com/2020/05/fixing-garadget-in-home-assistant.html +# Hardware: Garadget unit https://amzn.to/2jQLpVQ mqtt: cover: diff --git a/config/packages/glances.yaml b/config/packages/glances.yaml index f8e6a8f7..e1a64e42 100755 --- a/config/packages/glances.yaml +++ b/config/packages/glances.yaml @@ -1,10 +1,11 @@ #------------------------------------------- -# Setting up Glances Integration for home assistant to track ProxMox stats # @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig -# +# Glances - ProxMox/server stats via Glances integration. #------------------------------------------- - +###################################################################### +## CPU, memory, and disk sensors from Glances API. +###################################################################### sensor: - platform: template sensors: diff --git a/config/packages/hass_agent_homepc.yaml b/config/packages/hass_agent_homepc.yaml index bbe7af55..d1398c6c 100644 --- a/config/packages/hass_agent_homepc.yaml +++ b/config/packages/hass_agent_homepc.yaml @@ -1,9 +1,12 @@ #------------------------------------------- -# 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. +# @CCOSTAN +# Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig +# HASS.Agent Home PC - Office lamp follows CARLO-HOMEPC session state. +#------------------------------------------- +###################################################################### +## Locks/monitors PC activity via HASS.Agent; Sleep Number triggers live 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 diff --git a/config/packages/holiday.yaml b/config/packages/holiday.yaml index 2261ddc2..204cca58 100755 --- a/config/packages/holiday.yaml +++ b/config/packages/holiday.yaml @@ -1,11 +1,13 @@ -############################################################################### #------------------------------------------- -# Holiday Package # @CCOSTAN -# Repo : https://github.com/CCOSTAN/Home-AssistantConfig -# Video Breakdown - https://www.vcloudinfo.com/2019/02/breaking-down-the-flag-sensor-in-home-assistant.html +# Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig +# Holiday Package - Flag/holiday sensors and lighting triggers. #------------------------------------------- -## Modified for my own fun stuff! +###################################################################### +## Holiday routines, notifications, and lighting tweaks. +###################################################################### +# Video breakdown: https://www.vcloudinfo.com/2019/02/breaking-down-the-flag-sensor-in-home-assistant.html +# Modified for my own fun stuff! homeassistant: customize: diff --git a/config/packages/ios.yaml b/config/packages/ios.yaml index 0dc71983..7dd62526 100755 --- a/config/packages/ios.yaml +++ b/config/packages/ios.yaml @@ -1,11 +1,12 @@ #------------------------------------------- -# Realtime Debugging Related Packages # @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig -# More information found here #780, #168 -# https://github.com/CCOSTAN/Home-AssistantConfig/issues/780 -# https://github.com/CCOSTAN/Home-AssistantConfig/issues/168 +# iOS Debugging - Notification helpers and app diagnostics. #------------------------------------------- +###################################################################### +## iOS push config and troubleshooting helpers. +###################################################################### +# More info: https://github.com/CCOSTAN/Home-AssistantConfig/issues/780 | #168 notify: # - platform: ios #Not Needed anymore - 10/04/2020 diff --git a/config/packages/landscape_lighting.yaml b/config/packages/landscape_lighting.yaml index cee17c32..979e026d 100755 --- a/config/packages/landscape_lighting.yaml +++ b/config/packages/landscape_lighting.yaml @@ -1,11 +1,12 @@ #------------------------------------------- -# Landscape Lighting Packages # @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig -# Landscape Lights are Tuya Based Outlets in Smart_Life Package. -#------------------------------------------- - +# Landscape Lighting - Tuya Smart Life outlets for exterior lights. #------------------------------------------- +###################################################################### +## Schedules and overrides for landscape lighting. +###################################################################### +# Outlets managed via Smart_Life package. group: landscaping: entities: diff --git a/config/packages/lightning.yaml b/config/packages/lightning.yaml index f40b1517..8779c929 100755 --- a/config/packages/lightning.yaml +++ b/config/packages/lightning.yaml @@ -1,10 +1,12 @@ -################################### -## Lightning is no Joke around here. +#------------------------------------------- # @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig -# https://github.com/CCOSTAN/Home-AssistantConfig/issues/392 -# https://www.vcloudinfo.com/2020/08/adding-a-lightning-sensor-to-home-assistant.html -################################### +# Lightning Alerts - Monitor nearby strikes and notify. +#------------------------------------------- +###################################################################### +## Lightning sensor integration and alerting. +###################################################################### +# Guide: https://www.vcloudinfo.com/2020/08/adding-a-lightning-sensor-to-home-assistant.html | Issue #392 input_boolean: snooze_lightning: name: Snooze Lightning diff --git a/config/packages/logger.yaml b/config/packages/logger.yaml index d5851750..a30ef171 100755 --- a/config/packages/logger.yaml +++ b/config/packages/logger.yaml @@ -1,8 +1,11 @@ #------------------------------------------- -# Realtime Debugging Related Packages # @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig +# Logger Controls - Realtime debugging helpers. #------------------------------------------- +###################################################################### +## Adjust Home Assistant log level from the UI. +###################################################################### input_select: log_level: name: Log Level diff --git a/config/packages/medicine.yaml b/config/packages/medicine.yaml index eaf4dbe9..6395502e 100755 --- a/config/packages/medicine.yaml +++ b/config/packages/medicine.yaml @@ -1,10 +1,11 @@ -###################################################################### #------------------------------------------- # @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig -# ## - Reminders to take my medicine +# Medicine Reminders - Take medicine notifications. #------------------------------------------- ###################################################################### +## Medication reminder timers and alerts. +###################################################################### input_boolean: diff --git a/config/packages/nfc_tags.yaml b/config/packages/nfc_tags.yaml index 22951a3d..a6931a43 100755 --- a/config/packages/nfc_tags.yaml +++ b/config/packages/nfc_tags.yaml @@ -1,10 +1,11 @@ #------------------------------------------- -# Messing around with NFC stickers - https://amzn.to/3L7efQv # @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig -# +# NFC Tags - Trigger automations with NFC stickers. #------------------------------------------- - +###################################################################### +## NFC tag experiments and quick actions. https://amzn.to/3L7efQv +###################################################################### automation: - alias: 'Toggle Office Lamp with NFC tag' id: 30c6d2bb-fe8b-4101-9241-03416726cdf4 diff --git a/config/packages/noonhome.yaml b/config/packages/noonhome.yaml index e51247f7..e5e941a6 100755 --- a/config/packages/noonhome.yaml +++ b/config/packages/noonhome.yaml @@ -1,11 +1,12 @@ #------------------------------------------- -# Noon Home Switches and Lights - https://amzn.to/3fOIPx6 # @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig -# Changing the way we call these routines.. no longer using routines.. using custom commands via ALEXA Media Player. -# https://github.com/CCOSTAN/Home-AssistantConfig/issues/366 -# Noon No longer supported. +# Noon Home - Switch and light routines via Alexa Media Player. #------------------------------------------- +###################################################################### +## Noon Home lighting controls (legacy hardware). https://amzn.to/3fOIPx6 +###################################################################### +# Routines now use custom Alexa commands (issue #366). Noon no longer supported. ################################################## ## Scripts diff --git a/config/packages/office_motion.yaml b/config/packages/office_motion.yaml index d57f558e..c3f13aab 100755 --- a/config/packages/office_motion.yaml +++ b/config/packages/office_motion.yaml @@ -1,8 +1,12 @@ #------------------------------------------- -# Motion Sensor in the office. -# Find more recipes @ https://github.com/CCOSTAN/Home-AssistantConfig +# @CCOSTAN +# Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig +# Office Motion - Motion/illuminance triggers for office lighting. #------------------------------------------- -#------LightSensor Node---https://amzn.to/2oUgj5i +###################################################################### +## Office motion sensors and automations. +###################################################################### +# Light sensor node: https://amzn.to/2oUgj5i homeassistant: customize: binary_sensor.office_motion: diff --git a/config/packages/phynplus.yaml b/config/packages/phynplus.yaml index 018dd96d..210d47e8 100755 --- a/config/packages/phynplus.yaml +++ b/config/packages/phynplus.yaml @@ -1,11 +1,13 @@ #------------------------------------------- # @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig -# Phyn Smart Water ShutOff Support -# https://www.vcloudinfo.com/2020/05/phyn-plus-smart-water-shutoff-device.html -# Added in Custom HACK integration via https://github.com/MizterB/homeassistant-phyn +# Phyn Plus Water Shutoff - Leak detection and auto shutoff. #------------------------------------------- ###################################################################### +## Phyn Plus monitoring via custom integration. +###################################################################### +# Info: https://www.vcloudinfo.com/2020/05/phyn-plus-smart-water-shutoff-device.html +# HACS: https://github.com/MizterB/homeassistant-phyn ## Phyn Plus Water ShutOff - https://amzn.to/2Zy3sbJ ###################################################################### diff --git a/config/packages/powerwall.yaml b/config/packages/powerwall.yaml index 4c928dae..a4d45893 100755 --- a/config/packages/powerwall.yaml +++ b/config/packages/powerwall.yaml @@ -1,11 +1,13 @@ -###################################################################################################### -### @Tesla Powerwall - https://www.vcloudinfo.com/2018/01/going-green-to-save-some-green-in-2018.html -# # @CCOSTAN +#------------------------------------------- +# @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig -# Read more about this on https://www.vcloudinfo.com -# Tesla Powerwall added via UI Integration -# Tesla Powerwall Monitoring #272 +# Tesla Powerwall - Monitoring and outage automations. +#------------------------------------------- ###################################################################### +## Powerwall status sensors and load-shedding helpers. +###################################################################### +# Read more: https://www.vcloudinfo.com/2018/01/going-green-to-save-some-green-in-2018.html | Issue #272 +# Tesla Powerwall added via UI Integration # -------------------------------------------------------------- # Binary Sensors: # - binary_sensor.powerwall_charging ............. battery_charging (on=charging) @@ -23,14 +25,14 @@ # - sensor.powerwall_solar_power ................. kW solar production # # Lifetime kWh Meters: -# - sensor.powerwall_battery_export .............. kWh → grid/load -# - sensor.powerwall_battery_import .............. kWh ← battery charged +# - sensor.powerwall_battery_export .............. kWh -> grid/load +# - sensor.powerwall_battery_import .............. kWh <- battery charged # - sensor.powerwall_load_export ................. kWh exported from loads # - sensor.powerwall_load_import ................. kWh imported to loads -# - sensor.powerwall_site_export ................. kWh site → grid -# - sensor.powerwall_site_import ................. kWh site ← grid -# - sensor.powerwall_solar_export ................ kWh solar → site/battery/grid -# - sensor.powerwall_solar_import ................ kWh solar ← grid (rare) +# - sensor.powerwall_site_export ................. kWh site -> grid +# - sensor.powerwall_site_import ................. kWh site <- grid +# - sensor.powerwall_solar_export ................ kWh solar -> site/battery/grid +# - sensor.powerwall_solar_import ................ kWh solar <- grid (rare) # # Switches: # - switch.powerwall_off_grid_operation .......... island mode toggle diff --git a/config/packages/printer.yaml b/config/packages/printer.yaml index 69844549..f69d934b 100755 --- a/config/packages/printer.yaml +++ b/config/packages/printer.yaml @@ -1,9 +1,12 @@ #------------------------------------------- # @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig -# inspired by https://community.home-assistant.io/t/epson-wf-3540-ink-level-monitoring/21813 +# Printer Watchdog - Monitor Epson ink and status. #------------------------------------------- - +###################################################################### +## Printer status sensors and health alerts. +###################################################################### +# Inspired by https://community.home-assistant.io/t/epson-wf-3540-ink-level-monitoring/21813 ############################################################################## ### Automations - Detect when things are not right. Like any Good Watchdog. ############################################################################## diff --git a/config/packages/processmonitor.yaml b/config/packages/processmonitor.yaml index dd286e14..18618e98 100755 --- a/config/packages/processmonitor.yaml +++ b/config/packages/processmonitor.yaml @@ -1,7 +1,11 @@ #------------------------------------------- # @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig +# Process Monitor - Track HA-related services and processes. #------------------------------------------- +###################################################################### +## Process status sensors and notifications. +###################################################################### # homeassistant: # customize: # sensor.process_mosquitto: diff --git a/config/packages/proxmox.yaml b/config/packages/proxmox.yaml index 6e534889..9a34a0ab 100644 --- a/config/packages/proxmox.yaml +++ b/config/packages/proxmox.yaml @@ -1,8 +1,12 @@ #------------------------------------------- -# Setting up nightly reboot schedule for Frigate server via Proxmox -# https://www.vcloudinfo.com/click-here +# @CCOSTAN +# Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig +# Proxmox Frigate Host - Nightly reboot schedule. #------------------------------------------- - +###################################################################### +## Automates nightly reboot of the Frigate server via Proxmox API. +###################################################################### +# More info: https://www.vcloudinfo.com/click-here automation: - alias: "Nightly Frigate Server Reboot" id: nightly_frigate_reboot diff --git a/config/packages/rachio.yaml b/config/packages/rachio.yaml index 8b97f715..cbbd65d5 100755 --- a/config/packages/rachio.yaml +++ b/config/packages/rachio.yaml @@ -1,10 +1,10 @@ #------------------------------------------- # @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig -# Rachio Sprinkler system Support +# Rachio Sprinkler - Rain skips and seasonal scheduling. #------------------------------------------- ###################################################################### -## [Rachio Sprinkler system](https://amzn.to/2eoPKBW) - Smart Sprinkler controller +## Smart sprinkler controller via Rachio. https://amzn.to/2eoPKBW ###################################################################### # # sensor: @@ -12,4 +12,3 @@ # state_topic: "ifttt/rachio/watering_time" # name: "Rachio_watering_time" - diff --git a/config/packages/rheem_econet.yaml b/config/packages/rheem_econet.yaml index 7ef4ef65..5ca376b7 100755 --- a/config/packages/rheem_econet.yaml +++ b/config/packages/rheem_econet.yaml @@ -1,10 +1,12 @@ #------------------------------------------- # @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig -# Support for Rheem Water Heaters (https://amzn.to/36yOSnN) -# https://github.com/CCOSTAN/Home-AssistantConfig/issues/892 -# https://www.home-assistant.io/integrations/econet/ +# Rheem EcoNet Water Heater - Monitoring and control. #------------------------------------------- +###################################################################### +## Rheem EcoNet sensors/automations. https://amzn.to/36yOSnN +###################################################################### +# Docs: https://www.home-assistant.io/integrations/econet/ | Issue #892 # Powerwall outage control for Rheem WH lives in config/packages/powerwall.yaml ############################################################################## diff --git a/config/packages/roku.yaml b/config/packages/roku.yaml index f0f051ef..8e26b5a4 100755 --- a/config/packages/roku.yaml +++ b/config/packages/roku.yaml @@ -1,9 +1,11 @@ #------------------------------------------- # @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig -# Roku Related Functions - https://amzn.to/2Ctp8cr +# Roku - Presence detection and remote finder. #------------------------------------------- - +###################################################################### +## Roku media sensors and utility helpers. https://amzn.to/2Ctp8cr +###################################################################### input_boolean: living_room_remote_finder: name: "Living Room Remote Finder" diff --git a/config/packages/sleepiq.yaml b/config/packages/sleepiq.yaml index ccd84669..137b2f29 100755 --- a/config/packages/sleepiq.yaml +++ b/config/packages/sleepiq.yaml @@ -1,7 +1,11 @@ #------------------------------------------- # @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig +# SleepIQ - Bed presence and Sleep Number metrics. #------------------------------------------- +###################################################################### +## SleepIQ sensors and automation helpers. +###################################################################### homeassistant: customize_glob: "sensor.*_sleep_hours": diff --git a/config/packages/space.yaml b/config/packages/space.yaml index 7148d61e..98da41ca 100755 --- a/config/packages/space.yaml +++ b/config/packages/space.yaml @@ -1,10 +1,11 @@ #------------------------------------------- -# Space Related Packages # @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig +# Space - ISS and space-related sensors. #------------------------------------------- - - +###################################################################### +## Track space events and ISS passes. +###################################################################### sensor: - platform: rest @@ -39,4 +40,3 @@ automation: value1: 'Go Outside! There is a Rocket Launch very soon! {{states.sensor.next_launch.attributes.stream }}' group: 'information' - diff --git a/config/packages/speedtest.yaml b/config/packages/speedtest.yaml index baf52676..680a53b7 100644 --- a/config/packages/speedtest.yaml +++ b/config/packages/speedtest.yaml @@ -1,4 +1,11 @@ -# Automation to notify Carlo if internet speeds fall below 400 Mbps +#------------------------------------------- +# @CCOSTAN +# Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig +# Speedtest Alerts - Notify when internet speeds drop. +#------------------------------------------- +###################################################################### +## Alerts if download/upload fall below thresholds. +###################################################################### # For more info or questions, visit https://www.vcloudinfo.com/click-here automation: diff --git a/config/packages/stats.yaml b/config/packages/stats.yaml index 8bdea8dc..3afbeffe 100755 --- a/config/packages/stats.yaml +++ b/config/packages/stats.yaml @@ -1,8 +1,12 @@ #------------------------------------------- -# find me on X @CCOSTAN +# @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig -# Updated for AI notifications +# Stats - Historical metrics and AI notifications. #------------------------------------------- +###################################################################### +## Build historical stats for AI/alerting. +###################################################################### +# Find me on X @CCOSTAN ### Building out some Historical stats for AI. ##################### command_line: diff --git a/config/packages/superbowl.yaml b/config/packages/superbowl.yaml index 129dc96b..d8244a94 100755 --- a/config/packages/superbowl.yaml +++ b/config/packages/superbowl.yaml @@ -1,10 +1,11 @@ #------------------------------------------- -# Setting up some fun flash lights if anyone scores in the superbowl. Will need to update the sensors each year though. # @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig -# https://github.com/CCOSTAN/Home-AssistantConfig/issues/1502# +# Super Bowl Lights - Flash routines on scoring events. #------------------------------------------- - +###################################################################### +## Game-day automations; update sensors yearly. Issue #1502. +###################################################################### automation: - alias: 'Super Bowl Team Score Change' id: 5b3a4c89-1234-4567-8901-23456789abcd @@ -106,4 +107,3 @@ automation: {% endif %} brightness: 255 effect: 'none' - diff --git a/config/packages/vacuum.yaml b/config/packages/vacuum.yaml index d21fb7f6..e43bc6dd 100755 --- a/config/packages/vacuum.yaml +++ b/config/packages/vacuum.yaml @@ -1,10 +1,12 @@ #------------------------------------------- # @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig -# Neato Support for D7 Connected Botvac - control my [Neato Vacuum](https://amzn.to/2kqnnqu) with Home Assistant. -# Switched from Neato to Dreame Vacuum - https://amzn.to/4f7NpFP +# Vacuum - Dreame/Neato cleaning schedules and alerts. #------------------------------------------- - +###################################################################### +## Vacuum control and notifications (migrated from Neato to Dreame). +###################################################################### +# Neato D7: https://amzn.to/2kqnnqu | Dreame: https://amzn.to/4f7NpFP ############################################################################## ### Configuration - Authentication via the DEVELOPER Portal ### HACS - https://github.com/Tasshack/dreame-vacuum diff --git a/config/packages/wireless.yaml b/config/packages/wireless.yaml index e56ab910..809dd52d 100644 --- a/config/packages/wireless.yaml +++ b/config/packages/wireless.yaml @@ -1,7 +1,12 @@ -# Wireless AP client alert configurations -# See related discussion: https://github.com/CCOSTAN/Home-AssistantConfig/issues/1534 -# This file contains sensors and alerts for tracking Unifi AP clients. - +#------------------------------------------- +# @CCOSTAN +# Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig +# Wireless AP Alerts - Unifi client monitoring and repair triggers. +#------------------------------------------- +###################################################################### +## Alert when APs have zero clients; create repair issues. +###################################################################### +# Discussion: https://github.com/CCOSTAN/Home-AssistantConfig/issues/1534 automation: - id: unifi_ap_no_clients_repair_combined alias: "Unifi AP Create Repair Issue after 5m of 0 Clients" diff --git a/config/packages/youtube.yaml b/config/packages/youtube.yaml index e3c09d16..5fc3ad46 100755 --- a/config/packages/youtube.yaml +++ b/config/packages/youtube.yaml @@ -1,13 +1,13 @@ #------------------------------------------- -# Visit The Main Blog for More Home Assistant Goodness - https://www.vCloudInfo.com -# Follow me on the socials - @CCOSTAN +# @CCOSTAN # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig -# YouTube Related Packages from @Pinkywafer -# https://github.com/pinkywafer/Home-Assistant_Config/blob/master/packages/youtube/vcloudinfo.yaml -# More information found here in these issues -# https://github.com/CCOSTAN/Home-AssistantConfig/issues/720 +# YouTube Channel - Track vCloudInfo channel stats via YouTube sensor. #------------------------------------------- - +###################################################################### +## Channel metrics for @vCloudInfo/CCOSTAN. +###################################################################### +# Based on Pinkywafer's package: https://github.com/pinkywafer/Home-Assistant_Config/blob/master/packages/youtube/vcloudinfo.yaml +# Issue reference: https://github.com/CCOSTAN/Home-AssistantConfig/issues/720 sensor: - platform: youtube channel_id: UC301G8JJFzY0BZ_0lshpKpQ