Fix LedPower<x>/LedState

Michael Ingraham 2019-05-23 10:12:49 -04:00
parent 12a8cf2f74
commit 48307e04d2
1 changed files with 2 additions and 1 deletions

@ -110,7 +110,8 @@ Interlock | Relay interlock mode and group selection.<BR>`0` = set self-locking
| | Add up to 8 relays in 1 to 4 interlock groups, each separated by a space. For example<BR> `1,2 3,4` = Group Relay1 and Relay2 in group 1 and Relay3 and Relay4 in group 2 (_note the space between the two group declarations_) <BR> `1,2,3` = group Relay1, Relay2 and Relay3 in a single interlock group <BR>`1 3 2,4` = Relay1 is in group 1, Relay3 in group 2, Relay2 and Relay4 in group 3<a id="LedMask"></a> | | Add up to 8 relays in 1 to 4 interlock groups, each separated by a space. For example<BR> `1,2 3,4` = Group Relay1 and Relay2 in group 1 and Relay3 and Relay4 in group 2 (_note the space between the two group declarations_) <BR> `1,2,3` = group Relay1, Relay2 and Relay3 in a single interlock group <BR>`1 3 2,4` = Relay1 is in group 1, Relay3 in group 2, Relay2 and Relay4 in group 3<a id="LedMask"></a>
LedMask | Allows setting a [`<bitmask>`](https://en.wikipedia.org/wiki/Mask_(computing)#Masking_bits_to_1) which specifies which relays control the LED indicator used to display whether a relay is latched/powered. The order of the `<bitmask>` is from most significant bit (MSB) to least significant bit (LSB). Bit 15 (MSB) masks Relay16 through bit 0 (LSB) which masks Relay1, respectively. For each relay to be included in controlling the power LED, set its corresponding bit in the `<bitmask>` to `1`. `<bitmask>` bits without corresponding configured module relays have no effect and can be ignored. Introduced in [v6.5.0.7](../commit/df6645481e08b36fe61aaebeeeed249d60730386)<BR><BR>`<bitmask>` = [bitwise](https://whatis.techtarget.com/definition/bitwise) value representing each relay. Values may be entered as either hexadecimal or decimal values (e.g., 0xFFFF = 65535). `0xFFFF` (= 1111 1111 1111 1111) All relays control the power LED _(default)_<BR><BR>[LedState](#ledstate) must be enabled (i.e., `!= 0`) in order for `LedMask` to take effect.<BR><BR>**Examples:**<li>`LedMask 0xFFFD` Every relay, except Relay2, controls the power LED (0xFFFD = 1111 1111 1111 1101)</li><li>`LedMask 0x0002` Only Relay 2 controls the power LED (0x0002 = 0000 0000 0000 0010)</li><a id="LedPower"></a> LedMask | Allows setting a [`<bitmask>`](https://en.wikipedia.org/wiki/Mask_(computing)#Masking_bits_to_1) which specifies which relays control the LED indicator used to display whether a relay is latched/powered. The order of the `<bitmask>` is from most significant bit (MSB) to least significant bit (LSB). Bit 15 (MSB) masks Relay16 through bit 0 (LSB) which masks Relay1, respectively. For each relay to be included in controlling the power LED, set its corresponding bit in the `<bitmask>` to `1`. `<bitmask>` bits without corresponding configured module relays have no effect and can be ignored. Introduced in [v6.5.0.7](../commit/df6645481e08b36fe61aaebeeeed249d60730386)<BR><BR>`<bitmask>` = [bitwise](https://whatis.techtarget.com/definition/bitwise) value representing each relay. Values may be entered as either hexadecimal or decimal values (e.g., 0xFFFF = 65535). `0xFFFF` (= 1111 1111 1111 1111) All relays control the power LED _(default)_<BR><BR>[LedState](#ledstate) must be enabled (i.e., `!= 0`) in order for `LedMask` to take effect.<BR><BR>**Examples:**<li>`LedMask 0xFFFD` Every relay, except Relay2, controls the power LED (0xFFFD = 1111 1111 1111 1101)</li><li>`LedMask 0x0002` Only Relay 2 controls the power LED (0x0002 = 0000 0000 0000 0010)</li><a id="LedPower"></a>
LedPower | LED power state as on or off <BR> `0` = turn LED OFF and set `LedState 0` <BR> `1` = turn LED ON and set `LedState 0` <BR> `2` = toggle LED and set `LedState 0` <BR>(Use `Backlog LedPower 0; SetOption31 1` to disable LED even when Wi-Fi or MQTT is not connected) LedPower | LED power state as on or off <BR> `0` = turn LED OFF and set `LedState 0` <BR> `1` = turn LED ON and set `LedState 0` <BR> `2` = toggle LED and set `LedState 0` <BR>(Use `Backlog LedPower 0; SetOption31 1` to disable LED even when Wi-Fi or MQTT is not connected)
LedPower\<x\> | LED\<x\> power state control. **Enabled only when LedLink(i) is configured** (Introduced in 6.5.0.12)<BR> `0` = turn LED OFF and set `LedState 0` <BR> `1` = turn LED ON and set `LedState 0` <BR> `2` = toggle LED and set `LedState 0` <a id="LedState"></a>LedState | Manage LED state<BR> `0` = disable use of LED as much as possible <BR> `1` = show power state on LED (LED on when power on) *(inverted for Sonoff Touch/T1)*<BR> `2` = show MQTT subscriptions as a LED blink<BR> `3` = show power state and MQTT subscriptions as a LED blink<BR> `4` = show MQTT publications as a LED blink<BR> `5` = show power state and MQTT publications as a LED blink<BR> `6` = show all MQTT messages as a LED blink<BR> `7` = show power state and MQTT messages as a LED blink<BR><BR>`8` = LED on when Wi-Fi and MQTT are connected. ***Cannot be issued directly*** and is only activated when `LedPower` is switched from `0` to `1`<a id="Power"></a> LedPower\<x\> | LED\<x\> power state control. **Enabled only when LedLink(i) is configured** (Introduced in 6.5.0.12)<BR> `0` = turn LED OFF and set `LedState 0` <BR> `1` = turn LED ON and set `LedState 0` <BR> `2` = toggle LED and set `LedState 0` <a id="LedState"></a>
LedState | Manage LED state<BR> `0` = disable use of LED as much as possible <BR> `1` = show power state on LED (LED on when power on) *(inverted for Sonoff Touch/T1)*<BR> `2` = show MQTT subscriptions as a LED blink<BR> `3` = show power state and MQTT subscriptions as a LED blink<BR> `4` = show MQTT publications as a LED blink<BR> `5` = show power state and MQTT publications as a LED blink<BR> `6` = show all MQTT messages as a LED blink<BR> `7` = show power state and MQTT messages as a LED blink<BR><BR>`8` = LED on when Wi-Fi and MQTT are connected. ***Cannot be issued directly*** and is only activated when `LedPower` is switched from `0` to `1`<a id="Power"></a>
Power\<x\> | Control Relay\<x\> power state and also resetting PulseTime\<x\><BR> `0` / `off` = turn OFF <BR> `1` / `on` = turn ON <BR> `2` / `toggle` = if relay is `ON` switch to `OFF` and vice versa<BR> `3` / `blink` = toggle power for [BlinkCount](#blinkcount) times each [BlinkTime](#blinktime) duration (at the end of `blink`, relay power is returned to pre-blink state)<BR> `4` / `blinkoff` = stop blink sequence and return relay power to pre-blink state<a id="PowerOnState"></a> Power\<x\> | Control Relay\<x\> power state and also resetting PulseTime\<x\><BR> `0` / `off` = turn OFF <BR> `1` / `on` = turn ON <BR> `2` / `toggle` = if relay is `ON` switch to `OFF` and vice versa<BR> `3` / `blink` = toggle power for [BlinkCount](#blinkcount) times each [BlinkTime](#blinktime) duration (at the end of `blink`, relay power is returned to pre-blink state)<BR> `4` / `blinkoff` = stop blink sequence and return relay power to pre-blink state<a id="PowerOnState"></a>
PowerOnState | Control relay state after _**powering up**_ the device. [More information](PowerOnState-Configuration)<BR> `0` / `OFF` = keep relay(s) OFF after power up <BR> `1` / `ON` = turn relay(s) ON after power up <BR> `2` / `TOGGLE` = toggle relay(s) from last saved state <BR> `3` = switch relay(s) to their last saved state *(default)* <BR> `4` = turn relay(s) ON and disable further relay control <BR> `5` = after a `PulseTime` period turn relay(s) ON (acts as inverted [`PulseTime`](Commands#pulsetime) mode)<a id="PulseTime"></a> PowerOnState | Control relay state after _**powering up**_ the device. [More information](PowerOnState-Configuration)<BR> `0` / `OFF` = keep relay(s) OFF after power up <BR> `1` / `ON` = turn relay(s) ON after power up <BR> `2` / `TOGGLE` = toggle relay(s) from last saved state <BR> `3` = switch relay(s) to their last saved state *(default)* <BR> `4` = turn relay(s) ON and disable further relay control <BR> `5` = after a `PulseTime` period turn relay(s) ON (acts as inverted [`PulseTime`](Commands#pulsetime) mode)<a id="PulseTime"></a>
PulseTime\<x\> | Display the amount of `PulseTime` remaining on Relay\<x><BR>`<value>` Set the duration to keep Relay\<x\> `ON` when `Power<x> ON` command is issued. After this amount of time, the relay will be turned `OFF`.<BR>`0` / `OFF` = disable use of PulseTime for Relay\<x\><BR>`1..111` = set PulseTime for Relay\<x\> in 0.1 second increments<BR>`112..64900` = set PulseTime for Relay\<x\>, offset by 100, in 1 second increments. Add 100 to desired interval in seconds, e.g., `PulseTime 113` = 13 seconds and `PulseTime 460` = 6 minutes (i.e., 360 seconds)<BR><a id="SwitchDebounce"></a> PulseTime\<x\> | Display the amount of `PulseTime` remaining on Relay\<x><BR>`<value>` Set the duration to keep Relay\<x\> `ON` when `Power<x> ON` command is issued. After this amount of time, the relay will be turned `OFF`.<BR>`0` / `OFF` = disable use of PulseTime for Relay\<x\><BR>`1..111` = set PulseTime for Relay\<x\> in 0.1 second increments<BR>`112..64900` = set PulseTime for Relay\<x\>, offset by 100, in 1 second increments. Add 100 to desired interval in seconds, e.g., `PulseTime 113` = 13 seconds and `PulseTime 460` = 6 minutes (i.e., 360 seconds)<BR><a id="SwitchDebounce"></a>