### Install homebridge-mqttthing Globally

Source: https://github.com/arachnetech/homebridge-mqttthing/blob/master/README.md

Install the plugin globally using npm. This is the recommended method for server-wide installation.

```bash
npm install -g homebridge-mqttthing
```

--------------------------------

### JSON Codec Example Configuration

Source: https://github.com/arachnetech/homebridge-mqttthing/blob/master/docs/Codecs.md

An example accessory configuration demonstrating the use of the JSON codec for a lightbulb. It maps 'on' and 'RGB' properties and includes fixed values for version and sender.

```json
{
    "accessory": "mqttthing",
    "type": "lightbulb",
    "name": "Test RGB Light",
    "url": "mqtt://192.168.10.35:1883",
    "topics": {
        "getRGB": "test/rgblight/get",
        "setRGB": "test/rgblight/set",
        "getOn": "test/rgblight/get",
        "setOn": "test/rgblight/set"
    },
    "logMqtt": true,
    "integerValue": false,
    "codec": "json",
    "jsonCodec": {
        "properties": {
            "on": "state.power",
            "RGB": "state.rgb"
        },
        "fixed": {
            "version": 1,
            "sender": "MQTT-Thing"
        }
    }
}
```

--------------------------------

### Shelly AMAX Codec Example Configuration

Source: https://github.com/arachnetech/homebridge-mqttthing/blob/master/docs/Codecs.md

Example configuration for integrating a Bosch AMAX alarm system with Shelly switches using the shellyAMAX codec. This setup requires specific mappings for setting and getting alarm states.

```json
{
    "name": "AMAX",
    "accessory": "mqttthing",
    "url": "url",
    "username": "user",
    "password": "passwd",
    "type": "securitySystem",
    "codec": "shellyAMAX",
    "ShellyGen": 1,
    "AMAX": {
        "setState": {
            "Armed": {
                "name": "shellies/shellyuni-98CDAC25XXXX",
                "id": 0,
                "ACTIVE": "on"
            },
            "Disarmed": {
                "name": "shellies/shellyuni-98CDAC25XXXX",
                "id": 0,
                "ACTIVE": "on"
            }
        },
        "getState": {
            "Armed": {
                "name": "shellies/shellyuni-98CDAC25XXXX",
                "id": 0,
                "ACTIVE": 1
            },
            "Triggered": {
                "name": "shellies/shellyuni-98CDAC25XXXX",
                "id": 1,
                "ACTIVE": 0
            },
            "AltTriggered": {
                "name": "shellies/shellyuni-98CDAC25XXXX",
                "id": 1,
                "ACTIVE": 1
            }
        }
    },
    "targetStateValues": [
        "SA",
        "AA",
        "NA",
        "D"
    ],
    "currentStateValues": [
        "SA",
        "AA",
        "NA",
        "D",
        "T"
    ],
    "restrictTargetState": [
        1,
        3
    ],
    "logMqtt": true
}
```

--------------------------------

### General Configuration for Homebridge MQTT-Thing

Source: https://github.com/arachnetech/homebridge-mqttthing/blob/master/docs/Configuration.md

This is a comprehensive example of a typical configuration for a lightbulb accessory using Homebridge MQTT-Thing. It includes common settings for MQTT connection, topics, and accessory behavior.

```javascript
{
    "accessory": "mqttthing",
    "type": "lightbulb",
    "name": "My lightbulb",
    "url": "mqtt://192.168.1.235:1883",
    "username": "MQTT_username",
    "password": "MQTT_password",
    "mqttOptions": { "keepalive": 30 },
    "mqttPubOptions": { "retain": false },
    "logMqtt": true,
    "topics": {
        "getName": 	        "my/get/name/topic",
        "getOnline":        "my/get/online/topic",
        "getBatteryLevel":  "my/get/battery-level/topic",
        "getChargingState": "my/get/battery-charging-state/topic",
        "getStatusLowBattery": "my/get/status-low-battery/topic"
    },
    "integerValue": true,
    "onlineValue": "Online",
    "offlineValue": "Offline",
    "chargingStateValues": [ "NotCharging", "Charging", "NotChargeable" ],
    "startPub": [
        { "topic": "topic1", "message": "message1" },
        { "topic": "topic2", "message": "message2" }
    ],
    "confirmationPeriodms": 1000,
    "retryLimit": 5,
    "debounceRecvms": 200,
    "optimizePublishing": false,
    "validate": true
}
```

--------------------------------

### Configure Speaker with MQTTThing

Source: https://github.com/arachnetech/homebridge-mqttthing/blob/master/docs/Accessories.md

Configure a speaker accessory to control mute and volume via MQTT. Specify the topics for getting and setting these states.

