homebridge-broadlink-rm-blaster 1.4.0 → 1.7.0

package/CHANGELOG.md

@@ -6,6 +6,92 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## [1.7.0] - 2026-08-07
+
+### Added
+- MQTT control for simple on/off accessories, advanced accessories, dimmer
+  lights and TVs, alongside fans. Simple accessories, advanced accessories
+  and TVs take `{"state": "ON"}`; dimmers also take `{"level": 50}`.
+- Accessories controlled over MQTT publish their own on/off state as
+  `{"state": "ON"}` whenever they turn on or off, however that was
+  triggered.
+- Fans: a "Swing On Power On" option that starts the fan oscillating
+  whenever it is turned on, sent once the speed has settled. Skipped if it
+  is already swinging, since the signal is usually a toggle.
+
+### Changed
+- MQTT commands are now read from `<topic>/set` rather than `<topic>`,
+  which is left to carry the accessory's state. An existing fan keeps its
+  configured topic, but whatever publishes to it has to move to
+  `<topic>/set`.
+- Retaining MQTT messages is set per device and per accessory - "Retain
+  sensor data messages" on an RM device, "Retain state messages" on an
+  accessory - instead of one setting covering everything. Both default to
+  on, so retaining carries on as before.
+
+### Fixed
+- Sliding a fan on fired a signal the instant HomeKit reported it active,
+  while the slider was still moving. On a fan whose speed button is also
+  its power button that press is part of the very sequence the slider is
+  about to work out, so it read as one signal too many. Turning on now
+  waits on the same settle as the slider, and a slide sends one burst at
+  the end. Turning off stays immediate.
+- Turning a simple accessory or TV off with no Power Off Signal configured
+  logged "Sent Power Off" while actually re-sending Power On, which only
+  turns anything off if that signal is a toggle. The log now names the
+  signal really sent.
+
+## [1.6.0] - 2026-08-07
+
+### Added
+- Fans: a new accessory type. A fan has any number of speeds (one cycle
+  button, or separate up and down buttons), optional swing, and any number
+  of extra on/off features such as cooling, each exposed as its own
+  labelled switch. Power can come from a dedicated button - a single
+  toggle or separate on/off - or from whichever speed, swing or feature
+  button actually powers the fan.
+- Fans: an optional signal sent every time the fan is turned on, for
+  things like maxing out a heater's thermostat.
+- Fans: an optional resync switch that clears what the plugin thinks the
+  fan is doing without sending any signals, for when the fan has been used
+  from its own remote.
+- Fans: swing can also be put on its own switch, since the Home app hides
+  its built-in oscillate control once an accessory is more than just a
+  fan.
+- Fans can be driven from MQTT. Give a fan a topic and it listens on
+  `<base topic>/<topic>` for messages like
+  `{"state":"ON", "speed": 100, "swing": "ON"}`. Anything left out is not
+  changed, and retained messages are applied on connect.
+- `broadlink-rm-learner`: a "Just show hex code" option that captures one
+  signal and prints it for copy/pasting, without saving anything.
+
+### Changed
+- "Basic Accessories" renamed to "Simple On/Off Accessories" in the Config
+  UI form and the learner.
+- The learner's menu order now matches the Config UI form's sections.
+
+### Fixed
+- Dragging a fan's speed slider sent a signal for every position it passed
+  through. It is now debounced (0.5s by default) and acts only on where
+  the slider lands.
+- A fan feature with no name took the whole accessory down at startup,
+  which could happen after saving the fan in the Config UI. Unusable
+  features are skipped with a warning instead.
+- Blank rows left behind in any accessory list by saving the Config UI
+  form no longer log warnings about accessories named "undefined".
+- Config UI field descriptions no longer lose text wrapped in angle
+  brackets, which the form renders as HTML. The MQTT base topic
+  description had been affected since 1.3.0.
+
+## [1.5.0] - 2026-08-06
+
+### Added
+- Advanced Accessories: a new standalone accessory type where one button
+  press sends multiple signals in sequence, with a configurable timeout
+  between them. An optional Off signal gives it real on/off state (a
+  normal Switch); without one, it's an auto-resetting momentary trigger
+  instead. `broadlink-rm-learner` can learn these too.
+
 ## [1.4.0] - 2026-08-05
 
 ### Added

