Using AI to update a lot of the documentaiton in the Repo.

2024-09-03 18:08:43 +00:00 · 2024-09-03 18:08:43 +00:00 · 51346c1c4c
parent 02efd9ae3d
commit 51346c1c4c
18 changed files with 203 additions and 76 deletions
--- a/config/.HA_VERSION
+++ b/config/.HA_VERSION
@ -1 +1 @@
-2024.9.0.dev202408230221
+2024.10.0.dev202409030223
--- a/config/automation/Speech/announcements.yaml
+++ b/config/automation/Speech/announcements.yaml
@ -1,10 +1,17 @@
-##########  ############################################################
-# @CCOSTAN
-# Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig
-##  Announce when people come or go.
-## Announce over all Chromecast Audios
-#  Read more at https://vCloudInfo.com
-######################################################################
+#-------------------------------------------
+# People Greeting Announcement
+# Description: Announces when family members arrive home
+#
+# Features:
+# - Triggers when a person's state changes from 'not_home' to 'home'
+# - Waits for specific sensors to confirm entry
+# - Uses speech_engine script for personalized welcome messages
+# - Includes responsibility reminders and home status checks
+#
+# Integration: Uses ChromeCast for audio output
+# Follow me https://www.vcloudinfo.com/click-here
+# More Blog Posts: https://www.vcloudinfo.com
+#-------------------------------------------
 - alias: 'People Greeting'
  id: 29c5c9dd-550a-4761-a224-78cdc3dd9f43
  mode: restart
--- a/config/automation/Speech/guest_mode.yaml
+++ b/config/automation/Speech/guest_mode.yaml
@ -1,7 +1,16 @@
-##########  ############################################################
-##  Announce when people come or go.
-## Announce over all Chromecast Audios
-######################################################################
+#-------------------------------------------
+# Guest Mode Announcements
+# Description: Manages audio announcements for guest mode activation and deactivation
+#
+# Features:
+# - Announces when guest mode is enabled
+# - Provides weather summary for guests
+# - Resets guest mode when family returns home
+#
+# Integration: Uses speech_engine script for announcements
+# uses ChromeCast for audio output
+# Follow me on https://www.vcloudinfo.com/click-here
+#-------------------------------------------
 - alias: 'Guest Mode Audio Feedback'
  id: 3622ba04-9a28-4c02-807c-be4abc663fe0

--- a/config/automation/Speech/responsibilities.yaml
+++ b/config/automation/Speech/responsibilities.yaml
@ -1,6 +1,14 @@
-######################################################################
-##  Who's day is it anyway? Pretty sure my parent's didn't code to figure this out.
-######################################################################
+#-------------------------------------------
+# Responsibilities Announcement
+# Description: Triggers a speech announcement for daily responsibilities
+#
+# Features:
+# - Announces garbage day and recycling reminders
+# - Triggered by an input_boolean entity
+#
+# Integration: Uses speech_engine script for announcements
+# Follow me on https://www.vcloudinfo.com/click-here
+#-------------------------------------------
 - alias: 'responsibilities'
  id: f39bd8db-a348-4024-a6a6-a3e3c836646c
  trigger:
--- a/config/configuration.yaml
+++ b/config/configuration.yaml
@ -1,8 +1,10 @@
 #-------------------------------------------
-# @CCOSTAN
-# Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig
-# Read all about this and more at https://vCloudInfo.com
-######################################################################################################
+# Home Assistant Configuration
+# Author: Carlo Costanzo (@CCOSTAN)
+# GitHub: https://github.com/CCOSTAN/Home-AssistantConfig
+# Blog: https://vCloudInfo.com
+# Description: Main configuration file for Home Assistant setup
+#-------------------------------------------

 homeassistant:
  # customize: !include_dir_merge_named customize
--- a/config/group/switches.yaml
+++ b/config/group/switches.yaml
@ -1,3 +1,11 @@
+#-------------------------------------------
+# Switches Configuration
+# Description: Groups and organizes various switches in the home
+#
+# Original Repository: https://github.com/CCOSTAN/Home-AssistantConfig
+# Follow me on https://www.vcloudinfo.com/click-here
+#-------------------------------------------
+
 Interior Switches:
  entities:
    - switch.kitchen_accent_1
--- a/config/homekit.yaml
+++ b/config/homekit.yaml
@ -1,9 +1,12 @@
 #-------------------------------------------
-# @CCOSTAN
-# Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig
-# Read all about this and more at https://vCloudInfo.com
-# HomeKit control file.
-######################################################################################################
+# HomeKit Configuration for Home Assistant
+#
+# Description: This file controls the HomeKit integration settings,
+# defining which entities are exposed to Apple HomeKit.
+#
+# Follow me on https://www.vcloudinfo.com/click-here
+# Original Repository: https://github.com/CCOSTAN/Home-AssistantConfig
+##-------------------------------------------

 filter:
  include_domains:
