From b8209be849b80f1018fd5d4aa8c209fd91326a8c Mon Sep 17 00:00:00 2001 From: Ethel Morgan Date: Tue, 23 Jun 2020 16:25:11 +0100 Subject: add a basic README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..3a359b3 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ + + +# Catbus client library for Go + +[Catbus](https://ethulhu.co.uk/catbus) is a home automation platform built on MQTT. +This library wraps [Paho MQTT](https://godoc.org/github.com/eclipse/paho.mqtt.golang) for convenience, and some behavior additions. + +## Rebroadcast on connect + +To announce that a non-observing actuator exists, the actuator will need to broadcast an initial value on connect. +It does so using either a default value, or the last seen value put onto the bus, and will publish it after some delay after connecting. -- cgit v1.2.3