```json
{
    "accessory": "mqttthing",
    "type": "speaker",
    "name": "<name of sensor>",
    "topics":
    {
        "getMute":              "<topic used to indicate whether speaker is muted (Boolean)>",
        "setMute":              "<topic used to set whether speaker is muted (Boolean)>",
        "getVolume":            "<topic used to report current volume (0-100)>",
        "setVolume":            "<topic used to set volume (0-100)>"
    }
}
```

--------------------------------

### Configure Shelly RGBW2 Color for mqttthing

Source: https://github.com/arachnetech/homebridge-mqttthing/wiki/Tested-Configurations

Example configuration for Shelly RGBW2 Color, supporting dimming and fade transitions. Set the MQTT URL and device name, and configure topics for color control.

```json
{
    "accessory": "mqttthing",
    "type": "lightbulb",
    "name": "Shelly RGBW2",
    "url": "mqtt://192.168.0.200:1883",
    "logMqtt": false,
    "topics": {
        "getOn": "shellies/shelly-xxx/color/0",
        "setOn": "shellies/shelly-xxx/color/0/command",
        "getRGBW": {
            "topic": "shellies/shelly-xxx/color/0/status",
            "apply": "const response = JSON.parse(message); return response.red.toString() + ',' + response.green.toString() + ',' + response.blue.toString() + ',' + response.white.toString();"
        },
        "setRGBW": {
            "topic": "shellies/shelly-xxx/color/0/set",
            "apply": "if (message == '0,0,0,0') { return JSON.stringify({ 'turn': 'off', 'transition': 3000 }); } else { const splitMessage = message.split(','); return JSON.stringify({ 'turn': 'on', 'red': splitMessage[0], 'green': splitMessage[1], 'blue': splitMessage[2], 'white': splitMessage[3], 'gain': 100, 'transition': 4000 })" 
        }
    },
    "onValue": "on",
    "offValue": "off",
    "adaptiveLighting": false,
    "optimizePublishing": true,
    "debounceRecvms": 250
}
```

--------------------------------

### Mosquitto MQTT Broker Configuration

Source: https://github.com/arachnetech/homebridge-mqttthing/wiki/Tested-Configurations

Example configuration settings for the Mosquitto MQTT broker to handle persistent messages and auto-saving.

```ini
autosave_interval 1800
autosave_on_changes false
persistence true
persistence_file mosquitto.db
persistence_location /mosquitto/data/path/ etc.
```

--------------------------------

### Thermostat Configuration Example

Source: https://github.com/arachnetech/homebridge-mqttthing/blob/master/docs/Accessories.md

This JSON configuration defines a thermostat accessory using MQTTThing. Specify topics for reporting and controlling various thermostat states and values. Optional fields allow for humidity, temperature thresholds, and fault status.

```json
{
    "accessory": "mqttthing",
    "type": "thermostat",
    "name": "<name of device>",
    "url": "<url of MQTT server (optional)>",
    "username": "<username for MQTT (optional)>",
    "password": "<password for MQTT (optional)>",
    "topics":
    {
        "getCurrentHeatingCoolingState":  "<topic used to report 'current heating/cooling state'>",
        "setTargetHeatingCoolingState":   "<topic used to control 'target heating/cooling state'>",
        "getTargetHeatingCoolingState":   "<topic used to report 'target heating/cooling state'>",
        "getCurrentTemperature":          "<topic used to report 'current temperature'>",
        "setTargetTemperature":           "<topic used to control 'target temperature'>",
        "getTargetTemperature":           "<topic used to report 'target temperature'>",
        "setTemperatureDisplayUnits":     "<topic used to control 'temperature display units'>",
        "getTemperatureDisplayUnits":     "<topic used to report 'temperature display units'>",
        "getCurrentRelativeHumidity":     "<topic used to report 'current relative humidity' (optional)>",
        "setTargetRelativeHumidity":      "<topic used to control 'target relative humidity' (optional)>",
        "getTargetRelativeHumidity":      "<topic used to report 'target relative humidity' (optional)>",
        "setCoolingThresholdTemperature": "<topic used to control 'cooling threshold temperature' (optional)>",
        "getCoolingThresholdTemperature": "<topic used to report 'cooling threshold temperature' (optional)>",
        "setHeatingThresholdTemperature": "<topic used to control 'heating threshold temperature' (optional)>",
        "getHeatingThresholdTemperature": "<topic used to report 'heating threshold temperature' (optional)>",
        "getStatusFault":                 "<topic used to provide 'fault' status (optional)>"
    },
    "heatingCoolingStateValues": "<array of values to be used to represent Off, Heat, Cool and Auto respectively (optional)>",
    "temperatureDisplayUnitsValues": "<array of values to be used to represent Celsius and Fahrenheit respectively (optional)>",
    "minTemperature": minimum_target_temperature,
    "maxTemperature": maximum_taret_temperature,
    "restrictHeatingCoolingState": "<array of allowed values - see notes above (optional)>"
}
```

