ETM-Schurig
/
powersync-plugins
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add more zigbee plugin documentation

master
Simon Stürz 2020-12-17 08:55:09 +01:00
parent fb9f4338d4
commit 88ae369340
8 changed files with 342 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
zigbeegeneric/README.md
View File

@ -16,7 +16,7 @@ Simple on/off power sockets.
**Pairing instructions**: Open the ZigBee network for joining. Follow the manufacturer specific reset/pairing instruction.
> Most power sockets have a pairing button. Once the device is powered, it can be resetted / paired by clicking the pairing/setup button multiple times of keeping it pressed for several seconds.
> Most power sockets have a pairing button. Once the device is powered, it can be resetted / paired by clicking the button multiple times of keeping it pressed for several seconds.
## Requirements

1
zigbeegeneric/meta.json
View File

@ -8,5 +8,6 @@
"zigbee"
],
"categories": [
"socket"
]
}

112
zigbeelumi/README.md Normal file
View File

@ -0,0 +1,112 @@
# ZigBee Aqara / Xiaomi Mi / Lumi
This plugin allows to interact with ZigBee from Aqara / Xiaomi Mi / Lumi 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.
> Note: if you you already added one of the following devices and you restart the pairing process while the network is closed, the device will leave the ZigBee network and the thing will be removed automatically.
### Aqara smart plug
The [Aqara smart plug](https://www.aqara.com/en/smart_plug.html) can be switched on and off. The power consumtion is not suppoted yet, but planed for the future.
**Pairing instructions**: Open the ZigBee network for joining. Press and hold the pairing button until the LED starts blinking.
### Aqara weather sensor
The [Aqara weather sensor](https://www.aqara.com/us/temperature_humidity_sensor.html) is fully supported.
**Pairing instructions**: Open the ZigBee network for joining. Press and hold the pairing button until the LED starts blinking.
### Aqara door and window sensor
The [Aqara door and window sensor](https://www.aqara.com/us/door_and_window_sensor.html) is fully supported.
**Pairing instructions**: Open the ZigBee network for joining. Press and hold the pairing button until the LED starts blinking.
### Aqara motion sensor
The [Aqara motion sensor](https://www.aqara.com/us/motion_sensor.html) is fully supported. The duration for the present state can be configured in the thing settings.
**Pairing instructions**: Open the ZigBee network for joining. Press and hold the pairing button until the LED starts blinking.
### Aqara water leak sensor
The [Aqara water leak sensor](https://www.aqara.com/us/water_leak_sensor.html) is fully supported.
**Pairing instructions**: Open the ZigBee network for joining. Press and hold the pairing button until the LED starts blinking.
### Aqara vibration sensor
The [Aqara vibration sensor](https://www.aqara.com/us/vibration_sensor.html) is fully supported.
**Pairing instructions**: Open the ZigBee network for joining. Press and hold the pairing button until the LED starts blinking.
### Aqara mini switch
The [Aqara mini switch](https://www.aqara.com/us/wireless_mini_switch.html) is fully supported.
**Pairing instructions**: Open the ZigBee network for joining. Press and hold the pairing button until the LED starts blinking.
### Aqara wall switch (Double key)
The [Aqara wall switch (Double key)](https://xiaomi-mi.com/sockets-and-sensors/remote-switch-for-aqara-smart-light-wall-switch-double-key/) is fully supported.
**Pairing instructions**: Open the ZigBee network for joining. Press and hold the pairing button until the LED starts blinking.
### Aqara single switch Module T1
The [Aqara single switch module T1](https://www.aqara.com/eu/single_switch_T1_no-neutral.html) is fully supported.
**Pairing instructions**: Open the ZigBee network for joining. Press and hold the pairing button until the LED starts blinking.
### Xiaomi Mi temperature humidity sensor
The [Aqara single switch module T1](https://xiaomi-mi.com/sockets-and-sensors/xiaomi-mi-temperature-humidity-sensor/) is fully supported.
> Note: it takes about 30 seconds until the sensor shows up because the initilization takes longer than normal.
**Pairing instructions**: Open the ZigBee network for joining. Press and hold the pairing button with a needle until the LED starts blinking.
### Xiaomi Mi wireless switch
The [Xiaomi Mi wireless switch](https://xiaomi-mi.com/sockets-and-sensors/xiaomi-mi-wireless-switch/) supports currently only the single button press. The multi click events will be implemented in the future.
> Note: it takes about 30 seconds until the sensor shows up because the initilization takes longer than normal.
**Pairing instructions**: Open the ZigBee network for joining. Press and hold the pairing button with a needle until the LED starts blinking.
### Xiaomi Mi door and window sensor
The [Xiaomi Mi door and window sensor](https://xiaomi-mi.com/sockets-and-sensors/xiaomi-mi-door-window-sensors/) is fully supported.
> Note: it takes about 30 seconds until the sensor shows up because the initilization takes longer than normal.
**Pairing instructions**: Open the ZigBee network for joining. Press and hold the pairing button with a needle until the LED starts blinking.
### Xiaomi Mi occupancy sensor
The [Xiaomi Mi occupancy sensor](https://xiaomi-mi.com/sockets-and-sensors/xiaomi-mi-occupancy-sensor/) is fully supported. The duration for the present state can be configured in the thing settings.
> Note: it takes about 30 seconds until the sensor shows up because the initilization takes longer than normal.
**Pairing instructions**: Open the ZigBee network for joining. Press and hold the pairing button with a needle until the LED starts blinking.
## 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).

16
zigbeelumi/meta.json Normal file
View File

@ -0,0 +1,16 @@
{
"title": "ZigBee Lumi / Aqara / Xiaomi Mi",
"tagline": "Connect and control ZigBee devices from Lumi / Aquara / Xiaomi Mi native.",
"icon": "zigbee.svg",
"stability": "consumer",
"offline": true,
"technologies": [
"zigbee"
],
"categories": [
"sensor",
"switch",
"relay",
"socket"
]
}

179
zigbeelumi/zigbee.svg Normal file
View File

@ -0,0 +1,179 @@
<?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="96"
height="96"
id="svg4874"
version="1.1"
inkscape:version="0.92.3 (2405546, 2018-03-11)"
viewBox="0 0 96 96.000001"
sodipodi:docname="zigbee_.svg">
<defs
id="defs4876" />
<sodipodi:namedview
id="base"
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1.0"
inkscape:pageopacity="0.0"
inkscape:pageshadow="2"
inkscape:zoom="8.7812489"
inkscape:cx="10.528112"
inkscape:cy="41.064759"
inkscape:document-units="px"
inkscape:current-layer="g4780"
showgrid="true"
showborder="true"
fit-margin-top="0"
fit-margin-left="0"
fit-margin-right="0"
fit-margin-bottom="0"
inkscape:snap-bbox="true"
inkscape:bbox-paths="true"
inkscape:bbox-nodes="true"
inkscape:snap-bbox-edge-midpoints="true"
inkscape:snap-bbox-midpoints="true"
inkscape:object-paths="true"
inkscape:snap-intersection-paths="true"
inkscape:object-nodes="true"
inkscape:snap-smooth-nodes="true"
inkscape:snap-midpoints="true"
inkscape:snap-object-midpoints="true"
inkscape:snap-center="true"
showguides="true"
inkscape:guide-bbox="true"
inkscape:window-width="2880"
inkscape:window-height="1663"
inkscape:window-x="0"
inkscape:window-y="76"
inkscape:window-maximized="1">
<inkscape:grid
type="xygrid"
id="grid5451"
empspacing="8" />
<sodipodi:guide
orientation="1,0"
position="8,-8.0000001"
id="guide4063"
inkscape:locked="false" />
<sodipodi:guide
orientation="1,0"
position="4,-8.0000001"
id="guide4065"
inkscape:locked="false" />
<sodipodi:guide
orientation="0,1"
position="-8,88.000001"
id="guide4067"
inkscape:locked="false" />
<sodipodi:guide
orientation="0,1"
position="-8,92.000001"
id="guide4069"
inkscape:locked="false" />
<sodipodi:guide
orientation="0,1"
position="104,4"
id="guide4071"
inkscape:locked="false" />
<sodipodi:guide
orientation="0,1"
position="-5,8.0000001"
id="guide4073"
inkscape:locked="false" />
<sodipodi:guide
orientation="1,0"
position="92,-8.0000001"
id="guide4075"
inkscape:locked="false" />
<sodipodi:guide
orientation="1,0"
position="88,-8.0000001"
id="guide4077"
inkscape:locked="false" />
<sodipodi:guide
orientation="0,1"
position="-8,84.000001"
id="guide4074"
inkscape:locked="false" />
<sodipodi:guide
orientation="1,0"
position="12,-8.0000001"
id="guide4076"
inkscape:locked="false" />
<sodipodi:guide
orientation="0,1"
position="-5,12"
id="guide4078"
inkscape:locked="false" />
<sodipodi:guide
orientation="1,0"
position="84,-9.0000001"
id="guide4080"
inkscape:locked="false" />
<sodipodi:guide
position="48,-8.0000001"
orientation="1,0"
id="guide4170"
inkscape:locked="false" />
<sodipodi:guide
position="-8,48"
orientation="0,1"
id="guide4172"
inkscape:locked="false" />
</sodipodi:namedview>
<metadata
id="metadata4879">
<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 />
</cc:Work>
</rdf:RDF>
</metadata>
<g
inkscape:label="Layer 1"
inkscape:groupmode="layer"
id="layer1"
transform="translate(67.857146,-78.50504)">
<g
transform="matrix(0,-1,-1,0,373.50506,516.50504)"
id="g4845"
style="display:inline">
<g
inkscape:export-ydpi="90"
inkscape:export-xdpi="90"
inkscape:export-filename="next01.png"
transform="matrix(-0.9996045,0,0,1,575.94296,-611.00001)"
id="g4778"
inkscape:label="Layer 1">
<g
transform="matrix(-1,0,0,1,575.99999,611)"
id="g4780"
style="display:inline">
<path
inkscape:connector-curvature="0"
d="m 418.41067,377.27822 c -2.47698,-9.19 -6.3325,-9.76 -10.1,-11.048 -5.65022,5.45 -41.7365,40.432 -41.7365,40.432 0,0 -2.35494,-21.802 2.0068,-46.974 -0.058,0.002 -0.096,0.004 -0.152,0.006 6.22646,-3.99 13.61138,-6.332 21.55452,-6.332 22.10074,0 40.01582,17.908 40.01582,40 0,11.268 -4.67784,21.43 -12.17882,28.7 1.92676,-11.678 3.36934,-34.48 0.59024,-44.784 z"
id="path2"
style="fill:#808080;fill-opacity:1;stroke-width:2.00039554" />
<path
inkscape:connector-curvature="0"
d="m 363.40291,411.91422 c 0.69428,3.964 4.2637,8.424 10.6082,9.414 2.47898,-2.874 41.03022,-39.988 41.03022,-39.988 0.84834,14.016 0.93038,29.138 -1.72868,44.474 -6.5726,4.732 -14.61378,7.548 -23.32922,7.548 -22.10074,0 -40.01582,-17.908 -40.01582,-40 0,-12.346 5.6022,-23.378 14.39568,-30.716 -1.05042,7.744 -3.92954,32.202 -0.96038,49.268 z"
id="path4"
style="fill:#808080;fill-opacity:1;stroke-width:2.00039554" />
</g>
</g>
</g>
</g>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 5.6 KiB

7
zigbeephilipshue/README.md
View File

@ -6,6 +6,7 @@ This plugin allows to interact with Philips Hue ZigBee devices using a native Zi
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.
### Hue motion sensor
The [Hue motion sensor](https://www.philips-hue.com/en-us/p/hue-motion-sensor/046677473389) is fully supported. The time period for the present state can be specied in the thing setting.
@ -27,7 +28,7 @@ The [Hue dimmer switch](https://www.philips-hue.com/en-us/p/hue-dimmer-switch/04
Most of the lights and lamps from Philips Hue should be handled in a generic way by the `nymea-plugin-zigbee-generic-lights` plugin. There are 2 methods for bringing a Hue light / bulb into the nymea ZigBee network.
1. Use a [Hue dimmer switch](https://www.philips-hue.com/en-us/p/hue-dimmer-switch/046677473372):
1. Use a [Hue dimmer switch](https://www.philips-hue.com/en-us/p/hue-dimmer-switch/046677473372) (most reliable):
* Open the ZigBee network for for allowing new devices to join the network.
* Switch the lamp off and on again (take the power).
@ -42,12 +43,12 @@ Most of the lights and lamps from Philips Hue should be handled in a generic way
* Remove the lamp from the Hue Bridge using the official Hue App or nymea.
* The lamp should now be resetted and start joining the nymea ZigBee network.
The most reliable way is method 1.
## 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).
* Optional: [Hue dimmer switch](https://www.philips-hue.com/en-us/p/hue-dimmer-switch/046677473372) for resetting lights and bringing them into the nymea ZigBee network.
* *Optional*: [Hue dimmer switch](https://www.philips-hue.com/en-us/p/hue-dimmer-switch/046677473372) for resetting lights and bringing them into the nymea ZigBee network.
## More

29
zigbeetradfri/README.md
View File

@ -6,6 +6,8 @@ This plugin allows to interact with IKEA TRÅDFRI ZigBee devices using a native
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.
@ -14,6 +16,8 @@ The [Wireless dimmer](https://www.ikea.com/us/en/p/tradfri-wireless-dimmer-white
**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.
@ -22,12 +26,24 @@ The [Remote control](https://www.ikea.com/us/en/p/tradfri-remote-control-0044313
**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.
### TRÅDFRI Symfonisk
The [Remote control](https://www.ikea.com/us/en/p/symfonisk-sound-remote-white-20370482/) is *not* supported properly yet, even if it shows up when pairing. This implementation of this device is still under construction.
**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/) is fully supported.
**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.
@ -35,6 +51,7 @@ The [Signal repeater](https://www.ikea.com/us/en/p/tradfri-signal-repeater-30400
**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.
@ -42,13 +59,21 @@ The [Control outlet](https://www.ikea.com/us/en/p/tradfri-wireless-control-outle
**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.
Tested and verified lights:
* TRADFRI bulb E27 CWS opal 600lm (color light)
* TRADFRI bulb E27 WS clear 806lm (color temperature light)
**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).

3
zigbeetradfri/meta.json
View File

@ -10,6 +10,7 @@
"categories": [
"light",
"sensor",
"switch"
"switch",
"socket"
]
}