homebridge-tasmota-zbbridge

Homebridge Tasmota Zigbee Bridge

This Homebridge plugin can controll Tasmota or Zigbee devices connected to a MQTT broker.

Devices flashed with Tasmota firmware (Outlet Switch, Lightbulb, RGB Stripe, Sensor, etc.) are suported directly. Zigbee devices can be controlled using Zigbee2Tasmota or Zigbee2MQTT gateway/bridge.

By configuring a powerTopic it is possible to combine devices to a singe HomeKit appliance - Tasmota controlled switch can turn on a Zigbee lightbulb and then change the brightness or the collor over the Zigbee network (the lightbulb should be configured to turn on automatically when power is applied).

Installation

• Flash your device(s) with Tasmota
• Install homebridge npm install -g homebridge
• Install the plugin npm install -g homebridge-tasmota-zbbridge
• Alternatively use the great Homebridge Config UI X plugin to install and configure

Configuration

{
    "name": "ZbBridge",
    "zigbee2TasmotaDevices": [
        {
            "addr": "0x8E8E",
            "type": "light1",
            "name": "Hue Lamp",
            "powerTopic": "shelly-kitchen",
            "powerType": "POWER2"
        },
        {
            "addr": "0x001788011234567F",
            "type": "light3",
            "name": "Go"
        },
        {
            "addr": "0xAC3C:1",
            "type": "switch",
            "name": "Switch-1",
        },
        {
            "addr": "0xAC3C:2",
            "type": "switch",
            "name": "Switch-2",
        },
        {
            "addr": "0xAD0B",
            "type": "switch",
            "name": "Kitchen Outlet"
        },
        {
            "addr": "0x43D0",
            "type": "sensor",
            "name": "Garage Door",
            "sensorService": "ContactSensor",
            "sensorCharacteristic": "ContactSensorState",
            "sensorValuePath": "Contact"
        },
        {
            "addr": "0xD394",
            "type": "sensor",
            "name": "Sensor3",
            "sensorService": "StatelessProgrammableSwitch",
            "sensorValuePath": "Click",
            "sensorValueMapping": [
                {
                    "from": "single",
                    "to": "0"
                },
                {
                    "from": "double",
                    "to": "1"
                },
                {
                    "from": "hold",
                    "to": "2"
                }
            ]
        }
    ],
    "zigbee2mqttDevices": [
        {
            "ieee_address": "0x002788011234567F",
            "name": "Light Bulb"
        }
    ],
    "tasmotaDevices": [
        {
            "topic": "sonoff",
            "type": "POWER",
            "name": "Sonoff TM"
        },
        {
            "topic": "sonoff",
            "type": "StatusSNS.AM2301.Temperature",
            "name": "Sonoff TM Temperature"
        },
        {
            "topic": "sonoff",
            "type": "StatusSNS.AM2301.Humidity",
            "name": "Sonoff TM Humidity"
        },
        {
            "topic": "sonoff-4ch",
            "type": "POWER2",
            "name": "Sonoff 4CH Channel 2"
        }
    ],
    "mqttBroker": "raspi2",
    "zigbee2tasmotaTopic": "zbbridge",
    "zigbee2mqttTopic": "zigbee2mqtt",
    "platform": "TasmotaZbBridge"
}

zigbee2TasmotaDevices - Zigbee devices connected to the Zigbee2Tasmota gateway/bridge