package/README.md

@@ -1,4 +1,4 @@
-# Broadlink RM Blaster 1.4.0
+# Broadlink RM Blaster 1.7.0
 
 **This Homebridge plugin has been 100% vibe coded with Claude.**
 
@@ -23,12 +23,14 @@ hb-service add homebridge-broadlink-rm-blaster
 
 - **Multiple RM devices** configure several Broadlink RMs and assign each accessory to whichever one
 - **Interactive code learning** learn codes straight from your remote and add them to your config
-- **Basic accessories** power on/off
+- **Simple on/off accessories** power on/off
+- **Advanced accessories** one press sends multiple signals in sequence, with a configurable timeout between them
 - **Dimmer lights** one signal per discrete brightness level
+- **Fans** speed control, optional swing, extra on/off features (e.g. cooling), and an optional resync switch
 - **TVs** power on/off plus a usable remote in the iOS Remote app
 - **Temperature/humidity sensor** optionally expose sensor data
 - **ntfy.sh notifications** push notification when a RM fails to connect
-- **MQTT publishing** optionally publish sensor data to a MQTT broker
+- **MQTT** optionally publish sensor data to a broker, and drive fans from MQTT messages
 - **Fully configurable** via the Homebridge Config UI X plugin settings form
 
 ## Configuration
@@ -45,10 +47,71 @@ your config, run this in the Homebridge shell:
 broadlink-rm-learner
 ```
 
-Run `broadlink-rm-learner --help` for usage details.
+Run `broadlink-rm-learner --help` for usage details. Advanced Accessories
+(multiple signals per press) and Fans (speed levels, modes, swing) can be
+learned too, alongside Simple On/Off Accessories, TVs, and Dimmer Lights.
+There's also a "just show hex code" option that captures a single signal
+and prints it for copy/pasting, without saving anything.
 
 Backs up `config.json` to `config.json.backup` once per session before writing anything.
 
+## MQTT
+
+Enable MQTT in the plugin settings to publish temperature and humidity
+readings, and to control accessories over MQTT.
+
+Tick "Control via MQTT" on an accessory and give it a topic. It then reads
+commands from the MQTT base topic followed by that topic and `/set`, and
+publishes its own on/off state to the same topic without `/set`:
+
+| | Topic |
+| --- | --- |
+| Commands in | `broadlinkrm/bedroom-fan/set` |
+| State out | `broadlinkrm/bedroom-fan` |
+
+State is published as `{"state": "ON"}` or `{"state": "OFF"}` whenever the
+accessory turns on or off, however it was triggered. It is retained unless
+you untick "Retain state messages" on that accessory, so a subscriber
+connecting later immediately gets the last known state. Commands are JSON,
+and anything left out is not changed.
+
+### Simple on/off accessories, advanced accessories and TVs
+
+```json
+{ "state": "ON" }
+```
+
+| Key | Values |
+| --- | --- |
+| `state` | `ON` or `OFF` |
+
+### Dimmer lights
+
+```json
+{ "state": "ON", "level": 50 }
+```
+
+| Key | Values |
+| --- | --- |
+| `state` | `ON` or `OFF` |
+| `level` | `0` to `100` |
+
+### Fans
+
+```json
+{ "state": "ON", "speed": 100, "swing": "ON" }
+```
+
+| Key | Values |
+| --- | --- |
+| `state` | `ON` or `OFF` |
+| `speed` | `0` to `100` |
+| `swing` | `ON` or `OFF` |
+
+`{"speed": 50}` on its own only changes the speed. `"state": "OFF"` turns
+the fan off and ignores the rest of the message. Retained messages are
+applied when the plugin connects.
+
 ## Debugging
 
 To send a single hex code straight to your RM, bypassing Homebridge/HomeKit entirely run this in the Homebridge shell: