From 4592b00fe19ddcabef655c1a1549ea3ade6d395e Mon Sep 17 00:00:00 2001 From: Koen Kanters Date: Tue, 12 Feb 2019 21:16:42 +0100 Subject: [PATCH] Move docs to zigbee2mqtt.io repo. #1072 --- docgen/docgen.js | 10 - docgen/integrating-with-homeassistant.js | 299 -- docgen/supported-devices.js | 55 - docs/configuration/configuration.md | 68 - .../device_specific_configuration.md | 32 - docs/getting_started/flashing_the_cc2531.md | 47 - docs/getting_started/pairing_devices.md | 99 - docs/getting_started/running_zigbee2mqtt.md | 197 - docs/getting_started/what_do_i_need.md | 14 - ...ordinator_using_a_usb_to_serial_adapter.md | 39 - docs/how_tos/how_to_create_a_cc2530_router.md | 70 - docs/how_tos/how_to_debug.md | 25 - docs/how_tos/how_to_esp8266_with_cc2530.md | 168 - docs/how_tos/how_to_improve_network_range.md | 17 - docs/how_tos/how_to_secure_network.md | 25 - docs/how_tos/how_to_sniff_zigbee_husbzb.md | 52 - docs/how_tos/how_to_sniff_zigbee_traffic.md | 57 - docs/how_tos/how_to_support_new_devices.md | 111 - .../how_to_support_new_devices_on_hassio.md | 49 - docs/images/CP2102.png | Bin 22712 -> 0 bytes docs/images/E1524_group.png | Bin 59674 -> 0 bytes docs/images/HLK-PM03.jpg | Bin 4330 -> 0 bytes docs/images/cc2530.jpg | Bin 8736 -> 0 bytes docs/images/cc2530_cc2591.jpg | Bin 3054 -> 0 bytes docs/images/cc2530_pin_layout.png | Bin 187142 -> 0 bytes docs/images/cc2530_rfx2401.png | Bin 12095 -> 0 bytes docs/images/cc2530_router_enclosure.jpg | Bin 56286 -> 0 bytes docs/images/cc2531.jpg | Bin 4949 -> 0 bytes docs/images/cc_debugger.jpg | Bin 2794 -> 0 bytes docs/images/ccdebugger_cc2530.jpg | Bin 44455 -> 0 bytes docs/images/ccdebugger_pins.png | Bin 16539 -> 0 bytes docs/images/connected.jpg | Bin 108952 -> 0 bytes docs/images/devices/100.424.11.jpg | Bin 2124 -> 0 bytes docs/images/devices/1613V.jpg | Bin 3002 -> 0 bytes docs/images/devices/1TST-EU.jpg | Bin 9402 -> 0 bytes docs/images/devices/22670.jpg | Bin 2602 -> 0 bytes docs/images/devices/3210-L.jpg | Bin 6679 -> 0 bytes docs/images/devices/3216331P5.jpg | Bin 1993 -> 0 bytes docs/images/devices/3216431P5.jpg | Bin 7179 -> 0 bytes docs/images/devices/324131092621.jpg | Bin 2112 -> 0 bytes docs/images/devices/3261030P7.jpg | Bin 2307 -> 0 bytes docs/images/devices/3261331P7.jpg | Bin 2720 -> 0 bytes docs/images/devices/3320-L.jpg | Bin 2442 -> 0 bytes docs/images/devices/3321-S.jpg | Bin 5588 -> 0 bytes docs/images/devices/3325-S.jpg | Bin 2900 -> 0 bytes docs/images/devices/3326-L.jpg | Bin 2928 -> 0 bytes docs/images/devices/404000-404005-404012.jpg | Bin 5367 -> 0 bytes docs/images/devices/404006-404008-404004.jpg | Bin 4702 -> 0 bytes docs/images/devices/4052899926110.jpg | Bin 3010 -> 0 bytes docs/images/devices/4052899926158.jpg | Bin 3145 -> 0 bytes docs/images/devices/4058075036147.jpg | Bin 2767 -> 0 bytes docs/images/devices/4058075036185.jpg | Bin 2622 -> 0 bytes docs/images/devices/4058075816718.jpg | Bin 2756 -> 0 bytes docs/images/devices/4058075816794.jpg | Bin 6736 -> 0 bytes docs/images/devices/421786.jpg | Bin 9316 -> 0 bytes docs/images/devices/4256251-RZHAC.jpg | Bin 2541 -> 0 bytes docs/images/devices/433714.jpg | Bin 2209 -> 0 bytes docs/images/devices/45852GE.jpg | Bin 2753 -> 0 bytes docs/images/devices/45856GE.jpg | Bin 1936 -> 0 bytes docs/images/devices/45857GE.jpg | Bin 1917 -> 0 bytes docs/images/devices/464800.jpg | Bin 2539 -> 0 bytes docs/images/devices/4713407.jpg | Bin 10255 -> 0 bytes docs/images/devices/50045.jpg | Bin 2479 -> 0 bytes docs/images/devices/50049.jpg | Bin 6544 -> 0 bytes docs/images/devices/53170161.jpg | Bin 7353 -> 0 bytes docs/images/devices/7146060PH.jpg | Bin 4162 -> 0 bytes docs/images/devices/71831.jpg | Bin 2326 -> 0 bytes docs/images/devices/7199960PH.jpg | Bin 7034 -> 0 bytes docs/images/devices/72922-A.jpg | Bin 2692 -> 0 bytes docs/images/devices/7299355PH.jpg | Bin 6374 -> 0 bytes docs/images/devices/7299760PH.jpg | Bin 12534 -> 0 bytes docs/images/devices/73693.jpg | Bin 3808 -> 0 bytes docs/images/devices/73740.jpg | Bin 4141 -> 0 bytes docs/images/devices/73742.jpg | Bin 5183 -> 0 bytes docs/images/devices/74282.jpg | Bin 2732 -> 0 bytes docs/images/devices/74283.jpg | Bin 2000 -> 0 bytes docs/images/devices/74696.jpg | Bin 2714 -> 0 bytes docs/images/devices/81809.jpg | Bin 3560 -> 0 bytes docs/images/devices/8718696449691.jpg | Bin 2267 -> 0 bytes docs/images/devices/8718696485880.jpg | Bin 2984 -> 0 bytes docs/images/devices/8718696548738.jpg | Bin 2538 -> 0 bytes docs/images/devices/8718696598283.jpg | Bin 2632 -> 0 bytes docs/images/devices/8718696695203.jpg | Bin 2734 -> 0 bytes docs/images/devices/900008-WW.jpg | Bin 21090 -> 0 bytes docs/images/devices/915005106701.jpg | Bin 3322 -> 0 bytes docs/images/devices/915005733701.jpg | Bin 3041 -> 0 bytes docs/images/devices/9290002579A.jpg | Bin 2304 -> 0 bytes docs/images/devices/9290011370.jpg | Bin 2679 -> 0 bytes docs/images/devices/9290012573A.jpg | Bin 3455 -> 0 bytes docs/images/devices/9290012607.jpg | Bin 2446 -> 0 bytes docs/images/devices/A6121.jpg | Bin 11714 -> 0 bytes docs/images/devices/AA68199.jpg | Bin 2521 -> 0 bytes docs/images/devices/AA69697.jpg | Bin 2308 -> 0 bytes docs/images/devices/AA70155.jpg | Bin 7618 -> 0 bytes docs/images/devices/AB3257001NJ.jpg | Bin 2755 -> 0 bytes docs/images/devices/AB32840.jpg | Bin 3393 -> 0 bytes docs/images/devices/AB35996.jpg | Bin 2582 -> 0 bytes docs/images/devices/AB401130055.jpg | Bin 3554 -> 0 bytes docs/images/devices/AC01353010G.jpg | Bin 3293 -> 0 bytes docs/images/devices/AC0251100NJ.jpg | Bin 2041 -> 0 bytes docs/images/devices/AC03641.jpg | Bin 3456 -> 0 bytes docs/images/devices/AC03642.jpg | Bin 2479 -> 0 bytes docs/images/devices/AC03645.jpg | Bin 6943 -> 0 bytes docs/images/devices/AC03648.jpg | Bin 2896 -> 0 bytes docs/images/devices/AC03845.jpg | Bin 4023 -> 0 bytes docs/images/devices/AC08562.jpg | Bin 2350 -> 0 bytes docs/images/devices/AIRAM-CTR.U.jpg | Bin 9537 -> 0 bytes docs/images/devices/AV2010-22.jpg | Bin 2482 -> 0 bytes docs/images/devices/AV2010-25.jpg | Bin 2709 -> 0 bytes docs/images/devices/AV2010-32.jpg | Bin 8838 -> 0 bytes docs/images/devices/BY-165.jpg | Bin 2141 -> 0 bytes docs/images/devices/BY-185-C.jpg | Bin 2037 -> 0 bytes docs/images/devices/CC2530.ROUTER.jpg | Bin 8076 -> 0 bytes docs/images/devices/D1531.jpg | Bin 2331 -> 0 bytes docs/images/devices/D1532.jpg | Bin 7298 -> 0 bytes docs/images/devices/D1821.jpg | Bin 2752 -> 0 bytes docs/images/devices/DJT11LM.jpg | Bin 2217 -> 0 bytes docs/images/devices/DL-110-N.jpg | Bin 9980 -> 0 bytes docs/images/devices/DL-110-W.jpg | Bin 9980 -> 0 bytes docs/images/devices/DNCKATSW001.jpg | Bin 16374 -> 0 bytes docs/images/devices/DNCKATSW002.jpg | Bin 16374 -> 0 bytes docs/images/devices/DNCKATSW003.jpg | Bin 16374 -> 0 bytes docs/images/devices/DNCKATSW004.jpg | Bin 16374 -> 0 bytes docs/images/devices/E11-G13.jpg | Bin 2106 -> 0 bytes docs/images/devices/E11-G23-E11-G33.jpg | Bin 2862 -> 0 bytes docs/images/devices/E11-N1EA.jpg | Bin 7290 -> 0 bytes docs/images/devices/E12-N14.jpg | Bin 8221 -> 0 bytes docs/images/devices/E1524.jpg | Bin 14998 -> 0 bytes docs/images/devices/E1603.jpg | Bin 5801 -> 0 bytes docs/images/devices/E1ACA4ABE38A.jpg | Bin 3538 -> 0 bytes docs/images/devices/F7C033.jpg | Bin 2486 -> 0 bytes docs/images/devices/FB56+ZSW05HG1.2.jpg | Bin 10400 -> 0 bytes docs/images/devices/GD-CZ-006.jpg | Bin 5396 -> 0 bytes docs/images/devices/GL-B-007Z.jpg | Bin 6893 -> 0 bytes docs/images/devices/GL-B-008Z.jpg | Bin 10799 -> 0 bytes docs/images/devices/GL-C-006.jpg | Bin 9118 -> 0 bytes docs/images/devices/GL-C-008.jpg | Bin 5301 -> 0 bytes docs/images/devices/GL-D-003Z.jpg | Bin 15009 -> 0 bytes docs/images/devices/GL-S-003Z.jpg | Bin 13022 -> 0 bytes docs/images/devices/GL-S-007Z.jpg | Bin 16308 -> 0 bytes docs/images/devices/HALIGHTDIMWWB22.jpg | Bin 7077 -> 0 bytes docs/images/devices/HALIGHTDIMWWE27.jpg | Bin 5179 -> 0 bytes docs/images/devices/HGZB-01A.jpg | Bin 8466 -> 0 bytes docs/images/devices/HGZB-07A.jpg | Bin 3063 -> 0 bytes docs/images/devices/HGZB-20-DE.jpg | Bin 9342 -> 0 bytes docs/images/devices/HS1DS-E.jpg | Bin 26051 -> 0 bytes docs/images/devices/HS1DS.jpg | Bin 4960 -> 0 bytes docs/images/devices/HS1SA.jpg | Bin 3053 -> 0 bytes docs/images/devices/HS1WL.jpg | Bin 2661 -> 0 bytes docs/images/devices/HS3SA.jpg | Bin 13459 -> 0 bytes docs/images/devices/ICPSHC24-10EU-IL-1.jpg | Bin 7048 -> 0 bytes docs/images/devices/ICPSHC24-30EU-IL-1.jpg | Bin 7047 -> 0 bytes docs/images/devices/ICTC-G-1.jpg | Bin 1962 -> 0 bytes docs/images/devices/ICZB-IW11D.jpg | Bin 5007 -> 0 bytes docs/images/devices/JTQJ-BF-01LM-BW.jpg | Bin 7734 -> 0 bytes docs/images/devices/JTYJ-GD-01LM-BW.jpg | Bin 2706 -> 0 bytes docs/images/devices/K2RGBW01.jpg | Bin 3933 -> 0 bytes docs/images/devices/KS-SM001.jpg | Bin 3258 -> 0 bytes docs/images/devices/KTBL01LM.jpg | Bin 5986 -> 0 bytes docs/images/devices/KTBL02LM.jpg | Bin 2633 -> 0 bytes docs/images/devices/L1527.jpg | Bin 7054 -> 0 bytes docs/images/devices/L1528.jpg | Bin 6097 -> 0 bytes docs/images/devices/L1529.jpg | Bin 6497 -> 0 bytes docs/images/devices/L1531.jpg | Bin 2011 -> 0 bytes docs/images/devices/LED1536G5.jpg | Bin 2193 -> 0 bytes docs/images/devices/LED1537R6.jpg | Bin 3546 -> 0 bytes docs/images/devices/LED1545G12.jpg | Bin 2527 -> 0 bytes docs/images/devices/LED1546G12.jpg | Bin 2608 -> 0 bytes docs/images/devices/LED1622G12.jpg | Bin 2823 -> 0 bytes docs/images/devices/LED1623G12.jpg | Bin 2330 -> 0 bytes docs/images/devices/LED1624G9.jpg | Bin 2330 -> 0 bytes docs/images/devices/LED1649C5.1.jpg | Bin 2151 -> 0 bytes docs/images/devices/LED1649C5.jpg | Bin 2151 -> 0 bytes docs/images/devices/LED1650R5.jpg | Bin 4451 -> 0 bytes docs/images/devices/LTFY004.jpg | Bin 2629 -> 0 bytes docs/images/devices/MCCGQ01LM.jpg | Bin 2554 -> 0 bytes docs/images/devices/MCCGQ11LM.jpg | Bin 4365 -> 0 bytes docs/images/devices/MFKZQ01LM.jpg | Bin 7190 -> 0 bytes docs/images/devices/MG-AUWS01.jpg | Bin 2216 -> 0 bytes docs/images/devices/Mega23M12.jpg | Bin 6905 -> 0 bytes docs/images/devices/NL08-0800.jpg | Bin 3920 -> 0 bytes docs/images/devices/PL-110.jpg | Bin 9036 -> 0 bytes docs/images/devices/PLUG-EDP-RE-DY.jpg | Bin 13024 -> 0 bytes docs/images/devices/PSS-23ZBS.jpg | Bin 7463 -> 0 bytes docs/images/devices/QBCZ11LM.jpg | Bin 3240 -> 0 bytes docs/images/devices/QBKG03LM.jpg | Bin 1898 -> 0 bytes docs/images/devices/QBKG04LM.jpg | Bin 6785 -> 0 bytes docs/images/devices/QBKG11LM.jpg | Bin 6785 -> 0 bytes docs/images/devices/QBKG12LM.jpg | Bin 1898 -> 0 bytes docs/images/devices/RB-145.jpg | Bin 8895 -> 0 bytes docs/images/devices/RB-165.jpg | Bin 2829 -> 0 bytes docs/images/devices/RB-175-W.jpg | Bin 6422 -> 0 bytes docs/images/devices/RB-178-T.jpg | Bin 2481 -> 0 bytes docs/images/devices/RB-185-C.jpg | Bin 3213 -> 0 bytes docs/images/devices/RB-248-T.jpg | Bin 2287 -> 0 bytes docs/images/devices/RB-285-C.jpg | Bin 10233 -> 0 bytes docs/images/devices/RS-125.jpg | Bin 2733 -> 0 bytes docs/images/devices/RS-128-T.jpg | Bin 2258 -> 0 bytes docs/images/devices/RTCGQ01LM.jpg | Bin 4328 -> 0 bytes docs/images/devices/RTCGQ11LM.jpg | Bin 2110 -> 0 bytes docs/images/devices/SJCGQ11LM.jpg | Bin 2581 -> 0 bytes docs/images/devices/SL-110-M.jpg | Bin 3014 -> 0 bytes docs/images/devices/SL-110-N.jpg | Bin 3014 -> 0 bytes docs/images/devices/SL-110-W.jpg | Bin 3014 -> 0 bytes docs/images/devices/SP-120.jpg | Bin 2909 -> 0 bytes docs/images/devices/SP600.jpg | Bin 2520 -> 0 bytes docs/images/devices/ST-110.jpg | Bin 8824 -> 0 bytes docs/images/devices/STS-PRS-251.jpg | Bin 2354 -> 0 bytes docs/images/devices/STSS-MULT-001.jpg | Bin 3003 -> 0 bytes docs/images/devices/UC-110.jpg | Bin 8137 -> 0 bytes docs/images/devices/WSDCGQ01LM.jpg | Bin 2525 -> 0 bytes docs/images/devices/WSDCGQ11LM.jpg | Bin 1798 -> 0 bytes docs/images/devices/WXKG01LM.jpg | Bin 3376 -> 0 bytes docs/images/devices/WXKG02LM.jpg | Bin 2334 -> 0 bytes docs/images/devices/WXKG03LM.jpg | Bin 2719 -> 0 bytes docs/images/devices/WXKG11LM.jpg | Bin 8819 -> 0 bytes docs/images/devices/WXKG12LM.jpg | Bin 8819 -> 0 bytes docs/images/devices/XVV-Mega23M12.jpg | Bin 8782 -> 0 bytes docs/images/devices/Z01-A19NAE26.jpg | Bin 3469 -> 0 bytes docs/images/devices/Z01-CIA19NAE26.jpg | Bin 4330 -> 0 bytes docs/images/devices/Z809A.jpg | Bin 15914 -> 0 bytes docs/images/devices/ZCTS-808.jpg | Bin 7385 -> 0 bytes docs/images/devices/ZLED-2709.jpg | Bin 2742 -> 0 bytes docs/images/devices/ZNCLDJ11LM.jpg | Bin 4626 -> 0 bytes docs/images/devices/ZNCZ02LM.jpg | Bin 2491 -> 0 bytes docs/images/devices/ZNLDP12LM.jpg | Bin 4929 -> 0 bytes docs/images/devices/ZPIR-8000.jpg | Bin 8960 -> 0 bytes .../images/devices/ecozy_smart_thermostat.jpg | Bin 8274 -> 0 bytes docs/images/downloader_cable.png | Bin 14383 -> 0 bytes docs/images/enclosure.jpg | Bin 2876 -> 0 bytes docs/images/female_to_female_jumper_wires.jpg | Bin 3394 -> 0 bytes docs/images/home_assistant_change_name.png | Bin 26272 -> 0 bytes .../images/home_assistant_device_registry.png | Bin 42691 -> 0 bytes docs/images/logo.png | Bin 3702 -> 0 bytes docs/images/pi.jpg | Bin 2843 -> 0 bytes docs/images/power_cable.png | Bin 19317 -> 0 bytes docs/images/router_1.jpg | Bin 186169 -> 0 bytes docs/images/router_2.jpg | Bin 198541 -> 0 bytes docs/images/router_3.jpg | Bin 80963 -> 0 bytes docs/images/router_4.jpg | Bin 109212 -> 0 bytes docs/images/smartrf.png | Bin 370981 -> 0 bytes docs/images/usb_extension_cable.jpg | Bin 3188 -> 0 bytes docs/images/webee_cc2530_cc2591_pinlayout.png | Bin 105580 -> 0 bytes docs/images/wireshark_network_key.png | Bin 127717 -> 0 bytes docs/images/wireshark_packet.png | Bin 98128 -> 0 bytes docs/images/wireshark_tclink_key.png | Bin 19180 -> 0 bytes docs/images/xiaomi_sensors.jpg | Bin 2401 -> 0 bytes docs/index.md | 49 +- docs/information/3d_cases.md | 27 - docs/information/FAQ.md | 7 - .../alternative_flashing_methods.md | 125 - docs/information/binding.md | 15 - docs/information/cc_sniffer_devices.md | 26 - docs/information/docker.md | 50 - .../flashing_without_re-pairing.md | 23 - docs/information/groups.md | 39 - .../mqtt_topics_and_message_structure.md | 361 -- docs/information/supported_devices.md | 396 -- docs/information/virtual_environment.md | 116 - docs/information/zigbee_network.md | 34 - docs/integration/home_assistant.md | 3314 ----------------- test/docgen.test.js | 28 - test/images.test.js | 44 - 263 files changed, 1 insertion(+), 6087 deletions(-) delete mode 100644 docgen/docgen.js delete mode 100644 docgen/integrating-with-homeassistant.js delete mode 100644 docgen/supported-devices.js delete mode 100644 docs/configuration/configuration.md delete mode 100644 docs/configuration/device_specific_configuration.md delete mode 100644 docs/getting_started/flashing_the_cc2531.md delete mode 100644 docs/getting_started/pairing_devices.md delete mode 100644 docs/getting_started/running_zigbee2mqtt.md delete mode 100644 docs/getting_started/what_do_i_need.md delete mode 100644 docs/how_tos/how_to_connect_a_cc2530_coordinator_using_a_usb_to_serial_adapter.md delete mode 100644 docs/how_tos/how_to_create_a_cc2530_router.md delete mode 100644 docs/how_tos/how_to_debug.md delete mode 100644 docs/how_tos/how_to_esp8266_with_cc2530.md delete mode 100644 docs/how_tos/how_to_improve_network_range.md delete mode 100644 docs/how_tos/how_to_secure_network.md delete mode 100644 docs/how_tos/how_to_sniff_zigbee_husbzb.md delete mode 100644 docs/how_tos/how_to_sniff_zigbee_traffic.md delete mode 100644 docs/how_tos/how_to_support_new_devices.md delete mode 100644 docs/how_tos/how_to_support_new_devices_on_hassio.md delete mode 100644 docs/images/CP2102.png delete mode 100644 docs/images/E1524_group.png delete mode 100644 docs/images/HLK-PM03.jpg delete mode 100644 docs/images/cc2530.jpg delete mode 100644 docs/images/cc2530_cc2591.jpg delete mode 100644 docs/images/cc2530_pin_layout.png delete mode 100644 docs/images/cc2530_rfx2401.png delete mode 100644 docs/images/cc2530_router_enclosure.jpg delete mode 100644 docs/images/cc2531.jpg delete mode 100644 docs/images/cc_debugger.jpg delete mode 100644 docs/images/ccdebugger_cc2530.jpg delete mode 100644 docs/images/ccdebugger_pins.png delete mode 100644 docs/images/connected.jpg delete mode 100644 docs/images/devices/100.424.11.jpg delete mode 100644 docs/images/devices/1613V.jpg delete mode 100644 docs/images/devices/1TST-EU.jpg delete mode 100755 docs/images/devices/22670.jpg delete mode 100755 docs/images/devices/3210-L.jpg delete mode 100755 docs/images/devices/3216331P5.jpg delete mode 100644 docs/images/devices/3216431P5.jpg delete mode 100755 docs/images/devices/324131092621.jpg delete mode 100755 docs/images/devices/3261030P7.jpg delete mode 100644 docs/images/devices/3261331P7.jpg delete mode 100755 docs/images/devices/3320-L.jpg delete mode 100644 docs/images/devices/3321-S.jpg delete mode 100644 docs/images/devices/3325-S.jpg delete mode 100755 docs/images/devices/3326-L.jpg delete mode 100644 docs/images/devices/404000-404005-404012.jpg delete mode 100644 docs/images/devices/404006-404008-404004.jpg delete mode 100755 docs/images/devices/4052899926110.jpg delete mode 100755 docs/images/devices/4052899926158.jpg delete mode 100755 docs/images/devices/4058075036147.jpg delete mode 100755 docs/images/devices/4058075036185.jpg delete mode 100755 docs/images/devices/4058075816718.jpg delete mode 100755 docs/images/devices/4058075816794.jpg delete mode 100644 docs/images/devices/421786.jpg delete mode 100755 docs/images/devices/4256251-RZHAC.jpg delete mode 100755 docs/images/devices/433714.jpg delete mode 100755 docs/images/devices/45852GE.jpg delete mode 100644 docs/images/devices/45856GE.jpg delete mode 100755 docs/images/devices/45857GE.jpg delete mode 100644 docs/images/devices/464800.jpg delete mode 100644 docs/images/devices/4713407.jpg delete mode 100755 docs/images/devices/50045.jpg delete mode 100755 docs/images/devices/50049.jpg delete mode 100755 docs/images/devices/53170161.jpg delete mode 100755 docs/images/devices/7146060PH.jpg delete mode 100644 docs/images/devices/71831.jpg delete mode 100755 docs/images/devices/7199960PH.jpg delete mode 100755 docs/images/devices/72922-A.jpg delete mode 100755 docs/images/devices/7299355PH.jpg delete mode 100755 docs/images/devices/7299760PH.jpg delete mode 100755 docs/images/devices/73693.jpg delete mode 100755 docs/images/devices/73740.jpg delete mode 100755 docs/images/devices/73742.jpg delete mode 100755 docs/images/devices/74282.jpg delete mode 100755 docs/images/devices/74283.jpg delete mode 100755 docs/images/devices/74696.jpg delete mode 100644 docs/images/devices/81809.jpg delete mode 100755 docs/images/devices/8718696449691.jpg delete mode 100755 docs/images/devices/8718696485880.jpg delete mode 100755 docs/images/devices/8718696548738.jpg delete mode 100755 docs/images/devices/8718696598283.jpg delete mode 100755 docs/images/devices/8718696695203.jpg delete mode 100755 docs/images/devices/900008-WW.jpg delete mode 100755 docs/images/devices/915005106701.jpg delete mode 100755 docs/images/devices/915005733701.jpg delete mode 100755 docs/images/devices/9290002579A.jpg delete mode 100755 docs/images/devices/9290011370.jpg delete mode 100755 docs/images/devices/9290012573A.jpg delete mode 100755 docs/images/devices/9290012607.jpg delete mode 100755 docs/images/devices/A6121.jpg delete mode 100755 docs/images/devices/AA68199.jpg delete mode 100755 docs/images/devices/AA69697.jpg delete mode 100755 docs/images/devices/AA70155.jpg delete mode 100755 docs/images/devices/AB3257001NJ.jpg delete mode 100755 docs/images/devices/AB32840.jpg delete mode 100755 docs/images/devices/AB35996.jpg delete mode 100755 docs/images/devices/AB401130055.jpg delete mode 100755 docs/images/devices/AC01353010G.jpg delete mode 100644 docs/images/devices/AC0251100NJ.jpg delete mode 100755 docs/images/devices/AC03641.jpg delete mode 100755 docs/images/devices/AC03642.jpg delete mode 100755 docs/images/devices/AC03645.jpg delete mode 100644 docs/images/devices/AC03648.jpg delete mode 100755 docs/images/devices/AC03845.jpg delete mode 100755 docs/images/devices/AC08562.jpg delete mode 100644 docs/images/devices/AIRAM-CTR.U.jpg delete mode 100755 docs/images/devices/AV2010-22.jpg delete mode 100644 docs/images/devices/AV2010-25.jpg delete mode 100644 docs/images/devices/AV2010-32.jpg delete mode 100755 docs/images/devices/BY-165.jpg delete mode 100644 docs/images/devices/BY-185-C.jpg delete mode 100755 docs/images/devices/CC2530.ROUTER.jpg delete mode 100644 docs/images/devices/D1531.jpg delete mode 100644 docs/images/devices/D1532.jpg delete mode 100644 docs/images/devices/D1821.jpg delete mode 100755 docs/images/devices/DJT11LM.jpg delete mode 100755 docs/images/devices/DL-110-N.jpg delete mode 100755 docs/images/devices/DL-110-W.jpg delete mode 100755 docs/images/devices/DNCKATSW001.jpg delete mode 100755 docs/images/devices/DNCKATSW002.jpg delete mode 100755 docs/images/devices/DNCKATSW003.jpg delete mode 100755 docs/images/devices/DNCKATSW004.jpg delete mode 100755 docs/images/devices/E11-G13.jpg delete mode 100755 docs/images/devices/E11-G23-E11-G33.jpg delete mode 100755 docs/images/devices/E11-N1EA.jpg delete mode 100644 docs/images/devices/E12-N14.jpg delete mode 100644 docs/images/devices/E1524.jpg delete mode 100755 docs/images/devices/E1603.jpg delete mode 100644 docs/images/devices/E1ACA4ABE38A.jpg delete mode 100755 docs/images/devices/F7C033.jpg delete mode 100755 docs/images/devices/FB56+ZSW05HG1.2.jpg delete mode 100644 docs/images/devices/GD-CZ-006.jpg delete mode 100644 docs/images/devices/GL-B-007Z.jpg delete mode 100644 docs/images/devices/GL-B-008Z.jpg delete mode 100644 docs/images/devices/GL-C-006.jpg delete mode 100755 docs/images/devices/GL-C-008.jpg delete mode 100644 docs/images/devices/GL-D-003Z.jpg delete mode 100644 docs/images/devices/GL-S-003Z.jpg delete mode 100644 docs/images/devices/GL-S-007Z.jpg delete mode 100644 docs/images/devices/HALIGHTDIMWWB22.jpg delete mode 100755 docs/images/devices/HALIGHTDIMWWE27.jpg delete mode 100644 docs/images/devices/HGZB-01A.jpg delete mode 100644 docs/images/devices/HGZB-07A.jpg delete mode 100644 docs/images/devices/HGZB-20-DE.jpg delete mode 100644 docs/images/devices/HS1DS-E.jpg delete mode 100644 docs/images/devices/HS1DS.jpg delete mode 100755 docs/images/devices/HS1SA.jpg delete mode 100644 docs/images/devices/HS1WL.jpg delete mode 100644 docs/images/devices/HS3SA.jpg delete mode 100755 docs/images/devices/ICPSHC24-10EU-IL-1.jpg delete mode 100755 docs/images/devices/ICPSHC24-30EU-IL-1.jpg delete mode 100755 docs/images/devices/ICTC-G-1.jpg delete mode 100644 docs/images/devices/ICZB-IW11D.jpg delete mode 100755 docs/images/devices/JTQJ-BF-01LM-BW.jpg delete mode 100755 docs/images/devices/JTYJ-GD-01LM-BW.jpg delete mode 100755 docs/images/devices/K2RGBW01.jpg delete mode 100755 docs/images/devices/KS-SM001.jpg delete mode 100755 docs/images/devices/KTBL01LM.jpg delete mode 100755 docs/images/devices/KTBL02LM.jpg delete mode 100755 docs/images/devices/L1527.jpg delete mode 100755 docs/images/devices/L1528.jpg delete mode 100755 docs/images/devices/L1529.jpg delete mode 100644 docs/images/devices/L1531.jpg delete mode 100755 docs/images/devices/LED1536G5.jpg delete mode 100755 docs/images/devices/LED1537R6.jpg delete mode 100755 docs/images/devices/LED1545G12.jpg delete mode 100755 docs/images/devices/LED1546G12.jpg delete mode 100755 docs/images/devices/LED1622G12.jpg delete mode 100755 docs/images/devices/LED1623G12.jpg delete mode 100755 docs/images/devices/LED1624G9.jpg delete mode 100755 docs/images/devices/LED1649C5.1.jpg delete mode 100755 docs/images/devices/LED1649C5.jpg delete mode 100755 docs/images/devices/LED1650R5.jpg delete mode 100644 docs/images/devices/LTFY004.jpg delete mode 100755 docs/images/devices/MCCGQ01LM.jpg delete mode 100755 docs/images/devices/MCCGQ11LM.jpg delete mode 100755 docs/images/devices/MFKZQ01LM.jpg delete mode 100755 docs/images/devices/MG-AUWS01.jpg delete mode 100755 docs/images/devices/Mega23M12.jpg delete mode 100755 docs/images/devices/NL08-0800.jpg delete mode 100755 docs/images/devices/PL-110.jpg delete mode 100755 docs/images/devices/PLUG-EDP-RE-DY.jpg delete mode 100755 docs/images/devices/PSS-23ZBS.jpg delete mode 100755 docs/images/devices/QBCZ11LM.jpg delete mode 100755 docs/images/devices/QBKG03LM.jpg delete mode 100755 docs/images/devices/QBKG04LM.jpg delete mode 100755 docs/images/devices/QBKG11LM.jpg delete mode 100755 docs/images/devices/QBKG12LM.jpg delete mode 100755 docs/images/devices/RB-145.jpg delete mode 100755 docs/images/devices/RB-165.jpg delete mode 100755 docs/images/devices/RB-175-W.jpg delete mode 100644 docs/images/devices/RB-178-T.jpg delete mode 100755 docs/images/devices/RB-185-C.jpg delete mode 100644 docs/images/devices/RB-248-T.jpg delete mode 100755 docs/images/devices/RB-285-C.jpg delete mode 100755 docs/images/devices/RS-125.jpg delete mode 100755 docs/images/devices/RS-128-T.jpg delete mode 100755 docs/images/devices/RTCGQ01LM.jpg delete mode 100755 docs/images/devices/RTCGQ11LM.jpg delete mode 100755 docs/images/devices/SJCGQ11LM.jpg delete mode 100755 docs/images/devices/SL-110-M.jpg delete mode 100755 docs/images/devices/SL-110-N.jpg delete mode 100755 docs/images/devices/SL-110-W.jpg delete mode 100644 docs/images/devices/SP-120.jpg delete mode 100644 docs/images/devices/SP600.jpg delete mode 100755 docs/images/devices/ST-110.jpg delete mode 100755 docs/images/devices/STS-PRS-251.jpg delete mode 100755 docs/images/devices/STSS-MULT-001.jpg delete mode 100755 docs/images/devices/UC-110.jpg delete mode 100755 docs/images/devices/WSDCGQ01LM.jpg delete mode 100755 docs/images/devices/WSDCGQ11LM.jpg delete mode 100755 docs/images/devices/WXKG01LM.jpg delete mode 100755 docs/images/devices/WXKG02LM.jpg delete mode 100755 docs/images/devices/WXKG03LM.jpg delete mode 100755 docs/images/devices/WXKG11LM.jpg delete mode 100755 docs/images/devices/WXKG12LM.jpg delete mode 100644 docs/images/devices/XVV-Mega23M12.jpg delete mode 100755 docs/images/devices/Z01-A19NAE26.jpg delete mode 100755 docs/images/devices/Z01-CIA19NAE26.jpg delete mode 100755 docs/images/devices/Z809A.jpg delete mode 100644 docs/images/devices/ZCTS-808.jpg delete mode 100755 docs/images/devices/ZLED-2709.jpg delete mode 100644 docs/images/devices/ZNCLDJ11LM.jpg delete mode 100755 docs/images/devices/ZNCZ02LM.jpg delete mode 100644 docs/images/devices/ZNLDP12LM.jpg delete mode 100644 docs/images/devices/ZPIR-8000.jpg delete mode 100644 docs/images/devices/ecozy_smart_thermostat.jpg delete mode 100644 docs/images/downloader_cable.png delete mode 100644 docs/images/enclosure.jpg delete mode 100644 docs/images/female_to_female_jumper_wires.jpg delete mode 100644 docs/images/home_assistant_change_name.png delete mode 100644 docs/images/home_assistant_device_registry.png delete mode 100644 docs/images/logo.png delete mode 100644 docs/images/pi.jpg delete mode 100644 docs/images/power_cable.png delete mode 100644 docs/images/router_1.jpg delete mode 100644 docs/images/router_2.jpg delete mode 100644 docs/images/router_3.jpg delete mode 100644 docs/images/router_4.jpg delete mode 100644 docs/images/smartrf.png delete mode 100644 docs/images/usb_extension_cable.jpg delete mode 100644 docs/images/webee_cc2530_cc2591_pinlayout.png delete mode 100644 docs/images/wireshark_network_key.png delete mode 100644 docs/images/wireshark_packet.png delete mode 100644 docs/images/wireshark_tclink_key.png delete mode 100644 docs/images/xiaomi_sensors.jpg delete mode 100644 docs/information/3d_cases.md delete mode 100644 docs/information/FAQ.md delete mode 100644 docs/information/alternative_flashing_methods.md delete mode 100644 docs/information/binding.md delete mode 100644 docs/information/cc_sniffer_devices.md delete mode 100644 docs/information/docker.md delete mode 100644 docs/information/flashing_without_re-pairing.md delete mode 100644 docs/information/groups.md delete mode 100644 docs/information/mqtt_topics_and_message_structure.md delete mode 100644 docs/information/supported_devices.md delete mode 100644 docs/information/virtual_environment.md delete mode 100644 docs/information/zigbee_network.md delete mode 100644 docs/integration/home_assistant.md delete mode 100644 test/docgen.test.js delete mode 100644 test/images.test.js diff --git a/docgen/docgen.js b/docgen/docgen.js deleted file mode 100644 index 64b84b3ea..000000000 --- a/docgen/docgen.js +++ /dev/null @@ -1,10 +0,0 @@ -const fs = require('fs'); -const path = require('path'); - -const base = path.join(__dirname, '..', 'docs'); - -const supportDevices = require('./supported-devices'); -const integratingWithHomeassistant = require('./integrating-with-homeassistant'); - -fs.writeFileSync(path.join(base, 'information', 'supported_devices.md'), supportDevices); -fs.writeFileSync(path.join(base, 'integration', 'home_assistant.md'), integratingWithHomeassistant); diff --git a/docgen/integrating-with-homeassistant.js b/docgen/integrating-with-homeassistant.js deleted file mode 100644 index eca249efd..000000000 --- a/docgen/integrating-with-homeassistant.js +++ /dev/null @@ -1,299 +0,0 @@ -/** - * This script generates the integrating-with-homeassistant page. - */ - -const devices = require('zigbee-shepherd-converters').devices; -const HomeassistantExtension = require('../lib/extension/homeassistant'); -const homeassistant = new HomeassistantExtension(null, null, null, null); -const YAML = require('json2yaml'); - -let template = `# Home Assistant - -*NOTE 1: This file has been generated, do not edit this file manually!* - -*NOTE 2: If you are using the [Zigbee2mqtt Hass.io add-on](https://github.com/danielwelch/hassio-zigbee2mqtt) -use their documentation* - - -## MQTT discovery -**At least Home Assistant >= 0.84 is required!** - -**NOTE:** Groups are not auto-discovered, see configuration below. - -The easiest way to integrate Zigbee2mqtt with Home Assistant is by -using [MQTT discovery](https://www.home-assistant.io/docs/mqtt/discovery/). -This allows Zigbee2mqtt to automatically add devices to Home Assistant. - -To achieve the best possible integration (including MQTT discovery): -- In your **Zigbee2mqtt** \`configuration.yaml\` set \`homeassistant: true\` -- In your **Home Assistant** \`configuration.yaml\`: -\`\`\`yaml -mqtt: - discovery: true - broker: [YOUR MQTT BROKER] # Remove if you want to use builtin-in MQTT broker - birth_message: - topic: 'hass/status' - payload: 'online' - will_message: - topic: 'hass/status' - payload: 'offline' -\`\`\` - -Mind you that if you want to use the embedded broker of Home Assistant you -have to [follow this guide](https://www.home-assistant.io/docs/mqtt/broker#embedded-broker). - -Zigbee2mqtt is expecting Home Assistant to send it's birth/will -messages to \`hass/status\`. Be sure to add this to your \`configuration.yaml\` if you want -Zigbee2mqtt to resend the cached values when Home Assistant restarts - -## Home Assistant device registry -When using Home Assistant MQTT discovery, Zigbee2mqtt integrates -with the [Home Assistant device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). -This allows you to change the Home Assistant \`device_id\` and \`friendly_name\` from the web interface -without having to restart Home Assistant. It also makes it possible to show which entities belong to which device. - -![Changing name and device ID via web interface](../images/home_assistant_change_name.png) - -![Device registry](../images/home_assistant_device_registry.png) - -## I'm confused about the different device IDs, names and friendly names -- Home Assistant \`device_id\`: determined on first discovery of the device, can only be changed -via the Home Assistant web interface afterwards. Used to control/read the state from the device (e.g. in automations) -- Zigbee2mqtt \`friendly_name\`: used to change the MQTT topic where the device listens and publishes to. -- Home Assistant \`name\`: name shown in the Home Assistant UI (unless overridden -via a \`friendly_name\` in \`customize.yaml\`). If not changed via the Home Assistant web interface, -it is equal to the Zigbee2mqtt \`friendly_name\`. Is updated if the Zigbee2mqtt \`friendly_name\` changes -(requires restart of Home Assistant) -- Home Assistant \`friendly_name\` (\`customize.yaml\`): overrides the name in the Home Assistant web interface. - -## Responding to button clicks -To respond to button clicks (e.g. WXKG01LM) you can use the following Home Assistant configuration: - -{% raw %} -\`\`\`yaml -automation: - - alias: Respond to button clicks - trigger: - platform: mqtt - topic: 'zigbee2mqtt/