--- a/config/light_groups.yaml
+++ b/config/light_groups.yaml
@ -1,10 +1,15 @@
 #-------------------------------------------
-# @CCOSTAN
-# Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig
-# Read all about this and more at https://vCloudInfo.com
-# Additional Light groups control file for better Alexa / HomeKit support
-# https://github.com/CCOSTAN/Home-AssistantConfig/issues/764
-######################################################################################################
+# Light Groups Configuration for Home Assistant
+#
+# Description: This file defines light groups for improved control and integration
+# with voice assistants like Alexa and smart home platforms like HomeKit.
+#
+# For more information and updates, visit:
+# https://www.vcloudinfo.com/click-here
+#
+# Original Repository: https://github.com/CCOSTAN/Home-AssistantConfig
+# Related Issue: https://github.com/CCOSTAN/Home-AssistantConfig/issues/764
+#-------------------------------------------


 - platform: group
--- a/config/logger.yaml
+++ b/config/logger.yaml
@ -1,10 +1,16 @@
-############################################################
+#-------------------------------------------
+# Logger Configuration for Home Assistant
 #
-# Logger  You can filter anything betwen the []'s in the logger.
+# Description: This file controls the logging levels for various
+# components of Home Assistant. You can filter log entries by
+# adjusting the severity levels for each component.
 #
-############################################################
-
-# Log Severities: notset, debug, info, warn, warning, error, fatal, critical
+# Log Severities (in order of increasing severity):
+# notset, debug, info, warn, warning, error, fatal, critical
+#
+# Follow me on https://www.vcloudinfo.com/click-here
+# Original Repository: https://github.com/CCOSTAN/Home-AssistantConfig
+#-------------------------------------------

 default: info
 logs:
--- a/config/packages/conico.yaml
+++ b/config/packages/conico.yaml
@ -1,18 +1,24 @@
 #-------------------------------------------
-# @CCOSTAN
-# Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig
-# Conico Cameras via Alexa Media Player
+# Conico Cameras Configuration
+# Description: Integrates Conico Cameras with Alexa Media Player
+# Last Updated: 2023-11-15
+#
+# Features:
+# - Displays garage camera feed on Echo Show devices
+# - Triggers based on garage door state and occupancy changes
+#
+# Hardware:
+# - Conico Camera: https://amzn.to/2Kl1eHo
+# - Amazon Echo Show devices
+#
+# Integration: Alexa Media Player
+#
+# Original Repo: https://github.com/CCOSTAN/Home-AssistantConfig
+# Blog Post: https://www.vcloudinfo.com/2019/03/integrating-smart-cameras-with-alexa-echo-shows.html
+# Follow me on https://www.vcloudinfo.com/click-here
 #-------------------------------------------
-######################################################################
-##  Conico Camera - https://amzn.to/2Kl1eHo
-######################################################################


-######################################################################
-##  Show Camera on Echo Shows for 20 minutes after garage door opens.
-##  Show Image based on where Home Assistant thinks we are.
-######################################################################
-
 automation:
  - alias: 'Garage Camera on Alexa Shows'
    id: 4373df2a-77f2-4e19-be7c-46c7b27ca583
--- a/config/packages/finance.yaml
+++ b/config/packages/finance.yaml
@ -1,8 +1,22 @@
 #-------------------------------------------
-# @CCOSTAN
-# Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig
-# Tracking stocks with Yahoo Finance Custom Component
-# https://www.vcloudinfo.com/2020/10/how-to-track-stocks-in-home-assistant-using-a-custom-component.html
+# 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/
+#
+# Stocks Tracked:
+#   - Tesla (TSLA)
+#   - Apple (AAPL)
+#   - Amazon (AMZN)
+#   - Microsoft (MSFT)
+#
+# Update Interval: Every 4 hours
+#
+# Original Repo: https://github.com/CCOSTAN/Home-AssistantConfig
+# Blog Post: https://www.vcloudinfo.com/2020/10/how-to-track-stocks-in-home-assistant-using-a-custom-component.html
+# Follow me on https://www.vcloudinfo.com/click-here
 #-------------------------------------------

 yahoofinance:
--- a/config/packages/garadget.yaml
+++ b/config/packages/garadget.yaml
@ -1,9 +1,21 @@
 #-------------------------------------------