--------------------------------

### Sonoff Tasmota Temperature Sensor Configuration

Source: https://github.com/arachnetech/homebridge-mqttthing/wiki/Tested-Configurations

Example configuration for Sonoff devices running Tasmota firmware to report temperature.

```json
{
    "accessory": "mqttthing",
    "type": "temperatureSensor",
    "name": "YourName",
    "url": "mqtt://broker's IP",
    "username": "username",
    "password": "password",
    "topics": {
        "getCurrentTemperature": {
            "topic": "tele/YourName/SENSOR",
            "apply": "return JSON.parse(message).DS18B20.Temperature;"
        }
    }
}
```

--------------------------------

### Shelly Plus 1 Switch Configuration with Events RPC

Source: https://github.com/arachnetech/homebridge-mqttthing/wiki/Tested-Configurations

A working example for Shelly Plus 1 using the 'events/rpc' topic for listening, suitable for Homebridge 1.3.8 and mqttthing 1.1.38. Replace bracketed placeholders with your specific values.

```json
{
            "type": "switch",
            "name": "Doorbell",
            "url": "<ipaddress:1883>",
            "username": "<user>",
            "password": "<password>",
            "topics": {
                "getOn": {
                    "topic": "<shelly-id>/events/rpc",
                    "apply": "return JSON.parse(message).params[\"switch:0\"];"
                },
                "setOn": {
                    "topic": "<shelly-id>/rpc",
                    "apply": "return JSON.stringify({id: 123, src: 'user_1', method: 'Switch.Set', params: {id: 0, on: message}});"
                }
            },
            "manufacturer": "Shelly",
            "model": "Shelly 1 Plus",
            "serialNumber": "<I usually insert device mac address>",
            "firmwareRevision": "shellyOS",
            "accessory": "mqttthing"
        }
```

--------------------------------

### Codec with Property-Specific Functions

Source: https://github.com/arachnetech/homebridge-mqttthing/blob/master/docs/Codecs.md

An example of a codec's 'init' function returning a 'properties' map. This allows defining distinct 'encode' and 'decode' functions for specific accessory properties, falling back to default functions if not specified.

```javascript
function init() {
    return {
        properties: {
            targetProp1: {
                encode: encodeFunction1,
                decode: decodeFunction1
            },
            targetProp2: {
                encode: encodeFunction2
            },
        },
        encode: defaultEncodeFunction,
        decode: defaultDecodeFunction
    }
}
```

--------------------------------

### Configure Microphone Accessory

Source: https://github.com/arachnetech/homebridge-mqttthing/blob/master/docs/Accessories.md

Set up a microphone accessory to control mute status and volume via MQTT. Topics for getting and setting these states are required.

```json
{
    "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)>"
    }
}
```

--------------------------------

### Heater Cooler Accessory Configuration Example

Source: https://github.com/arachnetech/homebridge-mqttthing/blob/master/docs/Accessories.md

This JSON configuration defines the MQTT topics and custom values for a Heater Cooler accessory. It allows for control and reporting of active state, heating/cooling states, temperatures, and other features via MQTT.

```json
{
    "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)>"
}
```

--------------------------------

### Xiaomi/Aqara Switch Configuration

Source: https://github.com/arachnetech/homebridge-mqttthing/wiki/Tested-Configurations

Configuration for Xiaomi/Aqara switches (QBKG24LM/QBKG25LM/QBKG23LM). It sets up topics for getting and setting the switch state, with options for MQTT publishing.

```json
{
            "accessory": "mqttthing",
            "type": "switch",
            "name": "Switch Name",
            "url": "mqtt://:1883",
            "username": "username",
            "password": "password",
            "logMqtt": true,
            "mqttPubOptions": {
                "retain": true
            },
            "topics": {
                "getOn": {
                    "topic": "zigbee2mqtt/ID",
                    "apply": "return JSON.parse(message).state_right === 'ON' ? true : false;"
                },
                "setOn": {
                    "topic": "zigbee2mqtt/ID/set",
                    "apply": "return JSON.stringify({state_right: (message ? \"ON\" : \"OFF\")});"
                }
            }
        }
```

--------------------------------

### Came ZA3 Door Opener Configuration

Source: https://github.com/arachnetech/homebridge-mqttthing/wiki/Tested-Configurations

Homebridge MQTT Thing configuration for a Came ZA3 door opener. This setup uses specific 'apply' logic for topic messages.

