dandri/zigbee2mqtt
1
0
Fork 0
mirror of https://github.com/Koenkk/zigbee2mqtt.git synced 2026-08-28 05:24:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Cleanup references to wiki.

Browse Source
This commit is contained in:
Koen Kanters
2018-12-14 19:37:57 +01:00
parent 1f2d3ec850
commit ec20bfdd15
13 changed files with 17 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/ISSUE_TEMPLATE.md
+2 -2
View File
@@ -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/.
.travis.yml
-1
View File
@@ -17,7 +17,6 @@ before_script:
script:
- ".travis/docker.sh"
- ".travis/wiki.sh"
- ".travis/trigger-downstream.sh"
env:
.travis/wiki.sh
-28
View File
@@ -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
docgen/supported-devices.js
+1 -1
View File
@@ -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]
`;
docs/getting_started/what_do_i_need.md
+1 -1
View File
@@ -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?
docs/how_tos/how_to_support_new_devices.md
+5 -5
View File
@@ -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).
},
docs/how_tos/how_to_support_new_devices_on_hassio.md
+1 -1
View File
@@ -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)
docs/information/mqtt_topics_and_message_structure.md
+1 -1
View File
@@ -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.
docs/information/supported_devices.md
+1 -1
View File
@@ -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
lib/extension/devicePublish.js
+1 -1
View File
@@ -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;
}
lib/extension/deviceReceive.js
+2 -2
View File
@@ -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;
}
lib/util/settings.js
+1 -1
View File
@@ -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,
},
package.json
+1 -1
View File
@@ -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": "*",