• addr - Device hardware or short address and optional endpoint (for example Tuya 2ch switch). The hardware address (64 bits) is unique per device and factory assigned so once configured it will still work even if the device have to be paired again. Example: Use 0xAC3C:1 for address 0xAC3C, endpoint 1.
• type - Device type (light0, light1, light2, light3, light4, light5, switch, sensor) see descriptions in config.schema.json. Alternatively use generic light adding supported features: _B for brigthness, _CT for color temperature, _HS for hue and saturation and _XY for XY color support (for example light_B_CT_XY). Configure desired sensor type using the specific fields below.
• name - Accessory name to be used in the Home applicaiton. Should be unique. Will update ZbBridge Friendly Name if endpoint is not used.
• Advanced settings

  • powerTopic - (optional) Use another tasmota device to controll the power (configure it's identifying topic)

  • powerType - (optional) Tasmota switch topic used to turn on/off the zigbee device, (default: POWER)

  • sensorService - (optional) Sensor service name as defined here (default: ContactSensor)

  • sensorCharacteristic - (optional) Service characteristic name (default: ContactSensorState)

  • sensorValuePath - (optional) Path of the sensor value in the SENSOR message (default: Contact).

  • sensorValueMapping - (optional) Map sensor from value to homebridge to value. All other values will be ignored.

    For example CONTACT_DETECTED will be reported when following message is received:

    {"ZbReceived":{"0x43D0":{"Device":"0x43D0","Name":"ContactSensorExample","Contact":0,"Endpoint":1,"LinkQuality":66}}}
    

zigbee2mqttDevices - Zigbee devices connected to Zigbee2MQTT gateway/bridge

• ieee_address
• name - Accessory name to be used in the Home applicaiton. Should be unique.
• powerTopic - (optional) Use another tasmota device to controll the power (configure it's identifying topic)
• powerType - (optional) Tasmota switch topic used to turn on/off the zigbee device, (default: POWER)

tasmotaDevices - Tasmota flashed devices

• topic - Device topic as configured in the MQTT menu
• type - Device type (POWER, LIGHT, StatusSNS.AM2301.Temperature, StatusSNS.AM2301.Humidity, etc.) see descriptions in config.schema.json
• name - Accessory name to be used in the Home applicaiton. Should be unique.

mqttBroker - MQTT Broker hostname if not localhost

mqttUsername - MQTT Broker username if password protected

mqttPassword - MQTT Broker passwort if password protected

zigbee2tasmotaTopic - Zigbee2Tasmota gateway/bridge base topic (default: zbbridge)

zigbee2mqttTopic - Zigbee2MQTT gateway/bridge base topic (default: zigbee2mqtt)

Zigbee2MQTT

It is also possible to controll devices using Zigbee2MQTT gateway/bridge. This is useful if you want to combine Zigbee and Tasmota devices using the powerTopic.

Almost all accessory-types are supported but currently some characteristics are not mapped correctly (work in progress). Supported features are queried directly from Zigbe2MQTT and configured automatically.

Binding with Zigbee2Tasmota

You can add switches or sensors to HomeKit to control automations or bind them with other devices or groups for direct control.

Note: when a device is bound to a group you have to listen to the group messages for device status updates. By default EZSP will not report group messages unless you subscribe to the group.

IKEA remotes (with old firmware) only support 1 group and can be linked to a light only via group numbers (no direct binding).

Type following commands in the Tasmota console to bind a switch to a light:

1. Add the light to group 10

ZbSend {"Device":"IKEA_Light","Send":{"AddGroup":10}}

2. Bind the remote to group 10. Note: you need to press a button on the remote right before sending this command to make sure it's not in sleep mode

ZbBind {"Device":"IKEA_Remote","ToGroup":10,"Cluster":6}

3. Activate EZSP to listen to the group messages so the HomeKit device is updated each time a group command is received (Not necessary for CC2530 devices)

ZbListen1 10

You can also bind devices as usual using the link button. Then you have to find out the automatically generated group and activate EZSP to listen to this group:

1. Get all device groups:

ZbSend {"Device":"IKEA_Light","Send":{"GetAllGroups":true}}
tele/zbbridge/SENSOR = {"ZbReceived":{"0x303F":{"Device":"0x303F","Name":"IKEA_Light","0004<02":"FF01AFE0","GetGroupCapacity":255,"GetGroupCount":1,"GetGroup":[57519],"Endpoint":1,"LinkQuality":108}}}

3. Activate EZSP to listen to the group messages for the reported group (Not necessary for CC2530 devices)

ZbListen1 57519

The listen commands should be executed after each reboot. Alternatively a rule to execute them when the zigbee is initialized on boot could be created:

1. Create the rule:

RULE1 ON ZbState#status=0 DO Backlog ZbListen1 10; ZbListen2 57519 ENDON

2. Activate it:

RULE1 1