```json
     {
            "accessory": "mqttthing",
            "name": "ZA3 Door",
            "type": "garageDoorOpener",
            "url": "url",
            "username": "username",
            "password": "password",
            "topics": {
                "getTargetDoorState": {
                    "topic": "shellies/shelly1-C45BBE56XXXX/input/0",
                    "apply": "if (message == 1) { return 'o';} return 'C';"
                },
                "getCurrentDoorState": {
                    "topic": "shellies/shelly1-C45BBE56XXXX/input/0",
                    "apply": "if (message == 1) { return 'O';} return 'C';"
                },
                "setTargetDoorState": {
                    "topic": "shellies/shelly1-C45BBE56XXXX/relay/0/command",
                    "apply": "if (message == 'O') {return 'on'} ; return 'off';"
                }
            },
            "doorCurrentValues": [
                "O",
                "C",
                "o",
                "c",
                "S"
            ],
            "doorTargetValues": [
                "O",
                "C"
            ],
            "logMqtt": true
        }
```

--------------------------------

### Basic Light Bulb Configuration

Source: https://github.com/arachnetech/homebridge-mqttthing/blob/master/docs/Accessories.md

This is a basic configuration for a light bulb accessory. It includes essential topics for getting and setting the on/off state, and optionally for brightness, hue, saturation, and color temperature.

```json
{
    "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>",

```

--------------------------------

### Configure Fibaro Walli Dimmer with MQTTThing

Source: https://github.com/arachnetech/homebridge-mqttthing/wiki/Tested-Configurations

Configuration for a Fibaro Walli Dimmer (Z-Wave model FGWDEU-111) using Homebridge MQTTThing. This setup requires specifying Z-Wave node numbers and topics for brightness and power control.

```json
{
    "accessory": "mqttthing",
    "type": "lightbulb",
    "name": "Strahler",
    "topics": {
        "getOn": {
            "topic": "node6/switch_multilevel/1/target_value",
            "apply": "return message > 0 ? '255' : '0';"
        },
        "setOn": "node6/switch_multilevel/1/level/set",
        "setBrightness": {
            "topic": "node6/switch_multilevel/1/level/set",
            "apply": "return message == '100' ? '255' : message;"
        },
        "getBrightness": "node6/switch_multilevel/1/target_value"
    },
    "onValue": "255",
    "offValue": "0"
}
```

--------------------------------

### Deta Grid Connect Smart LED Downlight Configuration

Source: https://github.com/arachnetech/homebridge-mqttthing/wiki/Tested-Configurations

Configuration for Tasmota-flashed Deta Grid Connect Smart 10W RGB LED Downlights. This setup uses RGBWW and notes that the warm white channels are reversed. Replace `<topic>` with your MQTT topic.

```json
{
            "type": "lightbulb",
            "name": "<whatever you want the globe called>",
            "mqttPubOptions": {
                "retain": true
            },
            "topics": {
                "getRGBWW": "stat/<topic>/Color",
                "setRGBWW": "cmnd/<topic>/Color",
                "getOn": "stat/<topic>/POWER",
                "setOn": "cmnd/<topic>/POWER",
                "getBrightness": "stat/<topic>/Dimmer",
                "setBrightness": "cmnd/<topic>/Dimmer",
                "getColorTemperature": "stat/<topic>/CT",
                "setColorTemperature": "cmnd/<topic>/CT"
            },
            "onValue": "ON",
            "offValue": "OFF",
            "hex": true,
            "whiteMix": true,
            "accessory": "mqttthing"
        }
```

--------------------------------

### Homebridge MQTTThing Garage Door Opener Configuration

Source: https://github.com/arachnetech/homebridge-mqttthing/wiki/Tested-Configurations

This JSON configuration defines a 'garageDoorOpener' accessory for Homebridge MQTTThing. It specifies MQTT topics for getting and setting the door state, along with 'apply' functions to translate Tasmota's state messages ('o', 'c', 'S') into HomeKit compatible values ('O', 'C') and to prevent redundant commands.

```json
{
            "type": "garageDoorOpener",
            "name": "Garage Door",
            "url": "broker_ip_address:1883",
            "username": "your_mqtt_username",
            "password": "your_password",
            "logMqtt": true,
            "topics": {
                "getTargetDoorState": {
                    "topic": "stat/garagedoor/current",
                    "apply": "if(message=='o') message='O'; if(message=='c' || message=='S') message='C'; return message;"
                },
                "getCurrentDoorState": {
                    "topic": "stat/garagedoor/current",
                    "apply": "if(message=='C' || message=='O') state.global.doorPosition=message; return message;"
                },
                "setTargetDoorState": {
                    "topic": "cmnd/garagerelay/POWER",
                    "apply": "if (state.global.doorPosition==message) return undefined; return 'ON'"
                }
            },
            "history": true,
            "manufacturer": "Sonoff",
            "model": "Sonoff SV",
            "serialNumber": "mac_address_or_reference",
            "firmwareRevision": "8.5.0",
            "accessory": "mqttthing"
        }
```

--------------------------------