-# # @CCOSTAN
-# Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig
-## Garadget_Stuff -  [Garadget](https://amzn.to/2jQLpVQ) - Garage Door opener/sensor
-# Video and Write Up - https://www.vcloudinfo.com/2019/03/how-to-add-garadget-to-home-assistant.html
-# Switch to Access_Tokens - https://www.vcloudinfo.com/2020/05/fixing-garadget-in-home-assistant.html
+# Garadget Configuration
+# Description: Setup for Garadget garage door opener/sensor
+#
+# Integration: MQTT
+# Hardware: Garadget (https://amzn.to/2jQLpVQ)
+#
+# Features:
+#   - Garage door status monitoring
+#   - Remote open/close control
+#   - Door brightness sensing
+#
+# Documentation:
+#   - Integration Guide: https://www.vcloudinfo.com/2019/03/how-to-add-garadget-to-home-assistant.html
+#   - Access Token Update: https://www.vcloudinfo.com/2020/05/fixing-garadget-in-home-assistant.html
+#
+# Original Repository: https://github.com/CCOSTAN/Home-AssistantConfig
+# Follow me on https://www.vcloudinfo.com/click-here
 #-------------------------------------------

 mqtt:
--- a/config/recorder.yaml
+++ b/config/recorder.yaml
@ -1,6 +1,14 @@
-############################################################
-# recorder
-############################################################
+#-------------------------------------------
+# Recorder Configuration
+# Description: Settings for the Home Assistant recorder component
+# 
+# This component is responsible for storing events and states in a database
+# and purging old data to maintain database size.
+#
+# Documentation: https://www.home-assistant.io/integrations/recorder/
+# Follow me on https://www.vcloudinfo.com/click-here
+# Original Repo: https://github.com/CCOSTAN/Home-AssistantConfig
+#-------------------------------------------
 #db_url: sqlite:///data/home-assistant_v2.db
 purge_keep_days: 14
 include:
--- a/config/script/amp_settings.yaml
+++ b/config/script/amp_settings.yaml
@ -1,8 +1,13 @@
-######################################################################################################
-###Standardize AMP settings.
-## @CCOSTAN
-## Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig
-######################################################################################################
+#-------------------------------------------
+# AMP Settings Standardization Script
+# Description: This script standardizes the settings for audio amplifiers
+#              across various media players in the home.
+#
+# For more information and updates, visit:
+# https://www.vcloudinfo.com/click-here
+#
+# Original Repository: https://github.com/CCOSTAN/Home-AssistantConfig
+#-------------------------------------------

 # Set the AMP settings
 amp_settings:
--- a/config/script/speech_engine.yaml
+++ b/config/script/speech_engine.yaml
@ -11,7 +11,7 @@
    #   call_light_check
    #   call_inside_weather
    #   call_outside_weather
-# # @CCOSTAN
+# Follow me on https://www.vcloudinfo.com/click-here
 # Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig
 ######################################################################################################

--- a/config/script/speech_processing.yaml
+++ b/config/script/speech_processing.yaml
@ -1,12 +1,22 @@
-#####################################################################################################
-###Script to actually send notifications to the ChromeCast Audios during normal hours and only when we are home! Call like this:
-  # action:
-    # service: script.speech_engine
-    # media_player:
-    # speech_message:
-# # @CCOSTAN
-# Original Repo : https://github.com/CCOSTAN/Home-AssistantConfig
-######################################################################################################
+#-------------------------------------------
+# Speech Processing Script
+# Description: Sends notifications to ChromeCast Audio devices
+#
+# Features:
+# - Operates during specified hours
+# - Only activates when family is home or guest mode is on
+# - Adjustable volume based on time of day
+#
+# Usage:
+#   action: 
+#     service: script.speech_engine
+#     data:
+#       media_player: [target_media_player]
+#       speech_message: [message_to_speak]
+#
+# Original Repo: https://github.com/CCOSTAN/Home-AssistantConfig
+# follow me on X for updates: https://x.com/CCOSTAN
+#-------------------------------------------

 speech_processing:
  mode: queued
--- a/config/sensor/MQTT.yaml
+++ b/config/sensor/MQTT.yaml
@ -1,6 +1,12 @@
-###################################################
-## Various MQTT sensors
-###################################################
+#-------------------------------------------
+# MQTT Sensor Configuration
+# Description: Various MQTT sensors for Home Assistant
+#
+# For more information and updates, visit:
+# https://www.vcloudinfo.com/click-here
+#
+# Original Repository: https://github.com/CCOSTAN/Home-AssistantConfig
+#-------------------------------------------

 mqtt: 
  sensor:
--- a/config/templates/speech/briefing.yaml
+++ b/config/templates/speech/briefing.yaml
@ -1,3 +1,21 @@
+#-------------------------------------------
+# Speech Briefing Macros
+# Description: Contains various macros for generating speech briefings
+#
+# Features:
+# - Weather reports (inside and outside)
+# - Responsibility reminders
+# - Dark outside notification
+# - Holiday and countdown announcements
+# - Air quality reports
+# - Inspirational quotes and facts
+#
+# Original Repo: https://github.com/CCOSTAN/Home-AssistantConfig
+# Blog Post: https://www.vcloudinfo.com/category/home-assistant
+# Follow me on https://www.vcloudinfo.com/click-here
+#-------------------------------------------
+
+
 >-
  {%- macro dark_outside() -%}
    The sun has set. I will turn on the outside lights.