iobroker.zigbee 1.9.3 → 1.9.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +437 -430
  3. package/admin/adapter-settings.js +244 -244
  4. package/admin/admin.js +2991 -2991
  5. package/admin/i18n/de/translations.json +108 -108
  6. package/admin/i18n/en/translations.json +108 -108
  7. package/admin/i18n/es/translations.json +102 -102
  8. package/admin/i18n/fr/translations.json +108 -108
  9. package/admin/i18n/it/translations.json +102 -102
  10. package/admin/i18n/nl/translations.json +108 -108
  11. package/admin/i18n/pl/translations.json +108 -108
  12. package/admin/i18n/pt/translations.json +102 -102
  13. package/admin/i18n/ru/translations.json +108 -108
  14. package/admin/i18n/uk/translations.json +108 -108
  15. package/admin/i18n/zh-cn/translations.json +102 -102
  16. package/admin/img/philips_hue_lom001.png +0 -0
  17. package/admin/index.html +163 -163
  18. package/admin/index_m.html +1360 -1360
  19. package/admin/moment.min.js +1 -1
  20. package/admin/shuffle.min.js +2 -2
  21. package/admin/tab_m.html +1021 -1021
  22. package/admin/vis-network.min.css +1 -1
  23. package/admin/vis-network.min.js +26 -26
  24. package/admin/words.js +110 -110
  25. package/docs/de/basedocu.md +19 -19
  26. package/docs/de/readme.md +126 -126
  27. package/docs/en/readme.md +128 -128
  28. package/docs/flashing_via_arduino_(en).md +110 -110
  29. package/docs/ru/readme.md +28 -28
  30. package/docs/tutorial/groups-1.png +0 -0
  31. package/docs/tutorial/groups-2.png +0 -0
  32. package/docs/tutorial/tab-dev-1.png +0 -0
  33. package/io-package.json +27 -27
  34. package/lib/backup.js +171 -171
  35. package/lib/binding.js +319 -319
  36. package/lib/colors.js +465 -465
  37. package/lib/developer.js +151 -151
  38. package/lib/devicemgmt.js +374 -374
  39. package/lib/devices.js +3139 -3139
  40. package/lib/exclude.js +162 -162
  41. package/lib/groups.js +345 -345
  42. package/lib/json.js +59 -59
  43. package/lib/networkmap.js +55 -55
  44. package/lib/ota.js +198 -198
  45. package/lib/rgb.js +297 -297
  46. package/lib/seriallist.js +48 -48
  47. package/lib/states.js +6420 -6420
  48. package/lib/tools.js +54 -54
  49. package/lib/utils.js +165 -165
  50. package/lib/zbBaseExtension.js +36 -36
  51. package/lib/zbDelayedAction.js +144 -144
  52. package/lib/zbDeviceAvailability.js +319 -319
  53. package/lib/zbDeviceConfigure.js +148 -148
  54. package/lib/zbDeviceEvent.js +48 -48
  55. package/lib/zigbeecontroller.js +1014 -1014
  56. package/main.js +1 -1
  57. package/package.json +2 -2
  58. package/support/docgen.js +93 -93