### Configure Startup Publishing

Source: https://github.com/arachnetech/homebridge-mqttthing/blob/master/docs/Configuration.md

Publish MQTT messages on startup to set initial accessory states. This configuration uses an array of objects, each specifying a topic and message.

```javascript
"startPub": [
    { "topic": "test/lightbulb/setOn", "message": "1" },
    { "topic": "test/lightbulb/getOn", "message": "1" }
]
```

--------------------------------

### Mirabella Genio LED Bulb Configuration

Source: https://github.com/arachnetech/homebridge-mqttthing/wiki/Tested-Configurations

Configuration for a Mirabella Genio LED Bulb flashed with Tasmota. This example includes settings for MQTT URL, username, password, and various topics for power, brightness, and color temperature control. Ensure the topics and credentials match your MQTT broker and device setup.

```json
{
		"accessory": "mqttthing",
		"type": "lightbulb",
		"name": "LEDLight",
		"url": "mqtt://mqttbroker",
		"username": "DVES_USER",
		"password": "123456",
		"topics": {
			"setOn": "cmnd/DVES_8FC32E_fb/power",
			"getOn": "stat/DVES_8FC32E_fb/POWER",
			"getOnline": {
				"topic": "tele/sonoff/LWT",
				"apply": "return message == 'Online' ? 'ON' : 'OFF';"
			},	"getBrightness": "nodered/DVES_8FC32E_fb/dimmer/get",
        "setBrightness": "cmnd/DVES_8FC32E_fb/Dimmer",
        "getColorTemperature": "nodered/DVES_8FC32E_fb/colortemp/get",
        "setColorTemperature": "cmnd/DVES_8FC32E_fb/CT"
		},
		"integerValue": false,
		"onValue": "ON",
		"offValue": "OFF",
		"startPub": {
			"cmnd/DVES_8FC32E_fb/power": "",
			"stat/DVES_8FC32E_fb/POWER": ""
		},
		"logMqtt": true
	}
```

--------------------------------

### Sonoff Tasmota ZigBee Lightbulb Configuration

Source: https://github.com/arachnetech/homebridge-mqttthing/wiki/Tested-Configurations

Example configuration for a Sonoff Basic ZBR3 (ZigBee) using the Zigbee2Tasmota firmware on a Sonoff ZigBee Bridge. This snippet configures a lightbulb, mapping MQTT topics for getting and setting the power state. Replace 'ipaddres' with your MQTT broker's IP and '0xAB2F' with your specific ZigBee device ID.

```json
{
            "accessory": "mqttthing",
            "type": "lightbulb",
            "name": "testzigbee",
            "url": "mqtt://ipaddres",
            "integerValue": "true",
            "topics": {
                "getOn": {
                    "topic": "tele/sonoffBridgeTopic/SENSOR",
                    "apply": "return JSON.parse(message).ZbReceived['0xAB2F'].Power;"
                },
                "setOn": {
                    "topic": "cmnd/sonoffBridgeTopic/ZbSend",
                    "apply": "return '{\"device\":\'0xAB2F\', \"send\":{\"Power\":' + message + '}}'"
                }
            }
        }
```

--------------------------------

### User-Defined Keys in startPub Configuration

Source: https://github.com/arachnetech/homebridge-mqttthing/blob/master/wip/notes.txt

The config-ui-x GUI cannot handle 'startPub' configurations with user-defined keys. An alternative array-based format is proposed for better GUI compatibility.

```json
"startPub": {
  "test/lightbulb/setOn": "1",
  "test/lightbulb/getOn": "1",
  "test/lightbulb/setBrightness": "200",
  "test/lightbulb/getBrightness": "200",
  "test/lightbulb": "Hello world"
}
```

--------------------------------

### Alternative startPub Format for GUI Support

Source: https://github.com/arachnetech/homebridge-mqttthing/blob/master/wip/notes.txt

This alternative array-based format for 'startPub' is designed to be more compatible with configuration GUIs like config-ui-x, avoiding issues with user-defined keys.

```json
"startPub": [
  { "topic": "test/lightbulb/setOn", "message": "1" },
  { "topic": "test/lightbulb/getOn", "message": "1" }
]
```

--------------------------------

### JSON Codec Example Message

Source: https://github.com/arachnetech/homebridge-mqttthing/blob/master/docs/Codecs.md

An example of a message sent or received when using the JSON codec with the configuration above. It includes the fixed properties and the mapped state properties.

```json
{"version":1,"sender":"MQTT-Thing","state":{"power":true,"rgb":"125,82,255"}}
```

--------------------------------

### Sonoff Motion Sensor with Sonoff RF Bridge (Tasmota)

Source: https://github.com/arachnetech/homebridge-mqttthing/wiki/Tested-Configurations

