From cd5d91ca8d57006fb45df8f492855182fab9c97d Mon Sep 17 00:00:00 2001 From: Stephen M Moraco Date: Sun, 26 Feb 2023 17:47:22 -0700 Subject: [PATCH] update TOCs for Documentation --- HA-ADVERT.md | 5 +++-- README.md | 9 +++++---- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/HA-ADVERT.md b/HA-ADVERT.md index ed50e92..062cdbc 100644 --- a/HA-ADVERT.md +++ b/HA-ADVERT.md @@ -18,12 +18,13 @@ This page describes what is being advertised to Home Assistant. On this Page: -- [Status Endpoints](#mqtt-rpi-status-topics) - shows what changes when the commanding interface is exposed -- [Control Endpoints](#mqtt-rpi-command-topics) - configuring the Daemon to offer the commanding interface +- [Status Endpoints](#mqtt-rpi-status-topics) - shows the sensors offered by the Daemon +- [Control Endpoints](#mqtt-rpi-command-topics) - shows the buttons offered by the Daemon (when they are configured) Additional pages: - [Overall Daemon Instructions](/README.md) - This project top level README +- [Controlling your RPi from Home Assistant](./RMTECTRL.md) - (Optional) Set up to allow remote control from HA - [The Associated Lovelace RPi Monitor Card](https://github.com/ironsheep/lovelace-rpi-monitor-card) - This is our companion Custom Lovelace Card that makes displaying this RPi Monitor data very easy. - [ChangeLog](./ChangeLog) - We've been repairing or adding features to this script as users report issues or wishes. This is our list of changes. diff --git a/README.md b/README.md index e92c66f..a3e5899 100644 --- a/README.md +++ b/README.md @@ -30,15 +30,16 @@ On this Page: Additional pages: - [Controlling your RPi from Home Assistant](./RMTECTRL.md) - (Optional) Set up to allow remote control from HA -- [The Associated Lovelace RPi Monitor Card](https://github.com/ironsheep/lovelace-rpi-monitor-card) - This is our companion Custom Lovelace Card that makes displaying this RPi Monitor data very easy. -- [ChangeLog](./ChangeLog) - We've been repairing or adding features to this script as users report issues or wishes. This is our list of changes. +- [In practice: Advertisements to HA](./HA-ADVERT.md) - Details of the actual advertisements this Daemon publishes to MQTT +- [The Associated Lovelace RPi Monitor Card](https://github.com/ironsheep/lovelace-rpi-monitor-card) - This is our companion Lovelace Card that makes displaying this RPi Monitor data very easy +- [ChangeLog](./ChangeLog) - We've been repairing or adding features to this script as users report issues or wishes. This is our list of changes ## Features - Tested on Raspberry Pi's 2/3/4 with Jessie, Stretch and Buster -- Tested with Home Assistant v0.111.0 -> 2021.11.5 -- Tested with Mosquitto broker v5.1 - v6.0.1 +- Tested with Home Assistant v0.111.0 -> 2023.2.5 +- Tested with Mosquitto broker v5.1 - v6.1.3 - Data is published via MQTT - MQTT discovery messages are sent so RPi's are automatically registered with Home Assistant (if MQTT discovery is enabled in your HA installation) - MQTT authentication support