@irusland/homebridge-mqttthing

[![npm](https://badgen.net/npm/v/homebridge-mqttthing/latest)](https://www.npmjs.com/package/homebridge-mqttthing) [![npm](https://badgen.net/npm/dt/homebridge-mqttthing)](https://www.npmjs.com/package/homebridge-mqttthing) [![Discord](https://img.shields.io/discord/432663330281226270?color=728ED5&logo=discord&label=discord)](https://discord.gg/MTpeMC) [![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins) # Homebridge MQTT-Thing: Supported Accessories The following Homekit accessory types are supported by MQTT-Thing: * [Air Pressure Sensor](#air-pressure-sensor) * [Air Purifier](#air-purifier) * [Air Quality Sensor](#air-quality-sensor) * [Carbon Dioxide Sensor](#carbon-dioxide-sensor) * [Carbon Monoxide Sensor](#carbon-monoxide-sensor) * [Contact Sensor](#contact-sensor) * [Dehumidifier](#dehumidifier) * [Door](#door) * [Doorbell](#doorbell) * [Fan](#fan) * [Fanv2](#fanv2) * [Garage door opener](#garage-door-opener) * [Heater Cooler](#heater-cooler) * [Humidity Sensor](#humidity-sensor) * [Irrigation System](#irrigation-system) * [Leak Sensor](#leak-sensor) * [Light bulb](#light-bulb) * [Light Sensor](#light-sensor) * [Lock Mechanism](#lock-mechanism) * [Microphone](#microphone) * [Motion Sensor](#motion-sensor) * [Occupancy Sensor](#occupancy-sensor) * [Outlet](#outlet) * [Security System](#security-system) * [Speaker](#speaker) * [StatelessProgrammableSwitch](#statelessprogrammableswitch) * [Switch](#switch) * [Television](#television) * [Temperature Sensor](#temperature-sensor) * [Thermostat](#thermostat) * [Valve (Sprinkler, Shower, Faucet)](#valve) * [Weather Station](#weather-station) * [Window](#window) * [Window Covering (Blinds)](#window-covering) For general details on configuration, please see [Configuration.md](Configuration.md). ## Tested Configurations Tested and working configurations for devices are available on the [Wiki](https://github.com/arachnetech/homebridge-mqttthing/wiki/Tested-Configurations). Please add your working configurations for others. ## Air Pressure Sensor Air Pressure must be in the range 700 to 1100 hPa. *Air Pressure Sensor is only supported in Eve-App* ```javascript { "accessory": "mqttthing", "type": "airPressureSensor", "name": "<name of sensor>", "url": "<url of MQTT server (optional)>", "username": "<username for MQTT (optional)>", "password": "<password for MQTT (optional)>", "caption": "<label (optional)>", "topics": { "getAirPressure": "<topic used to provide 'air pressure'>", "getStatusActive": "<topic used to provide 'active' status (optional)>", "getStatusFault": "<topic used to provide 'fault' status (optional)>", "getStatusTampered": "<topic used to provide 'tampered' status (optional)>", "getStatusLowBattery": "<topic used to provide 'low battery' status (optional)>" }, "history": "<true to enable History service for Eve App (optional)>" } ``` ## Air Purifier Active state is set with a boolean value (see [Boolean Value Settings](../docs/Configuration.md#boolean-value-settings)). Target air purifier state can be **MANUAL** or **AUTO**. To use different values, specify an array of strings in **targetAirPurifierStateValues**. (*Note: Apple's Home App will apparently set the target air purifier state to **AUTO** when the device is activated.*) Current air purifier state can be **INACTIVE**, **IDLE** or **PURIFYING**. To use different values, specify an array of strings in **currentAirPurifierStateValues**. **INACTIVE** should be used in response if "Active" is set to false. **IDLE** or **PURIFYING** should be used in response if "Active" is set to true. Lock physical controls state may be **DISABLED** or **ENABLED**. To use different values, specify an array of strings in **lockPhysicalControlsValues**. Swing mode state may be **DISABLED** or **ENABLED**. To use different values, specify an array of strings in **swingModeValues**. The filter life level is used to indicate remaining filter life level in percent. The value should be a integer between 0 and 100 with no decimal places. Related to this is the filter change indication which is used to indicate if it is time to replace the filter. It is a boolean value and true indicates that a replacement is needed. After a filter replacement this should be set to false. If the hardware device does not have a way to indicate that the filter has been replaced, the reset filter indication can be used. It is currently only supported in the Eve app. When triggered (by the user after a filter change), the MQTT device should reset FilterChangeIndication to false and FilterLifeTime to 100. ```javascript { "accessory": "mqttthing", "type": "airPurifier", "name": "<name of device>", "url": "<url of MQTT server (optional)>", "username": "<username for MQTT (optional)>", "password": "<password for MQTT (optional)>", "logMqtt": true | false, "topics": { "setActive": "<topic used to control 'active' state>", "getActive": "<topic used to report 'active' state>", "getCurrentAirPurifierState": "<topic used to report 'current air purifier state'>", "setTargetAirPurifierState": "<topic used to control 'target air purifier state'>", "getTargetAirPurifierState": "<topic used to report 'target air purifier state'>", "setRotationSpeed": "<topic used to control 'rotation speed' (optional)>", "getRotationSpeed": "<topic used to report 'rotation speed' (optional)>" "setSwingMode": "<topic used to control 'swing mode' (optional)>", "getSwingMode": "<topic used to report 'swing mode' (optional)>", "setLockPhysicalControls": "<topic used to control 'lock physical controls' (optional)>", "getLockPhysicalControls": "<topic used to report 'lock physical controls' (optional)>", "getFilterChangeIndication": "<topic used to report 'filter change indication' (optional)'>", "getFilterLifeLevel": "<topic used to report 'filter life level' (optional)>", "setResetFilterIndication": "<topic used to control 'reset filter indication (optional)'>" }, "integerValue": "true to use 1|0 instead of true|false default onValue and offValue", "onValue": "<value representing on (optional)>", "offValue": "<value representing off (optional)>", "targetAirPurifierStateValues": "<array of values to be used to represent MANUAL, AUTO respectively (optional)>", "currentAirPurifierStateValues": "<array of values to be used to represent INACTIVE, IDLE, PURIFYING respectively (optional)>", "swingModeValues": "<array of values to be used to represent DISABLED and ENABLED respectively (optional)>", "lockPhysicalControlsValues": "<array of values to be used to represent DISABLED and ENABLED respectively (optional)>" } ``` ## Air Quality Sensor Air quality state can be `UNKNOWN`, `EXCELLENT`, `GOOD`, `FAIR`, `INFERIOR` or `POOR`. To use different values, specify them in **airQualityValues** in that order. For Air Quality History (in the Eve-App) you have to use `getVOCDensity` (Eve Room 2) or `getAirQualityPPM` (Eve Room 1). History records need to be cleared when Migrating from Room 1 to Room 2 because they are not compatible. ```javascript { "accessory": "mqttthing", "type": "airQualitySensor", "name": "<name of device>", "serviceNames": { "temperature": "<name for temperature service (optional)>", "humidity": "<name for humidity service (optional)>" }, "topics": { "getAirQuality": "<topic used to report air quality", "getCarbonDioxideLevel": "<topic used to report carbon dioxide level (optional)>", "getPM10Density": "<topic used to report PM10 Density (optional)>", "getPM2_5Density": "<topic used to report PM2.5 Density (optional)>", "getOzoneDensity": "<topic used to report Ozone Density (optional)>", "getNitrogenDioxideDensity": "<topic used to report NitrogenDioxide Density (optional)>", "getSulphurDioxideDensity": "<topic used to report Sulphur Dioxide Density (optional)>", "getVOCDensity": "<topic used to report VOC Density (optional)>", "getCarbonMonoxideLevel": "<topic used to report Carbon Monoxide level (optional)>", "getAirQualityPPM": "<topic used to report air quality voc in ppm (optional, Eve-only)>", "getStatusActive": "<topic used to provide 'active' status (optional)>", "getStatusFault": "<topic used to provide 'fault' status (optional)>", "getStatusTampered": "<topic used to provide 'tampered' status (optional)>", "getStatusLowBattery": "<topic used to provide 'low battery' status (optional)>", "getCurrentTemperature": "<topic used to provide 'current temperature' (optional)>", "getCurrentRelativeHumidity": "<topic used to provide 'current relative humidity' (optional)>" }, "airQualityValues": [ "unknown-value", "excellent-value", "good-value", "fair-value", "inferior-value", "poor-value" ], "history": "<true to enable History service for Eve App (optional)>", "room2": "<true to enable Room 2 support for Eve App (optional)>" } ``` ## Carbon Dioxide Sensor Carbon dioxide detected state can be `NORMAL` or `ABNORMAL`. To use different values, specify them in **carbonDioxideDetectedValues** in that order. ```javascript { "accessory": "mqttthing", "type": "carbonDioxideSensor", "name": "<name of device>", "topics": { "getCarbonDioxideDetected": "<topic used to report carbon dioxide detected", "getCarbonDioxideLevel": "<topic used to report carbon dioxide level (optional)>", "getCarbonDioxidePeakLevel": "<topic used to report carbon dioxide level (optional)>", "getStatusActive": "<topic used to provide 'active' status (optional)>", "getStatusFault": "<topic used to provide 'fault' status (optional)>", "getStatusTampered": "<topic used to provide 'tampered' status (optional)>", "getStatusLowBattery": "<topic used to provide 'low battery' status (optional)>" }, "carbonDioxideDetectedValues": [ "normal-value", "abnormal-value" ] } ``` ## Carbon Monoxide Sensor Carbon Monoxide detected state can be `NORMAL` or `ABNORMAL`. To use different values, specify them in **carbonMonoxideDetectedValues** in that order. ```javascript { "accessory": "mqttthing", "type": "carbonMonoxideSensor", "name": "<name of device>", "topics": { "getCarbonMonoxideDetected": "<topic used to report carbon Monoxide detected", "getCarbonMonoxideLevel": "<topic used to report carbon Monoxide level (optional)>", "getCarbonMonoxidePeakLevel": "<topic used to report carbon Monoxide level (optional)>", "getStatusActive": "<topic used to provide 'active' status (optional)>", "getStatusFault": "<topic used to provide 'fault' status (optional)>", "getStatusTampered": "<topic used to provide 'tampered' status (optional)>", "getStatusLowBattery": "<topic used to provide 'low battery' status (optional)>" }, "carbonMonoxideDetectedValues": [ "normal-value", "abnormal-value" ] } ``` ## Contact Sensor Contact sensor state is exposed as a Boolean. True (or 1 with integer values) maps to `CONTACT_NOT_DETECTED` (sensor triggered) and False (or 0) maps to `CONTACT_DETECTED` (not triggered). To use different MQTT values, configure `onValue` and `offValue`. If `history` is enabled, this plugin will count the number of openings and offers the possibility to reset the counter from the Eve app. ```javascript { "accessory": "mqttthing", "type": "contactSensor", "name": "<name of sensor>", "url": "<url of MQTT server (optional)>", "username": "<username for MQTT (optional)>", "password": "<password for MQTT (optional)>", "caption": "<label (optional)>", "topics": { "getContactSensorState": "<topic used to provide 'contact sensor' state>", "getStatusActive": "<topic used to provide 'active' status (optional)>", "getStatusFault": "<topic used to provide 'fault' status (optional)>", "getStatusTampered": "<topic used to provide 'tampered' status (optional)>", "getStatusLowBattery": "<topic used to provide 'low battery' status (optional)>" }, "integerValue": "true to use 1|0 instead of true|false default onValue and offValue", "onValue": "<value representing on (optional)>", "offValue": "<value representing off (optional)>", "resetStateAfterms": "<milliseconds after which to reset state automatically (optional)>", "history": "<true to enable History service for Eve App (optional)>" } ``` ## Dehumidifier Active state is set with a boolean value (see Boolean Value Settings). Target dehumidifier state can be HUMIDIFIER_OR_DEHUMIDIFIER, HUMIDIFIER or DEHUMIDIFIER. Current dehumidifier state can be INACTIVE, IDLE, HUMIDIFYING or DEHUMIDIFYING. The water level is used to indicate the amount of water in the bucket. ```javascript { "accessory": "mqttthing", "type": "dehumidifier", "name": "<name of sensor>", "url": "<url of MQTT server (optional)>", "username": "<username for MQTT (optional)>", "password": "<password for MQTT (optional)>", "caption": "<label (optional)>", "topics": { "setActive": "<topic used to control 'active' state>", "getActive": "<topic used to report 'active' state>", "getWaterLevel": "<topic used to report the water level>", "setWaterLevel": "<topic used to control the water level>", "getRelativeHumidityDehumidifierThreshold": "<topic used to report the the humidity threshold>", "setRelativeHumidityDehumidifierThreshold": "<topic used to control the the humidity threshold>", "getTargetHumidifierDehumidifierState": "<topic used to report the target state>", "setTargetHumidifierDehumidifierState": "<topic used to control the target state>", "getCurrentHumidifierDehumidifierState": "<topic used to report the current state>", "getCurrentRelativeHumidity": "<topic used to report the the humidity threshold>" } } ``` ## Door Door position state can be **DECREASING**, **INCREASING** or **STOPPED**. By default, these use values of `DECREASING`, `INCREASING`, and `STOPPED` respectively; these defaults can be changed using the **positionStateValues** setting. ```javascript { "accessory": "mqttthing", "type": "door", "name": "<name of device>", "topics": { "getCurrentPosition": "<topic used to report current position (integer 0-100)>", "setTargetPosition": "<topic used to control target position (integer 0-100)>", "getTargetPosition": "<topic used to report target position (optional)>", "getPositionState": "<topic used to report position state>", "setHoldPosition": "<topic used to control hold position (Boolean)>", "getObstructionDetected": "<topic used to report whether an obstruction is detected (Boolean)>" }, "positionStateValues": [ "decreasing-value", "increasing-value", "stopped-value" ], "minPosition": 0, "maxPosition": 100 } ``` The optional `minPosition` and `maxPosition` allow the minimum and maximum position values to be changed from their defaults of 0 and 100 respectively. ## Doorbell Doorbell ring switch state can be be `SINGLE_PRESS`, `DOUBLE_PRESS` or `LONG_PRESS`. By default, these events are raised when values of `1`, `2` and `L` respectively are published to the **getSwitch** topic. However, these values may be overridden by specifying an alternative array in the **switchValues** setting. ```javascript { "accessory": "mqttthing", "type": "doorbell", "name": "<name of sensor>", "url": "<url of MQTT server (optional)>", "username": "<username for MQTT (optional)>", "password": "<password for MQTT (optional)>", "caption": "<label (optional)>", "topics": { "getSwitch": "<topic used to provide doorbell switch state>" "getBrightness": "<topic used to get brightness (optional)>", "setBrightness": "<topic used to set brightness (optional)>", "getVolume": "<topic used to get volume (optional)>", "setVolume": "<topic used to set volume (optional)>", "getMotionDetected": "<topic used to provide 'motion detected' status (optional, if exposing motion sensor)>" }, "switchValues": "<array of 3 switch values corresponding to single-press, double-press and long-press respectively (optional)>" } ``` ## Fan Fan running state ('on') is true or false, or 1 or 0 if `integerValue: true` specified. Fan rotation direction is 0 for clockwise or 1 for anticlockwise. Fan rotation speed is an integer between 0 (off) and 100 (full speed). Set `confirmationPeriodms` to enable publishing confirmation for `setOn`/`getOn`. The accessory must echo messages it receives through the `setOn` subject to the `getOn` subject, otherwise homebridge-mqttthing will mark it as unresponsive and republish on the `setOn` subject. ```javascript { "accessory": "mqttthing", "type": "fan", "name": "<name of sensor>", "url": "<url of MQTT server (optional)>", "username": "<username for MQTT (optional)>", "password": "<password for MQTT (optional)>", "caption": "<label (optional)>", "topics": { "getOn": "<topic to notify homebridge of 'fan on' status>", "setOn": "<topic published by homebridge to set 'fan on' status>", "getRotationDirection": "<topic to notify homebridge of rotation direction (optional)>", "setRotationDirection": "<topic published by homebridge to set rotation direction (optional)>", "getRotationSpeed": "<topic to notify homebridge of rotation speed (optional)", "setRotationSpeed": "<topic published by homebridge to set rotation speed (optional)" }, "integerValue": "true to use 1|0 instead of true|false default onValue and offValue", "onValue": "<value representing on (optional)>", "offValue": "<value representing off (optional)>", "turnOffAfterms": "<milliseconds after which to turn off automatically (optional)>" } ``` ## Fanv2 Active state is set with a boolean value (see [Boolean Value Settings](../docs/Configuration.md#boolean-value-settings)). Target fan state can be **MANUAL** or **AUTO**. To use different values, specify an array of strings in **targetFanValues**. Current fan state can be **INACTIVE**, **IDLE** or **BLOWING_AIR**. To use different values, specify an array of strings in **currentFanStateValues**. **INACTIVE** should be used in response if "Active" is set to false. **IDLE** or **BLOWING_AIR** should be used in response if "Active" is set to true. Lock physical controls state may be **DISABLED** or **ENABLED**. To use different values, specify an array of strings in **lockPhysicalControlsValues**. Swing mode state may be **DISABLED** or **ENABLED**. To use different values, specify an array of strings in **swingModeValues**. Fan rotation direction is 0 for clockwise or 1 for anticlockwise. ```javascript { "accessory": "mqttthing", "type": "fanv2", "name": "<name of device>", "url": "<url of MQTT server (optional)>", "username": "<username for MQTT (optional)>", "password": "<password for MQTT (optional)>", "logMqtt": true | false, "topics": { "setActive": "<topic used to control 'active' state>", "getActive": "<topic used to report 'active' state>", "getCurrentFanState": "<topic used to report 'current fan state' (optional)> ", "setTargetFanState": "<topic used to control 'target fan state' (optional)>", "getTargetFanState": "<topic used to report 'target fan state'(optional)>", "setRotationSpeed": "<topic used to control 'rotation speed' (optional)>", "getRotationSpeed": "<topic used to report 'rotation speed' (optional)>" "getRotationDirection": "<topic used to report 'rotation direction' (optional)>", "setRotationDirection": "<topic used to control 'rotation direction' (optional)>", "setSwingMode": "<topic used to control 'swing mode' (optional)>", "getSwingMode": "<topic used to report 'swing mode' (optional)>", "setLockPhysicalControls": "<topic used to control 'lock physical controls' (optional)>", "getLockPhysicalControls": "<topic used to report 'lock physical controls' (optional)>", }, "integerValue": "true to use 1|0 instead of true|false default onValue and offValue", "onValue": "<value representing on (optional)>", "offValue": "<value representing off (optional)>", "targetFanStateValues": "<array of values to be used to represent MANUAL, AUTO respectively (optional)>", "currentFanStateValues": "<array of values to be used to represent INACTIVE, IDLE, BLOWING_AIR respectively (optional)>", "swingModeValues": "<array of values to be used to represent DISABLED and ENABLED respectively (optional)>", "lockPhysicalControlsValues": "<array of values to be used to represent DISABLED and ENABLED respectively (optional)>" } ``` ## Garage Door Opener Garage door opener *target* state can be **OPEN** or **CLOSED**. By default, values of `O` and `C` are used respectively (unless changed through **doorTargetValues**). Homekit always assumes that the door is moving towards is target state, so to control it externally you must publish the getTargetDoorState topic to notify Homekit of the new target state. (You may also wish to publish the setTargetDoorState topic to notify your accessory of the new target state.) The same topic may be used for both to simplify this. Garage door opener *current* door state can be **OPEN**, **CLOSED**, **OPENING**, **CLOSING**, **STOPPED**. By default, these use values of `O`, `C`, `o`, `c` and `S` respectively; these defaults can be changed using the **doorCurrentValues** setting. As a simpler alternative, `getDoorMoving` may be used to specify a Boolean topic indicating whether or not the garage door is currently moving. Mqttthing will generate an appropriate current state automatically, assuming that the door is moving towards its target state or stopped at its target state. If the *current* and *target* state values are the same (but non-default), these can be changed together by using the **doorValues** setting. Lock current state can be **UNSECURED**, **SECURED**, **JAMMED** or **UNKNOWN**. By default, these use values of `U`, `S`, `J`, `?` respectively; these can be changed using the **lockValues** setting. Lock target state can be **UNSECURED** or **SECURED**. By default, these use values of `U` and `S` respectively (unless changed through **lockValues**). ```javascript { "accessory": "mqttthing", "type": "garageDoorOpener", "name": "<name of sensor>", "url": "<url of MQTT server (optional)>", "username": "<username for MQTT (optional)>", "password": "<password for MQTT (optional)>", "caption": "<label (optional)>", "topics": { "setTargetDoorState": "<topic used to set 'target door state'>", "getTargetDoorState": "<topic used to report 'target door state'>", "getCurrentDoorState": "<topic used to report 'current door state'>", "setLockTargetState": "<topic used to set 'lock target state' (optional)>", "getLockTargetState": "<topic used to report 'lock target state' (optional)>", "getLockCurrentState": "<topic used to report 'lock current state' (optional)>", "getObstructionDetected": "<topic used to report 'obstruction detected' (optional)>" }, "doorCurrentValues": [ "Open", "Closed", "Opening", "Closing", "Stopped" ], "doorTargetValues": ["open", "close"], "lockValues": [ "Unsecured", "Secured", "Jammed", "Unknown" ] } ``` ### Topics `setTargetDoorState` - Topic published when the target door state is changed in HomeKit. Values are _final_ `doorValues` (not opening/closing). `getTargetDoorState` - Topic that may be published to notify HomeKit that the target door state has been changed externally. Values are _final_ `doorValues` (not opening/closing). May use same topic as `getCurrentDoorState` as above. Omit if all control is through HomeKit. `getCurrentDoorState` - Topic published to notify HomeKit that a door state has been achieved. HomeKit will expect current door state to end up matching target door state. Values are `doorValues`. `setLockTargetState` - Topic published when the target lock state is changed in HomeKit. Values are `lockValues`. `getLockTargetState` - Topic that may be published to notify HomeKit that the target lock state has been changed externally. Values are `lockValues`. May use same topic as `getLockCurrentState` as above. Omit if all control is through HomeKit. `getLockCurrentState` - Topic published to notify HomeKit that a lock state has been achieved. Values are `lockValues`. `getObstructionDetected` - Topic published to notify HomeKit whether an obstruction has been detected (Boolean value). ### Values `doorValues` - Array of 5 door values corresponding to open, closed, opening, closing and stopped respectively. If not specified, defaults to `[ 'O', 'C', 'o', 'c', 'S' ]`. `doorCurrentValues` - Array of 5 door values corresponding to open, closed, opening, closing and stopped respectively. If not specified, defaults to `[ 'O', 'C', 'o', 'c', 'S' ]`. `doorTargetValues` - Array of 2 door values corresponding to the door *target* values of open or closed, respectively. If not specified, defaults to `[ 'O', 'C' ]`. `lockValues` - Array of 4 lock values corresponding to unsecured, secured, jammed and unknown respectively. if not specified, defaults to `[ 'U', 'S', 'J', '?' ]`. `integerValue` - Set to true to use values 1 and 0 instead of "true" and "false" respectively for obstruction detected value. ## Heater Cooler Active state is set with a boolean value (see [Boolean Value Settings](../docs/Configuration.md#boolean-value-settings)). Current heater/cooler state can be **INACTIVE**, **IDLE**, **HEATING** or **COOLING**. To use different values, specify an array of strings in **currentHeaterCoolerValues**. **INACTIVE** should be used in response if "Active" is set to false. **IDLE**, **HEATING** or **COOLING** should be used in response if "Active" is set to true. Target heater/cooler state can be **AUTO**, **HEAT** or **COOL**. To use different values, specify an array of strings in **targetHeaterCoolerValues**. Lock physical controls state may be **DISABLED** or **ENABLED**. To use different values, specify an array of strings in **lockPhysicalControlsValues**. Swing mode state may be **DISABLED** or **ENABLED**. To use different values, specify an array of strings in **swingModeValues**. Temperature display units can be **CELSIUS** or **FAHRENHEIT**. To use different values, specify an array of strings in `temperatureDisplayUnitsValues`. `minTemperature` and `maxTemperature` may optionally be used to change the minimum and maximum heating and cooling target and temperatures that can be set from Homekit (and also affect current temperature range). Configure `restrictHeaterCoolerState` to an array of integers to restrict the target heating/cooling states made available by Homekit, where 0 represents AUTO, 1 HEAT and 2 COOL, for example: * `"restrictHeaterCoolerState": [0, 1]` - for AUTO or HEAT (but no COOL). * `"restrictHeaterCoolerState": [1, 2]` - for HEAT or COOL (but no AUTO). Configure cooling threshold temperature unless target heater/cooler states exclude **COOL**, and/or heating threshold temperature unless target heater/cooler states exclude **HEAT**. ```javascript { "accessory": "mqttthing", "type": "heaterCooler", "name": "<name of device>", "url": "<url of MQTT server (optional)>", "username": "<username for MQTT (optional)>", "password": "<password for MQTT (optional)>", "logMqtt": true | false, "topics": { "setActive": "<topic used to control 'active' state>", "getActive": "<topic used to report 'active' state>", "getCurrentHeaterCoolerState": "<topic used to report 'current heater/cooler state'>", "setTargetHeaterCoolerState": "<topic used to control 'target heater/cooler state'>", "getTargetHeaterCoolerState": "<topic used to report 'target heater/cooler state'>", "getCurrentTemperature": "<topic used to report 'current temperature'>", "setCoolingThresholdTemperature": "<topic used to control 'cooling threshold temperature'>", "getCoolingThresholdTemperature": "<topic used to report 'cooling threshold temperature'>", "setHeatingThresholdTemperature": "<topic used to control 'heating threshold temperature'>", "getHeatingThresholdTemperature": "<topic used to report 'heating threshold temperature'>", "setTemperatureDisplayUnits": "<topic used to control 'temperature display units'>", "getTemperatureDisplayUnits": "<topic used to report 'temperature display units'>", "setRotationMode": "<topic used to control 'rotation mode' (optional)>", "getRotationMode": "<topic used to report 'rotation mode' (optional)>", "setSwingMode": "<topic used to control 'swing mode' (optional)>", "getSwingMode": "<topic used to report 'swing mode' (optional)>", "setRotationSpeed": "<topic used to control 'rotation speed' (optional)>", "getRotationSpeed": "<topic used to report 'rotation speed' (optional)>", "getStatusFault": "<topic used to provide 'fault' status (optional)>" }, "currentHeaterCoolerValues": "<array of values to be used to represent INACTIVE, IDLE, HEATING, COOLING respectively (optional)>", "targetHeaterCoolerValues": "<array of values to be used to represent AUTO, HEAT, COOL respectively (optional)>", "lockPhysicalControlsValues": "<array of values to be used to represent DISABLED and ENABLED respectively (optional)>", "swingModeValues": "<array of values to be used to represent DISABLED and ENABLED respectively (optional)>", "temperatureDisplayUnitsValues": "<array of values to be used to represent CELSIUS and FAHRENHEIT respectively (optional)>", "minTemperature": minimum_target_temperature, "maxTemperature": maximum_target_temperature, "restrictHeaterCoolerState": "<array of allowed values - see notes above (optional)>" } ``` ## Humidity Sensor Current relative humidity must be in the range 0 to 100 percent with no decimal places. ```javascript { "accessory": "mqttthing", "type": "humiditySensor", "name": "<name of sensor>", "url": "<url of MQTT server (optional)>", "username": "<username for MQTT (optional)>", "password": "<password for MQTT (optional)>", "caption": "<label (optional)>", "topics": { "getCurrentRelativeHumidity": "<topic used to provide 'current relative humidity'>", "getStatusActive": "<topic used to provide 'active' status (optional)>", "getStatusFault": "<topic used to provide 'fault' status (optional)>", "getStatusTampered": "<topic used to provide 'tampered' status (optional)>", "getStatusLowBattery": "<topic used to provide 'low battery' status (optional)>" }, "history": "<true to enable History service for Eve App (optional)>" } ``` ## Irrigation System Multi-zone sprinkler accessory. See also [Valve (Sprinkler, Shower, Faucet)](#valve) for a single valve accessory. If `durationTimer` is set to **true** (recommended), this plugin will handle the duration timer for each zone and will automatically send a stop command after the configured time. If the device itself provides duration timing via MQTT or if you want to query or set the duration via MQTT, you can make use of `setDuration`/`getDuration`. The remaining time is shown in HomeKit even if no `getRemainingDuration` is configured. `getRemainingDuration` can be used to update the remaining time, if the duration is changed at the device itself in some way. The topics under `"topics"` are optional. They describe the main topics for the entire system and are derived from the states of the individual zones. So `"topics"` might be empty (`"topics": {}`). Topics for the individual zones must be defined under `"zones" / "topics"`. The default run time defaults to between 5 minutes and 1 hour (in 5 minute increments). This can be changed with `minDuration` and `maxDuration`. Note however that the Home App in iOS 12 doesn't like to show durations below 5 minutes. (This appears to have been improved in the iOS 13 Beta.) ```javascript { "accessory": "mqttthing", "type": "irrigationSystem", "name": "<name of system>", "url": "<url of MQTT server (optional)>", "username": "<username for MQTT (optional)>", "password": "<password for MQTT (optional)>", "topics": { "getActive": "<topic to report the target state (optional)>", "setActive": "<topic to control the target state (optional)>", "getStatusFault": "<topic used to provide 'fault' status (optional)>" }, "zones": [ { "name": "First Zone", "topics": { "getActive": "<topic to report the target state of the first zone>", "setActive": "<topic to control the target state of the first zone>", "getInUse": "<topic to report the current state feedback of the first zone>", "setDuration": "<topic used to set default duration (seconds) (optional, with external timer)>", "getDuration": "<topic used to get default duration (seconds) (optional, with external timer)>", "getRemainingDuration": "<topic used to get remaining duration (seconds) (optional, with external timer)>", "getStatusFault": "<topic used to provide 'fault' status (optional)>" } }, ... { "name": "Last Zone", "topics": { "getActive": "<topic to report the target state of the last zone>", "setActive": "<topic to control the target state of the last zone>", "getInUse": "<topic to report the current state feedback of the last zone>", "setDuration": "<topic used to set default duration (seconds) (optional, with external timer)>", "getDuration": "<topic used to get default duration (seconds) (optional, with external timer)>", "getRemainingDuration": "<topic used to get remaining duration (seconds) (optional, with external timer)>", "getStatusFault": "<topic used to provide 'fault' status (optional)>" } } ], "integerValue": "true to use 1|0 instead of true|false default onValue and offValue", "onValue": "<value representing on (optional)>", "offValue": "<value representing off (optional)>", "durationTimer": "<true to enable duration timer (recommended)>", "minDuration": "<minimum duration (in seconds) (optional)>", "maxDuration": "<maximum duration (in seconds) (optional)>" } ``` ## Leak Sensor Leak sensor state is exposed as a Boolean. True (or 1 with integer values) maps to `LEAK_DETECTED` and False (or 0) maps to `LEAK_NOT_DETECTED`. To use different MQTT values, configure `onValue` and `offValue`. ```javascript { "accessory": "mqttthing", "type": "leakSensor", "name": "<name of sensor>", "topics": { "getLeakDetected": "<topic used to provide 'leak detected' state (Boolean)>", }, "resetStateAfterms": "<milliseconds after which to reset state automatically (optional)>" } ``` ## Light bulb Light bulb can either use separate topics (for on, brightness, hue and saturation), or it can be configured to use a combined value holding comma-separated hue,sat,val or red,green,blue. Using a topic with combined values disables most of the other topics according to this [line](https://github.com/arachnetech/homebridge-mqttthing/blob/c2abf22dbef27bd329a038bd394a6ab112681fd6/index.js#L2462). Hue is 0-360. Saturation is 0-100. Brightness is 0-100. Red, green and blue are 0-255. Colour temperature ranges from 140 (cold white) to 500 (warm white), centred at about 151. If `topics.setHSV` is populated, a combined value is used and any individual brightness, hue, saturation and color temperature topics are ignored. On/off is sent with `setOn` if configured, or by setting V to 0 when off. If `topics.setRGB` is populated, a combined value is used in the format red,green,blue (ranging from 0-255). On/off may be sent with `setOn`; brightness, hue and saturation topics are ignored. If `topics.setWhite` is also populated, the white level is extracted and sent separately to the combined RGB value. Configuring `topics.setWhite` without `topics.setRGB` will give a dimmable white light with a range from 0 (off) to 255 (full brightness) using the `setWhite` topic only (i.e. with no separate on/off state through `setOn`). If `topics.setRGBW` is populated, a combined value is used in the format red,green,blue,white (ranging from 0-255). The minimum of red, green and blue is subtracted from all three colour channels and sent to the white channel instead. On/off may be set with `setOn` (otherwise "0,0,0,0" indicates off); brightness, hue, saturation and temperature topics are ignored. If `topics.setRGBWW` is populated, a combined value is used in the format red,green,blue,warm_white,cold_white (each component ranging from 0-255). Warm and cold white components are set based on the colour values published by Homekit from the _Temperature_ control, and after warm and cold white are extracted any remaining white level in the RGB values is sent equally to both white channels. The RGB values used for warm white and cold white extraction can be configured with `warmWhite` and `coldWhite`, allowing calibration to RGBWW LED colours. (Homekit's warm white and cold white colours are used by default.) On/off may be set with `setOn` (otherwise "0,0,0,0,0" indicates off); brightness, hue, saturation and temperature topics are ignored. (Homekit's behaviour when a coloured (hue/saturation-supporting) light also attempts to support temperature can be unpredictable - so the RGBWW implementation does not use Homekit colour temperature.) RGBWW lights support a `noWhiteMix` option which when set to true disables extraction of white components from colours - i.e. powering only RGB channels or WW,CW channels. When `noWhiteMix` is *true*, `redThreshold`, `greenThreshold` and `blueThreshold` may optionally be configured with the colour offsets above which RGB is used instead of WW; their default value is 15. To order by cold_white,warm_white, set `switchWhites` to *true*. Set `confirmationPeriodms` to enable publishing confirmation for `setOn`/`getOn`. The accessory must echo messages it receives through the `setOn` subject to the `getOn` subject, otherwise homebridge-mqttthing will mark it as unresponsive and republish on the `setOn` subject. When using colour temperature directly (through the `setColorTemperature` topic), `minColorTemperature` and `maxColorTemperature` may be configured to change Homekits default range of 140-500. ```javascript { "accessory": "mqttthing", "type": "lightbulb", "name": "<name of lightbulb>", "url": "<url of MQTT server (optional)>", "username": "<username for MQTT (optional)>", "password": "<password for MQTT (optional)>", "caption": "<label (optional)>", "topics": { "getOn": "<topic to get the status>", "setOn": "<topic to set the status>", "getBrightness": "<topic to get the brightness (optional)>", "setBrightness": "<topic to set the brightness (optional - if dimmable)>", "getHue": "<topic to get the hue (optional)>", "setHue": "<topic to set the hue (optional - if coloured)>", "getSaturation": "<topic to get the saturation (optional)>", "setSaturation": "<topic to set the saturation (optional - if coloured)>", "getHSV": "<in HSV mode, topic to get comma-separated hue, saturation and value>", "setHSV": "<in HSV mode, topic to set comma-separated hue, saturation and value>", "getRGB": "<in RGB mode, topic to get comma-separated red, green, blue>", "setRGB": "<in RGB mode, topic to set comma-separated red, green, blue>", "getRGBW": "<in RGBW mode, topic to get comma-separated red, green, blue, white>", "setRGBW": "<in RGBW mode, topic to set comma-separated red, green, blue, white>", "getRGBWW": "<in RWGWW mode, topic to get comma-separated red, green, blue, warm_white, cold_white>", "setRGBWW": "<in RWGWW mode, topic to set comma-separated red, green, blue, warm_white, cold_white>", "getWhite": "<topic to get white level (0-255)> - used with getRGB for RGBW with separately-published white level", "setWhite": "<topic to set white level (0-255)> - used with setRGB for RGBW with separately-published white level", "getColorTemperature": "<topic to report color temperature (140-500) (optional)>", "setColorTemperature": "<topic to control color temperature (140-500) (optional)>" }, "integerValue": "true to use 1|0 instead of true|false default onValue and offValue", "onValue": "<value representing on (optional)>", "offValue": "<value representing off (optional)>", "hex": "true to format combined RGB/RGBW in hexadecimal instead of as comma-separated decimals", "hexPrefix": "format combined RGB/RGBW in hexadecimal with specified prefix (typically '#') instead of as comma-separated decimals", "turnOffAfterms": "<milliseconds after which to turn off automatically (optional)>", "warmWhite": "in RGBWW mode, RGB value of warm white in format red,green,blue (optional)", "coldWhite": "in RGBWW mode, RGB value of cold white in format red,green,blue (optional)", "minColorTemperature": 140, "maxColorTemperature": 500 } ``` Coloured lights and lights with a setColorTemperature topic support adaptive lighting by default. This may change behaviour when setting colour temperature manually on a bulb without a setColorTemperature topic, as calculation of appropriate hue and saturation values must be done within Homebridge instead of by Homekit. Adaptive lighting support can be disabled by setting `adaptiveLighting` to `false`. When using config-ui-x, multiple lightbulb types are available. The generic 'lightbulb' allows all possible settings to be entered. Serveral sub-types ('lightbulb-OnOff', 'lightbulb-Dimmable' etc.) show the configuration settings relevant for specific light types only. This can greatly simplify the configuration process. ## Light Sensor Current ambient light level must be in the range 0.0001 Lux to 100000 Lux to a maximum of 4dp. ```javascript { "accessory": "mqttthing", "type": "lightSensor", "name": "<name of sensor>", "url": "<url of MQTT server (optional)>", "username": "<username for MQTT (optional)>", "password": "<password for MQTT (optional)>", "caption": "<label (optional)>", "topics": { "getCurrentAmbientLightLevel": "<topic used to provide 'current ambient light level'>", "getStatusActive": "<topic used to provide 'active' status (optional)>", "getStatusFault": "<topic used to provide 'fault' status (optional)>", "getStatusTampered": "<topic used to provide 'tampered' status (optional)>", "getStatusLowBattery": "<topic used to provide 'low battery' status (optional)>" }, "integerValue": "true to use 1|0 instead of true|false default onValue and offValue", "onValue": "<value representing on (optional)>", "offValue": "<value representing off (optional)>" } ``` ## Lock Mechanism Lock current state can be **UNSECURED**, **SECURED**, **JAMMED** or **UNKNOWN**. By default, these use values of `U`, `S`, `J`, `?` respectively; these can be changed using the **lockValues** setting. Lock target state can be **UNSECURED** or **SECURED**. By default, these use values of `U` and `S` respectively (unless changed through **lockValues**). ```javascript { "accessory": "mqttthing", "type": "lockMechanism", "name": "<name of sensor>", "topics": { "setLockTargetState": "<topic used to set 'lock target state'>", "getLockTargetState": "<topic used to provide 'lock target state'>", "getLockCurrentState": "<topic used to provide 'lock current state'>" }, "lockValues": [ "Unsecured", "Secured", "Jammed", "Unknown" ] } ``` ### Topics `setLockTargetState` - Topic published when the target lock state is changed in HomeKit. Values are `lockValues`. `getLockTargetState` - Topic that may be published to notify HomeKit that the target lock state has been changed externally. Values are `lockValues`. May use same topic as `getLockCurrentState` as above. Omit if all control is through HomeKit. `getLockCurrentState` - Topic published to notify HomeKit that a lock state has been achieved. Values are `lockValues`. ### Values `lockValues` - Array of 4 lock values corresponding to unsecured, secured, jammed and unknown respectively. if not specified, defaults to `[ 'U', 'S', 'J', '?' ]`. ## Microphone ```javascript { "accessory": "mqttthing", "type": "microphone", "name": "<name of sensor>", "topics": { "getMute": "<topic used to indicate whether microphone is muted (Boolean)>", "setMute": "<topic used to set whether microphone is muted (Boolean)>", "getVolume": "<topic used to report current volume (0-100)>", "setVolume": "<topic used to set volume (0-100)>" } } ``` ## Motion Sensor ```javascript { "accessory": "mqttthing", "type": "motionSensor", "name": "<name of sensor>", "url": "<url of MQTT server (optional)>", "username": "<username for MQTT (optional)>", "password": "<password for MQTT (optional)>", "caption": "<label (optional)>", "topics": { "getMotionDetected": "<topic used to provide 'motion detected' status>", "getStatusActive": "<topic used to provide 'active' status (optional)>", "getStatusFault": "<topic used to provide 'fault' status (optional)>", "getStatusTampered": "<topic used to provide 'tampered' status (optional)>", "getStatusLowBattery": "<topic used to provide 'low battery' status (optional)>" }, "integerValue": "true to use 1|0 instead of true|false default onValue and offValue", "onValue": "<value representing on (optional)>", "offValue": "<value representing off (optional)>", "turnOffAfterms": "<milliseconds after which to reset motion sensor state automatically (optional) - allowing a motion sensor just to publish its onValue>", "history": "<true to enable History service for Eve App (optional)>" } ``` ## Occupancy Sensor Occupancy sensor state is exposed as a Boolean. True (or 1 with integer values) maps to `OCCUPANCY_DETECTED` (sensor triggered) and False (or 0) maps to `OCCUPANCY_NOT_DETECTED` (not triggered). To use different MQTT values, configure `onValue` and `offValue`. ```javascript { "accessory": "mqttthing", "type": "occupancySensor", "name": "<name of sensor>", "url": "<url of MQTT server (optional)>", "username": "<username for MQTT (optional)>", "password": "<password for MQTT (optional)>", "caption": "<label (optional)>", "topics": { "getOccupancyDetected": "<topic used to provide 'occupancy detected' status>", "getStatusActive": "<topic used to provide 'active' status (optional)>", "getStatusFault": "<topic used to provide 'fault' status (optional)>", "getStatusTampered": "<topic used to provide 'tampered' status (optional)>", "getStatusLowBattery": "<topic used to provide 'low b