@@ -1,19 +1,19 @@
1
- ![Logo](../../admin/zigbee.png)
2
- # ioBroker.zigbee
3
-
4
- ![Number of Installations](http://iobroker.live/badges/zigbee-installed.svg)
5
- ![Number of Installations](http://iobroker.live/badges/zigbee-stable.svg)
6
- [![NPM version](http://img.shields.io/npm/v/iobroker.zigbee.svg)](https://www.npmjs.com/package/iobroker.zigbee)
7
-
8
- [![Translation status](https://weblate.iobroker.net/widgets/adapters/-/zigbee/svg-badge.svg)](https://weblate.iobroker.net/engage/adapters/?utm_source=widget)
9
- [![Downloads](https://img.shields.io/npm/dm/iobroker.zigbee.svg)](https://www.npmjs.com/package/iobroker.zigbee)
10
-
11
- Der Zigbee Adapter dient zur Ansteuerung eines Zigbee Netzes unter zu Hilfe nahme eines direkt am ioBroker angeschlossenen Koordinators. Der Koordinator kann dabei über USB, Seriell oder über TCP/IP angeschlossen werden.
12
-
13
- Vor dem ersten Start des Adpaters sollten auf der Konfigurationsseite einige Einstellungen vorgenommen werden:
14
- - Com Anschlussnahme
15
- - Koordinator Typ
16
- - Netzwerk verschlüsselung über PanID und extPanID
17
- - Zigbee Kanal
18
-
19
- Nachdem diese Parameter eingestellt wurden kann der Adapter gestartet werden.
1
+ ![Logo](../../admin/zigbee.png)
2
+ # ioBroker.zigbee
3
+
4
+ ![Number of Installations](http://iobroker.live/badges/zigbee-installed.svg)
5
+ ![Number of Installations](http://iobroker.live/badges/zigbee-stable.svg)
6
+ [![NPM version](http://img.shields.io/npm/v/iobroker.zigbee.svg)](https://www.npmjs.com/package/iobroker.zigbee)
7
+
8
+ [![Translation status](https://weblate.iobroker.net/widgets/adapters/-/zigbee/svg-badge.svg)](https://weblate.iobroker.net/engage/adapters/?utm_source=widget)
9
+ [![Downloads](https://img.shields.io/npm/dm/iobroker.zigbee.svg)](https://www.npmjs.com/package/iobroker.zigbee)
10
+
11
+ Der Zigbee Adapter dient zur Ansteuerung eines Zigbee Netzes unter zu Hilfe nahme eines direkt am ioBroker angeschlossenen Koordinators. Der Koordinator kann dabei über USB, Seriell oder über TCP/IP angeschlossen werden.
12
+
13
+ Vor dem ersten Start des Adpaters sollten auf der Konfigurationsseite einige Einstellungen vorgenommen werden:
14
+ - Com Anschlussnahme
15
+ - Koordinator Typ
16
+ - Netzwerk verschlüsselung über PanID und extPanID
17
+ - Zigbee Kanal
18
+
19
+ Nachdem diese Parameter eingestellt wurden kann der Adapter gestartet werden.
package/docs/de/readme.md CHANGED
@@ -1,126 +1,126 @@
1
- # ioBroker Adapter für Zigbee-Geräte
2
- Mit Hilfe eines Koordinators für ZigBee-Netze, basierend auf dem Chip "Texas Instruments CC253x" (und anderen), wird ein eigenes ZigBee-Netz erschaffen, dem ZigBee-Geräte (Lampen, Dimmer, Sensoren, …) beitreten können. Dank der direkten Interaktion mit dem Koordinator erlaubt der ZigBee-Adapter die Steuerung der Geräte ohne jegliche Gateways/Bridges der Hersteller (Xiaomi/Tradfri/Hue). Zusätzliche Informationen zu ZigBee kann man hier [hier nachlesen (Englisch)](https://github.com/Koenkk/zigbee2mqtt/wiki/ZigBee-network).
3
-
4
- ## Die Hardware
5
- Für den Koordinator (siehe oben) ist eine zusätzliche Hardware erforderlich, welche die Umsetzung zwischen USB und ZigBee-Funksignalen ermöglicht. Es gibt 2 Gruppen:
6
-
7
- - Aufsteckmodul für den RaspberryPi (wird nicht mehr verwendet da veraltet und keine Zigbee 3.0 Unterstützung)<br>
8
- - USB-Stick ähnliche Hardware
9
-
10
- ![](img/CC2531.png)
11
- ![](img/sku_429478_2.png)
12
- ![](img/cc26x2r.PNG)
13
- ![](img/CC2591.png)
14
- ![](img/sonoff.png)
15
-
16
-
17
- Bei manchen dieser Geräte ist zum Betrieb das Aufspielen einer geeigneten Firmware erforderlich:
18
- Bitte schaut zuerst wie die entsprechenden Koordinatoren geflasht werden müssen. Die Firmware ist [hier](https://github.com/Koenkk/Z-Stack-firmware) zu fimden.
19
-
20
- Zunehmend beliebt kommt der "Sonoff ZIGBEE 3.0 USB-STICK CC2652P" zum Einsatz:
21
- ![](img/sonoff.png)
22
-
23
- - Flashen einer passenden Firmware nicht zwingend erforderlich (Ware wird bereits mit geeigneter Firmware ausgeliefert) <br>
24
- - Unterstützt den neueren ZigBee 3.0 Standard
25
-
26
- Die mit dem ZigBee-Netz verbundenen Geräte übermitteln dem Koordinator ihren Zustand und benachrichtigen über Ereignisse (Knopfdruck, Bewegungserkennung, Temperaturänderung, …). Diese Infos werden im Adapter unter den jeweiligen ioBroker-Objekten angezeigt und können so in ioBroker weiterverarbeitet werden. Außerdem ist es möglich Kommandos an das ZigBee-Gerät zu senden (Zustandsänderung Steckdosen und Lampen, Farb- und Helligkeitseinstellungen, …).
27
-
28
-
29
- ## Die Software
30
-
31
- Die Software wird unterteilt in "Konverter" und "Adapter".
32
-
33
- ![](img/software1.jpg)
34
-
35
- - Konverter <br>
36
- Der Konverter gliedert sich auf in zwei Teile: <br>
37
- a) Allgemeine Bereitstellung der Daten aus den ZigBee-Funksignalen. Dieser [Softwareteil](https://github.com/Koenkk/zigbee-herdsman) wird für alle ZigBee-Geräte verwendet. <br>
38
- b) Gerätespezifische [Aufbereitung](https://github.com/Koenkk/zigbee-herdsman-converters) der Daten auf eine definierte Schnittstelle zum Adapter. <br>
39
-
40
- - Adapter <br>
41
- Dieser Softwareteil ist die Anbindung des Konverters an ioBroker. Der [Adapter](https://github.com/ioBroker/ioBroker.zigbee) beinhaltet die grafische Darstellung zur Verwaltung der ZigBee-Geräte, sowie die Erzeugung der ioBroker-Objekte zur Steuerung der ZigBee-Geräte.
42
-
43
- ## Installation
44
- 1. Koordinator Hardware am RaspberryPi anstecken.<br>
45
- 2. Über z.B. PuTTY mit RaspberryPi verbinden.<br>
46
- 3. Eventuell vorhandene ZigBee-Backupdatei löschen. Andernfalls wird der ZigBee-Adapter in ioBroker nicht grün und im ioBroker Log steht, dass der Adapter falsch konfiguriert ist.<br>
47
- sudo rm /opt/iobroker/iobroker-data/zigbee_0/nvbackup.json<br>
48
- 4. Pfad des Koordinators ermitteln:
49
- `ls -la /dev/serial/by-id/`
50
- ![](img/Bild2.png)
51
- 5. ioBroker -> ZigBee-Adapter installieren, hier als Beispiel die Version 1.8.10 <br> ![](img/Bild3.png) <br> Hiermit werden alle erforderlichen Softwareteile (Konverter und Adapter) installiert.
52
- 6. Adapter öffnen -> ![](img/Bild4.png) -> Zuvor ermittelten Pfad des Koordinators mit dem Zusatz /dev/serial/by-id/ eintragen:![](img/Bild5.jpg) <br> Es ist zu achten dass am Ende kein leer Zeichen mitgenommen wird
53
- 7. Netzwerk-ID und Pan ID vergeben zur Unterscheidung von anderen ZigBee-Netzwerken in Funkreichweite, z.B. <br>
54
- ![](img/Bild6.png) ![](img/Bild7.png) <br> ![](img/Bild8.png) ![](img/Bild9.png)
55
- 8. Prüfen ob der Adapter in ioBroker grün wird. Sollzustand: <br> ![](img/Bild10.png) <br> Andernfalls ioBroker Log lesen und Fehlerursache suchen, im Forum stehen viele Lösungsansätze.
56
-
57
- ## Pairing
58
- Jedes ZigBee-Gerät (Schalter, Lampe, Sensor, …) muss mit dem Koordinator gekoppelt werden (Pairing): <br>
59
-
60
- - ZigBee-Gerät:
61
- Jedes **ZigBee-Gerät** kann nur mit genau 1 ZigBee-Netzwerk verbunden sein. Hat das ZigBee-Gerät noch Pairing-Informationen zu einem fremden Koordinator (z.B. Philips Hue Bridge) gespeichert, dann muss es von diesem ZigBee-Netzwerk zuerst entkoppelt werden. Dieses Entkoppeln vom alten ZigBee-Netzwerk erfolgt vorzugsweise über die Bedienoberfläche des alten ZigBee-Netzwerkes (z.B. Philips Hue App). Alternativ kann man das ZigBee-Gerät auf Werkseinstellungen zurücksetzen. <br>
62
- Um ein ZigBee-Gerät nun in den Pairing-Mode zu versetzen, gibt es typischer Weise folgende Möglichkeiten: <br>
63
- 1. ZigBee-Gerät von einem ZigBee-Netzwerk entkoppeln
64
- 2. Pairing-Button am ZigBee-Gerät drücken
65
- 3. Versorgungsspannung des ZigBee-Gerätes aus- und dann wieder einschalten
66
-
67
- Danach ist das ZigBee-Gerät für typischer Weise 60 Sekunden im Pairing-Mode. <br>
68
- Ähnlich wie die Vorgehensweise zum Rücksetzen auf Werkseinstellungen ist auch das Aktivieren des Pairing-Mode abhängig vom jeweiligen Gerätetyp (ggf. Bedienungsanleitung des ZigBee-Gerätes lesen). <br>
69
-
70
- - Koordinator:
71
- Grünen Knopf drücken, um den Koordinator für 60 Sekunden (oder die in den Adaptereinstellungen gewählte Zeit) in den Pairing-Mode zu versetzen. <br>
72
- ![](img/Bild12.png)
73
-
74
- - Warten bis im Dialog "New device joined" erscheint:
75
- ![](img/Bild13.png)
76
-
77
- - Pairing überprüfen:
78
- Das zu koppelnde Gerät muss vom ioBroker ZigBee-Adapter unterstützt werden. Im Gutfall wird im ZigBee-Adapter ein neues Gerät angezeigt (z.B. Philips Light Stripe) und entsprechende ioBroker-Objekte angelegt:
79
- ![](img/Bild14.png) ![](img/Bild15.png)
80
-
81
- - Im Schlechtfall wird das ZigBee-Gerät aktuell noch nicht unterstützt. Im nächsten Abschnitt ist beschrieben, was zu tun ist, um dieses ZigBee-Gerät dennoch nutzen zu können.
82
-
83
- ## Pairing von bisher unbekannten ZigBee-Geräten
84
-
85
- Bei bisher unbekannten ZigBee-Geräten erscheint beim Pairing der ZigBee-Name des ZigBee-Gerätes (z.B. HOMA1001) mit dem Zusatz "not described in statesMapping" <br>
86
- ![](img/Bild28.png) <br>
87
- ![](img/Bild16.png) <br>
88
-
89
- Durch Drehen dieser Kachel erhält man Detailinformationen zu dem ZigBee-Gerät: <br>
90
- ![](img/Bild17.png) ![](img/Bild18.png) <br>
91
-
92
- Nach einer Registrierung bei [github.com](https://github.com/ioBroker/ioBroker.zigbee/issues) kann über einen "Issue" das fehlende ZigBee-Gerät gemeldet werden:
93
-
94
- ![](img/Bild19.png) <br>
95
-
96
- • Detailinformationen der Kachel (siehe oben) in den Issue einfügen, erstelle eine kurze Dokumentation (vorzugweise auf Englisch) und absenden. Ein Entwickler wird sich daraufhin über den Issue melden.
97
-
98
- Nach Anpassung der relevanten Dateien muss der ZigBee-Adapter neugestartet und dann das ZigBee-Gerät vom Koordinator entkoppelt werden (unpair):
99
- ![](img/Bild20.png) <br>
100
- Danach kann das Pairing wiederholt werden. Sollzustand nach dem Pairing: <br>
101
- ![](img/Bild21.png) <br>
102
-
103
- Bei manchen ZigBee-Geräten ist es erforderlich alle Softwareschnittstellen ("exposes") des neuen ZigBee-Gerätes in den ioBroker-Objekten anzuzeigen, um alle Funktionen des ZigBee-Gerätes nutzen zu können. In solchen Fällen muss das neue ZigBee-Gerät in die "Ausschliessen"-Gruppe aufgenommen werden.
104
-
105
- ![](img/Bild22.png) <br>
106
-
107
- ![](img/Bild23.png) -> ![](img/Bild24.png) -> ![](img/Bild25.png) -> ZigBee-Gerät (z.B. HOMA1001) auswählen -> ![](img/Bild26.png) <br>
108
- Nach einem Neustart des ZigBee-Adapters sollte das neue ZigBee-Gerät nun uneingeschränkt funktionieren.
109
-
110
- ## Symbole im ZigBee-Adapter
111
-
112
- | icon | Beschreibung |
113
- | ------------- | ------------- |
114
- | ![](img/Bild30.png) | **State Cleanup** <br> Löschen von ungültigen ioBroker-Objekten, welche durch den Vorgang "Ausschliessen" entstehen können. |
115
- | ![](img/Bild31.png) | **Auf Firmware Updates überprüfen** <br> Firmware der ZigBee-Geräte (z.B. Philips Hue Lampen) aktualisieren |
116
- | ![](img/Bild32.png) | **Add Group** <br>Über diese Funktion können mehrere ZigBee-Geräte zu einer logischen Gruppe zusammengefasst werden und dann über ein ioBroker-Objekt gemeinsam angesteuert werden, z.B. brightness=20 dann wird bei allen ZigBee-Geräten der Gruppe brightness auf 20 gesetzt. |
117
- | ![](img/Bild33.png) | **Touchlink zurücksetzen und koppeln** <br> Touchlink ist eine Funktion von ZigBee, die es physisch nahe beieinander liegenden Geräten ermöglicht, miteinander zu kommunizieren, ohne sich im selben Netzwerk zu befinden. Diese Funktion wird nicht von allen Geräten unterstützt. Um ein ZigBee-Gerät über Touchlink auf Werkseinstellungen zurückzusetzen, bringe das Gerät in die Nähe (< 10 cm) des ZigBee-Koordinators und drücke dann das grüne Symbol. |
118
- | ![](img/Bild34.png) | **Pairing mit QR Code** <br>Bei manchen ZigBee-Geräten erfolgt das Pairing mittels QR-Code. |
119
- | ![](img/Bild35.png) | **Pairing** <br> Anlernvorgang neuer ZigBee-Geräte (Pairing) starten. |
120
- | ![](img/Bild36.png) | Zeit seit mit diesem ZigBee-Gerät <br> zuletzt ein Datenaustausch stattgefunden hat. |
121
- | ![](img/Bild37.png) | Stärke des ZigBee-Funksignals <br> an diesem ZigBee-Gerät (<10 schlecht, <50 mittel, >50 gut).ZigBee ist ein Funk-Mesh-Netzwerk (mesh = vermascht). Die meisten netzbetriebenen ZigBee-Geräte (z.B. Philips Hue Lampe) können als ZigBee-Router wirken, also als Funkknotenpunkt. ZigBee-Geräte müssen somit nicht zwingend eine direkte Funkverbindung zum Koordinator aufbauen, sondern können stattdessen jeden Router im Netzwerk zur Funkverbindung nutzen. Mit jedem ZigBee-Router wird somit die Funkreichweite des Netzwerkes erweitert. Alle ZigBee-Geräte prüfen regelmäßig, ob es eine bessere Funkroute gibt und stellen sich automatisch um. Dieser Vorgang kann jedoch etliche Minuten dauern.|
122
-
123
- ## Zusätzliche Informationen
124
- Es gibt noch ein [Freundschaftsprojekt](https://www.zigbee2mqtt.io/) mit gleichen Funktionen und gleicher Technologie, welcher mit denselben Geräten über ein MQTT Protokoll kommuniziert. Wenn irgendwelche Verbesserungen oder neu unterstütze Geräte im Projekt ZigBee2MQTT eingefügt werden, können jene auch in dieses Projekt hinzugefügt werden. Solltet Ihr Unterschiede merken, schreibt bitte ein Issue und wir kümmern uns darum.
125
- Weitere Themen zu diesem Adapter sind auch im zugehörigen [Wiki](https://github.com/ioBroker/ioBroker.zigbee/wiki) dokumentiert.
126
-
1
+ # ioBroker Adapter für Zigbee-Geräte
2
+ Mit Hilfe eines Koordinators für ZigBee-Netze, basierend auf dem Chip "Texas Instruments CC253x" (und anderen), wird ein eigenes ZigBee-Netz erschaffen, dem ZigBee-Geräte (Lampen, Dimmer, Sensoren, …) beitreten können. Dank der direkten Interaktion mit dem Koordinator erlaubt der ZigBee-Adapter die Steuerung der Geräte ohne jegliche Gateways/Bridges der Hersteller (Xiaomi/Tradfri/Hue). Zusätzliche Informationen zu ZigBee kann man hier [hier nachlesen (Englisch)](https://github.com/Koenkk/zigbee2mqtt/wiki/ZigBee-network).
3
+
4
+ ## Die Hardware
5
+ Für den Koordinator (siehe oben) ist eine zusätzliche Hardware erforderlich, welche die Umsetzung zwischen USB und ZigBee-Funksignalen ermöglicht. Es gibt 2 Gruppen:
6
+
7
+ - Aufsteckmodul für den RaspberryPi (wird nicht mehr verwendet da veraltet und keine Zigbee 3.0 Unterstützung)<br>
8
+ - USB-Stick ähnliche Hardware
9
+
10
+ ![](img/CC2531.png)
11
+ ![](img/sku_429478_2.png)
12
+ ![](img/cc26x2r.PNG)
13
+ ![](img/CC2591.png)
14
+ ![](img/sonoff.png)
15
+
16
+
17
+ Bei manchen dieser Geräte ist zum Betrieb das Aufspielen einer geeigneten Firmware erforderlich:
18
+ Bitte schaut zuerst wie die entsprechenden Koordinatoren geflasht werden müssen. Die Firmware ist [hier](https://github.com/Koenkk/Z-Stack-firmware) zu fimden.
19
+
20
+ Zunehmend beliebt kommt der "Sonoff ZIGBEE 3.0 USB-STICK CC2652P" zum Einsatz:
21
+ ![](img/sonoff.png)
22
+
23
+ - Flashen einer passenden Firmware nicht zwingend erforderlich (Ware wird bereits mit geeigneter Firmware ausgeliefert) <br>
24
+ - Unterstützt den neueren ZigBee 3.0 Standard
25
+
26
+ Die mit dem ZigBee-Netz verbundenen Geräte übermitteln dem Koordinator ihren Zustand und benachrichtigen über Ereignisse (Knopfdruck, Bewegungserkennung, Temperaturänderung, …). Diese Infos werden im Adapter unter den jeweiligen ioBroker-Objekten angezeigt und können so in ioBroker weiterverarbeitet werden. Außerdem ist es möglich Kommandos an das ZigBee-Gerät zu senden (Zustandsänderung Steckdosen und Lampen, Farb- und Helligkeitseinstellungen, …).
27
+
28
+
29
+ ## Die Software
30
+
31
+ Die Software wird unterteilt in "Konverter" und "Adapter".
32
+
33
+ ![](img/software1.jpg)
34
+
35
+ - Konverter <br>
36
+ Der Konverter gliedert sich auf in zwei Teile: <br>
37
+ a) Allgemeine Bereitstellung der Daten aus den ZigBee-Funksignalen. Dieser [Softwareteil](https://github.com/Koenkk/zigbee-herdsman) wird für alle ZigBee-Geräte verwendet. <br>
38
+ b) Gerätespezifische [Aufbereitung](https://github.com/Koenkk/zigbee-herdsman-converters) der Daten auf eine definierte Schnittstelle zum Adapter. <br>
39
+
40
+ - Adapter <br>
41
+ Dieser Softwareteil ist die Anbindung des Konverters an ioBroker. Der [Adapter](https://github.com/ioBroker/ioBroker.zigbee) beinhaltet die grafische Darstellung zur Verwaltung der ZigBee-Geräte, sowie die Erzeugung der ioBroker-Objekte zur Steuerung der ZigBee-Geräte.
42
+
43
+ ## Installation
44
+ 1. Koordinator Hardware am RaspberryPi anstecken.<br>
45
+ 2. Über z.B. PuTTY mit RaspberryPi verbinden.<br>
46
+ 3. Eventuell vorhandene ZigBee-Backupdatei löschen. Andernfalls wird der ZigBee-Adapter in ioBroker nicht grün und im ioBroker Log steht, dass der Adapter falsch konfiguriert ist.<br>
47
+ sudo rm /opt/iobroker/iobroker-data/zigbee_0/nvbackup.json<br>
48
+ 4. Pfad des Koordinators ermitteln:
49
+ `ls -la /dev/serial/by-id/`
50
+ ![](img/Bild2.png)
51
+ 5. ioBroker -> ZigBee-Adapter installieren, hier als Beispiel die Version 1.8.10 <br> ![](img/Bild3.png) <br> Hiermit werden alle erforderlichen Softwareteile (Konverter und Adapter) installiert.
52
+ 6. Adapter öffnen -> ![](img/Bild4.png) -> Zuvor ermittelten Pfad des Koordinators mit dem Zusatz /dev/serial/by-id/ eintragen:![](img/Bild5.jpg) <br> Es ist zu achten dass am Ende kein leer Zeichen mitgenommen wird
53
+ 7. Netzwerk-ID und Pan ID vergeben zur Unterscheidung von anderen ZigBee-Netzwerken in Funkreichweite, z.B. <br>
54
+ ![](img/Bild6.png) ![](img/Bild7.png) <br> ![](img/Bild8.png) ![](img/Bild9.png)
55
+ 8. Prüfen ob der Adapter in ioBroker grün wird. Sollzustand: <br> ![](img/Bild10.png) <br> Andernfalls ioBroker Log lesen und Fehlerursache suchen, im Forum stehen viele Lösungsansätze.
56
+
57
+ ## Pairing
58
+ Jedes ZigBee-Gerät (Schalter, Lampe, Sensor, …) muss mit dem Koordinator gekoppelt werden (Pairing): <br>
59
+
60
+ - ZigBee-Gerät:
61
+ Jedes **ZigBee-Gerät** kann nur mit genau 1 ZigBee-Netzwerk verbunden sein. Hat das ZigBee-Gerät noch Pairing-Informationen zu einem fremden Koordinator (z.B. Philips Hue Bridge) gespeichert, dann muss es von diesem ZigBee-Netzwerk zuerst entkoppelt werden. Dieses Entkoppeln vom alten ZigBee-Netzwerk erfolgt vorzugsweise über die Bedienoberfläche des alten ZigBee-Netzwerkes (z.B. Philips Hue App). Alternativ kann man das ZigBee-Gerät auf Werkseinstellungen zurücksetzen. <br>
62
+ Um ein ZigBee-Gerät nun in den Pairing-Mode zu versetzen, gibt es typischer Weise folgende Möglichkeiten: <br>
63
+ 1. ZigBee-Gerät von einem ZigBee-Netzwerk entkoppeln
64
+ 2. Pairing-Button am ZigBee-Gerät drücken
65
+ 3. Versorgungsspannung des ZigBee-Gerätes aus- und dann wieder einschalten
66
+
67
+ Danach ist das ZigBee-Gerät für typischer Weise 60 Sekunden im Pairing-Mode. <br>
68
+ Ähnlich wie die Vorgehensweise zum Rücksetzen auf Werkseinstellungen ist auch das Aktivieren des Pairing-Mode abhängig vom jeweiligen Gerätetyp (ggf. Bedienungsanleitung des ZigBee-Gerätes lesen). <br>
69
+
70
+ - Koordinator:
71
+ Grünen Knopf drücken, um den Koordinator für 60 Sekunden (oder die in den Adaptereinstellungen gewählte Zeit) in den Pairing-Mode zu versetzen. <br>
72
+ ![](img/Bild12.png)
73
+
74
+ - Warten bis im Dialog "New device joined" erscheint:
75
+ ![](img/Bild13.png)
76
+
77
+ - Pairing überprüfen:
78
+ Das zu koppelnde Gerät muss vom ioBroker ZigBee-Adapter unterstützt werden. Im Gutfall wird im ZigBee-Adapter ein neues Gerät angezeigt (z.B. Philips Light Stripe) und entsprechende ioBroker-Objekte angelegt:
79
+ ![](img/Bild14.png) ![](img/Bild15.png)
80
+
81
+ - Im Schlechtfall wird das ZigBee-Gerät aktuell noch nicht unterstützt. Im nächsten Abschnitt ist beschrieben, was zu tun ist, um dieses ZigBee-Gerät dennoch nutzen zu können.
82
+
83
+ ## Pairing von bisher unbekannten ZigBee-Geräten
84
+
85
+ Bei bisher unbekannten ZigBee-Geräten erscheint beim Pairing der ZigBee-Name des ZigBee-Gerätes (z.B. HOMA1001) mit dem Zusatz "not described in statesMapping" <br>
86
+ ![](img/Bild28.png) <br>
87
+ ![](img/Bild16.png) <br>
88
+
89
+ Durch Drehen dieser Kachel erhält man Detailinformationen zu dem ZigBee-Gerät: <br>
90
+ ![](img/Bild17.png) ![](img/Bild18.png) <br>
91
+
92
+ Nach einer Registrierung bei [github.com](https://github.com/ioBroker/ioBroker.zigbee/issues) kann über einen "Issue" das fehlende ZigBee-Gerät gemeldet werden:
93
+
94
+ ![](img/Bild19.png) <br>
95
+
96
+ • Detailinformationen der Kachel (siehe oben) in den Issue einfügen, erstelle eine kurze Dokumentation (vorzugweise auf Englisch) und absenden. Ein Entwickler wird sich daraufhin über den Issue melden.
97
+
98
+ Nach Anpassung der relevanten Dateien muss der ZigBee-Adapter neugestartet und dann das ZigBee-Gerät vom Koordinator entkoppelt werden (unpair):
99
+ ![](img/Bild20.png) <br>
100
+ Danach kann das Pairing wiederholt werden. Sollzustand nach dem Pairing: <br>
101
+ ![](img/Bild21.png) <br>
102
+
103
+ Bei manchen ZigBee-Geräten ist es erforderlich alle Softwareschnittstellen ("exposes") des neuen ZigBee-Gerätes in den ioBroker-Objekten anzuzeigen, um alle Funktionen des ZigBee-Gerätes nutzen zu können. In solchen Fällen muss das neue ZigBee-Gerät in die "Ausschliessen"-Gruppe aufgenommen werden.
104
+
105
+ ![](img/Bild22.png) <br>
106
+
107
+ ![](img/Bild23.png) -> ![](img/Bild24.png) -> ![](img/Bild25.png) -> ZigBee-Gerät (z.B. HOMA1001) auswählen -> ![](img/Bild26.png) <br>
108
+ Nach einem Neustart des ZigBee-Adapters sollte das neue ZigBee-Gerät nun uneingeschränkt funktionieren.
109
+
110
+ ## Symbole im ZigBee-Adapter
111
+
112
+ | icon | Beschreibung |
113
+ | ------------- | ------------- |
114
+ | ![](img/Bild30.png) | **State Cleanup** <br> Löschen von ungültigen ioBroker-Objekten, welche durch den Vorgang "Ausschliessen" entstehen können. |
115
+ | ![](img/Bild31.png) | **Auf Firmware Updates überprüfen** <br> Firmware der ZigBee-Geräte (z.B. Philips Hue Lampen) aktualisieren |
116
+ | ![](img/Bild32.png) | **Add Group** <br>Über diese Funktion können mehrere ZigBee-Geräte zu einer logischen Gruppe zusammengefasst werden und dann über ein ioBroker-Objekt gemeinsam angesteuert werden, z.B. brightness=20 dann wird bei allen ZigBee-Geräten der Gruppe brightness auf 20 gesetzt. |
117
+ | ![](img/Bild33.png) | **Touchlink zurücksetzen und koppeln** <br> Touchlink ist eine Funktion von ZigBee, die es physisch nahe beieinander liegenden Geräten ermöglicht, miteinander zu kommunizieren, ohne sich im selben Netzwerk zu befinden. Diese Funktion wird nicht von allen Geräten unterstützt. Um ein ZigBee-Gerät über Touchlink auf Werkseinstellungen zurückzusetzen, bringe das Gerät in die Nähe (< 10 cm) des ZigBee-Koordinators und drücke dann das grüne Symbol. |
118
+ | ![](img/Bild34.png) | **Pairing mit QR Code** <br>Bei manchen ZigBee-Geräten erfolgt das Pairing mittels QR-Code. |
119
+ | ![](img/Bild35.png) | **Pairing** <br> Anlernvorgang neuer ZigBee-Geräte (Pairing) starten. |
120
+ | ![](img/Bild36.png) | Zeit seit mit diesem ZigBee-Gerät <br> zuletzt ein Datenaustausch stattgefunden hat. |
121
+ | ![](img/Bild37.png) | Stärke des ZigBee-Funksignals <br> an diesem ZigBee-Gerät (<10 schlecht, <50 mittel, >50 gut).ZigBee ist ein Funk-Mesh-Netzwerk (mesh = vermascht). Die meisten netzbetriebenen ZigBee-Geräte (z.B. Philips Hue Lampe) können als ZigBee-Router wirken, also als Funkknotenpunkt. ZigBee-Geräte müssen somit nicht zwingend eine direkte Funkverbindung zum Koordinator aufbauen, sondern können stattdessen jeden Router im Netzwerk zur Funkverbindung nutzen. Mit jedem ZigBee-Router wird somit die Funkreichweite des Netzwerkes erweitert. Alle ZigBee-Geräte prüfen regelmäßig, ob es eine bessere Funkroute gibt und stellen sich automatisch um. Dieser Vorgang kann jedoch etliche Minuten dauern.|
122
+
123
+ ## Zusätzliche Informationen
124
+ Es gibt noch ein [Freundschaftsprojekt](https://www.zigbee2mqtt.io/) mit gleichen Funktionen und gleicher Technologie, welcher mit denselben Geräten über ein MQTT Protokoll kommuniziert. Wenn irgendwelche Verbesserungen oder neu unterstütze Geräte im Projekt ZigBee2MQTT eingefügt werden, können jene auch in dieses Projekt hinzugefügt werden. Solltet Ihr Unterschiede merken, schreibt bitte ein Issue und wir kümmern uns darum.
125
+ Weitere Themen zu diesem Adapter sind auch im zugehörigen [Wiki](https://github.com/ioBroker/ioBroker.zigbee/wiki) dokumentiert.
126
+
package/docs/en/readme.md CHANGED
@@ -1,128 +1,128 @@
1
- # ioBroker adapter for ZigBee devices
2
- With the help of a coordinator, based on the chip "Texas Instruments CC253x" (and others), a ZigBee network is created for ZigBee devices (bulbs, dimmers, sensors, …) to join. Thanks to the direct interaction with the coordinator, the ZigBee adapter allows to control the devices without any manufacturer gateways/bridges (Xiaomi/Tradfri/Hue). Additional information about ZigBee can be found [here](https://github.com/Koenkk/zigbee2mqtt/wiki/ZigBee-network).
3
-
4
- ## Hardware
5
- Additional hardware is required for the coordinator (see above), which enables conversion between USB and ZigBee radio signals. There are 2 groups:
6
-
7
- • Attachment module for the RaspberryPi (its old and not supported Zigbee V3)<br>
8
- • USB stick like hardware
9
-
10
- ![](../de/img/CC2531.png)
11
- ![](../de/img/sku_429478_2.png)
12
- ![](../de/img/cc26x2r.PNG)
13
- ![](../de/img/CC2591.png)
14
- ![](../de/img/sonoff.png)
15
-
16
-
17
- Some of these devices require the installation of a suitable firmware for operation:
18
- The required flasher/programmer and the process of preparation are described [here](https://github.com/Koenkk/zigbee2mqtt/wiki/Getting-started) or [here (Russian)](https://github.com/kirovilya/ioBroker.zigbee/wiki/%D0%9F%D1%80%D0%BE%D1%88%D0%B8%D0%B2%D0%BA%D0%B0).
19
-
20
- The "Sonoff ZIGBEE 3.0 USB STICK CC2652P" is becoming increasingly popular:
21
- ![](../de/img/sonoff.png)
22
-
23
- - Flashing of a suitable firmware is not absolutely necessary (hardware is already delivered with suitable firmware)
24
- - Supports the newer ZigBee 3.0 standard
25
-
26
- The devices connected to the ZigBee network transmit their status to the coordinator and notify it of events (button press, motion detection, temperature change, ...). This information is displayed in the adapter under the respective ioBroker objects and can thus be further processed in ioBroker. It is also possible to send commands to the ZigBee device (change of status of sockets and lamps, color and brightness settings, ...).
27
-
28
-
29
- ## Software
30
-
31
- The software is divided into "converter" and "adapter".
32
-
33
- ![](img/software1.jpg)
34
-
35
- - Converter
36
- The converter is divided into two parts: <br>
37
- a) General provision of the data from the ZigBee radio signals. This [software part](https://github.com/Koenkk/zigbee-herdsman) is used for all ZigBee devices. <br>
38
- b) Device-specific [processing](https://github.com/Koenkk/zigbee-herdsman-converters) of the data to a defined interface to the adapter.
39
- - Adapter<br>
40
- This software part is the connection of the converter to ioBroker. The [adapter](https://github.com/ioBroker/ioBroker.zigbee) includes the graphical user interface for managing the ZigBee devices and the creation of ioBroker objects for controlling the ZigBee devices.
41
-
42
-
43
- ## Installation
44
- 1. Connect the coordinator hardware to the RaspberryPi.<br>
45
- 2. Connect to RaspberryPi e.g. via PuTTY.<br>
46
- 3. Delete any existing ZigBee backup file. Otherwise the ZigBee adapter will not turn green in ioBroker and the ioBroker log will state that the adapter is misconfigured <br>
47
- 4. Find out the path of the coordinator :
48
- `ls -la /dev/serial/by-id/`
49
- ![](../de/img/Bild2.png)
50
- 5. ioBroker -> install ZigBee adapter, here Version 1.8.10 <br> ![](../de/img/Bild3.png) <br> This will install all the necessary software parts (converter and adapter).
51
- 6. Open adapter -> ![](img/Bild4.png) -> Enter the previously determined path of the coordinator with the addition /dev/serial/by-id/:![](../de/img/Bild5.jpg) <br> There must be NO spaces at the end of the path.
52
- 7. Configure network ID and Pan ID to differentiate from other ZigBee networks within radio range, e.g. <br>
53
- ![](../de/img/Bild6.png) ![](../de/img/Bild7.png) <br> ![](../de/img/Bild8.png) ![](img/Bild9.png)
54
- 8. Check if the adapter turns green in ioBroker. Target state: <br> ![](../de/img/Bild10.png) <br> Otherwise read the ioBroker log and look for the cause of the error, check also our Forum.
55
-
56
- ## Pairing
57
- Each ZigBee device (switch, bulb, sensor, ...) must be paired with the coordinator (pairing): <br>
58
-
59
- - ZigBee device:
60
- Each ZigBee device can only be connected to exactly 1 ZigBee network. If the ZigBee device still has pairing information saved for a different coordinator (e.g. Philips Hue Bridge), then it must first be decoupled from this ZigBee network. This decoupling from the old ZigBee network preferably is done via the user interface of the old ZigBee network (z.B. Philips Hue App). Alternatively, you can reset the ZigBee device to factory settings. <br>
61
- There are typically the following options for putting a ZigBee device into pairing mode <br>
62
- 1. Unpair a ZigBee device from a ZigBee network
63
- 2. Press the pairing button on the ZigBee device
64
- 3. Switch the supply voltage of the ZigBee device off and then on again
65
-
66
-
67
- The ZigBee device is then in pairing mode for typically 60 seconds. Similar to the procedure for resetting to factory settings, activating the pairing mode also depends on the respective device type (if necessary, read the operating instructions of the ZigBee device).
68
-
69
- - Coordinator:
70
- Press the green button to put the coordinator into pairing mode for 60 seconds. <br>
71
- ![](../de/img/Bild12.png)
72
-
73
- - Wait until "New device joined" appears in the dialog: <br>
74
- ![](img/Bild13.png)
75
-
76
- - Check Pairing:
77
- The device to be paired must be supported by the ioBroker ZigBee adapter. In the best case, a new device is displayed in the ZigBee adapter (e.g. Philips Light Stripe) and corresponding ioBroker objects are created:
78
- ![](../de/img/Bild14.png) ![](../de/img/Bild15.png)
79
-
80
- - In the worst case, the ZigBee device is not currently supported. The next section describes what needs to be done to use this ZigBee device anyhow.
81
-
82
- ## Pairing of unknown ZigBee devices so far
83
-
84
- With unknown ZigBee devices so far, the ZigBee name of the ZigBee device (e.g. HOMA1001) appears during pairing with the addition "not described in statesMapping" <br>
85
- ![](../de/img/Bild28.png) <br>
86
- ![](../de/img/Bild16.png) <br>
87
-
88
- Turning this tile gives you detailed information about the ZigBee device: <br>
89
- ![](../de/img/Bild17.png) ![](img/Bild18.png) <br>
90
-
91
- After registering at [github.com](https://github.com/ioBroker/ioBroker.zigbee/issues) the missing ZigBee device must be reported via an "Issue":
92
-
93
- ![](../de/img/Bild19.png) <br>
94
-
95
- - Insert detailed information of the tile (see above) into the issue, create a short documentation (preferably in English) and send it. A developer will then respond via the issue.
96
-
97
- After modifying the relevant files, the ZigBee adapter must be restarted and the ZigBee device must be unpaired from the coordinator:
98
- ![](../de/img/Bild20.png) <br>
99
- After that, the pairing can be repeated. Target state after pairing: <br>
100
- ![](../de/img/Bild21.png) <br>
101
-
102
- With some ZigBee devices it is necessary to display all software interfaces ("exposes") of the new ZigBee device in the ioBroker objects in order to be able to use all the functions of this ZigBee device. In such cases, the new ZigBee device must be included in the "Exclude" group.
103
-
104
- ![](../de/img/Bild22.png) <br>
105
-
106
- ![](img/Bild23.png) -> ![](../de/img/Bild24.png) -> ![](img/Bild25.png) -> select ZigBee device (e.g. HOMA1001) -> ![](img/Bild26.png) <br>
107
- After restarting the ZigBee adapter, the new ZigBee device should now work without restrictions.
108
-
109
-
110
-
111
- ## Symbols within the ZigBee adapter
112
-
113
- | icon | Beschreibung |
114
- | ------------- | ------------- |
115
- | ![](../de/img/Bild30.png) | **State Cleanup** Deletion of invalid ioBroker objects, which can result from the "Exclude" process. |
116
- | ![](../de/img/Bild31.png) | **Check firmware updates** Update the firmware of the ZigBee devices (e.g. Philips Hue bulbs). |
117
- | ![](../de/img/Bild32.png) | **Add Group** Using this function, ZigBee devices can be combined into a logical group and then be controlled together via one ioBroker object, e.g. brightness=20 sets the brightness of all ZigBee devices in the group to 20. |
118
- | ![](../de/img/Bild33.png) | **Touchlink reset and pairing** Touchlink is a ZigBee function that allows devices that are physically close to each other to communicate with each other without being in the same network. Not all devices support this feature.To factory reset a ZigBee device via Touchlink, bring the device close (< 10 cm) to the ZigBee coordinator and then press this green icon. |
119
- | ![](../de/img/Bild34.png) | **Pairing with QR code** Bei With some ZigBee devices, pairing is done using a QR code. |
120
- | ![](../de/img/Bild35.png) | **Let's start Pairing** Start the pairing process for new ZigBee devices. |
121
- | ![](../de/img/Bild36.png) | Time since data was last exchanged with this ZigBee device. |
122
- | ![](../de/img/Bild37.png) | Strength of the ZigBee radio signal at this ZigBee device (<10 poor, <50 medium, >50 good).ZigBee is a wireless mesh network. Most mains-operated ZigBee devices (e.g. Philips Hue bulbs) can act as a ZigBee router, this means as a radio node. ZigBee devices therefore do not necessarily have to establish a direct wireless connection to the coordinator, but can instead use any router in the network for the wireless connection. The radio range of the network is thus extended with each ZigBee router. All ZigBee devices regularly check whether there is a better radio route and switch over automatically. However, this process can take several minutes.|
123
-
124
- ## Additional information
125
- There is [another](https://www.zigbee2mqtt.io/) with the same functions and the same technology, which communicates with the same devices via an MQTT protocol. If any improvements or new supported devices are included in the ZigBee2MQTT project, those can also be added to this project. If you notice any differences, please write an issue and we will take care of it.
126
- Other topics related to this adapter are also documented in the associated wiki.
127
-
128
-
1
+ # ioBroker adapter for ZigBee devices
2
+ With the help of a coordinator, based on the chip "Texas Instruments CC253x" (and others), a ZigBee network is created for ZigBee devices (bulbs, dimmers, sensors, …) to join. Thanks to the direct interaction with the coordinator, the ZigBee adapter allows to control the devices without any manufacturer gateways/bridges (Xiaomi/Tradfri/Hue). Additional information about ZigBee can be found [here](https://github.com/Koenkk/zigbee2mqtt/wiki/ZigBee-network).
3
+
4
+ ## Hardware
5
+ Additional hardware is required for the coordinator (see above), which enables conversion between USB and ZigBee radio signals. There are 2 groups:
6
+
7
+ • Attachment module for the RaspberryPi (its old and not supported Zigbee V3)<br>
8
+ • USB stick like hardware
9
+
10
+ ![](../de/img/CC2531.png)
11
+ ![](../de/img/sku_429478_2.png)
12
+ ![](../de/img/cc26x2r.PNG)
13
+ ![](../de/img/CC2591.png)
14
+ ![](../de/img/sonoff.png)
15
+
16
+
17
+ Some of these devices require the installation of a suitable firmware for operation:
18
+ The required flasher/programmer and the process of preparation are described [here](https://github.com/Koenkk/zigbee2mqtt/wiki/Getting-started) or [here (Russian)](https://github.com/kirovilya/ioBroker.zigbee/wiki/%D0%9F%D1%80%D0%BE%D1%88%D0%B8%D0%B2%D0%BA%D0%B0).
19
+
20
+ The "Sonoff ZIGBEE 3.0 USB STICK CC2652P" is becoming increasingly popular:
21
+ ![](../de/img/sonoff.png)
22
+
23
+ - Flashing of a suitable firmware is not absolutely necessary (hardware is already delivered with suitable firmware)
24
+ - Supports the newer ZigBee 3.0 standard
25
+
26
+ The devices connected to the ZigBee network transmit their status to the coordinator and notify it of events (button press, motion detection, temperature change, ...). This information is displayed in the adapter under the respective ioBroker objects and can thus be further processed in ioBroker. It is also possible to send commands to the ZigBee device (change of status of sockets and lamps, color and brightness settings, ...).
27
+
28
+
29
+ ## Software
30
+
31
+ The software is divided into "converter" and "adapter".
32
+
33
+ ![](img/software1.jpg)
34
+
35
+ - Converter
36
+ The converter is divided into two parts: <br>
37
+ a) General provision of the data from the ZigBee radio signals. This [software part](https://github.com/Koenkk/zigbee-herdsman) is used for all ZigBee devices. <br>
38
+ b) Device-specific [processing](https://github.com/Koenkk/zigbee-herdsman-converters) of the data to a defined interface to the adapter.
39
+ - Adapter<br>
40
+ This software part is the connection of the converter to ioBroker. The [adapter](https://github.com/ioBroker/ioBroker.zigbee) includes the graphical user interface for managing the ZigBee devices and the creation of ioBroker objects for controlling the ZigBee devices.
41
+
42
+
43
+ ## Installation
44
+ 1. Connect the coordinator hardware to the RaspberryPi.<br>
45
+ 2. Connect to RaspberryPi e.g. via PuTTY.<br>
46
+ 3. Delete any existing ZigBee backup file. Otherwise the ZigBee adapter will not turn green in ioBroker and the ioBroker log will state that the adapter is misconfigured <br>
47
+ 4. Find out the path of the coordinator :
48
+ `ls -la /dev/serial/by-id/`
49
+ ![](../de/img/Bild2.png)
50
+ 5. ioBroker -> install ZigBee adapter, here Version 1.8.10 <br> ![](../de/img/Bild3.png) <br> This will install all the necessary software parts (converter and adapter).
51
+ 6. Open adapter -> ![](img/Bild4.png) -> Enter the previously determined path of the coordinator with the addition /dev/serial/by-id/:![](../de/img/Bild5.jpg) <br> There must be NO spaces at the end of the path.
52
+ 7. Configure network ID and Pan ID to differentiate from other ZigBee networks within radio range, e.g. <br>
53
+ ![](../de/img/Bild6.png) ![](../de/img/Bild7.png) <br> ![](../de/img/Bild8.png) ![](img/Bild9.png)
54
+ 8. Check if the adapter turns green in ioBroker. Target state: <br> ![](../de/img/Bild10.png) <br> Otherwise read the ioBroker log and look for the cause of the error, check also our Forum.
55
+
56
+ ## Pairing
57
+ Each ZigBee device (switch, bulb, sensor, ...) must be paired with the coordinator (pairing): <br>
58
+
59
+ - ZigBee device:
60
+ Each ZigBee device can only be connected to exactly 1 ZigBee network. If the ZigBee device still has pairing information saved for a different coordinator (e.g. Philips Hue Bridge), then it must first be decoupled from this ZigBee network. This decoupling from the old ZigBee network preferably is done via the user interface of the old ZigBee network (z.B. Philips Hue App). Alternatively, you can reset the ZigBee device to factory settings. <br>
61
+ There are typically the following options for putting a ZigBee device into pairing mode <br>
62
+ 1. Unpair a ZigBee device from a ZigBee network
63
+ 2. Press the pairing button on the ZigBee device
64
+ 3. Switch the supply voltage of the ZigBee device off and then on again
65
+
66
+
67
+ The ZigBee device is then in pairing mode for typically 60 seconds. Similar to the procedure for resetting to factory settings, activating the pairing mode also depends on the respective device type (if necessary, read the operating instructions of the ZigBee device).
68
+
69
+ - Coordinator:
70
+ Press the green button to put the coordinator into pairing mode for 60 seconds. <br>
71
+ ![](../de/img/Bild12.png)
72
+
73
+ - Wait until "New device joined" appears in the dialog: <br>
74
+ ![](img/Bild13.png)
75
+
76
+ - Check Pairing:
77
+ The device to be paired must be supported by the ioBroker ZigBee adapter. In the best case, a new device is displayed in the ZigBee adapter (e.g. Philips Light Stripe) and corresponding ioBroker objects are created:
78
+ ![](../de/img/Bild14.png) ![](../de/img/Bild15.png)
79
+
80
+ - In the worst case, the ZigBee device is not currently supported. The next section describes what needs to be done to use this ZigBee device anyhow.
81
+
82
+ ## Pairing of unknown ZigBee devices so far
83
+
84
+ With unknown ZigBee devices so far, the ZigBee name of the ZigBee device (e.g. HOMA1001) appears during pairing with the addition "not described in statesMapping" <br>
85
+ ![](../de/img/Bild28.png) <br>
86
+ ![](../de/img/Bild16.png) <br>
87
+
88
+ Turning this tile gives you detailed information about the ZigBee device: <br>
89
+ ![](../de/img/Bild17.png) ![](img/Bild18.png) <br>
90
+
91
+ After registering at [github.com](https://github.com/ioBroker/ioBroker.zigbee/issues) the missing ZigBee device must be reported via an "Issue":
92
+
93
+ ![](../de/img/Bild19.png) <br>
94
+
95
+ - Insert detailed information of the tile (see above) into the issue, create a short documentation (preferably in English) and send it. A developer will then respond via the issue.
96
+
97
+ After modifying the relevant files, the ZigBee adapter must be restarted and the ZigBee device must be unpaired from the coordinator:
98
+ ![](../de/img/Bild20.png) <br>
99
+ After that, the pairing can be repeated. Target state after pairing: <br>
100
+ ![](../de/img/Bild21.png) <br>
101
+
102
+ With some ZigBee devices it is necessary to display all software interfaces ("exposes") of the new ZigBee device in the ioBroker objects in order to be able to use all the functions of this ZigBee device. In such cases, the new ZigBee device must be included in the "Exclude" group.
103
+
104
+ ![](../de/img/Bild22.png) <br>
105
+
106
+ ![](img/Bild23.png) -> ![](../de/img/Bild24.png) -> ![](img/Bild25.png) -> select ZigBee device (e.g. HOMA1001) -> ![](img/Bild26.png) <br>
107
+ After restarting the ZigBee adapter, the new ZigBee device should now work without restrictions.
108
+
109
+
110
+
111
+ ## Symbols within the ZigBee adapter
112
+
113
+ | icon | Beschreibung |
114
+ | ------------- | ------------- |
115
+ | ![](../de/img/Bild30.png) | **State Cleanup** Deletion of invalid ioBroker objects, which can result from the "Exclude" process. |
116
+ | ![](../de/img/Bild31.png) | **Check firmware updates** Update the firmware of the ZigBee devices (e.g. Philips Hue bulbs). |
117
+ | ![](../de/img/Bild32.png) | **Add Group** Using this function, ZigBee devices can be combined into a logical group and then be controlled together via one ioBroker object, e.g. brightness=20 sets the brightness of all ZigBee devices in the group to 20. |
118
+ | ![](../de/img/Bild33.png) | **Touchlink reset and pairing** Touchlink is a ZigBee function that allows devices that are physically close to each other to communicate with each other without being in the same network. Not all devices support this feature.To factory reset a ZigBee device via Touchlink, bring the device close (< 10 cm) to the ZigBee coordinator and then press this green icon. |
119
+ | ![](../de/img/Bild34.png) | **Pairing with QR code** Bei With some ZigBee devices, pairing is done using a QR code. |
120
+ | ![](../de/img/Bild35.png) | **Let's start Pairing** Start the pairing process for new ZigBee devices. |
121
+ | ![](../de/img/Bild36.png) | Time since data was last exchanged with this ZigBee device. |
122
+ | ![](../de/img/Bild37.png) | Strength of the ZigBee radio signal at this ZigBee device (<10 poor, <50 medium, >50 good).ZigBee is a wireless mesh network. Most mains-operated ZigBee devices (e.g. Philips Hue bulbs) can act as a ZigBee router, this means as a radio node. ZigBee devices therefore do not necessarily have to establish a direct wireless connection to the coordinator, but can instead use any router in the network for the wireless connection. The radio range of the network is thus extended with each ZigBee router. All ZigBee devices regularly check whether there is a better radio route and switch over automatically. However, this process can take several minutes.|
123
+
124
+ ## Additional information
125
+ There is [another](https://www.zigbee2mqtt.io/) with the same functions and the same technology, which communicates with the same devices via an MQTT protocol. If any improvements or new supported devices are included in the ZigBee2MQTT project, those can also be added to this project. If you notice any differences, please write an issue and we will take care of it.
126
+ Other topics related to this adapter are also documented in the associated wiki.
127
+
128
+