Skip to content

Commit e362676

Browse files
committed
some doc updates
1 parent 154c89c commit e362676

2 files changed

Lines changed: 9 additions & 9 deletions

File tree

docs/contribute/porting.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,9 @@ The pinout is stored in the **device config string**.
9090
| **`B`** | Reset button | • Puts device in pairing |
9191
| **`L`** | Network led | • Blinks while pairing <br> • Is the backlight sometimes |
9292
| **`S`** | Switch | • User input <br> • Tactile/touch button or external switch <br> • Spam to put in pairing mode |
93-
| **`R`** | Relay / Triac | • Output <br> • Non-latching: `RC1` - 1 pin: on when high <br> • Latching: `RC2C3` - 2 pins: pulse on, pulse off |
93+
| **`R`** | Relay / Triac | • Output <br> • Non-latching: `RC1` - 1 pin: on when high <br> • Latching: `RC2C3` - 2 pins: pulse on, pulse off <br> • Add `i` to invert (active-low): `RC1i` |
9494
| **`X`** | Cover Switch | • User input for cover control <br> • Format: `XA2B3u` - 2 pins + pull resistor: open button, close button |
95-
| **`C`** | Cover | • Motor control for curtains/blinds/shades <br> • Format: `CA2B3` - 2 pins: open relay, close relay |
95+
| **`C`** | Cover | • Motor control for curtains/blinds/shades <br> • Format: `CA2B3` - 2 pins: open relay, close relay <br> • Add `i` to invert both relays (active-low): `CA2B3i` |
9696
| **`I`** | Indicator LED | • 1 per relay, follows state <br> • Briefly flashes on button press (binding confirmation) <br> • Blinks while pairing if there is no network led |
9797

9898
For buttons (`B`), switches (`S`), and cover switches (`X`), the next character chooses the internal pull-up/down resistor:
@@ -101,7 +101,7 @@ For buttons (`B`), switches (`S`), and cover switches (`X`), the next character
101101
Usually, pressing the button bridges the GPIO pin to Ground (active low).
102102
⤷ So we need a pull-up resistor `u`: to hold it at VCC (high) while not-pressed.
103103

104-
For LEDs, add `i` to invert the state.
104+
For LEDs (`L`, `I`), relays (`R`), and cover relays (`C`), add `i` to invert the output (active-low).
105105

106106
Additional options:
107107
| Format | Option | Function |

docs/updating.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,11 @@ This page describes **converting** and **updating** supported devices **wireless
5757
8. **Start** the update (red download button)
5858
9. **Re-download** the custom [# Quirks / Converters / Extensions](#quirks--converters--extensions) and restart ZHA / Z2M
5959
10. **Interview** the device **`i`**
60-
⤷ option missing from ZHA, remove and re-pair if needed
61-
(updates endpoints, clusters and identifiers)
62-
11. **Reconfigure** the device **`🗘`**
63-
(resets reporting and stuff?, keeps user binds and settings)
64-
12. Re-do user settings if needed
60+
⤷ option missing from ZHA, remove and re-pair if needed
61+
(updates endpoints, clusters and identifiers)
62+
11. **Reconfigure** the device **`🗘`**
63+
(resets reporting intervals, keeps user binds and settings)
64+
12. Re-do user settings if needed
6565

6666
> *If your device is several versions behind, it will update directly to the latest version.*
6767
@@ -120,7 +120,7 @@ zha:
120120
> - e.g. 10W dumb bulb is safe
121121
> - estimated values: >4W for EndDevice, >8W for Router
122122
> - **not recommended: no-Neutral switch + smart bulb ( <1W when brightness=0 )**
123-
> ⤷ dummy load (capactior) may be required
123+
> ⤷ dummy load (capacitor) may be required
124124

125125
<details>
126126
<summary> <b> Index link format </b> </summary>

0 commit comments

Comments
 (0)