With the Zigbee-coordinator based on Texas Instruments SoC cc253x (and others models) or deCONZ ConBee/RaspBee modules, it creates its own zigbee-network, into which zigbee-devices are connected. By work directly with the coordinator, the driver allows you to manage devices without additional application / gateways / bridge from device manufacturers (Xiaomi / TRADFRI / Hue / Tuya). About the device Zigbee-network can be read here (in English).
For work, you need one of the following devices, flashed with a special ZNP firmware: cc2531, cc2530, cc26x2r, cc2538
The necessary equipment for the firmware and the device preparation process are described here (in English) or here (in Russian)
(experimental support)
ConBee I ConBee II RaspBee
To start the driver, you must specify the name of the port on which the Zigbee-module (stick) is connected. Usually this is the port /dev/ttyACM0 or /dev/ttyUSB0 for the UART-connection. Or you can find with ls -l /dev/serial/by-id the device direct.
For Windows this will be the COM port number.
Starting from version 1.0.0 you can also use tcp connection for cases using esp8266 (or other microcontrollers) as serial-bridge. For example tcp://192.168.1.46:8880. Read more info here https://www.zigbee2mqtt.io/information/connecting_cc2530#via-an-esp8266
To connect devices, you need to switch the Zigbee-coordinator to pairing mode by pressing the green button. The countdown will begin (60 seconds) until the device connectivity is available. To connect Zigbee devices in most cases, just press the pairing button on the device itself. But there are features for some devices. More information about pairing with devices can be found here (in English)
After successful pairing, the device appears in the configuration panel. If the device appears in the configuration panel but has the type "undefined", then this is an unknown device and can not be work with it. If the device is in the list of available devices, but added as "undefined", then try to remove the device and add it again.
The devices connected to the Zigbee-network and inform the coordinator of their status and events (button presses, motion detection, temperature change). This information is reflected in the ioBroker object-states. Some ioBroker states have feedback and send commands to the zigbee-device when the value changes (switching the state of the outlet or lamp, changing the scene or the brightness of the lamp).
You may create groups of devices.
It is a Zigbee feature, intended for example to switch bulbs synchronized. Assign groups via device tabs edit button. A group will show as own "device" in Objects.
Note: Not all devices support groups (not supported by end devices like sensors).
https://www.zigbee2mqtt.io/information/binding
This is a tool for advanced users to test currently unsupported devices or enhance this adapters functionality. More instructions can be found on tab.
There is a friendly project with similar functionality on the same technologies, where you can work with the same devices using the MQTT protocol. Therefore, if any improvements or support for new zigbee-devices occur in the Zigbee2MQTT project, we can transfer and add the same functionality to this adapter. If you notice this, then write the issue - we'll postpone it.
There are knowledge bases that can be useful for working with Zigbee-devices and equipment:
- in English https://www.zigbee2mqtt.io/
- in Russian https://myzigbee.ru/
Works with devices from this list https://github.com/ioBroker/ioBroker.zigbee/wiki/Supported-devices
You can thank the authors by these links:
- to Kirov Ilya https://www.paypal.me/goofyk
- to Arthur Rupp https://paypal.me/pools/c/8gWlKqAfIF
- (kirovilya) Critical. Fixed error starting adapter if cc-chip was only flashed
- (kirovilya) Nue/3A FNB56-ZSW02LX2.0
- (Strunzdesign) Added missing raw button events for Philips Hue Smart Button ROM001
- (Sacred-Shadow) Fix Color for Outdoor Lantern W RGBW OSRAM
new Zigbee-herdsman features:
- ConBee/RaspBee (experimental support) Koenkk/zigbee-herdsman#72
- OTA update for some devices (IKEA, OSRAM and other) Koenkk/zigbee2mqtt#2921
- Touchlink reset and join Koenkk/zigbee2mqtt#2396
- Green Power devices support Koenkk/zigbee2mqtt#3322
- (peterfido) iCasa KPD14S und KPD18S hinzu
- (kirovilya) Moes Zigbee Thermostatic Radiator
- (kirovilya) LifeControl power plug MCLH-03, bulb MCLH-02, water leak MCLH-07, door sensor MCLH-04
- (kirovilya) Philips LCT002, LCT011, LTW015, LWG004
- (kirovilya) Gledopto GL-C-007 with with channel
- (MultivitaminJuice) Iluminize 511.040
- (Sacred-Shadow) Bitron 902010/24
- (kirovilya) Color indication of LQI and Battery icon
- (kirovilya) Device info modal dialog
- (arteck) Philips LCT026
- (obakuhl) Improvements Osram switch mini
- (arteck) Nue / 3A FB56+ZSW1GKJ2.5, LXN-1S27LX1.0
- (agross) Philips Signe Floor and Table
- (arteck) TRADFRI bulb E14 WS 470lm, OSRAM PAR16 TW Z3
- (kirovilya) Smart remote controller (4 buttons)
- (allofmex) OTA updates
- (kirovilya) Aqara opple change mode keys (for binding)
- (palsch) Heiman HS2WD-E siren
- (kirovilya) Philips Hue Adore Bathroom Mirror Light
- (kirovilya) Oujiabao Gas and carbon monoxide alarm
- (kirovilya) Tuya SOS button
- (Erdnuss3003) Schwaiger ZBT-DIMLight-GLS0800
- (arteck) Smart Home Pty FB56-ZCW11HG1.4, LXT56-LS27LX1.7
- (arteck) Xiaomi plug lumi.plug.mmeu01
- (arteck) Innr RS 228 T, RS 230 C
- (arteck) Gledopto GL-MC-001, GL-D-003ZS
- (allmyjoes) Bitron AV2010/21A
- (arteck) Osram Panel TW 595 UGR22
- (kirovilya) IKEA SURTE door WS 38x64
- (andigandi) Philips Hue LCG002, Hue LTG002
- (arteck) iCasa ICZB-FC
- (arteck) Osram A60 DIM Z3
- (arteck) Paulmann 371000001
- (DaCHRIS) Osram PAR16 DIM Z3
- (DaCHRIS) Philips LWG001
- (DaCHRIS) Illuminize 511.202
- (SchumyHao) TERNCY-SD01 knob dimmer
- (SchumyHao) Xiaomi lumi.lock.aq1
- (kirovilya) New eWeLink devices: button, TH sensor, contact sensor, motion sensor
- (kirovilya) Allow pairing to routers (again)
- (Erdnuss3003) Philips Hue LCT021
- (root) Trust ZWLD-100 water leak sensor
- (smartpran) Bitron AV2010/32
- (Tw1nh34d) Hornbach FLAIR LED
- (asgothian) Hue smart button, Heiman smoke sensor
- (kirovilya) Philips LTC014, LTC015
- (kirovilya) Power states for QBKG11LM
- (Garfonso) Change role for occupancy state to 'sensor.motion'
- (kirovilya) Change illuminance state to illuminance_lux (for lux value)
- (arteck) Philips LCF002
- (arteck) TRADFRI open/close remote
- (kirovilya) Tuya sensor TS0201
- (kirovilya) All button events for Aqara Opple switch
- (ma-john) OSRAM PAR16 RGBW Z3
- (arteck) Phillips LWA004
- (MiniMe6666) Heiman SmokeSendor-N-3.0
- (kirovilya) Force remove device
- (kirovilya) Fix some networkmap bugs
- (kirovilya) Extended info button
- (kirovilya) Long press for WXKG01LM
- fix for old z-stack firmware
- Powered by new zigbee-herdsman library and new converters database
- Drop support NodeJS 6
- Serialport 8.0.5 (in zigbee-herdsman)
- More new devices
- Some design update
- Binding
- (allofmex) Improved publish-to-zigbee queue
- (arteck) Gledopto GL-B-001Z
- (kirovilya) iHORN Temperature & humidity sensor
- (kirovilya) Trust ZLED-TUNE9, DIYRuZ contact, Lonsonho Plug
- (kirovilya) IKEA driver 30W
- (allofmex) Hue Smart Plug
- (arteck) LST004
- (Asgothian) Danalock V3 BTZB
- (Asgothian) GroupErrorInGetDevices
- (Asgothian) new Dev Innr RB 245
- (Asgothian) new Dev RS 225
- (Asgothian) new Dev Heiman COSensor
- (Asgothian) Improved device configuration method
- (Stabilostil) Fix for install error if running zigbee-adapter is updated
- (kirovilya) Update Z-Stack 3 compatible
- (kirovilya) Restore lumi.sensor_ht
- (kirovilya) OSRAM SMART+ spot GU5.3 tunable white #340
- (allofmex) Temperature and illuminance calibration added for hue motion sensors
- (kirovilya) new Trust lamp
- (kirovilya) DiY 20 button keypad (http://modkam.ru/?p=1114)
- (kirovilya) Xiaomi/Aqara: double click for b186acn01, Hold and Shake state for some switch
- (kirovilya) Hieman HS2SK, Tuya temperature sensor
- (kirovilya) Konke: button, temperature, contact, motion
- (allofmex) Hue sml sensitivity, Hue motion sensitivity
- (arteck) Innr RB 250 C, Gledopto GL-D-003Z, GL-G-001Z, GL-FL-004TZ, Philips LPT001
- (kirovilya) OSRAM CLA60 RGBW Z3, Xiaomi curtain ZNCLDJ11LM
- (kirovilya) Implement a time response for some xiaomi devices
- (arteck) Heiman smoke sensor, TRADFRI bulb E14 WS opal 600lm, Innr RB265
- fix wrong initial extPanID. Sorry that need to repairing all devices again.
- fix code for aqara cube
- Support both Z-Stack 1.2 and 3.0 coordinator firmware
- Serialport 7.1.5
- (arteck) Adjustable time for pairing
- (kirovilya) Additional xiaomi plug states and decoupled mode for xiaomi wall switches
- (kirovilya) New DIY devices ZigUP and DIYRUZ_R4_5
- (arteck) JIAWEN FB56-ZCW08KU1.2, Nue / 3A FNB56-ZCW25FB1.9, HOMA1031, Trust CSW_ADUROLIGHT
- (allofmex) security update
- (allofmex) brightness fix
- (Asgothian) Osram Gardenpole Mini
- (Asgothian) Innr Plugs (BY 265 C, BY 165 C, RB265
- (Asgothian) Fix for Ikea Tradfri repeater (image)
- (sonntam) tint enhancements
- (stream2me) support for Danalock V3
- fixes
- (kirovilya) Aqara Wireless Relay Controller, Smart LED Driver
- (asgothian) eCozy Thermostat, Nue / 3A, Gledopto GL-C-006 GL-C-009, Philips SML002, OSRAM Outdoor Lantern W RGBW, TRADFRI motion sensor
- (arteck) sensor_86sw2 new states
- (allofmex) Improved device configuration and network map
- (allofmex) security update
- (allofmex) brightness fix
- some fixes
- (allofmex) Visualize mesh newtwork map, "available" state, configuration requests
- (Apollon77) Update test framework
- (sonntam) Tint remote
- (arteck) OSRAM Lightify Switch Mini, rwl021 dimmer
- (asgothian) TRADFRI signal repeater, Innr SP 120, Xiaomi Gas detector
No support of node.js 4 any more
- (bluefox) Xiaomi Lock was added
- (nisiode) Some fixes
- (sonntam) Some fixes
- (arteck) Heiman SmokeSensor
- (asgothian, allofmex) Eurotronic support
- Groups and new Developer tab were added
- (arteck) Many new devices
- (allofmex) Developer tab
- (modmax) Reading attributes
- (kirovilya) Groups support
BREAKING CHANGES:
- (kirovilya) Rename state "isopen" to "opened".
- (kirovilya) Change brightness interval from 0..254 to 0..100
Other changes:
- (kirovilya) Fix for admin2
- (kirovilya) + Gledopto
- (kirovilya) + Mijia vibration sensor
- (kirovilya) Common state "link_quality"
- (arteck) + Philips LLC010, LLC011, LLC012, LTW001, LTW004, LTW010, LTW012, LTC001, LCT024
- (arteck) + Osram PAR 16 50 RGBW - LIGHTIFY
- (arteck) + Innr RS 128 T, RS 185 C
- (arteck) + DE FLS-PP3
- (arteck) + Ilux LEColorLight
- (kirovilya) Light state "transition_time" for brightness, color, colortemp
- (arteck) Fix 'is open' state
- (kirovilya, arteck) New models and devices
- (kirovilya) Support zigbee-shepherd-converters 4.*
- (kirovilya) Allow enter port without selector
- (arteck) Bugfix and new devices: Classic A60 W clear - LIGHTIFY and Surface Light TW
- (kirovilya) Occupancy timeout state for motion sensor
- (kirovilya) Serialport selector
- (kirovilya) Network map feature
- (kirovilya) Allow pairing through router
- (kirovilya) Change battery percent interval to 2700..3200
- (arteck) New devices: Hue LTW010, Osram Flex RGBW
- (kirovilya) Triple and quadruple clicks for WXKG11LM
- (kirovilya) isopen - magnet state, in contrast to contact
- (kirovilya) Option "Disable LED for cc2531"
- (kirovilya) More new devices from zigbee-shepherd-converters
- (kirovilya) Some layout fixes in admin
- (kirovilya) Fix battery for smoke sensor
- (arteck) New devices: Osram LED PAR16, Osram Smart+ plug, Philips Hue bulb
- (kirovilya) Turn on/off lights when change brightness > 0 and = 0
- (kirovilya) Allow backup/restore zigbee-database for js-controller 1.5.0
- (kirovilya) New device - Jiawen bulb
- (kirovilya) Allow remove device with setup key
- (from zigbee-shepherd-converters) Change battery percent interval to 3000-2700
- (kirovilya) Update states on adapter start (for restored shepherd.db)
- (kirovilya) Brightness - not percent - range 0..255
- (kirovilya) Configuration panID (zigbee network identifier)
- (kirovilya) Moved to ioBroker organization
- (kirovilya) Return runing on NodeJS 4.*
- (kirovilya) Public version
- (kirovilya) All refactored
- (kirovilya) First version
The MIT License (MIT)
Copyright (c) 2018-2020 Kirov Ilya [email protected]
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.