Example configuration for a Sonoff Motion Sensor connected via a Sonoff RF Bridge flashed with Tasmota. Remember to update the MQTT broker URL, Tasmota ID, and the specific RF received data code ('123456' in the example) from your MQTT messages.

```json
"accessories": [
        {
            "accessory": "mqttthing",
            "type": "motionSensor",
            "name": "mBerging",
            "url": "mqtt://0.0.0.0:1883",
            "username": "",
            "password": "",
            "caption": "",
            "topics": {
                "getMotionDetected": {
                    "topic": "tele/tasmota_XXXXX/RESULT",
                    "apply": "return( ( JSON.parse(message).RfReceived.Data == '123456' ) ? 1 : 0);"
                }
            },
            "integerValue": "true",
            "turnOffAfterms": "6000"
        }
    ],

```

--------------------------------

### Configure Window Covering Accessory

Source: https://github.com/arachnetech/homebridge-mqttthing/blob/master/docs/Accessories.md

Use this configuration to set up a window covering accessory. Define topics for position, state, and obstruction detection. Customize position state values and the min/max position range if needed.

```json
{
    "accessory": "mqttthing",
    "type": "windowCovering",
    "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)>",
        "setTargetHorizontalTiltAngle":  "<topic used to control target horizontal tilt angle (-90 to 90)>",
        "getTargetHorizontalTiltAngle":  "<topic used to report target horizontal tilt angle (optional)>",
        "getCurrentHorizontalTiltAngle": "<topic used to report current horizontal tilt angle>",
        "setTargetVerticalTiltAngle":    "<topic used to control target vertical tilt angle (-90 to 90)>",
        "getTargetVerticalTiltAngle":    "<topic used to report target vertical tilt angle (optional)>",
        "getCurrentVerticalTiltAngle":   "<topic used to report current vertical tilt angle>",
        "getObstructionDetected":        "<topic used to report whether an obstruction is detected (Boolean)>"
    },
    "positionStateValues": [ "decreasing-value", "increasing-value", "stopped-value" ],
    "minPosition": 0,
    "maxPosition": 100
}
```

--------------------------------

### Apply Format for Topics in config.schema.json

Source: https://github.com/arachnetech/homebridge-mqttthing/blob/master/wip/notes.txt

This format for topics is not well-supported by the config-ui-x GUI because it doesn't handle properties with multiple types. Consider alternative structures if GUI support is critical.

```json
"setBrightness": {
  "topic": "test/lightbulb/setBrightness",
  "apply": "return Math.round( message * 2.55 );"
}
```

--------------------------------

### ShellyPlus1 Thermostat Configuration

Source: https://github.com/arachnetech/homebridge-mqttthing/wiki/Tested-Configurations

Configuration for a ShellyPlus1 device acting as a thermostat relay. Requires MQTT to be enabled on the Shelly device and the ShellyPlus1Thermostat script to be installed and configured.

```json
{
            "name": "ShellyPlus1 Thermostat",
            "accessory": "mqttthing",
            "type": "thermostat",
            "url": "homebridge",
            "username": "homebridge",
            "password": "homebridge",
            "topics": {
                "getCurrentHeatingCoolingState": "shellyplus1-XXXXXXXXXXXX/thermostat/currentHeatingCoolingState",
                "setTargetHeatingCoolingState": "topic": "shellyplus1-XXXXXXXXXXXX/thermostat/targetHeatingCoolingState",
                "getTargetHeatingCoolingState": "shellyplus1-XXXXXXXXXXXX/thermostat/targetHeatingCoolingState",
                "getCurrentTemperature": "shellyplus1-XXXXXXXXXXXX/thermostat/currentTemperature",
                "setTargetTemperature": "shellyplus1-XXXXXXXXXXXX/thermostat/targetTemperature",
                "getTargetTemperature": "shellyplus1-XXXXXXXXXXXX/thermostat/targetTemperature",
                "setCoolingThresholdTemperature": "shellyplus1-XXXXXXXXXXXX/thermostat/coolingThresholdTemperature"
                "getCoolingThresholdTemperature": "shellyplus1-XXXXXXXXXXXX/thermostat/coolingThresholdTemperature",
                "setHeatingThresholdTemperature": "shellyplus1-XXXXXXXXXXXX/thermostat/heatingThresholdTemperature"
                "getHeatingThresholdTemperature": "shellyplus1-XXXXXXXXXXXX/thermostat/heatingThresholdTemperature"
            },
            "minTemperature": 16,
            "maxTemperature": 24,
            "restrictHeatingCoolingState": [
                0,
                1
            ],
            "logMqtt": false,
            "_bridge": {
                "username": "XX:XX:XX:XX:XX:XX"
            }
        }
```

--------------------------------

### Configure Gosund SP111 Plug

Source: https://github.com/arachnetech/homebridge-mqttthing/wiki/Tested-Configurations

