diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index b91c5f9db..6e71cdf59 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,5 +1,5 @@ Unsupported device -First check: https://github.com/Koenkk/zigbee2mqtt/wiki/How-to-support-new-devices +First check: https://koenkk.github.io/zigbee2mqtt/how_tos/how_to_support_new_devices.html Bug report @@ -7,5 +7,5 @@ Bug report - Make sure you are running the latest CC253X firmware from https://github.com/koenkk/z-stack-firmware. - Provide a clear description of the problem. - If applicable, provide steps how to reproduce the problem. -- Provide a log with `log_level` set to `debug`, see https://github.com/Koenkk/zigbee2mqtt/wiki/Configuration +- Provide a log with `log_level` set to `debug`, see https://koenkk.github.io/zigbee2mqtt/configuration/configuration.html - DON'T copy logs directly here, post a link to https://hastebin.com/ or https://pastebin.com/. diff --git a/.travis.yml b/.travis.yml index daa91ae9a..ae9fe3945 100644 --- a/.travis.yml +++ b/.travis.yml @@ -17,7 +17,6 @@ before_script: script: - ".travis/docker.sh" - - ".travis/wiki.sh" - ".travis/trigger-downstream.sh" env: diff --git a/.travis/wiki.sh b/.travis/wiki.sh deleted file mode 100755 index a2039f14e..000000000 --- a/.travis/wiki.sh +++ /dev/null @@ -1,28 +0,0 @@ -#!/bin/sh -e - -setup_git() { - git config --global user.email "travis@travis-ci.org" - git config --global user.name "Travis CI" -} - -update_wiki() { - rm -rf zigbee2mqtt.wiki - git clone https://${GH_TOKEN}@github.com/Koenkk/zigbee2mqtt.wiki.git - npm run docgen zigbee2mqtt.wiki - cd zigbee2mqtt.wiki - git add -A - git diff-index --quiet HEAD || git commit -m "Travis CI: update wiki" - git push origin - cd .. - rm -rf zigbee2mqtt.wiki -} - -# Only update wiki if on master branch and not pull request -if [ "$TRAVIS_BRANCH" = "master" -a "$TRAVIS_PULL_REQUEST" = "false" ] -then - echo "Updating wiki!" - setup_git - update_wiki -else - echo "Not updating wiki, triggered by pull request or not on master branch" -fi diff --git a/docgen/supported-devices.js b/docgen/supported-devices.js index 1fec99ff2..bd6f7aa1f 100644 --- a/docgen/supported-devices.js +++ b/docgen/supported-devices.js @@ -19,7 +19,7 @@ let template = `# Supported devices Currently **${devices.length}** devices are supported from **${vendorsCount}** different vendors. In case you own a Zigbee device which is **NOT** listed here, please see -[How to support new devices](https://github.com/Koenkk/zigbee2mqtt/wiki/How-to-support-new-devices). +[How to support new devices](https://koenkk.github.io/zigbee2mqtt/how_tos/how_to_support_new_devices.html). [DEVICES] `; diff --git a/docs/getting_started/what_do_i_need.md b/docs/getting_started/what_do_i_need.md index 8530b7282..7cd9ba630 100644 --- a/docs/getting_started/what_do_i_need.md +++ b/docs/getting_started/what_do_i_need.md @@ -6,7 +6,7 @@ In order to run zigbee2mqtt we need the following hardware: | CC debugger | +-10$ on AliExpress | ![CC debugger](../images/cc_debugger.jpg) | | CC2531 USB sniffer | +-8.50$ on AliExpress | ![CC2531 USB sniffer](../images/cc2531.jpg) | | Downloader cable CC2531 | +-2$ on AliExpress | ![Downloader cable CC2531](../images/downloader_cable.png) | -| [Supported Zigbee device(s)](https://github.com/Koenkk/zigbee2mqtt/wiki/Supported-devices) | - | ![Zigbee devices](../images/xiaomi_sensors.jpg) | +| [Supported Zigbee device(s)](https://koenkk.github.io/zigbee2mqtt/information/supported_devices.html) | - | ![Zigbee devices](../images/xiaomi_sensors.jpg) | | PC or Raspberry Pi to run bridge | - | ![Raspberry Pi](../images/pi.jpg) | # What's next? diff --git a/docs/how_tos/how_to_support_new_devices.md b/docs/how_tos/how_to_support_new_devices.md index fb3dc1c2e..3b8ae4892 100644 --- a/docs/how_tos/how_to_support_new_devices.md +++ b/docs/how_tos/how_to_support_new_devices.md @@ -7,13 +7,13 @@ This page will guide you through the process of adding support for new devices t In case you require any help feel free to create an [issue](https://github.com/Koenkk/zigbee2mqtt/issues). ## 1. Pairing the device with Zigbee2mqtt -The first step is to pair the device with zigbee2mqtt. It should be possible to pair your unsupported device out of the box because zigbee2mqtt can pair with any zigbee device. You need to find out how to bring your device into pairing mode, most of the times via a factory reset. For some vendors this is already documented [here](https://github.com/Koenkk/zigbee2mqtt/wiki/Pairing-devices). +The first step is to pair the device with zigbee2mqtt. It should be possible to pair your unsupported device out of the box because zigbee2mqtt can pair with any zigbee device. You need to find out how to bring your device into pairing mode, most of the times via a factory reset. For some vendors this is already documented [here](https://koenkk.github.io/zigbee2mqtt/getting_started/pairing_devices.html). Once you successfully paired the device you will see something like: ``` 2018-5-1 18:06:41 INFO New device with address 0x00158d0001b79111 connected! 2018-5-1 18:06:42 WARN Device with modelID 'lumi.sens' is not supported. -2018-5-1 18:06:42 WARN Please see: https://github.com/Koenkk/zigbee2mqtt/wiki/How-to-support-new-devices +2018-5-1 18:06:42 WARN Please see: https://koenkk.github.io/zigbee2mqtt/how_tos/how_to_support_new_devices.html ``` *NOTE: Make sure that `permit_join: true` is set in `configuration.yaml` otherwise new devices cannot join the network.* @@ -24,9 +24,9 @@ The next step is the to add an entry of your device to `node_modules/zigbee-shep { zigbeeModel: ['lumi.sens'], // The model ID from: Device with modelID 'lumi.sens' is not supported. model: 'WSDCGQ01LM', // Vendor model number, look on the device for a model number - vendor: 'Xiaomi', // Vendor of the device (only used for wiki and startup logging) - description: 'MiJia temperature & humidity sensor ', // Description of the device, copy from vendor site. (only used for wiki and startup logging) - supports: 'temperature and humidity', // Actions this device supports (only used for wiki) + vendor: 'Xiaomi', // Vendor of the device (only used for documentation and startup logging) + description: 'MiJia temperature & humidity sensor ', // Description of the device, copy from vendor site. (only used for documentation and startup logging) + supports: 'temperature and humidity', // Actions this device supports (only used for documentation) fromZigbee: [], // We will add this later toZigbee: [], // Should be empty, unless device can be controlled (e.g. lights, switches). }, diff --git a/docs/how_tos/how_to_support_new_devices_on_hassio.md b/docs/how_tos/how_to_support_new_devices_on_hassio.md index b0f1d9eef..e98971dba 100644 --- a/docs/how_tos/how_to_support_new_devices_on_hassio.md +++ b/docs/how_tos/how_to_support_new_devices_on_hassio.md @@ -16,7 +16,7 @@ example:**622baa375aa1** `docker exec -it 622baa375aa1 bash` 5. You are now inside the zigbee2mqtt container and can follow the standard guide:\ -[https://github.com/Koenkk/zigbee2mqtt/wiki/How-to-support-new-devices](https://github.com/Koenkk/zigbee2mqtt/wiki/How-to-support-new-devices) +[https://koenkk.github.io/zigbee2mqtt/how_tos/how_to_support_new_devices.html](https://koenkk.github.io/zigbee2mqtt/how_tos/how_to_support_new_devices.html) 6. The VI editor is installed on the image, if you are not familiar with VI you may want take a look here: [https://www.guru99.com/the-vi-editor.html](https://www.guru99.com/the-vi-editor.html) diff --git a/docs/information/mqtt_topics_and_message_structure.md b/docs/information/mqtt_topics_and_message_structure.md index 8de85d4be..18153a48b 100644 --- a/docs/information/mqtt_topics_and_message_structure.md +++ b/docs/information/mqtt_topics_and_message_structure.md @@ -23,7 +23,7 @@ Allows you to permit joining of new devices via MQTT. This is not persistent (wi Allows you to switch the `log_level` during runtime. This is not persistent (will not be saved to `configuration.yaml`). Possible payloads are: `"debug"`, `"info"`, `"warn"`, `"error"`. ## zigbee2mqtt/bridge/config/remove -Allows you to remove devices from the network. Payload should be the `friendly_name`, e.g. `0x00158d0001b79111`. On successful remove a [`device_removed`](https://github.com/Koenkk/zigbee2mqtt/wiki/MQTT-topics-and-message-structure#zigbee2mqttbridgelog) message is send. +Allows you to remove devices from the network. Payload should be the `friendly_name`, e.g. `0x00158d0001b79111`. On successful remove a [`device_removed`](https://koenkk.github.io/zigbee2mqtt/information/mqtt_topics_and_message_structure.html#zigbee2mqttbridgelog) message is send. ## zigbee2mqtt/bridge/config/rename Allows you to change the `friendly_name` of a device on the fly. diff --git a/docs/information/supported_devices.md b/docs/information/supported_devices.md index 29b8515ae..495a5aa32 100644 --- a/docs/information/supported_devices.md +++ b/docs/information/supported_devices.md @@ -5,7 +5,7 @@ Currently **137** devices are supported from **29** different vendors. In case you own a Zigbee device which is **NOT** listed here, please see -[How to support new devices](https://github.com/Koenkk/zigbee2mqtt/wiki/How-to-support-new-devices). +[How to support new devices](https://koenkk.github.io/zigbee2mqtt/how_tos/how_to_support_new_devices.html). ### Belkin diff --git a/lib/extension/devicePublish.js b/lib/extension/devicePublish.js index 30c196149..de0227077 100644 --- a/lib/extension/devicePublish.js +++ b/lib/extension/devicePublish.js @@ -87,7 +87,7 @@ class DevicePublish { const model = zigbeeShepherdConverters.findByZigbeeModel(device.modelId); if (!model) { logger.warn(`Device with modelID '${device.modelId}' is not supported.`); - logger.warn(`Please see: https://github.com/Koenkk/zigbee2mqtt/wiki/How-to-support-new-devices`); + logger.warn(`Please see: https://koenkk.github.io/zigbee2mqtt/how_tos/how_to_support_new_devices.html`); return; } diff --git a/lib/extension/deviceReceive.js b/lib/extension/deviceReceive.js index debda5313..0f34f8cd8 100644 --- a/lib/extension/deviceReceive.js +++ b/lib/extension/deviceReceive.js @@ -39,7 +39,7 @@ class DeviceReceive { if (!mappedDevice) { logger.warn(`Device with modelID '${device.modelId}' is not supported.`); - logger.warn(`Please see: https://github.com/Koenkk/zigbee2mqtt/wiki/How-to-support-new-devices`); + logger.warn(`Please see: https://koenkk.github.io/zigbee2mqtt/how_tos/how_to_support_new_devices.html`); return; } @@ -75,7 +75,7 @@ class DeviceReceive { ); } - logger.warn(`Please see: https://github.com/Koenkk/zigbee2mqtt/wiki/How-to-support-new-devices.`); + logger.warn(`Please see: https://koenkk.github.io/zigbee2mqtt/how_tos/how_to_support_new_devices.html.`); return; } diff --git a/lib/util/settings.js b/lib/util/settings.js index 6011f2bcc..29181eacc 100644 --- a/lib/util/settings.js +++ b/lib/util/settings.js @@ -25,7 +25,7 @@ const defaults = { * * Therefore zigbee2mqtt BY DEFAULT caches all values and resend it with every message. * advanced.cache_state in configuration.yaml allows to configure this. - * https://github.com/Koenkk/zigbee2mqtt/wiki/Configuration + * https://koenkk.github.io/zigbee2mqtt/configuration/configuration.html */ cache_state: true, }, diff --git a/package.json b/package.json index d6608a464..c3fa756ed 100644 --- a/package.json +++ b/package.json @@ -31,7 +31,7 @@ "bugs": { "url": "https://github.com/Koenkk/zigbee2mqtt/issues" }, - "homepage": "https://github.com/Koenkk/zigbee2mqtt/wiki", + "homepage": "https://koenkk.github.io/zigbee2mqtt", "dependencies": { "git-last-commit": "*", "js-yaml": "*",