diff --git a/docs/getting_started/flashing_the_cc2531.md b/docs/getting_started/flashing_the_cc2531.md index b59d0187..cac3a73f 100644 --- a/docs/getting_started/flashing_the_cc2531.md +++ b/docs/getting_started/flashing_the_cc2531.md @@ -11,7 +11,7 @@ The CC2531 USB stick needs to be flashed with a custom firmware. 3. If the light on the CC debugger is RED press set reset button on the CC debugger. The light on the CC debugger should now turn GREEN. If not use [CC debugger user guide](http://www.ti.com/lit/ug/swru197h/swru197h.pdf) to troubleshoot your problem. ![How to connect](../images/connected.jpg) -4. Download the firmware [CC2531ZNP-Prod.hex](https://raw.githubusercontent.com/Koenkk/Z-Stack-firmware/master/coordinator/CC2531/bin/CC2531ZNP-Prod.hex) +4. Download the firmware [CC2531ZNP-Prod.hex](https://github.com/Koenkk/Z-Stack-firmware/tree/master/coordinator/CC2531/bin) 5. Start SmartRF Flash Programmer, setup as shown below and press `Perform actions`. ![SmartRF Flash Programmer](../images/smartrf.png) @@ -36,7 +36,7 @@ make 4. Connect **BOTH** the `CC2531 USB sniffer` and the `CC debugger` to your PC using USB. 5. If the light on the CC debugger is RED, press the Reset button on the CC debugger. The light on the CC debugger should now turn GREEN. If not, follow the [CC debugger user guide](http://www.ti.com/lit/ug/swru197h/swru197h.pdf) to troubleshoot your problem. ![How to connect](../images/connected.jpg) -6. Download the firmware [CC2531ZNP-Prod.hex](https://raw.githubusercontent.com/Koenkk/Z-Stack-firmware/master/coordinator/CC2531/bin/CC2531ZNP-Prod.hex). +6. Download the firmware [CC2531ZNP-Prod.hex](https://github.com/Koenkk/Z-Stack-firmware/tree/master/coordinator/CC2531/bin). 7. Flash your firmware: ``` sudo ./cc-tool -e -w CC2531ZNP-Prod.hex diff --git a/docs/information/3d_cases.md b/docs/information/3d_cases.md index 7b6a5ab1..176e866f 100644 --- a/docs/information/3d_cases.md +++ b/docs/information/3d_cases.md @@ -9,6 +9,9 @@ ## CC2531 Zigbee dongle - Case design for a [CC2531 Zigbee dongle][thingiverse-rpi-cc2531-dongle] +## CC2530 Zigbee dongle + - Case design for a [CC2530 Zigbee minimal case][thingiverse-cc2530-case] + ## Alternatives A lot of different case designs can be found via the [Thingiverse search][thingiverse-search-rpi] @@ -16,4 +19,5 @@ A lot of different case designs can be found via the [Thingiverse search][thingi [thingiverse-jwillmer-design]: https://www.thingiverse.com/thing:3101600 [thingiverse-search-rpi]: https://www.thingiverse.com/search?q=raspberry+pi+case [thingiverse-rpi-owncloud-design]: https://www.thingiverse.com/thing:1357022 -[thingiverse-rpi-cc2531-dongle]: https://www.thingiverse.com/thing:2803664 \ No newline at end of file +[thingiverse-rpi-cc2531-dongle]: https://www.thingiverse.com/thing:2803664 +[thingiverse-cc2530-case]: https://www.thingiverse.com/thing:3257462 diff --git a/docs/integration/home_assistant.md b/docs/integration/home_assistant.md index efd712b0..f36051a3 100644 --- a/docs/integration/home_assistant.md +++ b/docs/integration/home_assistant.md @@ -79,7 +79,7 @@ The following Home Assistant configuration allows you to control Zigbee2mqtt fro # Group group: zigbee_group: - view: no + view: false control: hidden name: Zigbee2mqtt entities: @@ -175,6 +175,7 @@ automation: - id: disable_zigbee_join alias: Disable Zigbee joining + hide_entity: true trigger: - entity_id: input_boolean.zigbee_permit_join platform: state @@ -218,7 +219,7 @@ sensor: availability_topic: "zigbee2mqtt/bridge/state" icon: "mdi:toggle-switch" value_template: "{{ value_json.click }}" - json_attributes: + json_attributes: - "linkquality" - "battery" - "voltage" @@ -237,7 +238,7 @@ sensor: availability_topic: "zigbee2mqtt/bridge/state" icon: "mdi:toggle-switch" value_template: "{{ value_json.click }}" - json_attributes: + json_attributes: - "linkquality" - "battery" - "voltage" @@ -256,7 +257,7 @@ sensor: availability_topic: "zigbee2mqtt/bridge/state" icon: "mdi:toggle-switch" value_template: "{{ value_json.click }}" - json_attributes: + json_attributes: - "linkquality" - "battery" - "voltage" @@ -275,7 +276,7 @@ sensor: availability_topic: "zigbee2mqtt/bridge/state" icon: "mdi:toggle-switch" value_template: "{{ value_json.click }}" - json_attributes: + json_attributes: - "linkquality" - "battery" - "voltage" @@ -294,7 +295,7 @@ sensor: availability_topic: "zigbee2mqtt/bridge/state" icon: "mdi:toggle-switch" value_template: "{{ value_json.click }}" - json_attributes: + json_attributes: - "linkquality" - "battery" - "voltage" @@ -337,7 +338,7 @@ sensor: unit_of_measurement: "Watt" icon: "mdi:flash" value_template: "{{ value_json.power }}" - json_attributes: + json_attributes: - "linkquality" - "voltage" - "temperature" @@ -358,7 +359,7 @@ switch: payload_on: "ON" value_template: "{{ value_json.state_left }}" command_topic: "zigbee2mqtt//left/set" - json_attributes: + json_attributes: - "linkquality" - "button_left" @@ -370,7 +371,7 @@ switch: payload_on: "ON" value_template: "{{ value_json.state_right }}" command_topic: "zigbee2mqtt//right/set" - json_attributes: + json_attributes: - "linkquality" - "button_right" ``` @@ -387,7 +388,7 @@ switch: payload_on: "ON" value_template: "{{ value_json.state_left }}" command_topic: "zigbee2mqtt//left/set" - json_attributes: + json_attributes: - "linkquality" - "button_left" @@ -399,7 +400,7 @@ switch: payload_on: "ON" value_template: "{{ value_json.state_right }}" command_topic: "zigbee2mqtt//right/set" - json_attributes: + json_attributes: - "linkquality" - "button_right" @@ -410,7 +411,7 @@ sensor: unit_of_measurement: "Watt" icon: "mdi:flash" value_template: "{{ value_json.power }}" - json_attributes: + json_attributes: - "linkquality" - "voltage" - "temperature" @@ -430,7 +431,7 @@ sensor: unit_of_measurement: "°C" device_class: "temperature" value_template: "{{ value_json.temperature }}" - json_attributes: + json_attributes: - "linkquality" - "battery" - "voltage" @@ -442,7 +443,7 @@ sensor: unit_of_measurement: "%" device_class: "humidity" value_template: "{{ value_json.humidity }}" - json_attributes: + json_attributes: - "linkquality" - "battery" - "voltage" @@ -459,7 +460,7 @@ sensor: unit_of_measurement: "°C" device_class: "temperature" value_template: "{{ value_json.temperature }}" - json_attributes: + json_attributes: - "linkquality" - "battery" - "voltage" @@ -471,7 +472,7 @@ sensor: unit_of_measurement: "%" device_class: "humidity" value_template: "{{ value_json.humidity }}" - json_attributes: + json_attributes: - "linkquality" - "battery" - "voltage" @@ -483,7 +484,7 @@ sensor: unit_of_measurement: "hPa" device_class: "pressure" value_template: "{{ value_json.pressure }}" - json_attributes: + json_attributes: - "linkquality" - "battery" - "voltage" @@ -508,7 +509,7 @@ sensor: availability_topic: "zigbee2mqtt/bridge/state" device_class: "battery" value_template: "{{ value_json.battery }}" - json_attributes: + json_attributes: - "linkquality" - "voltage" - "action" @@ -535,7 +536,7 @@ sensor: unit_of_measurement: "lx" device_class: "illuminance" value_template: "{{ value_json.illuminance }}" - json_attributes: + json_attributes: - "linkquality" - "battery" - "voltage" @@ -546,7 +547,7 @@ sensor: availability_topic: "zigbee2mqtt/bridge/state" device_class: "battery" value_template: "{{ value_json.battery }}" - json_attributes: + json_attributes: - "linkquality" - "voltage" - "action" @@ -572,7 +573,7 @@ sensor: availability_topic: "zigbee2mqtt/bridge/state" device_class: "battery" value_template: "{{ value_json.battery }}" - json_attributes: + json_attributes: - "linkquality" - "voltage" - "action" @@ -598,7 +599,7 @@ sensor: availability_topic: "zigbee2mqtt/bridge/state" device_class: "battery" value_template: "{{ value_json.battery }}" - json_attributes: + json_attributes: - "linkquality" - "voltage" - "action" @@ -624,7 +625,7 @@ sensor: availability_topic: "zigbee2mqtt/bridge/state" device_class: "battery" value_template: "{{ value_json.battery }}" - json_attributes: + json_attributes: - "linkquality" - "voltage" - "action" @@ -641,7 +642,7 @@ sensor: availability_topic: "zigbee2mqtt/bridge/state" icon: "mdi:gesture-double-tap" value_template: "{{ value_json.action }}" - json_attributes: + json_attributes: - "linkquality" - "battery" - "voltage" @@ -679,7 +680,7 @@ sensor: unit_of_measurement: "Watt" icon: "mdi:flash" value_template: "{{ value_json.power }}" - json_attributes: + json_attributes: - "linkquality" - "voltage" - "temperature" @@ -708,7 +709,7 @@ sensor: unit_of_measurement: "Watt" icon: "mdi:flash" value_template: "{{ value_json.power }}" - json_attributes: + json_attributes: - "linkquality" - "voltage" - "temperature" @@ -736,7 +737,7 @@ sensor: availability_topic: "zigbee2mqtt/bridge/state" device_class: "battery" value_template: "{{ value_json.battery }}" - json_attributes: + json_attributes: - "linkquality" - "voltage" - "action" @@ -762,7 +763,7 @@ sensor: availability_topic: "zigbee2mqtt/bridge/state" device_class: "battery" value_template: "{{ value_json.battery }}" - json_attributes: + json_attributes: - "linkquality" - "voltage" - "action" @@ -779,7 +780,7 @@ sensor: availability_topic: "zigbee2mqtt/bridge/state" icon: "mdi:lock" value_template: "{{ value_json.inserted }}" - json_attributes: + json_attributes: - "linkquality" - "forgotten" - "keyerror" @@ -795,7 +796,7 @@ sensor: availability_topic: "zigbee2mqtt/bridge/state" icon: "mdi:gesture-double-tap" value_template: "{{ value_json.action }}" - json_attributes: + json_attributes: - "linkquality" - "battery" - "voltage" @@ -946,7 +947,7 @@ sensor: unit_of_measurement: "brightness" icon: "mdi:brightness-5" value_template: "{{ value_json.brightness }}" - json_attributes: + json_attributes: - "linkquality" ``` {% endraw %} @@ -1283,7 +1284,7 @@ sensor: availability_topic: "zigbee2mqtt/bridge/state" icon: "mdi:gesture-double-tap" value_template: "{{ value_json.action }}" - json_attributes: + json_attributes: - "linkquality" - "battery" - "voltage" @@ -1321,7 +1322,7 @@ sensor: unit_of_measurement: "°C" device_class: "temperature" value_template: "{{ value_json.temperature }}" - json_attributes: + json_attributes: - "linkquality" - "battery" - "voltage" @@ -1333,7 +1334,7 @@ sensor: unit_of_measurement: "lx" device_class: "illuminance" value_template: "{{ value_json.illuminance }}" - json_attributes: + json_attributes: - "linkquality" - "battery" - "voltage" @@ -1344,7 +1345,7 @@ sensor: availability_topic: "zigbee2mqtt/bridge/state" device_class: "battery" value_template: "{{ value_json.battery }}" - json_attributes: + json_attributes: - "linkquality" - "voltage" - "action" @@ -1384,7 +1385,7 @@ sensor: unit_of_measurement: "Watt" icon: "mdi:flash" value_template: "{{ value_json.power }}" - json_attributes: + json_attributes: - "linkquality" - "voltage" - "temperature" @@ -1411,7 +1412,7 @@ sensor: state_topic: "zigbee2mqtt/" availability_topic: "zigbee2mqtt/bridge/state" value_template: "{{ value_json.linkquality }}" - json_attributes: + json_attributes: - "description" - "type" - "rssi" @@ -1443,7 +1444,7 @@ switch: payload_on: "ON" value_template: "{{ value_json.state_left }}" command_topic: "zigbee2mqtt//left/set" - json_attributes: + json_attributes: - "linkquality" - "button_left" @@ -1455,7 +1456,7 @@ switch: payload_on: "ON" value_template: "{{ value_json.state_right }}" command_topic: "zigbee2mqtt//right/set" - json_attributes: + json_attributes: - "linkquality" - "button_right" ``` @@ -1472,7 +1473,7 @@ switch: payload_on: "ON" value_template: "{{ value_json.state_left }}" command_topic: "zigbee2mqtt//left/set" - json_attributes: + json_attributes: - "linkquality" - "button_left" @@ -1484,7 +1485,7 @@ switch: payload_on: "ON" value_template: "{{ value_json.state_right }}" command_topic: "zigbee2mqtt//right/set" - json_attributes: + json_attributes: - "linkquality" - "button_right" @@ -1496,7 +1497,7 @@ switch: payload_on: "ON" value_template: "{{ value_json.state_center }}" command_topic: "zigbee2mqtt//center/set" - json_attributes: + json_attributes: - "linkquality" - "button_center" ``` @@ -1513,7 +1514,7 @@ switch: payload_on: "ON" value_template: "{{ value_json.state_bottom_left }}" command_topic: "zigbee2mqtt//bottom_left/set" - json_attributes: + json_attributes: - "linkquality" - "button_bottom_left" @@ -1525,7 +1526,7 @@ switch: payload_on: "ON" value_template: "{{ value_json.state_bottom_right }}" command_topic: "zigbee2mqtt//bottom_right/set" - json_attributes: + json_attributes: - "linkquality" - "button_bottom_right" @@ -1537,7 +1538,7 @@ switch: payload_on: "ON" value_template: "{{ value_json.state_top_left }}" command_topic: "zigbee2mqtt//top_left/set" - json_attributes: + json_attributes: - "linkquality" - "button_top_left" @@ -1549,7 +1550,7 @@ switch: payload_on: "ON" value_template: "{{ value_json.state_top_right }}" command_topic: "zigbee2mqtt//top_right/set" - json_attributes: + json_attributes: - "linkquality" - "button_top_right" ``` @@ -1816,7 +1817,7 @@ sensor: unit_of_measurement: "°C" device_class: "temperature" value_template: "{{ value_json.temperature }}" - json_attributes: + json_attributes: - "linkquality" - "battery" - "voltage" @@ -2097,7 +2098,7 @@ sensor: unit_of_measurement: "Watt" icon: "mdi:flash" value_template: "{{ value_json.power }}" - json_attributes: + json_attributes: - "linkquality" - "voltage" - "temperature" @@ -2345,7 +2346,7 @@ sensor: unit_of_measurement: "Watt" icon: "mdi:flash" value_template: "{{ value_json.power }}" - json_attributes: + json_attributes: - "linkquality" - "voltage" - "temperature" @@ -2393,7 +2394,7 @@ switch: payload_on: "ON" value_template: "{{ value_json.state_left }}" command_topic: "zigbee2mqtt//left/set" - json_attributes: + json_attributes: - "linkquality" - "button_left" @@ -2405,7 +2406,7 @@ switch: payload_on: "ON" value_template: "{{ value_json.state_right }}" command_topic: "zigbee2mqtt//right/set" - json_attributes: + json_attributes: - "linkquality" - "button_right" ``` @@ -2444,7 +2445,7 @@ sensor: availability_topic: "zigbee2mqtt/bridge/state" device_class: "battery" value_template: "{{ value_json.battery }}" - json_attributes: + json_attributes: - "linkquality" - "voltage" - "action" @@ -2470,7 +2471,7 @@ sensor: availability_topic: "zigbee2mqtt/bridge/state" device_class: "battery" value_template: "{{ value_json.battery }}" - json_attributes: + json_attributes: - "linkquality" - "voltage" - "action" @@ -2536,7 +2537,7 @@ sensor: availability_topic: "zigbee2mqtt/bridge/state" device_class: "battery" value_template: "{{ value_json.battery }}" - json_attributes: + json_attributes: - "linkquality" - "voltage" - "action" @@ -2577,7 +2578,7 @@ sensor: unit_of_measurement: "°C" device_class: "temperature" value_template: "{{ value_json.temperature }}" - json_attributes: + json_attributes: - "linkquality" - "battery" - "voltage" @@ -2673,7 +2674,7 @@ sensor: unit_of_measurement: "Watt" icon: "mdi:flash" value_template: "{{ value_json.power }}" - json_attributes: + json_attributes: - "linkquality" - "voltage" - "temperature"