diff --git a/Commands.md b/Commands.md index fcfd3530..5d4cfe82 100644 --- a/Commands.md +++ b/Commands.md @@ -104,8 +104,9 @@ Simply put, other messages may precede messages published as a result of your co Backlog | List of commands to be executed in sequence separated by `;`
See [Using Backlog](#using-backlog) for examples. BlinkCount | Number of relay toggles ([blinks](#power)) **(does not control the status LED)**
`0` = blink many times before restoring power state
`1..32000` = set number of blinks BlinkTime | `2..3600` set duration, in 0.1 second increments, to [blink](#power) (i.e., toggle Power) for a relay **(does not control the status LED)** -ButtonDebounce | User control over button debounce timing
`40..1000` = set button debounce time in ms. Default is `40` -FanSpeed | Fan speed control *([iFan02](Sonoff-iFan02) module only)*
`0` = turn fan OFF
`1..3` = set fan speed
`+` = increase fan speed
`-` = decrease fan speed
+ButtonDebounce | User control over button debounce timing
`40..1000` = set button debounce time in ms. Default is `40` +Buzzer | `,,` All parameters are optional. Default value for each is `1` (one 100ms beep)

`2` - Beep twice with duration 100ms and pause 100ms
`2,3` - Beep twice with duration 300ms and pause 100ms
`2,3,4` - Beep twice with duration 300ms and pause 400ms +FanSpeed | Fan speed control *(iFan02/iFan03 only)*
`0` = turn fan OFF
`1..3` = set fan speed
`+` = increase fan speed
`-` = decrease fan speed
Interlock | Relay interlock mode and group selection.
`0` = set self-locking mode for all relays *(default)*
`1` = set interlock mode for selected relays | | 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.

`` = [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)
    • @@ -117,7 +118,7 @@ PowerOnState | Control relay state after _**powering up**_ the device. [More inf PulseTime\ | Display the amount of `PulseTime` remaining on the corresponding Relay (enumerated)
    `` Set the duration to keep the corresponding 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 the corresponding Relay
    `1..111` = set PulseTime for the corresponding Relay in 0.1 second increments
    `112..64900` = set PulseTime for the corresponding 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)
    SwitchDebounce | User control over switch debounce timing
    `40..1000` = set switch debounce time in ms. Default is `40` SwitchMode\ | [Switch mode](Buttons-and-Switches#switchmode)
    `0` = toggle *(default)*
    `1` = follow (0 = off, 1 = on)
    `2` = inverted follow (0 = on, 1 = off)
    `3` = pushbutton (default 1, 0 = toggle)
    `4` = inverted pushbutton (default 0, 1 = toggle)
    `5` = pushbutton with hold (default 1, 0 = toggle, Hold = hold)
    `6` = inverted pushbutton with hold (default 0, 1 = toggle, hold = hold)
    `7` = pushbutton toggle (0 = toggle, 1 = toggle) -See also | [`SetOption11`](#SetOption11) - Swap pushbutton single and double press functionality
    [`SetOption13`](#SetOption13) - Allow immediate action on single button press
    [`SetOption26`](#SetOption26) - Use indexes even when only one relay is present
    [`SetOption31`](#SetOption31) - Disable Wi-Fi LED status blinking
    [`SetOption32`](#SetOption32) - Set hold interval before sending `HOLD` action +See also | [`SetOption11`](#SetOption11) - Swap pushbutton single and double press functionality
    [`SetOption13`](#SetOption13) - Allow immediate action on single button press
    [`SetOption26`](#SetOption26) - Use indexes even when only one relay is present
    [`SetOption31`](#SetOption31) - Disable Wi-Fi LED status blinking
    [`SetOption32`](#SetOption32) - Set hold interval before sending `HOLD` action
    [`SetOption67`](#SetOption67) - Enable/Disable Buzzer ### Management