This configuration is for the Gosund SP111 V1.1 / Blitzwolf BW-SHP2 plug. It sets up MQTT topics for power state, energy monitoring (Watts, Volts, Amperes), and includes options for history and initial publishing.

```json
{
            "type": "outlet",
            "name": "stecki3",
            "username": "home",
            "password": "000",
            "mqttPubOptions": {
                "retain": true
            },
            "topics": {
                "getInUse": "tele/stecki3/STATE",
                "getOn": "stat/stecki3/POWER",
                "setOn": "cmnd/stecki3/POWER",
                "getWatts": {
                    "topic": "tele/stecki3/SENSOR",
                    "apply": "return JSON.parse(message).ENERGY.Power;"
                },
                "getVolts": {
                    "topic": "tele/stecki3/SENSOR",
                    "apply": "return JSON.parse(message).ENERGY.Voltage;"
                },
                "getAmperes": {
                    "topic": "tele/stecki3/SENSOR",
                    "apply": "return JSON.parse(message).ENERGY.Current;"
                }
            },
            "history": "true",
            "onValue": "ON",
            "offValue": "OFF",
            "startPub": [
                {
                    "topic": "cmnd/stecki3/POWER",
                    "message": "ON"
                },
                {
                    "topic": "stat/stecki3/POWER",
                    "message": ""
                }
            ],
            "mqttOptions": {
                "keepalive": 30
            },
            "logMqtt": true,
            "onlineValue": "Online",
            "manufacturer": "Gosund",
            "model": "SP111 1.1",
            "serialNumber": "192.168.178.40",
            "accessory": "mqttthing"
        }
```

--------------------------------

### Tuya Zigbee Switch Configuration

Source: https://github.com/arachnetech/homebridge-mqttthing/wiki/Tested-Configurations

Configuration for a Tuya Zigbee Switch using Zigbee2Tasmota. Ensure the 'tele/sonoffBridgeTopic/SENSOR' topic and device ID '0xAB2F' are correctly set for your setup.

```json
{
            "accessory": "mqttthing",
            "type": "lightbulb",
            "name": "testzigbee",
            "url": "mqtt://ipaddres",
            "integerValue": "true",
            "topics": {
                "getOn": {
                    "topic": "tele/sonoffBridgeTopic/SENSOR",
                    "apply": "return JSON.parse(message).ZbReceived[\"0xAB2F\"].Power;"
                },
                "setOn": {
                    "topic": "cmnd/sonoffBridgeTopic/ZbSend",
                    "apply": "return '{\"device\":\"0xF422\", \"Write\":{\"Power\":' + message + '}}'"
                }
            }
        }
```

--------------------------------

### Shelly Dimmer/SL Lightbulb Configuration

Source: https://github.com/arachnetech/homebridge-mqttthing/wiki/Tested-Configurations

Configuration for a Shelly Dimmer/SL as a lightbulb. This includes settings for getting and setting the on/off state and brightness. Replace MQTT credentials and device name.

```json
{
    "accessory": "mqttthing",
    "username": "USERNAME",
    "password": "PASSWORD",
    "type": "lightbulb",
    "name": "Fancy Name",
    "url": "mqtt://192.168.188.30:1883",
    "topics": {
        "getOn": "shellies/shellydimmer-XXXXXX/light/0",
        "setOn": "shellies/shellydimmer-XXXXXX/light/0/command",
        "getBrightness": {
            "topic": "shellies/shellydimmer-XXXXXX/light/0/status",
            "apply": "return (JSON.parse(message).ison ? JSON.parse(message).brightness : 0);"
        },
        "setBrightness": {
            "topic": "shellies/shellydimmer-XXXXXX/light/0/set",
            "apply": "return JSON.stringify({ turn:\"on\", brightness: parseInt(message)})"
        }
    },
    "onValue": "on",
    "offValue": "off"
}
```

--------------------------------

### Configure Deta 1-Gang WiFi Switch with MQTTThing

Source: https://github.com/arachnetech/homebridge-mqttthing/wiki/Tested-Configurations

Configuration for a Deta 1-Gang WiFi Switch flashed with Tasmota firmware. Requires MQTT details and specifies topics for online status, power state, and control.

```json
{
    "type": "switch",
    "name": "Main Light Switch",
    "url": "mqtt://<homebridge IP or FQDN>:1883",
    "username": "<username>",
    "password": "<password>",
    "topics": {
        "getOnline": {
            "topic": "tele/<topic>/LWT",
            "apply": "return message == 'Online' ? 'ON' : 'OFF';"
        },
        "getOn": "stat/<topic>/POWER",
        "setOn": "cmnd/<topic>/POWER"
    },
    "integerValue": false,
    "onValue": "ON",
    "offValue": "OFF",
    "startPub": {
        "cmnd/<topic>/POWER": "",
        "stat/<topic>/POWER": ""
    },
    "accessory": "mqttthing"
}
```

