homebridge-rinnai-touch-platform

# MQTT The plugin is able to operate as an MQTT client. It publishes various topics containing information about the Rinnai/Brivis system which other clients can subscribe to. It also subscribes to topics allowing other clients to send commands to the Rinnai Touch module. This can be useful for interacting with external applications such as [Home Assistant](https://www.home-assistant.io) and [Node-RED](https://nodered.org). ## Configuration It is recommended to use the Homebridge UI to configure the MQTT client which can be found in the "MQTT Settings" section within the Homebrudge UI. You can also manually configure it in the JSON config file using the following keys: |Key|Required|Type|Description|Default Value (if not supplied)| |-|-|-|-|-| |`host`|Yes|string|MQTT Broker host name|| |`port`|Yes|number|MQTT Broker port|`1883`| |`username`|No|string|Credentials for MQTT Broker|| |`password`|No|string||| |`topicPrefix`|No|string|Optional text to prefix to each topic name|| |`formatHomeAssistant`|No|boolean|Enable Home Assistant message format|`false`| |`formatConnection`|No|boolean|Enable Connection Status message format|`false`| |`formatFault`|No|boolean|Enable Fault Status message format|`false`| |`publishStatusChanged`|No|boolean|Publish when status has changed|`false`| |`publishIntervals`|No|boolean|Publish at regular intervals|`false`| |`publishFrequency`|No|number|Publish frequency (secs)|`60`| |`publishAll`|No|boolean|Publish all topics even if payload has not changed|`false`| |`showMqttEvents`|No|boolean|Include MQTT events in the logs|`true`| |`subscribeTemperature`|No|object|Defines the topics the plugin subscribes to for receiving temeprature payloads|| ### subscribeTemperature settings: |Key|Required|Type|Description|Default Value (if not supplied)| |-|-|-|-|-| |`U`|No|string|Topic for Zone U's temperature (ie. Common zone)|| |`A`|No|string|Topic for Zone A's temperature|| |`B`|No|string|Topic for Zone B's temperature|| |`C`|No|string|Topic for Zone C's temperature|| |`D`|No|string|Topic for Zone D's temperature|| |`jsonPathU`|No|string|JSONPath to extract temperature from MQTT payload (Zone U)|| |`jsonPathA`|No|string|JSONPath to extract temperature from MQTT payload (Zone A)|| |`jsonPathB`|No|string|JSONPath to extract temperature from MQTT payload (Zone B)|| |`jsonPathC`|No|string|JSONPath to extract temperature from MQTT payload (Zone C)|| |`jsonPathD`|No|string|JSONPath to extract temperature from MQTT payload (Zone D)|| ### Example ``` "mqtt": { "host": "mqtt://localhost", "port": 1883, "username": "mantorok", "password": "password", "topicPrefix": "rinnai", "formatHomeAssistant": true, "formatConnection": false, "formatFault": true, "publishStatusChanged": false, "publishIntervals": true, "publishFrequency": 60, "publishAll": false, "showMqttEvents": true, "subscribeTemperature": { "U": "temp/u", "A": "temp/a", "B": "temp/b", "C": "temp/c", "D": "temp/d", "jsonPathU": "$.temperature", "jsonPathA": "$.temperature", "jsonPathB": "$.temperature", "jsonPathC": "$.temperature", "jsonPathD": "$.temperature", } }, ``` ## Topics Published topics end with `/get` and subscribed topics end with `/set` The following formats are supported: - [Home Assistant](#home-assistant) - [Module Connection Status](#module-connection-status) - [Module Fault Status](#module-fault-status) - [Current Temperature Subscription](#current-temperature-subscription) ### Home Assistant This format is used for integration with Home Assistant. |Topic|Payload|Supports Zones| |-|-|-| |`hvac/action/get`|Gets current state of HVAC. Values can be "off", "idle", "heating", "cooling", "fan"|Yes| |`hvac/current_temperature/get`|Gets current temperature|Yes| |`hvac/fan_mode/get` `hvac/fan_mode/set`|Gets or sets fan speed. Values can be "low", "medium", "high"|No| |`hvac/fan_speed/get` `hvac/fan_speed/set`|Gets or sets fan speed. Values can be between 1 and 16 inclusive (offers finer control compared to `fan_mode`)|No| |`hvac/mode/get` `hvac/mode/set`|Gets or sets mode of HVAC. Values can be “off”, “cool”, “heat”, “fan_only”|No| |`hvac/temperature/get` `hvac/temperature/set`|Gets or sets target temperature. Values are between 8 and 30 inclusive|Yes| |`switch/zone/{zone}/get` `switch/zone/{zone}/set`|Gets or sets the zone state. Values can be "on" or "off". `{zone}` can be a, b, c or d|No| |`switch/heat/get` `switch/heat/set`|Gets or sets the heater state. Values can be "on" or "off"|No| |`switch/cool/get` `switch/cool/set`|Gets or sets the cooler state. Values can be "on" or "off"|No| |`switch/evap/get` `switch/evap/set`|Gets or sets the evaporative cooler state. Values can be "on" or "off"|No| |`switch/fan/get` `switch/fan/set`|Gets or sets the circulation fan state. Values can be "on" or "off"|No| |`switch/manual/get` `switch/manual/set`|Gets or sets the manual state. Values can be "on" or "off". Used for systems with single controller|No| |`switch/manual/{zone}/get` `switch/manual/{zone}/set`|Gets or sets the manual state. Values can be "on" or "off". Used for systems with mutliple controllers. `{zone}` can be a, b, c or d|No| |`switch/pump/get` `switch/pump/set`|Gets or sets the evaporative cooler's pump state. Values can be "on" or "off"|No| The payload is either a single value or a JSON object containing values for each zone (if the payload supports zones). The JSON object has the following format: {U: "value1", A: "value2", B: "value3", ... } where U is the common zone (if applicable) ### Module Connection Status This format is used for publishing network connection status between the plugin and the WiFi module. |Topic|Type|Payload| |-|-|-| |`connection/status/get`|Publish|Current TCP Connection status to the WiFi module. States can be `ok` or `error`| ### Module Fault Status This format is used for publishing faults detected by the controller. |Topic|Type|Payload| |-|-|-| |`fault/detected/get`|Publish|Has fault been detected. States can be `true` or `false`| |`fault/message/get`|Publish|Message containing details of the fault| ### Current Temperature Subscription This format allows the plugin to receive the current temperature from external sources such as 3rd party temperature sensors via MQTT. Each zone can have their own temperature topic subscription. This can be useful when the WiFi module doesn't include the temperature in its status information or only reports a single temperature for all zones. An optional JSONPath can be defined to extract the temperature from a payload containing JSON. If the JSONPath is not supplied then only the temperature (ie. a number) is assumed to be in the payload. See [https://jsonpath.com](https://jsonpath.com) for more details. NOTE: The Topic Prefix is not used for these topics.