Skip to content

Commit

Permalink
update TOCs for Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ironsheep committed Feb 27, 2023
1 parent 845fe07 commit cd5d91c
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
5 changes: 3 additions & 2 deletions HA-ADVERT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit cd5d91c

Please sign in to comment.