From 98ad36f8a5db63edb8179f17b553af5d463a0108 Mon Sep 17 00:00:00 2001 From: Michael Ingraham <34340210+meingraham@users.noreply.github.com> Date: Wed, 1 May 2019 21:06:57 -0400 Subject: [PATCH] PulseTime rewording --- Commands.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Commands.md b/Commands.md index f698eeec..a93d29b9 100644 --- a/Commands.md +++ b/Commands.md @@ -103,7 +103,7 @@ 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 device LED)**
`0` = blink many times before restoring power state
`1..32000` = set number of blinks -BlinkTime | Time in 0.1 seconds to [blink](#power) (toggle Power) for a relay **(does not control device LED)**
`2..3600` = set with 0.1 second increment +BlinkTime | `2..3600` set duration, in 0.1 second increments, to [blink](#power) (i.e., toggle Power) for a relay **(does not control the device power 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
Interlock | Relay interlock mode and group selection.
`0` = set self-locking mode for all relays *(default)*
`1` = set interlock mode for selected relays @@ -113,7 +113,7 @@ LedPower | LED power state as on or off
`0` = turn LED OFF and LedState OFF 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\ | Set PulseTime of relay\ in 0.1 seconds
`0` / `off` = disable use of PulseTime for Relay\ *(default)*
`1..111` = set PulseTime for Relay\ in 0.1 seconds increments
`112..64900` = set PulseTime for Relay\ with 1 seconds increment starting with 12 seconds (add 100 to desired interval in seconds, e.g. 113 = 13 seconds and 220 = 120 seconds)
+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)
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