Skip to content

Commit

Permalink
Lint
Browse files Browse the repository at this point in the history
  • Loading branch information
@Koenkk
Koenkk committed Dec 3, 2024
1 parent 8cf3bc5 commit 9206d99
Show file tree
Hide file tree
Showing 37 changed files with 11,051 additions and 596 deletions.
1 change: 1 addition & 0 deletions .prettierignore
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
docs/devices/*.md
public/images/devices
pnpm-lock.yaml
20 changes: 10 additions & 10 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ It is based on [VuePress v2](https://v2.vuepress.vuejs.org/).

**Directory-Structure:**

- `docgen`: Some scripts to test and generate the Device-Pages.
- `docs`: The current documentation.
- `docs/.vuepress`: Some VuePress enhancements like Stylesheets.
- `public`: Static assets.
- `supported-devices-component`: Vue.js component rendering the devices-overview page.
- `navbar.ts`: Configuration for the top navigation.
- `sidebar.ts`: Configuration for the sidebars by individual sections (like _Guide_).
- `vuepress.config.ts`: The [VuePress config file](https://v2.vuepress.vuejs.org/reference/config.html).
- `docgen`: Some scripts to test and generate the Device-Pages.
- `docs`: The current documentation.
- `docs/.vuepress`: Some VuePress enhancements like Stylesheets.
- `public`: Static assets.
- `supported-devices-component`: Vue.js component rendering the devices-overview page.
- `navbar.ts`: Configuration for the top navigation.
- `sidebar.ts`: Configuration for the sidebars by individual sections (like _Guide_).
- `vuepress.config.ts`: The [VuePress config file](https://v2.vuepress.vuejs.org/reference/config.html).

## Docgen

Expand All @@ -40,8 +40,8 @@ npm run docgen

Docgen includes some scripts to help testing the page.

- `check-device-images`: Checks for missing device images
- `check-links`: Checks for broken internal links
- `check-device-images`: Checks for missing device images
- `check-links`: Checks for broken internal links

**Attention**: `check-links` iterates over the generated VuePress files, so you have to build the page first!

Expand Down
24 changes: 12 additions & 12 deletions docs/advanced/more/3d_cases.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,39 +6,39 @@ sidebar: auto

## Texas Instruments launchpad

- Case designs for [TI LAUNCHXL boards for CC1352P1, CC1352P-2 and CC2652R][thingiverse-c1352p1-cc1352p-2-cc2652r-launchxl]
- Case designs for [TI LAUNCHXL boards for CC1352P1, CC1352P-2 and CC2652R][thingiverse-c1352p1-cc1352p-2-cc2652r-launchxl]

## CC2530

- Case design for a [CC2530 Zigbee minimal case][thingiverse-cc2530-case]
- Case design for a [CC2530 Zigbee minimal case][thingiverse-cc2530-case]

## CC2531

- Case design for a [CC2531 Zigbee dongle][thingiverse-rpi-cc2531-dongle]
- Case design for a [CC2531 Zigbee dongle][thingiverse-rpi-cc2531-dongle]

## CC2531 with external antenna

- Case design for a [CC2531 Zigbee dongle with external antenna][thingiverse-rpi-cc2531-dongle-external-antenna]
- Case design with buttons for a [CC2531 Zigbee dongle with external antenna][thingiverse-rpi-cc2531-dongle-with-buttons]
- Case design for a [CC2531 Zigbee dongle with external antenna][thingiverse-rpi-cc2531-dongle-external-antenna]
- Case design with buttons for a [CC2531 Zigbee dongle with external antenna][thingiverse-rpi-cc2531-dongle-with-buttons]

## Electrolama zig-a-zig-ah! (zzh!)

- Case design with button for a [Electrolama zig-a-zig-ah! (zzh!)][thingiverse-CC2652R-zzh-case]
- Case design with button for a [Electrolama zig-a-zig-ah! (zzh!)][thingiverse-CC2652R-zzh-case]

## Slaesh's CC2652RB stick

- Case design for a [Slaesh's CC2652RB stick][thingiverse-CC2652RB-slaesh-case]
- Case design for a [Slaesh's CC2652RB stick][thingiverse-CC2652RB-slaesh-case]

## CC2530 + CC2591

- Case design for a [minimal case compatible with the CC2530 + CC2591 combination][thingiverse-cc2530-cc2591-case]
- Case design with PSU and C7 socket for a [CC2530 + CC2591 + PSU + C7 socket][thingiverse-cc2530-cc2591-case-psu-c7]
- Case design with PSU HLK-PM03 for a [CC2530 + CC2591 + HLK-PM03][thingiverse-cc2530-cc2591-case-hlk-pm03]
- Case design for a [minimal case compatible with the CC2530 + CC2591 combination][thingiverse-cc2530-cc2591-case]
- Case design with PSU and C7 socket for a [CC2530 + CC2591 + PSU + C7 socket][thingiverse-cc2530-cc2591-case-psu-c7]
- Case design with PSU HLK-PM03 for a [CC2530 + CC2591 + HLK-PM03][thingiverse-cc2530-cc2591-case-hlk-pm03]

## Raspberry Pi Zero

- Blog post about a [round case for the Raspberry Pi Zero by Jens Willmer][jwillmer-blog-post]. The files can also be found on [Thingiverse][thingiverse-jwillmer-design].
- [Minimal Pi Zero Case by Jens Willmer][thingiverse-jwillmer-design2]
- Blog post about a [round case for the Raspberry Pi Zero by Jens Willmer][jwillmer-blog-post]. The files can also be found on [Thingiverse][thingiverse-jwillmer-design].
- [Minimal Pi Zero Case by Jens Willmer][thingiverse-jwillmer-design2]

## Alternatives

Expand Down
10 changes: 5 additions & 5 deletions docs/advanced/more/tuya_xiaomi_ota_url.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ This guide explains how to retrieve a TuYa or Xiaomi OTA file for your device. T

Prerequisites:

- Docker
- TuYa bridge or Xiaomi gateway
- [Android Studio](https://developer.android.com/studio)
- Docker
- TuYa bridge or Xiaomi gateway
- [Android Studio](https://developer.android.com/studio)

## Step 1: running the proxy

Expand Down Expand Up @@ -41,8 +41,8 @@ Start Android Studio and create a new empty project:

NOTE: This only works for native Aqara gateways which can be connected to the Aqara Home app (not the Xiaomi home app!)

- Works: ZHWG16LM/HE1-G0, ZHWG15LM, ZHWG12LM
- Doesn't work: ZNDMWG03LM, DGNWG02LM
- Works: ZHWG16LM/HE1-G0, ZHWG15LM, ZHWG12LM
- Doesn't work: ZNDMWG03LM, DGNWG02LM

1. Download the Aqara home app apk from [this link](https://apkpure.com/nl/aqara-home/com.lumiunited.aqarahome), tested with version 2.2.5. Drag the downloaded apk on the emulator (which will install it).
1. Open the Aqara home app in the emulator, log in with your account
Expand Down
8 changes: 4 additions & 4 deletions docs/advanced/support-new-devices/01_support_new_devices.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,10 +101,10 @@ In case your device does not report anything out of the blue, the Clusters page

Some basic external converter examples:

- [Bulb (light)](https://github.com/Koenkk/zigbee2mqtt.io/blob/master/docs/externalConvertersExample/light.js)
- [Plug (switch)](https://github.com/Koenkk/zigbee2mqtt.io/blob/master/docs/externalConvertersExample/switch.js)
- [Advanced example](https://github.com/Koenkk/zigbee2mqtt.io/blob/master/docs/externalConvertersExample/freepad_ext.js)
- Definitions of already supported devices can be found [here](https://github.com/Koenkk/zigbee-herdsman-converters/tree/master/src/devices). It may help to look at devices from the same vendor or type.
- [Bulb (light)](https://github.com/Koenkk/zigbee2mqtt.io/blob/master/docs/externalConvertersExample/light.js)
- [Plug (switch)](https://github.com/Koenkk/zigbee2mqtt.io/blob/master/docs/externalConvertersExample/switch.js)
- [Advanced example](https://github.com/Koenkk/zigbee2mqtt.io/blob/master/docs/externalConvertersExample/freepad_ext.js)
- Definitions of already supported devices can be found [here](https://github.com/Koenkk/zigbee-herdsman-converters/tree/master/src/devices). It may help to look at devices from the same vendor or type.

### 2.2. Adding converter(s) for your device

Expand Down
10 changes: 5 additions & 5 deletions docs/advanced/support-new-devices/02_support_new_tuya_devices.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@ datatype: DataType.uint8;
data: Buffer;
```

- `dp` is so called "Data Point ID" which is at the core of Tuya devices. From the point of view of a device the DPIDs are the functions that the device provides.
- `datatype` is the type of data contained in the `data` field, see `dataTypes` in `node_modules/zigbee-herdsman-converters/lib/tuya.js`
- `dp` is so called "Data Point ID" which is at the core of Tuya devices. From the point of view of a device the DPIDs are the functions that the device provides.
- `datatype` is the type of data contained in the `data` field, see `dataTypes` in `node_modules/zigbee-herdsman-converters/lib/tuya.js`

Some datapoints are 'report only' (they report changes that happen within the device) others are 'issue and report' (they can report by themselves, but also respond with a report when set). Data points are not unified across all Tuya devices so they can differ per device.

Expand All @@ -88,9 +88,9 @@ Zigbee2MQTT:debug 2022-11-30 18:29:19: Datapoint '106' with value '77' not defin

Next we have to find out what this datapoint means (`106` in this example), there are different ways to do this:

- [Find Tuya datapoint using the Tuya gateway](./03_find_tuya_data_points.md) (easiest but requires Tuya gateway)
- Check if an already supported Tuya device has this datapoint mapped ([search](https://github.com/Koenkk/zigbee-herdsman-converters/search?q=tuyaDatapoints))
- Guess based on the value
- [Find Tuya datapoint using the Tuya gateway](./03_find_tuya_data_points.md) (easiest but requires Tuya gateway)
- Check if an already supported Tuya device has this datapoint mapped ([search](https://github.com/Koenkk/zigbee-herdsman-converters/search?q=tuyaDatapoints))
- Guess based on the value

For this device we know that datapoint `106` is the humidity, we can now update the `exposes` and `tuyaDatapoints` section of the external converter:

Expand Down
8 changes: 4 additions & 4 deletions docs/advanced/zigbee/02_improve_network_range_and_stability.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ Any device using the open 2.4 GHz spectrum could interfere with Zigbee such as B

This includes devices that you may not realize _are_ 2.4 GHz. Check anything that is wireless including wireless audio transmitters such as:

- [JL Audio JL Link TRX](https://www.crutchfield.com/S-kjc9jL5lfL6/p_136TRX/JL-Audio-JLINK-TRX-High-Fidelity-Audio-Transmitter-Receiver-Kit.html)
- [SVS Soundpath (gen 1)](https://www.svsound.com/products/soundpath-wireless-audio-adapter)
- [JL Audio JL Link TRX](https://www.crutchfield.com/S-kjc9jL5lfL6/p_136TRX/JL-Audio-JLINK-TRX-High-Fidelity-Audio-Transmitter-Receiver-Kit.html)
- [SVS Soundpath (gen 1)](https://www.svsound.com/products/soundpath-wireless-audio-adapter)

Utility companies are known to use Zigbee with their "smart meters" but may not advertise them as Zigbee.
Other devices that broadcast Zigbee, or modified versions of Zigbee are known to cause issues.
Expand Down Expand Up @@ -83,8 +83,8 @@ Although Zigbee2MQTT does not require many resources, the hardware you are runni

Zigbee traffic can be categorized as either _Unicast_ or _Broadcast_:

- _Unicast_ is an addressed message, usually between a Zigbee device and the coordinator, possibly through some intermediate devices
- _Broadcast_ is a special type of message that is designed to reach **all** devices in the network
- _Unicast_ is an addressed message, usually between a Zigbee device and the coordinator, possibly through some intermediate devices
- _Broadcast_ is a special type of message that is designed to reach **all** devices in the network

When a device receives a broadcast message for the first time, it will re-transmit it at least once. The device keeps track of broadcasts that have recently been re-transmitted to prevent repeating messages forever. For large networks, broadcasts can generate a lot of traffic, and it takes time for the message to propagate to all devices.

Expand Down
54 changes: 27 additions & 27 deletions docs/advanced/zigbee/04_sniff_zigbee_traffic.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,10 @@ Now Wireshark is able to decrypt the messages. When e.g. turning on a light you

### Prerequisites

- Computer
- Ubuntu / Debian machine (tested with Ubuntu 18.04 / 18.10 and Debian 10)
- Windows machine (tested with Windows 10)
- CC2531 adapter
- Computer
- Ubuntu / Debian machine (tested with Ubuntu 18.04 / 18.10 and Debian 10)
- Windows machine (tested with Windows 10)
- CC2531 adapter

### 1. Flashing the CC2531 adapter

Expand Down Expand Up @@ -152,8 +152,8 @@ Run the ZBOSS executable in `gui\zboss_sniffer.exe`, enter the path to your Wire

#### Troubleshooting

- If you get `couldn't run /usr/bin/dumpcap in child process: permission denied` when running whsniff, check if /usr/bin/dumpcap is executable for everyone. Or `chmod 755 /usr/bin/dumpcap`.
- You may need to remove `modemmanager` as this has been known to cause issues. [Howto](../../guide/faq/README.md#modemmanager-is-installed)
- If you get `couldn't run /usr/bin/dumpcap in child process: permission denied` when running whsniff, check if /usr/bin/dumpcap is executable for everyone. Or `chmod 755 /usr/bin/dumpcap`.
- You may need to remove `modemmanager` as this has been known to cause issues. [Howto](../../guide/faq/README.md#modemmanager-is-installed)

## With EmberZNet and HUSBZB-1 adapters

Expand All @@ -167,23 +167,23 @@ The adapter should work out of the box and require no extra step.

Install drivers (whichever works for your adapter):

- [Silicon Labs CP210x Universal Windows Driver](https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers?tab=downloads)
- Extract drivers to a folder
- Inside that folder, right-click on `silabser.inf` then `Show more options` and choose `Install`
- [WCH CH343SER](https://www.wch-ic.com/downloads/CH343SER_EXE.html)
- Execute and follow setup steps to install.
- [Silicon Labs CP210x Universal Windows Driver](https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers?tab=downloads)
- Extract drivers to a folder
- Inside that folder, right-click on `silabser.inf` then `Show more options` and choose `Install`
- [WCH CH343SER](https://www.wch-ic.com/downloads/CH343SER_EXE.html)
- Execute and follow setup steps to install.

### Using Ember ZLI

#### Prerequisites

- Computer
- Linux machine (tested with Debian 12 64-bit)
- Windows machine (tested with Windows 11)
- MacOS machine
- EmberZNet or HUSBZB-1 adapter
- Wireshark (optional, can write directly to a [PCAP file](https://github.com/Nerivec/ember-zli/wiki/Sniff#sending-to-pcap-file) instead)
- NodeJS / npm (if using npm-based installation method)
- Computer
- Linux machine (tested with Debian 12 64-bit)
- Windows machine (tested with Windows 11)
- MacOS machine
- EmberZNet or HUSBZB-1 adapter
- Wireshark (optional, can write directly to a [PCAP file](https://github.com/Nerivec/ember-zli/wiki/Sniff#sending-to-pcap-file) instead)
- NodeJS / npm (if using npm-based installation method)

#### 1. Installing required tools

Expand All @@ -197,12 +197,12 @@ Install drivers (whichever works for your adapter):

#### Prerequisites

- Computer
- Linux machine (tested with Ubuntu 18.10)
- Windows machine (tested with Windows 10)
- EmberZNet or HUSBZB-1 adapter
- Wireshark
- Java
- Computer
- Linux machine (tested with Ubuntu 18.10)
- Windows machine (tested with Windows 10)
- EmberZNet or HUSBZB-1 adapter
- Wireshark
- Java

#### 1. Installing required tools

Expand Down Expand Up @@ -232,9 +232,9 @@ Open the Device Manager (Win+X, M) and find which COM port your adapter is using

### Prerequisites

- Ubuntu Linux / macOS 10.14+ / Windows 10+
- [nRF52 dongle](https://www.digikey.com/en/products/detail/nordic-semiconductor-asa/NRF52840-DONGLE/9491124) or [development kit](https://www.digikey.com/en/products/detail/nordic-semiconductor-asa/nrf52840-dk/8593726)
- Wireshark v3.0+
- Ubuntu Linux / macOS 10.14+ / Windows 10+
- [nRF52 dongle](https://www.digikey.com/en/products/detail/nordic-semiconductor-asa/NRF52840-DONGLE/9491124) or [development kit](https://www.digikey.com/en/products/detail/nordic-semiconductor-asa/nrf52840-dk/8593726)
- Wireshark v3.0+

### 1. Programming dongle, installing required tools

Expand Down
10 changes: 5 additions & 5 deletions docs/advanced/zigbee/05_create_a_cc2530_router.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,11 @@ Now the CC2530 can be flashed using the same instructions as [Flashing the CC253

The following steps have to be followed:

- Drill 2 holes in the enclosure; one for the antenna, one for the power cable
- Lay a knot in the power cable; this serves as strain relief
- Solder the power cable on to the AC pins of the HLK-PM03
- Use 2 female to female jumper wires to connect the VC+ pin of the HLK-PM03 to the VCC pin of the CC2530 and the VC- pin of the HLK-PM03 to the GND pin of the CC2530
- Use double sided tape to fix the CC2530 and HLK-PM03 into the enclosure
- Drill 2 holes in the enclosure; one for the antenna, one for the power cable
- Lay a knot in the power cable; this serves as strain relief
- Solder the power cable on to the AC pins of the HLK-PM03
- Use 2 female to female jumper wires to connect the VC+ pin of the HLK-PM03 to the VCC pin of the CC2530 and the VC- pin of the HLK-PM03 to the GND pin of the CC2530
- Use double sided tape to fix the CC2530 and HLK-PM03 into the enclosure

### Result

Expand Down
Loading

0 comments on commit 9206d99

Please sign in to comment.