--------------------------------

### Configure Weather Station Accessory

Source: https://github.com/arachnetech/homebridge-mqttthing/blob/master/docs/Accessories.md

Use this configuration to set up a weather station accessory. Specify topics for various weather readings like temperature, humidity, and air pressure. Optional settings include service names, MQTT connection details, and history logging for Eve App.

```json
{
    "accessory": "mqttthing",
    "type": "weatherStation",
    "name": "<name of sensor>",
    "serviceNames": {
        "temperature": "<name for temperature service (optional)>",
        "humidity":    "<name for humidity service (optional)>",
        "airPressure": "<name for air pressure service (optional)>",
        "weather":     "<name for weather service (optional)>"
    },
    "url": "<url of MQTT server (optional)>",
    "username": "<username for MQTT (optional)>",
    "password": "<password for MQTT (optional)>",
    "caption": "<label (optional)>",
    "topics":
    {
        "getCurrentTemperature":        "<topic used to provide 'current temperature'>",
        "getCurrentRelativeHumidity":   "<topic used to provide 'current relative humidity (optional)'>",
        "getCurrentAmbientLightLevel":  "<topic used to provide 'current ambient light level (optional)'>",
        "getAirPressure":               "<topic used to provide 'air pressure' (optional, Eve-only)>",
        "getWeatherCondition":          "<topic used to provide 'weather condition' (optional, Eve-only)>",
        "getRain1h":                    "<topic used to provide 'rain [mm] in last 1h' (optional, Eve-only)>",
        "getRain24h":                   "<topic used to provide 'rain [mm] in last 24h' (optional, Eve-only)>",
        "getUVIndex":                   "<topic used to provide 'UV index' (optional, Eve-only)>",
        "getVisibility":                "<topic used to provide 'visibility [km]' (optional, Eve-only)>",
        "getWindDirection":             "<topic used to provide 'wind direction' (optional, Eve-only)>",
        "getWindSpeed":                 "<topic used to provide 'wind speed [km/h]' (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)>"
    },
    "history": "<true to enable History service for Eve App (optional)>"
}
```

--------------------------------

### Homebridge Configuration for Philips Hue Switch

Source: https://github.com/arachnetech/homebridge-mqttthing/wiki/Tested-Configurations

Configuration for a Philips Hue 4-Button Remote connected via zigbee2mqtt. This setup maps button actions to switch events and retrieves battery status.

```json
    "accessories": [
        {
            "accessory": "mqttthing",
            "type": "statelessProgrammableSwitch",
            "url": "http://192.168.86.190:1883",
            "topics": {
                "getSwitch": [
                    {
                        "topic": "zigbee2mqtt/0x00178801020d430f",
                        "apply": "var action = JSON.parse(message).action; var counter = JSON.parse(message).counter; if (action == \"on-press\") {if (counter == 1) {return \"1\"} else {return \"2\"}} else if (action == \"on-hold\") {return \"L\"};"
                    },
                    {
                        "topic": "zigbee2mqtt/0x00178801020d430f",
                        "apply": "var action = JSON.parse(message).action; var counter = JSON.parse(message).counter; if (action == \"up-press\") {if (counter == 1) {return \"1\"} else {return \"2\"}} else if (action == \"up-hold\") {return \"L\"};"
                    },
                    {
                        "topic": "zigbee2mqtt/0x00178801020d430f",
                        "apply": "var action = JSON.parse(message).action; var counter = JSON.parse(message).counter; if (action == \"down-press\") {if (counter == 1) {return \"1\"} else {return \"2\"}} else if (action == \"down-hold\") {return \"L\"};"
                    },
                    {
                        "topic": "zigbee2mqtt/0x00178801020d430f",
                        "apply": "var action = JSON.parse(message).action; var counter = JSON.parse(message).counter; if (action == \"off-press\") {if (counter == 1) {return \"1\"} else {return \"2\"}} else if (action == \"off-hold\") {return \"L\"};"
                    }
                ],
                "getBatteryLevel": {
                    "topic": "zigbee2mqtt/0x00178801020d430f",
                    "apply": "return JSON.parse(message).battery"
                }
            },
            "name": "Hue RZ Taster Bett",
            "confirmationPeriodms": 1000
        }
    ]

```

--------------------------------

### Configure Window Accessory

Source: https://github.com/arachnetech/homebridge-mqttthing/blob/master/docs/Accessories.md

Configure a window accessory to report and control its position. This includes topics for current and target position, position state, hold, and obstruction detection. Optional settings allow customization of position values and ranges.

```json
{
    "accessory": "mqttthing",
    "type": "window",
    "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
}
```