From 3833cf7e3ef7012efc5efd38eec09300931deb99 Mon Sep 17 00:00:00 2001 From: blakadder Date: Wed, 22 May 2019 12:09:51 +0200 Subject: [PATCH] Updated Commands (markdown) --- Commands.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Commands.md b/Commands.md index 791d36fc..4e8839d4 100644 --- a/Commands.md +++ b/Commands.md @@ -110,7 +110,7 @@ Interlock | Relay interlock mode and group selection.
`0` = set self-locking | | Add up to 8 relays in 1 to 4 interlock groups, each separated by a space. For example
`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_)
`1,2,3` = group Relay1, Relay2 and Relay3 in a single interlock group
`1 3 2,4` = Relay1 is in group 1, Relay3 in group 2, Relay2 and Relay4 in group 3 LedMask | Allows setting a [``](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 `` 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 `` to `1`. `` bits without corresponding configured module relays have no effect and can be ignored. Introduced in [v6.5.0.7](../commit/df6645481e08b36fe61aaebeeeed249d60730386)

`` = [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)_

[LedState](#ledstate) must be enabled (i.e., `!= 0`) in order for `LedMask` to take effect.

**Examples:**
  • `LedMask 0xFFFD` Every relay, except Relay2, controls the power LED (0xFFFD = 1111 1111 1111 1101)
  • `LedMask 0x0002` Only Relay 2 controls the power LED (0x0002 = 0000 0000 0000 0010)
    • LedPower | LED power state as on or off
    `0` = turn LED OFF and set `LedState 0`
    `1` = turn LED ON and set `LedState 0`
    `2` = toggle LED and set `LedState 0`
    (Use `Backlog LedPower 0; SetOption31 1` to disable LED even when Wi-Fi or MQTT is not connected) -LedPower\ | LED\ power state control. **Enabled only when LedLink(i) is configured**
    `0` = turn LED OFF and set `LedState 0`
    `1` = turn LED ON and set `LedState 0`
    `2` = toggle LED and set `LedState 0` LedState | Manage LED state
    `0` = disable use of LED as much as possible
    `1` = show power state on LED (LED on when power on) *(inverted for Sonoff Touch/T1)*
    `2` = show MQTT subscriptions as a LED blink
    `3` = show power state and MQTT subscriptions as a LED blink
    `4` = show MQTT publications as a LED blink
    `5` = show power state and MQTT publications as a LED blink
    `6` = show all MQTT messages as a LED blink
    `7` = show power state and MQTT messages as a LED blink

    `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` +LedPower\ | LED\ power state control. **Enabled only when LedLink(i) is configured** (Introduced in 6.5.0.12)
    `0` = turn LED OFF and set `LedState 0`
    `1` = turn LED ON and set `LedState 0`
    `2` = toggle LED and set `LedState 0` LedState | Manage LED state
    `0` = disable use of LED as much as possible
    `1` = show power state on LED (LED on when power on) *(inverted for Sonoff Touch/T1)*
    `2` = show MQTT subscriptions as a LED blink
    `3` = show power state and MQTT subscriptions as a LED blink
    `4` = show MQTT publications as a LED blink
    `5` = show power state and MQTT publications as a LED blink
    `6` = show all MQTT messages as a LED blink
    `7` = show power state and MQTT messages as a LED blink

    `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` Power\ | Control Relay\ power state and also resetting PulseTime\
    `0` / `off` = turn OFF
    `1` / `on` = turn ON
    `2` / `toggle` = if relay is `ON` switch to `OFF` and vice versa
    `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)
    `4` / `blinkoff` = stop blink sequence and return relay power to pre-blink state PowerOnState | Control relay state after _**powering up**_ the device. [More information](PowerOnState-Configuration)
    `0` / `OFF` = keep relay(s) OFF after power up
    `1` / `ON` = turn relay(s) ON after power up
    `2` / `TOGGLE` = toggle relay(s) from last saved state
    `3` = switch relay(s) to their last saved state *(default)*
    `4` = turn relay(s) ON and disable further relay control
    `5` = after a `PulseTime` period turn relay(s) ON (acts as inverted [`PulseTime`](Commands#pulsetime) mode) PulseTime\ | Display the amount of `PulseTime` remaining on Relay\
    `` Set the duration to keep Relay\ `ON` when `Power ON` command is issued. After this amount of time, the relay will be turned `OFF`.
    `0` / `OFF` = disable use of PulseTime for Relay\
    `1..111` = set PulseTime for Relay\ in 0.1 second increments
    `112..64900` = set PulseTime for Relay\, 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)