Add zigbee tradfri plugin documentation
Simon Stürz
parent
54a710db00
commit
78ae7db224
|
|
@ -1,4 +1,4 @@
|
||||||
# Zigbee Philips Hue
|
# ZigBee Philips Hue
|
||||||
|
|
||||||
This plugin allows to interact with Philips Hue ZigBee devices using a native ZigBee network controller in nymea.
|
This plugin allows to interact with Philips Hue ZigBee devices using a native ZigBee network controller in nymea.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,59 @@
|
||||||
|
# ZigBee IKEA TRÅDFRI
|
||||||
|
|
||||||
|
This plugin allows to interact with IKEA TRÅDFRI ZigBee devices using a native ZigBee network controller in nymea.
|
||||||
|
|
||||||
|
## Supported Things
|
||||||
|
|
||||||
|
In order to bring a ZigBee device into the nymea ZigBee network, the network needs to be opened for joining before you perform the device pairing instructions. The joining process can take up to 30 seconds. If the device does not show up, please restart the pairing process.
|
||||||
|
|
||||||
|
### TRÅDFRI Wireless dimmer
|
||||||
|
|
||||||
|
The [Wireless dimmer](https://www.ikea.com/us/en/p/tradfri-wireless-dimmer-white-10408598/) requires the latest firmware version in order to work properly with nymea. If the thing shows up in nymea once paired, but no button events will be recongized, please update the device to the latest firmware version and re-add it to nymea.
|
||||||
|
|
||||||
|
> Known working device firmware version: `2.2.008`
|
||||||
|
|
||||||
|
**Pairing instructions**: Open the ZigBee network for joining. Click the connect button 4 times within 5 seconds.
|
||||||
|
|
||||||
|
### TRÅDFRI Remote control
|
||||||
|
|
||||||
|
The [Remote control](https://www.ikea.com/us/en/p/tradfri-remote-control-00443130/) requires the latest firmware version in order to work properly with nymea. If the thing shows up in nymea once paired, but no button events will be recongized, please update the device to the latest firmware version and re-add it to nymea.
|
||||||
|
|
||||||
|
> Known working device firmware version: `2.3.014`
|
||||||
|
|
||||||
|
**Pairing instructions**: Open the ZigBee network for joining. Click the connect button 4 times within 5 seconds.
|
||||||
|
|
||||||
|
### TRÅDFRI Motion sensor
|
||||||
|
|
||||||
|
The [Remote control](https://www.ikea.com/us/en/p/tradfri-wireless-motion-sensor-white-60377655/) requires the latest firmware version in order to work properly with nymea. If the thing shows up in nymea once paired, but no button events will be recongized, please update the device to the latest firmware version and re-add it to nymea.
|
||||||
|
|
||||||
|
**Pairing instructions**: Open the ZigBee network for joining. Click the connect button 4 times within 5 seconds.
|
||||||
|
|
||||||
|
### TRÅDFRI Signal repeater
|
||||||
|
|
||||||
|
The [Signal repeater](https://www.ikea.com/us/en/p/tradfri-signal-repeater-30400407/) is fully supported.
|
||||||
|
|
||||||
|
**Pairing instructions**: Open the ZigBee network for joining. Press the setup button with a needle for 5 seconds.
|
||||||
|
|
||||||
|
|
||||||
|
#### Control outlet
|
||||||
|
|
||||||
|
The [Control outlet](https://www.ikea.com/us/en/p/tradfri-wireless-control-outlet-30356169/) should be handeld in a generic way by the `nymea-plugin-zigbee-generic` plugin.
|
||||||
|
|
||||||
|
**Pairing instructions**: Open the ZigBee network for joining. Press the setup button with a needle for 5 seconds. The power socket will switch quick on and off and start the pairing process.
|
||||||
|
|
||||||
|
|
||||||
|
### TRÅDFRI lights
|
||||||
|
|
||||||
|
Most of the lights and lamps from IKEA TRÅDFRI should be handled in a generic way by the `nymea-plugin-zigbee-generic-lights` plugin.
|
||||||
|
|
||||||
|
**Pairing instructions**: Open the ZigBee network for joining. Switch the light off and on 6 times in a 1 second rythm. Once the light start flashing/dimming, the pairing process has been started successfully and the lamp will join the nymea ZigBee network.
|
||||||
|
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
* A compatible ZigBee controller and a running ZigBee network in nymea. You can find more information about supported controllers and ZigBee network configurations [here](https://nymea.io/documentation/users/usage/configuration#zigbee).
|
||||||
|
|
||||||
|
|
||||||
|
## More
|
||||||
|
|
||||||
|
[IKEAD](https://www.ikea.com)
|
||||||
|
|
@ -0,0 +1,76 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||||
|
<!-- Created with Inkscape (http://www.inkscape.org/) -->
|
||||||
|
|
||||||
|
<svg
|
||||||
|
xmlns:dc="http://purl.org/dc/elements/1.1/"
|
||||||
|
xmlns:cc="http://creativecommons.org/ns#"
|
||||||
|
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
|
||||||
|
xmlns:svg="http://www.w3.org/2000/svg"
|
||||||
|
xmlns="http://www.w3.org/2000/svg"
|
||||||
|
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
||||||
|
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
||||||
|
width="825mm"
|
||||||
|
height="340mm"
|
||||||
|
viewBox="0 0 825 340"
|
||||||
|
version="1.1"
|
||||||
|
id="svg855"
|
||||||
|
inkscape:version="0.92.4 (5da689c313, 2019-01-14)"
|
||||||
|
sodipodi:docname="ikea.svg">
|
||||||
|
<defs
|
||||||
|
id="defs849" />
|
||||||
|
<sodipodi:namedview
|
||||||
|
id="base"
|
||||||
|
pagecolor="#ffffff"
|
||||||
|
bordercolor="#666666"
|
||||||
|
borderopacity="1.0"
|
||||||
|
inkscape:pageopacity="0.0"
|
||||||
|
inkscape:pageshadow="2"
|
||||||
|
inkscape:zoom="0.175"
|
||||||
|
inkscape:cx="400"
|
||||||
|
inkscape:cy="560"
|
||||||
|
inkscape:document-units="mm"
|
||||||
|
inkscape:current-layer="layer1"
|
||||||
|
showgrid="false"
|
||||||
|
units="in"
|
||||||
|
inkscape:window-width="1280"
|
||||||
|
inkscape:window-height="962"
|
||||||
|
inkscape:window-x="-8"
|
||||||
|
inkscape:window-y="-8"
|
||||||
|
inkscape:window-maximized="1" />
|
||||||
|
<metadata
|
||||||
|
id="metadata852">
|
||||||
|
<rdf:RDF>
|
||||||
|
<cc:Work
|
||||||
|
rdf:about="">
|
||||||
|
<dc:format>image/svg+xml</dc:format>
|
||||||
|
<dc:type
|
||||||
|
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
|
||||||
|
<dc:title></dc:title>
|
||||||
|
</cc:Work>
|
||||||
|
</rdf:RDF>
|
||||||
|
</metadata>
|
||||||
|
<g
|
||||||
|
inkscape:label="Capa 1"
|
||||||
|
inkscape:groupmode="layer"
|
||||||
|
id="layer1"
|
||||||
|
transform="translate(0,43)">
|
||||||
|
<path
|
||||||
|
class="st0"
|
||||||
|
d="M 822.09929,293.97727 H 4.7954572 V -38.004839 H 822.21644 V 293.97727 Z"
|
||||||
|
id="path836"
|
||||||
|
inkscape:connector-curvature="0"
|
||||||
|
style="fill:#0058a3;stroke-width:1.17142594" />
|
||||||
|
<path
|
||||||
|
class="st1"
|
||||||
|
d="m 20.726849,127.98623 c 0,80.24266 164.585331,146.89678 392.779071,146.89678 228.19378,0 392.66199,-66.65412 392.66199,-146.89678 0,-80.242687 -164.58535,-146.896807 -392.66199,-146.896807 -228.07659,0 -392.779071,66.65412 -392.779071,146.896807 z"
|
||||||
|
id="path838"
|
||||||
|
inkscape:connector-curvature="0"
|
||||||
|
style="fill:#ffdb00;stroke-width:1.17142594" />
|
||||||
|
<path
|
||||||
|
class="st0"
|
||||||
|
d="m 281.13482,64.143513 c -1.75714,3.51428 -1.75714,6.911412 -1.75714,10.425692 v 43.928465 c 0,0 23.54566,-30.574227 28.93422,-37.837078 4.09999,-5.388546 9.13712,-13.002799 9.13712,-16.517079 h 76.84553 c -5.27143,3.51428 -11.12853,9.83996 -15.93138,15.697092 -4.21712,5.154291 -28.11423,34.322805 -28.11423,34.322805 0,0 35.49419,54.00272 40.06275,60.91414 2.57714,3.74857 5.38858,7.26285 8.66857,10.42569 h -88.44265 c 0,-3.51428 -3.39714,-10.65999 -7.1457,-16.28283 -3.74857,-5.62283 -24.01423,-36.43136 -24.01423,-36.43136 v 42.2885 c 0,3.51428 0,6.91141 1.75714,10.42569 h -73.68269 c 1.75714,-3.51428 1.75714,-6.91141 1.75714,-10.42569 V 74.569205 c 0,-3.51428 0,-6.911412 -1.75714,-10.425692 z m 272.82509,0 H 411.7488 c 1.75712,3.51428 1.75712,6.911412 1.75712,10.425692 V 175.07755 c 0,3.51428 0,6.91141 -1.75712,10.42569 h 142.21111 v -33.61993 c -3.51428,1.75712 -6.91141,1.75712 -10.42569,1.75712 h -59.85986 v -15.93139 h 57.517 v -25.65423 h -57.517 V 96.006282 h 59.85986 c 3.51428,0 6.91141,0 10.42569,1.640011 z M 750.99372,175.07755 c 1.17143,3.86568 3.16288,7.37999 5.73999,10.42569 H 679.6539 c 0.35151,-3.51428 -0.93714,-6.91141 -2.34286,-10.42569 0,0 -1.17142,-2.81144 -2.81143,-6.91142 l -0.70285,-1.75715 h -44.39701 l -0.70288,1.8743 c 0,0 -1.28858,3.39713 -2.46,6.91141 -1.17143,3.51428 -2.46,6.91142 -1.99142,10.42569 h -60.79699 c 2.45997,-3.04573 4.33427,-6.56001 5.5057,-10.42569 L 605.38549,74.686351 c 1.28857,-3.514279 2.57714,-6.911412 2.10856,-10.425691 h 102.73408 c -0.93717,3.514279 0.93713,6.911412 2.22571,10.425691 3.04569,7.614253 35.96274,93.596929 38.53988,100.391199 m -86.91981,-34.32277 -10.77709,-28.11424 c -0.93713,-2.57714 -1.75716,-5.27143 -2.34285,-7.96569 -0.46859,2.69426 -1.17143,5.38855 -2.10856,7.96569 -0.35151,1.17143 -4.92,13.47139 -10.19144,28.11424 z M 170.7865,74.569205 c 0,-3.51428 0,-6.911412 1.75714,-10.425692 H 92.418113 c 1.75714,3.51428 1.75714,6.911412 1.75714,10.425692 V 175.07755 c 0,3.51428 0,6.91141 -1.75714,10.42569 h 80.125527 c -1.75714,-3.51428 -1.75714,-6.91141 -1.75714,-10.42569 z M 726.39381,73.74918 c -0.23422,8.785717 6.67712,16.165714 15.57994,16.39997 8.78568,0.234218 16.16568,-6.67712 16.39997,-15.579945 0,-0.234219 0,-0.585732 0,-0.820025 0.1173,-8.668533 -6.67712,-15.814238 -15.34569,-15.931384 -0.23422,0 -0.35151,0 -0.58569,0 -8.55143,-0.351513 -15.69713,6.325717 -15.93139,14.877104 -0.23422,0.351513 -0.23422,0.702878 -0.11729,1.05428 m 28.69993,0 c 0.23421,7.028558 -5.38859,13.002837 -12.41715,13.119983 -7.02855,0.234219 -13.0028,-5.388546 -13.11994,-12.417105 0,-0.234218 0,-0.468585 0,-0.819987 -0.23422,-6.794303 5.03711,-12.534289 11.83141,-12.768544 0.35151,0 0.58569,0 0.93713,0 6.91141,-0.117295 12.6514,5.388546 12.76855,12.299958 0,0.234219 0,0.468586 0,0.585695 m -4.92,9.605704 h -3.16284 l -3.74857,-6.794266 h -4.09998 v 6.794266 h -2.81144 V 64.143513 h 7.14571 c 3.39713,0.117295 5.97428,2.811401 5.97428,6.208534 0,2.342853 -1.28858,4.45145 -3.39717,5.622877 z m -7.14571,-9.605704 c 1.87427,0.117295 3.51428,-1.288536 3.51428,-3.16284 0,-1.874267 -1.28857,-3.514279 -3.16284,-3.514279 -0.11729,0 -0.23422,0 -0.35151,0 h -3.86568 v 6.794265 h 3.86568"
|
||||||
|
id="path840"
|
||||||
|
inkscape:connector-curvature="0"
|
||||||
|
style="fill:#0058a3;stroke-width:1.17142594" />
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 5.5 KiB |
|
|
@ -0,0 +1,15 @@
|
||||||
|
{
|
||||||
|
"title": "ZigBee TRÅDFRI",
|
||||||
|
"tagline": "Connect and control ZigBee IKEA TRÅDFRI devices native.",
|
||||||
|
"icon": "ikea.svg",
|
||||||
|
"stability": "consumer",
|
||||||
|
"offline": true,
|
||||||
|
"technologies": [
|
||||||
|
"zigbee"
|
||||||
|
],
|
||||||
|
"categories": [
|
||||||
|
"light",
|
||||||
|
"sensor",
|
||||||
|
"switch"
|
||||||
|
]
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue