Skip to content

Commit

Permalink
fix(typo): docs/guide (#2239)
Browse files Browse the repository at this point in the history
  • Loading branch information
Rotzbua authored Oct 2, 2023
1 parent ce928f1 commit 62ed251
Show file tree
Hide file tree
Showing 14 changed files with 22 additions and 22 deletions.
10 changes: 5 additions & 5 deletions docs/guide/adapters/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ _(in order of first appearance)_
* <details>
<summary>ZigStar Stick v4</summary>

Powerfull Open source dongle with external antenna based on CC2652P
Powerful Open source dongle with external antenna based on CC2652P
* [Coordinator firmware](https://github.com/Koenkk/Z-Stack-firmware/raw/Z-Stack_3.x.0_coordinator_20230507/coordinator/Z-Stack_3.x.0/bin/CC1352P2_CC2652P_launchpad_coordinator_20230507.zip)
* [Router firmware](https://github.com/Koenkk/Z-Stack-firmware/raw/Z-Stack_3.x.0_router_20221102/router/Z-Stack_3.x.0/bin/CC1352P2_CC2652P_launchpad_router_20221102.zip)
* [Description](https://zig-star.com/projects/zigbee-stick-v4/)
Expand Down Expand Up @@ -151,7 +151,7 @@ _(in order of first appearance)_
* <details>
<summary>ZigStar LAN Coordinator</summary>

Powerfull Open source LAN Coordinator with external antenna on CC2652P
Powerful Open source LAN Coordinator with external antenna on CC2652P
* [Coordinator firmware](https://github.com/Koenkk/Z-Stack-firmware/raw/Z-Stack_3.x.0_coordinator_20230507/coordinator/Z-Stack_3.x.0/bin/CC1352P2_CC2652P_launchpad_coordinator_20230507.zip)
* [Router firmware](https://github.com/Koenkk/Z-Stack-firmware/raw/Z-Stack_3.x.0_router_20221102/router/Z-Stack_3.x.0/bin/CC1352P2_CC2652P_launchpad_router_20221102.zip)
* [Description](https://zig-star.com/projects/zigbee-gw-lan/)
Expand All @@ -177,7 +177,7 @@ _(in order of first appearance)_
* <details>
<summary>SMLIGHT SLZB-06 Zigbee Ethernet USB POE WiFi LAN adapter</summary>

Powerfull, tiny modern design, developed for Zigbee2MQTT, PoE supported, pre-flashed and ready to use Zigbee adapter. Supports Zigbee 3.0, Ethernet, LAN, USB and WiFi connections. Rich packing that includes SLZB-06 adapter, +5dB antenna, screws, adhesive tapes, screwdriver, microUSB-typeC adapter, screw-fix-helper and QR-manual. Distant update, modern UI open-source firmware. Optoelectronic isolation for Ethernet, LEDs and physical button for interacting with user. Fits home and business use.
Powerful, tiny modern design, developed for Zigbee2MQTT, PoE supported, pre-flashed and ready to use Zigbee adapter. Supports Zigbee 3.0, Ethernet, LAN, USB and WiFi connections. Rich packing that includes SLZB-06 adapter, +5dB antenna, screws, adhesive tapes, screwdriver, microUSB-typeC adapter, screw-fix-helper and QR-manual. Distant update, modern UI open-source firmware. Optoelectronic isolation for Ethernet, LEDs and physical button for interacting with user. Fits home and business use.
* [Coordinator firmware (CC2652P)](https://github.com/Koenkk/Z-Stack-firmware/raw/Z-Stack_3.x.0_coordinator_20230507/coordinator/Z-Stack_3.x.0/bin/CC1352P2_CC2652P_other_coordinator_20230507.zip)
* [ESP32 firmware](https://github.com/smlight-dev/slzb-06-firmware/)
* [Manual](https://smlight.tech/manual/slzb-06/)
Expand Down Expand Up @@ -280,7 +280,7 @@ _(in order of first appearance)_
* <details>
<summary>ZigStar ZigiHAT PoE </summary>

Powerfull Open source Pi HAT based on CC2652P with PoE,RTC onboard
Powerful Open source Pi HAT based on CC2652P with PoE,RTC onboard
* [Coordinator firmware](https://github.com/Koenkk/Z-Stack-firmware/raw/Z-Stack_3.x.0_coordinator_20230507/coordinator/Z-Stack_3.x.0/bin/CC1352P2_CC2652P_launchpad_coordinator_20230507.zip)
* [Router firmware](https://github.com/Koenkk/Z-Stack-firmware/raw/Z-Stack_3.x.0_router_20221102/router/Z-Stack_3.x.0/bin/CC1352P2_CC2652P_launchpad_router_20221102.zip)
* [Description](https://zig-star.com/projects/zigbee-zigihat/)
Expand Down Expand Up @@ -526,7 +526,7 @@ Initial development started on experimental (beta stage) support for Silicon Lab

USB dongle is originally a DIY design from [Modkam (Russian speaking Zigbee DIY community)](https://modkam.ru/2021/02/28/proshivka-stikov-efr32/) and it using pre-flashed ["SM-011 V1.0" (ZYZBP008) radio module from CoolKit-Technologies](https://github.com/CoolKit-Technologies/DevDocs/tree/master/Zigbee) (which has a Silabs EFR32MG21 Zigbee SoC chip on it).

Warning! Before buying understand that the "SM-011 V1.0" module/board used in this is missing electromagnetic interference shielding and have relativly low-quality circuit board antenna with less than optimal hardware tuning so it has been reported signal reception with these is very sensitive to all types of interference unless connect it via a very long USB extension cable that is properly shielded to get it away from any sources of EMF/EMI/RMI.
Warning! Before buying understand that the "SM-011 V1.0" module/board used in this is missing electromagnetic interference shielding and have relatively low-quality circuit board antenna with less than optimal hardware tuning so it has been reported signal reception with these is very sensitive to all types of interference unless connect it via a very long USB extension cable that is properly shielded to get it away from any sources of EMF/EMI/RMI.

Note that the same USB dongle is also sold pre-flashed with Zigbee Router firmware as a lower price and it is reported to act much better as a Zigbee Router than what it does as a Zigbee Coordinator.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ int LED = 2; //GPIO2=D4 and the Blue LED on the WeMos D1 Mini and the ESP-12E mo

![](https://www.waveshare.com/img/devkit/CC-Debugger/CC-Debugger-JTAG-Header.jpg)

If you have a 3.3V Arduino you can optionaly connect `3.3V -> Target Voltage Sense (Pin 2)` and program the CC2531 without connecting the CC2531 to USB (in the next step).
If you have a 3.3V Arduino you can optionally connect `3.3V -> Target Voltage Sense (Pin 2)` and program the CC2531 without connecting the CC2531 to USB (in the next step).

Connect the ESP8266 pins as described below to the debug header of the CC device

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/adapters/flashing/connecting_cc2530.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Wire the CC2530 to the ESP8266 using the following scheme:
| GND | P05 |

### Option 1 - Flashing the ESP8266 with ESPEasy
The ESP8266 needs to be flashed with ESPEasy. ESPEasy has suficient documentation on how to get you up and running:
The ESP8266 needs to be flashed with ESPEasy. ESPEasy has sufficient documentation on how to get you up and running:
- [How to flash the ESP8266 with ESPEasy](https://www.letscontrolit.com/wiki/index.php?title=Tutorial_ESPEasy_Firmware_Upload)
- ESP8266 firmware: [ESP_Easy_mega-XXXXXXXX_normal_ESP8266_4096.bin](https://github.com/letscontrolit/ESPEasy/releases)
- [More information about ESPEasy](https://www.letscontrolit.com/wiki/index.php/ESPEasy#Introduction)
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/adapters/flashing/flashing_via_cc2538-bsl.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ sudo python3 cc2538-bsl.py -ewv -p /dev/ttyUSB0 --bootloader-sonoff-usb ./CC1352
```
`-ewv` means Mass **e**rase, **w**rite, **v**erify
`-p` is the port on which your device is running, in this case `/dev/ttyUSB0`
`--bootloader-sonoff-usb` means that the bootloader is activated by the script, by toggeling RTS and DTR in the correct pattern for Sonoff USB dongle (remove this if your device is not a Sonoff dongle).
`--bootloader-sonoff-usb` means that the bootloader is activated by the script, by toggling RTS and DTR in the correct pattern for Sonoff USB dongle (remove this if your device is not a Sonoff dongle).

If the flash process was successfully done, an output like this appears:
```
Expand Down
4 changes: 2 additions & 2 deletions docs/guide/configuration/device-availability.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ availability:
devices:
'0x12345678':
friendly_name: 'my_bulb'
# Set availablility: false to disable the availability feature for a specific device
# Set availability: false to disable the availability feature for a specific device
availability: false
'0x87654321':
friendly_name: 'my_switch'
# Change availibity timeout to 3 minutes for this device only
# Change availability timeout to 3 minutes for this device only
availability:
timeout: 3
```
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/configuration/frontend.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebarDepth: 1
Ongoing discussion about the frontend can be found [here](https://github.com/Koenkk/zigbee2mqtt/issues/4266)
:::

Zigbee2MQTT has a built-in webbased frontend.
Zigbee2MQTT has a built-in web-based frontend.

![Frontend](../../images/frontend.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/configuration/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ advanced:
log_file: log.txt
# Optional: Rotate log every 10MB around 3 files (default: true)
log_rotation: true
# Optional: Output location of the log (default: shown below), leave empty to supress logging (log_output: [])
# Optional: Output location of the log (default: shown below), leave empty to suppress logging (log_output: [])
# possible options: 'console', 'file', 'syslog'
log_output:
- console
Expand Down
4 changes: 2 additions & 2 deletions docs/guide/faq/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Migration from one adapter to another requires backup and restore support which
1. Stop Zigbee2MQTT
1. Determine whether migrating [requires re-pairing of your devices](#what-does-and-does-not-require-repairing-of-all-devices)
- If re-pairing is required: remove `data/coordinator_backup.json` (if it exists) and `data/database.db`
- If re-pairing is **not** required: [copy the ieee address of the old adpter into the new one](../adapters/flashing/copy_ieeaddr.html)
- If re-pairing is **not** required: [copy the ieee address of the old adapter into the new one](../adapters/flashing/copy_ieeaddr.html)
1. Update the `serial` -> `port` in your `configuration.yaml`
1. Start Zigbee2MQTT
- If re-pairing was required:
Expand Down Expand Up @@ -108,7 +108,7 @@ If after some uptime Zigbee2MQTT crashes with errors like: `SRSP - AF - dataRequ
- Normally this can be fixed by replugging the adapter and restarting Zigbee2MQTT
- If you are using a CC2530 or CC2531 adapter consider upgrading to one of the [recommended adapters](../adapters/README.md). The CC2530/CC2531 is considered legacy hardware and runs into memory corruption easily.
- Make sure you are using the latest firmware on your adapter, see the [adapter page](../adapters/README.md) for a link to the latest firmware.
- If using a Raspberry Pi; this problem can occur if you are using a bad power supply or when other USB devices are connected direclty to the Pi (especially occurs with external SSD), try connecting other USB devices through a powered USB hub.
- If using a Raspberry Pi; this problem can occur if you are using a bad power supply or when other USB devices are connected directly to the Pi (especially occurs with external SSD), try connecting other USB devices through a powered USB hub.
- Disable the USB autosuspend feature, if `cat /sys/module/usbcore/parameters/autosuspend` returns `1` or `2` it is enabled; to disable execute:
```bash
sed -i 's/GRUB_CMDLINE_LINUX_DEFAULT="/&usbcore.autosuspend=-1 /' /etc/default/grub
Expand Down
4 changes: 2 additions & 2 deletions docs/guide/installation/02_docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,7 @@ This workaround only works with cgroup v1, which is not enabled on many newer di

2. UDEV Rules

Create a new udev rule for serial adpater, `idVendor` and `idProduct` must be equal to values from `lsusb` command. The rule below creates device `/dev/zigbee-serial`:
Create a new udev rule for serial adapter, `idVendor` and `idProduct` must be equal to values from `lsusb` command. The rule below creates device `/dev/zigbee-serial`:

```shell
echo "SUBSYSTEM==\"tty\", ATTRS{idVendor}==\"0451\", ATTRS{idProduct}==\"16a8\", SYMLINK+=\"zigbee-serial\", RUN+=\"/usr/local/bin/docker-setup-zigbee-serial.sh\"" | sudo tee /etc/udev/rules.d/99-zigbee-serial.rules
Expand Down Expand Up @@ -530,7 +530,7 @@ modprobe cdc-acm
````
After issuing the commands, the Zigbee controller may need to be unplugged and re-inserted to the USB port.

You may also need additional drivers based on your USB Zigbee controlller setup, e.g. CH341 module is not included by default. You can download precompiled modules from jadahl.com pages - select module directory based on NAS CPU architecture (DS218+ -> INTEL Celeron J3355 -> Apollo Lake).
You may also need additional drivers based on your USB Zigbee controller setup, e.g. CH341 module is not included by default. You can download precompiled modules from jadahl.com pages - select module directory based on NAS CPU architecture (DS218+ -> INTEL Celeron J3355 -> Apollo Lake).
````
cd /lib/modules
wget http://www.jadahl.com/iperf-arp-scan/DSM_7.0/apollolake/ch341.ko
Expand Down
4 changes: 2 additions & 2 deletions docs/guide/usage/exposes.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Examples:
## Generic

### Binary
Indicates a device exposes a binary value. Always has `value_on` and `value_off` which indicates how to interpet the value. Optionally has a `value_toggle` which can be send to toggle the value.
Indicates a device exposes a binary value. Always has `value_on` and `value_off` which indicates how to interpret the value. Optionally has a `value_toggle` which can be send to toggle the value.

Examples:
```json
Expand Down Expand Up @@ -55,7 +55,7 @@ Examples:
```

### Numeric
Indicates a device exposes a numeric value. Optionally has `value_max`, `value_min`, `value_step`, `unit` and `presets`. The `presets` defines values which have a special interpetation.
Indicates a device exposes a numeric value. Optionally has `value_max`, `value_min`, `value_step`, `unit` and `presets`. The `presets` defines values which have a special interpretation.

Examples:
```json
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/usage/integrations/home_assistant.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ devices:
state_value_template: '{{ value_json.state_right }}'
```
### Changing device properties
As an advanced example to show changing any MQTT property can be overriden, the following configuration changes the `suggested_area` property of the `device`. The example shows that you can just copy the given MQTT discovery hierarchy underneath the `homeassistant` property (given that `suggested_area` is underneath the `device` property). Please note, that other `device` properties are possibly set by Zigbee2MQTT (e.g. `manufacturer`).
As an advanced example to show changing any MQTT property can be overridden, the following configuration changes the `suggested_area` property of the `device`. The example shows that you can just copy the given MQTT discovery hierarchy underneath the `homeassistant` property (given that `suggested_area` is underneath the `device` property). Please note, that other `device` properties are possibly set by Zigbee2MQTT (e.g. `manufacturer`).

This example changes the [light's device's `suggested area` discovery property](https://www.home-assistant.io/integrations/light.mqtt/#device) to "Living Room":

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/usage/mqtt_topics_and_messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -320,7 +320,7 @@ Creates a backup of the `data` folder (without the `data/log` directory). Payloa

#### zigbee2mqtt/bridge/request/install_code/add

Allows to add an install code to the coordinator. Use this when you want to pair a Zigbee 3.0 devices which can only be paired with an install code. These devices typicaly have a QR code on it. When scanning this QR code you will get a code, e.g. `ZB10SG0D831018234800400000000000000000009035EAFFFE424793DLKAE3B287281CF11F550733A0CFC38AA31E802`. Publish this code to `zigbee2mqtt/bridge/request/install_code/add` with payload `{"value":"THE_CODE"}`. Example response: `{"data":{"value":"THE_CODE"},"status":"ok"}`.
Allows to add an install code to the coordinator. Use this when you want to pair a Zigbee 3.0 devices which can only be paired with an install code. These devices typically have a QR code on it. When scanning this QR code you will get a code, e.g. `ZB10SG0D831018234800400000000000000000009035EAFFFE424793DLKAE3B287281CF11F550733A0CFC38AA31E802`. Publish this code to `zigbee2mqtt/bridge/request/install_code/add` with payload `{"value":"THE_CODE"}`. Example response: `{"data":{"value":"THE_CODE"},"status":"ok"}`.

### Device

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/usage/ota_updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This feature allows to update your Zigbee devices over-the-air.

::: tip TIP
Always check if the firmware update will bring you advantages. Firmware updates are NOT made for Zigbee2MQTT, but for working with apps and hubs from the brand.
In some cases the firmware update can cause that your device will react different then Zigbee2MQTT expects, making that you can't use it the way you want, at least untill Zigbee2MQTT is changed to react to those changes.
In some cases the firmware update can cause that your device will react different then Zigbee2MQTT expects, making that you can't use it the way you want, at least until Zigbee2MQTT is changed to react to those changes.
If you get annoyed by the notifications that there are updates available, then turn the automatic check off.
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/usage/scenes.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ To only store the state of a single light in a scene for a group send e.g. `{"sc
```

In case a `scene_store` is called with the same `SCENE_ID` all values except the `transition` are overridden. In this way it's possible to have a transition for a scene created through `scene_store`.
Equaling `scene_store` a `group_id` can be provided when calling `scene_add` for a single light. In that scenario the state will be applied when the scene is recalled on the group. This is powerfull in providing support for transitions while also allowing each light to have a different state in the scene and thus also allowing different transition times per light when the scene is recalled on the group.
Equaling `scene_store` a `group_id` can be provided when calling `scene_add` for a single light. In that scenario the state will be applied when the scene is recalled on the group. This is powerful in providing support for transitions while also allowing each light to have a different state in the scene and thus also allowing different transition times per light when the scene is recalled on the group.

## Recall scene
To recall the scene send a command to `zigbee2mqtt/[GROUP_OR_DEVICE_FRIENDLY_NAME]/set` with payload `{"scene_recall": SCENE_ID}` where `SCENE_ID` is a number (e.g. `1`).
Expand Down

0 comments on commit 62ed251

Please sign in to comment.