diff --git a/Commands.md b/Commands.md index e09c5d98..137c602b 100644 --- a/Commands.md +++ b/Commands.md @@ -106,8 +106,8 @@ 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|**6.2.0**
User control over button debounce timing
`40..1000` = set button debounce time in milliseconds. Default is `40` -Buzzer|**6.6.0.4**
`,,,`
All parameters are optional. The default is one 100milliseconds beep (`1` for ``, ``, and ``).
The `` parameter is a 32-bit [bitmask](https://en.wikipedia.org/wiki/Mask_(computing)#Masking_bits_to_1) where a `1` bit beeps and a `0` bit is silence according to the `` and `` duration parameters, respectively. The tune is played from most significant bit (MSB) to least significant bit (LSB). Leading and trailing `0` bits are ignored. If the `` parameter is specified, the `` parameter is ignored. If the `` parameter is `0`, it is ignored.

`3` - Beep three times with 100milliseconds duration and 100milliseconds pause
`2,3` - Beep twice with 300milliseconds duration and 100milliseconds pause
`2,3,4` - Beep twice with 300milliseconds duration and 400milliseconds pause
`1,2,3,0xF54` (0000 0000 0000 0000 0000 1111 0101 0100). Each `1` bit beeps for 200milliseconds and each bounded `0` bit pauses for 300milliseconds
A device LED can be assigned as a `Buzzer` component to display a blink pattern. +ButtonDebounce|**6.2.0**
User control over button debounce timing
`40..1000` = set button debounce time in milliseconds *(default = `40`)* +Buzzer|**6.6.0.4**
`,,,`
All parameters are optional. The default is one 100 millisecond beep (`1` for ``, ``, and ``).
The `` parameter is a 32-bit [bitmask](https://en.wikipedia.org/wiki/Mask_(computing)#Masking_bits_to_1) where a `1` bit beeps and a `0` bit is silence according to the `` and `` duration parameters, respectively. The tune is played from most significant bit (MSB) to least significant bit (LSB). Leading and trailing `0` bits are ignored. If the `` parameter is specified, the `` parameter is ignored. If the `` parameter is `0`, it is ignored.

`3` - Beep three times with 100 milliseconds duration and 100 milliseconds pause
`2,3` - Beep twice with 300 milliseconds duration and 100 milliseconds pause
`2,3,4` - Beep twice with 300 milliseconds duration and 400 milliseconds pause
`1,2,3,0xF54` (0000 0000 0000 0000 0000 1111 0101 0100). Each `1` bit beeps for 200 milliseconds and each bounded `0` bit pauses for 300 milliseconds
A device LED can be assigned as a `Buzzer` component to display a blink pattern. FanSpeed|**6.1.0**
Fan speed control *(iFan02/iFan03 only)*
`0` = turn fan OFF
`1..3` = set fan speed
`+` = increase fan speed
`-` = decrease fan speed
Interlock|**6.5.0**
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 @@ -119,7 +119,7 @@ Power0|**6.6.0.9**
Control the power state simultaneously Power\|Control the corresponding Relay (enumerated) power state and also restart 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 when the device is _**powered up**_. [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 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|**6.2.0**
User control over switch debounce timing
`40..1000` = set switch debounce time in milliseconds. Default is `40` +SwitchDebounce|**6.2.0**
User control over switch debounce timing
`40..1000` = set switch debounce time in milliseconds *(default = `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
[`SetOption67`](#SetOption67) - Enable/Disable Buzzer @@ -178,7 +178,7 @@ Password\|`1` = reset AP\ Wi-Fi password to firmwar Ssid\|`1` = reset AP\ Wi-Fi SSID to firmware default (`STA_SSID1` or `STA_SSID2`) and restart
``= set AP\ Wi-Fi SSID (32 char limit, **do not use special characters or white spaces in the SSID**) and restart WebColor\|**6.6.0**
Web GUI colors
`#RRGGBB` = Set web GUI color (x = `1..18`):
`1` = Global text (Black)
`2` = Global background (White)
`3` = Form background (Greyish)
`4` = Input text (Black)
`5` = Input background (White)
`6` = Console text (Black)
`7` = Console background (White)
`8` = Warning text (Red)
`9` = Success text (Green)
`10` = Button text (White)
`11` = Button (Blueish)
`12` = Button hovered over (Darker blueish)
`13` = Restart/Reset/Delete button (Redish)
`14` = Restart/Reset/Delete button hover (Darker reddish)
`15` = Save button (Greenish)
`16` = Save button hover (Darker greenish)
`17` = Config timer tab text (White)
`18` = Config timer tab background (Light grey) WebPassword|Show current web server password
`0` = disable use of password for WebUI
`1` = reset password to firmware default (`WEB_PASSWORD`)
`` = set WebUI password for user `WEB_USERNAME` (32 char limit) -WebRefresh|**6.3.0**
Web page refresh
`1000..10000` = set refresh time in milliseconds. Default is 2345
Default WEB_USERNAME is `admin`. +WebRefresh|**6.3.0**
Web page refresh
`1000..10000` = set refresh time in milliseconds *(default = `2345`)*
Default WEB_USERNAME is `admin`. WebSend|**6.1.0**
Send a command to Tasmota host. If a command starts with a `\` it will be used as a link.
`[:,:] `
`` = hostname or IP address.
`` = port for the device if not the default `80`
`` = enter username of the device you're sending the command to
`` = enter password of the device you're sending the command to
`` = command and payload
*example: `[] POWER1 ON` sends `http:///cm?cmnd=POWER1 ON`* WebSensor\|**6.6.0.5**
Control display of sensor telemetry in the web UI
`0` - Do not display sensor's telemetry
`1` - Display sensor's telemetry (*default*)
`` = number corresponding to the sensor - listed in the `sns` section of the [supported sensor spreadsheet](https://docs.google.com/spreadsheets/d/e/2PACX-1vRBFqaP5QAFmT8iIYBxrn-EQp7-SrkxL6tb0OjpqtBxDEsmkiWCFei3sFyA_UXoqlbs3CqtEdOfC6Pa/pubhtml?gid=1029939700&single=true)
`` = `3` Energy telemetry
Issue a `Status 4` to obtain a list of sensor types enabled in the firmware loaded on the device. WebServer|`0` = stop web server
`1` = start web server in user mode
`2` = start web server in admin mode @@ -191,7 +191,7 @@ See also|[`SetOption55`](#Setoption55) - mDNS service control
[`SetOption56`] Command|Parameters :---|:--- ButtonRetain|`0` = disable use of MQTT retain flag *(default)*
`1` = enable MQTT retain flag on button press -ButtonTopic|`` = set MQTT button topic (32 chars max)
`0` = disable use of MQTT button topic
`1` = set MQTT button topic to device `%topic%`
`2` = reset MQTT button topic to firmware default (`MQTT_BUTTON_TOPIC`) _(default = `0`)_
**_If using MQTT to issue this command, if it is used with the device `GroupTopic`, the command will not be executed._** +ButtonTopic|`` = set MQTT button topic (32 chars max)
`0` = disable use of MQTT button topic
`1` = set MQTT button topic to device `%topic%`
`2` = reset MQTT button topic to firmware default (`MQTT_BUTTON_TOPIC`) *(default = `0`)*
**_If using MQTT to issue this command, if it is used with the device `GroupTopic`, the command will not be executed._** FullTopic|`1` = reset MQTT fulltopic to firmware default (`MQTT_FULLTOPIC`) and restart
`` = set MQTT fulltopic (100 chars max) using optional %topic% and %prefix% and restart.
**_If using MQTT to issue this command, if it is used with the device `GroupTopic`, you must specify `%topic%` and/or `%prefix%` to insure uniqueness._** GroupTopic|`1` = reset MQTT group topic to firmware default (`MQTT_GRPTOPIC`) and restart
`` = set MQTT group topic (32 chars max) and restart MqttClient|`1` = reset MQTT client to firmware config (`MQTT_CLIENT_ID`) and restart
`` = set MQTT client (32 chars max) and restart.
You can use wildcard `%06X` to replace with last six characters of MAC address.
**_If using MQTT to issue this command, if it is used with the device `GroupTopic`, the command will not be executed._** @@ -214,7 +214,7 @@ StateText3|`` = set `TOGGLE` state text (10 chars StateText4|`` = set `HOLD` state text (10 chars max) SwitchRetain|`0` = disable use of MQTT retain flag *(default)*
`1` = enable MQTT retain flag on switch press Subscribe|**6.5.0**
List all topics currently subscribed
`, [, ]`
The `` parameter is optional. It is specified to parse a key/value pair from a JSON payload in the MQTT message. In order to parse a value from a multi-level JSON pair, you can use one dot (`.`) syntax to split the key into sections.

Subscribes to an MQTT topic and assigns an [`Event`](#event) name to it. You must compile your own binary with `#define SUPPORT_MQTT_EVENT` in your `user_config_override.h` file.

**Examples:**
  • `Rule1`
          `ON System#Boot DO Subscribe BkLight, stat/%topic%/POWER ENDON`
          `ON Event#BkLight=ON DO ENDON`
  • `Rule1`
          `ON System#Boot DO Subscribe DnTemp, stat/%topic%/SENSOR, DS18B20.Temperature ENDON`
          `ON Event#DnTemp>=21 DO ENDON`
          where the MQTT message payload is `{"Time":"2017-02-16T10:13:52", "DS18B20":{"Temperature":20.6}}`
    • -SwitchTopic|`` = set MQTT switch topic (32 chars max)
    `0` = disable use of MQTT switch topic
    `1` = set MQTT switch topic to device `%topic%`
    `2` = reset MQTT switch topic to firmware default (`MQTT_SWITCH_TOPIC`) _(default = `0`)_
    [Read more](Buttons-and-switches) about this.
    **_If using MQTT to issue this command, if it is used with the device `GroupTopic`, the command will not be executed._** +SwitchTopic|`` = set MQTT switch topic (32 chars max)
    `0` = disable use of MQTT switch topic
    `1` = set MQTT switch topic to device `%topic%`
    `2` = reset MQTT switch topic to firmware default (`MQTT_SWITCH_TOPIC`) *(default = `0`)*
    [Read more](Buttons-and-switches) about this.
    **_If using MQTT to issue this command, if it is used with the device `GroupTopic`, the command will not be executed._** TelePeriod|`0` = disable telemetry messages
    `1` = reset telemetry period to firmware default (`TELE_PERIOD`)
    `10..3600` = set telemetry period in seconds *(default = `300`)* Topic|`1` = reset MQTT topic to firmware default (`MQTT_TOPIC`) and restart
    `` = set MQTT topic (32 chars max) **and** `ButtonTopic` and restart.
    **_If using MQTT to issue this command, if it is used with the device `GroupTopic`, the command will not be executed._** Unsubscribe|**6.5.0**
    Unsubscribe from all topics currently subscribed using the [`Subscribe`](#subscribe) command
    `` = unsubscribe from a specific MQTT topic

    You must compile your own binary with `#define SUPPORT_MQTT_EVENT` in your `user_config_override.h` file. @@ -278,7 +278,7 @@ Note: Information on sensors documented below is transmitted in the Tasmota tele Command|Parameters :---|:--- -AdcParam|**6.6.0**
    ADC0 analog input tuning parameters
    `, , , `

    ``
    • `2` = Temperature [Steinhart-Hart thermistor equation](https://en.wikipedia.org/wiki/Steinhart%E2%80%93Hart_equation) parameters:
      • `` = NTC Voltage bridge resistor in Ohms (_default = 32000_)
      • `` = NTC Resistance in Ohms (_default = 10000_)
      • `` = NTC Beta Coefficient (_default = 3350_)
    • `3` = Light [Lux equation](https://www.allaboutcircuits.com/projects/design-a-luxmeter-using-a-light-dependent-resistor/) parameters:
      • `` = LDR Voltage bridge resistor in Ohms (_default = 10000_)
      • `` = LDR Lux Scalar (_default = 12518931_)
      • `` = LDR Lux Exponent (_default = -1.4050_)
    +AdcParam|**6.6.0**
    ADC0 analog input tuning parameters
    `, , , `

    ``
    • `2` = Temperature [Steinhart-Hart thermistor equation](https://en.wikipedia.org/wiki/Steinhart%E2%80%93Hart_equation) parameters:
      • `` = NTC Voltage bridge resistor in Ohms *(default = `32000`)*
      • `` = NTC Resistance in Ohms *(default = `10000`)*
      • `` = NTC Beta Coefficient *(default = `3350`)*
    • `3` = Light [Lux equation](https://www.allaboutcircuits.com/projects/design-a-luxmeter-using-a-light-dependent-resistor/) parameters:
      • `` = LDR Voltage bridge resistor in Ohms *(default = `10000`)*
      • `` = LDR Lux Scalar *(default = `12518931`)*
      • `` = LDR Lux Exponent *(default = `-1.4050`)*
    Altitude|`-30000..30000` - altitude in meters AmpRes|Current sensor resolution
    `0..3` = maximum number of decimal places Counter\|`0` = reset Counter\
    `1..64900` = preset Counter\
    `-1..-64900` = decrease Counter\
    `+1..+64900` = increase Counter\
    In order to define and use a Counter, _**you must configure one of the free device GPIO as `Counter`**_ @@ -414,7 +414,7 @@ SetOption28|**6.1.0**
    RF received data format
    `0` SetOption29|**6.1.0**
    IR received data format
    `0` = hex *(default)*
    `1` = decimal SetOption30|**6.1.0**
    Enforce Home Assistant auto-discovery as light
    `0` = relays are announced as a switch and PWM as a light *(default)*
    `1` = both relays and PWM are announced as light SetOption31|**6.2.0**
    Disable status LED blinking during Wi-Fi and MQTT connection problems.[`LedPower`](#LedPower) must be set to `0` for this feature to work.
    `0` = LED blinking enabled *(default)*
    `1` = LED blinking disabled -SetOption32|Number of 0.1 seconds to hold button before sending `HOLD` action message.
    `1..100` to set button hold time *(default =`40`)*. This option also affects the time required to perform a firmware defaults reset (10x `HOLD` action time) +SetOption32|Number of 0.1 seconds to hold button before sending `HOLD` action message.
    `1..100` to set button hold time *(default = `40`)*. This option also affects the time required to perform a firmware defaults reset (10x `HOLD` action time) SetOption33|Max power limit can be exceeded by number of seconds before the relay is turned off
    `1..250` = set number of seconds *(default = `5`)* SetOption34|**Unused from v6.6.0.10. Use [TuyaMCU](#TuyaMCU) command.**
    Set [Tuya dimmer device id](https://github.com/arendst/Sonoff-Tasmota/pull/4095). Use [SetOption43](#setoption43) to set the appropriate dimmer range.
    `0..255` = device id SetOption36|**6.5.0**
    Boot loop defaults restoration control.
    `0` = disable boot loop control
    `1..200` = set number of boot loops (a restart caused by any exception or watchdog timer within less than `BOOT_LOOP_TIME` (default 10 seconds) before beginning to restore settings *(default = `1`)*. Once this number is reached, subsequent restarts will:
    • 1st restart: disable ESP8285 generic GPIOs interfering with flash SPI
    • 2nd restart: disable rules causing boot loop
    • 3rd restart: disable all rules
    • 4th restart: reset user defined GPIOs to disable any attached peripherals
    • 5th restart: reset module to Sonoff Basic (1)
    @@ -553,9 +553,9 @@ DisplayHeight|**6.6.0.2**
    Specify the display heigh Command|Parameters |:--- |:--- -MotorMIS|`1,2,4,8,16` Set micro stepping increment - 1/1 (full steps) to 1/16 (_default = 1_) -MotorSPR|`integer` Set the number of steps the given motor needs for one revolution (_default = 200_)
    This is dependent on the type of motor and micro stepping. Most common motors are 1.8° per step. -MotorRPM|`1..300` Set revolutions per minute (_default = 30_) +MotorMIS|`1,2,4,8,16` Set micro stepping increment - 1/1 (full steps) to 1/16 *(default = `1`)* +MotorSPR|`integer` Set the number of steps the given motor needs for one revolution *(default = `200`)*
    This is dependent on the type of motor and micro stepping. Most common motors are 1.8° per step. +MotorRPM|`1..300` Set revolutions per minute *(default = `30`)* MotorMove|`integer` Move the motor the given number of steps (positive values: clockwise, negative values: counterclockwise) MotorRotate|`integer` Rotate the motor the given number of degrees (positive values: clockwise, negative values: counterclockwise) MotorTurn|`float` Spin the motor the given number of turns (positive values: clockwise, negative values: counterclockwise) \ No newline at end of file