Updated Commands (markdown)

Michael Ingraham 2019-05-08 15:05:45 -04:00
parent 04f1f4e33a
commit c67cf3c9e7
1 changed files with 40 additions and 40 deletions

@ -99,9 +99,9 @@ Simply put, other messages may precede messages published as a result of your co
### Control
|Command | Parameters
|:--- | :---
<a id="Backlog"></a>Backlog | List of commands to be executed in sequence separated by `;`<BR> See [Using Backlog](#using-backlog) for examples.<a id="BlinkCount"></a>
Command | Parameters
:--- | :---
Backlog | <a id="Backlog"></a>List of commands to be executed in sequence separated by `;`<BR> See [Using Backlog](#using-backlog) for examples.<a id="BlinkCount"></a>
BlinkCount | Number of relay toggles ([blinks](#power)) **(does not control device LED)**<BR> `0` = blink many times before restoring power state <BR> `1..32000` = set number of blinks<a id="BlinkTime"></a>
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)<a id="ButtonDebounce"></a>
ButtonDebounce | User control over button debounce timing <BR>`40..1000` = set button debounce time in ms. Default is `40`<a id="FanSpeed"></a>
@ -122,7 +122,7 @@ See also | [`SetOption11`](#SetOption11) - Swap pushbutton single and double p
Command | Parameters
:--- | :---
<a id="Delay"></a>Delay|`2..3600` = set delay between two backlog commands with 0.1 second increment<a id="Emulation"></a>
Delay|<a id="Delay"></a>`2..3600` = set delay between two backlog commands with 0.1 second increment<a id="Emulation"></a>
Emulation|`0` = disable emulation<BR>`1` = enable Belkin WeMo emulation for Alexa<BR>`2` = enable Hue Bridge emulation for Alexa<a id="Event"></a>
Event | Execute an event to trigger a rule as [documented](Rules#trigger)<a id="FriendlyName"></a>
FriendlyName\<x\>|`1` = Reset friendly name to firmware default<BR>`<value>` = set friendly name (32 char limit)<a id="Gpios"></a>
@ -158,7 +158,7 @@ WebLog|`0` = disable web logging<BR> `1` = show only error messages<BR> `2` = sh
|Command | Parameters
|:--- | :---
<a id="AP"></a>AP|`0` = switch to other Wi-Fi Access Point<BR>`1`= select Wi-Fi Access Point 1<BR>`2`= select Wi-Fi Access Point 2<a id="Hostname"></a>
AP|<a id="AP"></a>`0` = switch to other Wi-Fi Access Point<BR>`1`= select Wi-Fi Access Point 1<BR>`2`= select Wi-Fi Access Point 2<a id="Hostname"></a>
Hostname|`1` = reset hostname to `MQTT_TOPIC-<4digits>` and restart<BR>`<value>` = set hostname (32 char limit) and restart. If hostname contains `%` it will be reset to the default instead.<a id="IPAddress1"></a>
IPAddress1|`0.0.0.0.` = use dynamic IP address (DHCP)<BR>`XXX.XXX.XXX.XXX` = set static IP address<a id="IPAddress2"></a>
IPAddress2|`XXX.XXX.XXX.XXX` = set gateway IP address<a id="IPAddress3"></a>
@ -179,7 +179,7 @@ See also | [`SetOption55`](#Setoption55) - mDNS service control<BR>[`SetOption
Command | Parameters
:--- | :---
<a id="ButtonRetain"></a>ButtonRetain|`0` = disable use of MQTT retain flag *(default)*<BR>`1` = enable MQTT retain flag on button press<a id="ButtonTopic"></a>
ButtonRetain|<a id="ButtonRetain"></a>`0` = disable use of MQTT retain flag *(default)*<BR>`1` = enable MQTT retain flag on button press<a id="ButtonTopic"></a>
ButtonTopic|`<value>` = set MQTT button topic (32 chars max)<BR>`0` = disable use of MQTT button topic<BR>`1` = set MQTT button topic to device `%topic%`<BR>`2` = reset MQTT button topic to firmware default (`MQTT_BUTTON_TOPIC`) _(default = `0`)_<a id="FullTopic"></a>
FullTopic|`1` = reset MQTT fulltopic to firmware default (`MQTT_FULLTOPIC`) and restart<BR>`<value>` = set MQTT fulltopic (100 chars max) using optional %topic% and %prefix% and restart<a id="GroupTopic"></a>
GroupTopic|`1` = reset MQTT group topic to firmware default (`MQTT_GRPTOPIC`) and restart<BR>`<value>` = set MQTT group topic (32 chars max) and restart<a id="MqttClient"></a>
@ -209,9 +209,9 @@ See also | [`SetOption2`](#setoption2) - Add units to status messages<BR>[`Set
### [Rules](Rules)
|Command | Parameters
|:--- | :---
<a id="Rule"></a>Rule\<x\> | There are 3 separate rule sets, each with a 511 character limit. Each rule set can contain multiple [rules](Rules#rule-syntax). Each of the rule sets can be enabled or disabled individually (x = `1..3`)<BR>`0` = disable Rule\<x\><BR>`1` = enable Rule\<x\><BR>`2` = toggle Rule\<x\><BR>`4` = disable one-shot detection (perform commands as long as trigger is met)<BR>`5` = enable one-shot (e.g., sometimes used for slow changing sensors like temperature) detection<BR>`6` = toggle one-shot detection<BR>`8` = disable stop-on-error after exception restart<BR>`9` = enable stop-on-error after exception restart<BR>`10` = toggle stop-on-error after exception restart<BR>`<value>` = define [Rule\<x\>](Rules)<BR>`+<value>` = append to [Rule\<x\>](Rules)<BR>`""` = clear Rule\<x\><a id="RuleTimer"></a>
Command | Parameters
:--- | :---
Rule\<x\> |<a id="Rule"></a>There are 3 separate rule sets, each with a 511 character limit. Each rule set can contain multiple [rules](Rules#rule-syntax). Each of the rule sets can be enabled or disabled individually (x = `1..3`)<BR>`0` = disable Rule\<x\><BR>`1` = enable Rule\<x\><BR>`2` = toggle Rule\<x\><BR>`4` = disable one-shot detection (perform commands as long as trigger is met)<BR>`5` = enable one-shot (e.g., sometimes used for slow changing sensors like temperature) detection<BR>`6` = toggle one-shot detection<BR>`8` = disable stop-on-error after exception restart<BR>`9` = enable stop-on-error after exception restart<BR>`10` = toggle stop-on-error after exception restart<BR>`<value>` = define [Rule\<x\>](Rules)<BR>`+<value>` = append to [Rule\<x\>](Rules)<BR>`""` = clear Rule\<x\><a id="RuleTimer"></a>
RuleTimer\<x\> | Up to eight timers to be used as countdown event (x = `1..8`)<BR>`0..32766` = set countdown rule timer in seconds<a id="Mem"></a>
Mem\<x\> | Manage up to 5 variables stored on flash (x = `1..5`)<BR>`<value>` = store a string value in a variable<BR>`"` = clear stored value in Mem\<x\><a id="Var"></a>
Var\<x\> | Manage up to 5 variables stored in memory (x = `1..5`)<BR>`<string>` = store a string value in a variable<BR>`"` = clear stored value in Var\<x\><a id="Add"></a>
@ -241,7 +241,7 @@ Timer1 {"Arm":1,"Mode":2,"Time":"-2:23","Window":0,"Days":"11TW11S","Repeat":1,"
Command | Parameters
:--- | :---
<a id="Latitude"></a>Latitude|`<value>` = set latitude<a id="Longitude"></a>
Latitude|<a id="Latitude"></a>`<value>` = set latitude<a id="Longitude"></a>
Longitude|`<value>` = set longitude<a id="Timers"></a>
Timers | Timers control<BR> `0` = disable all timers<BR>`1` = enable all timers<BR>`2` = toggle all timers<BR><a id="Timer"></a>
Timer\<x\> | Parameters for Timer\<x\> where x = `1..16`<BR>`0` = clear parameters for Timer\<x\><BR>`1..16` = copy Timer\<y\> parameters to Timer\<x\><BR>`{ "name":value ; .. }` = set all or individual parameters using JSON string with names and values from the below table of data pairs
@ -260,9 +260,9 @@ Action |`0` = turn output OFF<BR> `1` = turn output ON<BR>`2` = TOGGLE output<B
### [Sensor](Sensor-Configuration)
Note: Information on sensors documented below is transmitted in the Tasmota telemetry message
|Command | Parameters
|:--- | :---
<a id="Altitude"></a>Altitude|`-30000..30000` - altitude in meters<a id="AmpRes"></a>
Command | Parameters
:--- | :---
Altitude|<a id="Altitude"></a>`-30000..30000` - altitude in meters<a id="AmpRes"></a>
AmpRes | Current sensor resolution<BR>`0..3` = maximum number of decimal points<a id="Counter"></a>
Counter\<x\>|`0` = reset Counter\<x\><BR> `1..64900` = preset Counter\<x\><BR>`-1..-64900` = decrease Counter\<x\><BR>`+1..+64900` = increase Counter\<x\><BR>In order to define and use a Counter, _**you must configure one of the free device GPIO as 'Counter<x>'**_<a id="CounterDebounce"></a>
CounterDebounce|`0` = turn off counter debounce<BR> `1..3200` = set counter debounce time in msec<a id="CounterType"></a>
@ -282,9 +282,9 @@ See also | [`SetOption8`](#SetOption8) - Show temperature in Celsius *(defaul
### [Power Monitoring](Sonoff-Pow-and-Pow-R2)
|Command | Parameters
|:--- | :---
<a id="AmpRes"></a>AmpRes | Current sensor resolution<BR>`0..3` = maximum number of decimal points<a id="CurrentHigh"></a>
Command | Parameters
:--- | :---
AmpRes |<a id="AmpRes"></a>Current sensor resolution<BR>`0..3` = maximum number of decimal points<a id="CurrentHigh"></a>
CurrentHigh|`0` = disable current high threshold *(default)*<BR>`<value>` = set current high threshold value in miliamps<a id="CurrentLow"></a>
CurrentLow|`0` = disable current low threshold *(default)*<BR>`<value>` = set current low threshold value in miliamps<a id="CurrentSet"></a>
CurrentSet|`<value>` = [calibrate](power-monitoring-calibration) current to target value in mA<a id="EnergyRes"></a>
@ -311,12 +311,12 @@ WattRes | Power sensor resolution<BR>`0..3` = maximum number of decimal points
See Also | [`SetOption21`](#SetOption21) - Energy monitoring when power is off<BR>[`SetOption33`](#SetOption33) - Configure power monitoring Max_Power_Retry count number<BR>
### [Light](Lights)
<!--- <a id="Brightness>"></a>Brightness|`0..255` = set brightness value from 0 to 255 (introduced in 6.5.0.9)<a id="Channel"></a>
<!--- Brightness|<a id="Brightness>"></a>`0..255` = set brightness value from 0 to 255 (introduced in 6.5.0.9)<a id="Channel"></a>
Channel\<x\>|`0..100` = set PWM channel dimmer value from 0 to 100%<a id="Color"></a> -->
|Command | Parameters
|:--- | :---
<a id="Channel"></a>Channel\<x\>|`0..100` = set PWM channel dimmer value from 0 to 100%<a id="Color"></a>
Command | Parameters
:--- | :---
Channel\<x\>|<a id="Channel"></a>`0..100` = set PWM channel dimmer value from 0 to 100%<a id="Color"></a>
Color | Show color setting (hex or decimal depending on [`SetOption17`](#SetOption17))<BR> `r,g,b` = set color by decimal value (`0..255`)<BR>`#CWWW` = set hex color value for CT lights <BR>`#RRGGBB` = set hex color value for RGB lights<BR>`#RRGGBBWW` = set hex color value for RGBW lights<BR>`#RRGGBBCCWW` = set hex color value for RGBCCT lights (5 PWM channels)
| | Set color to<BR>`1` = red<BR>`2` = green<BR>`3` = blue<BR>`4` = orange<BR>`5` = light green<BR>`6` = light blue<BR>`7` = amber<BR>`8` = cyan<BR>`9` = purple<BR>`10` = yellow<BR>`11` = pink<BR>`12` = white (using RGB channels)<BR>`+` = next color<BR>`-` = previous color<a id="Color2"></a>
Color2 | Same as `Color` but adjust to current `Dimmer` value<a id="Color3"></a>
@ -349,9 +349,9 @@ See also | [`SetOption15`](#SetOption15) - Set PWM control<BR>[`SetOption16`](
### [Sonoff RF Bridge](Sonoff-RF-Bridge-433)
|Command | Parameters
|:--- | :---
<a id="RfCode"></a>RfCode | Show last sent 24-bit user code<BR>`1..8388607` = send 24-bit user code<BR>`#1..#7FFFFF` = send 24-bit hexadecimal user code using RfSync, RfLow and RfHigh timing<a id="RfHigh"></a>
Command | Parameters
:--- | :---
RfCode |<a id="RfCode"></a>Show last sent 24-bit user code<BR>`1..8388607` = send 24-bit user code<BR>`#1..#7FFFFF` = send 24-bit hexadecimal user code using RfSync, RfLow and RfHigh timing<a id="RfHigh"></a>
RfHigh|`1` = reset high pulse time to 840 microseconds<BR>`2..32767` = set high pulse time in microseconds<BR>`#2..#7FFF` = set high pulse time in hexadecimal microseconds<a id="RfHost"></a>
RfHost | Show 16-bit host part of user code<BR>`1` = reset 16-bit host part of user code to 11802 (#2E1A)<BR>`2..32767` = set 16-bit host part of user code<BR>`#2..7FFF` = set 16-bit host part of user code in hexadecimal<a id="RfKey"></a>
RfKey\<x\> | Send learned or default RF data for RfKey\<x\> (x = `1 16`)<BR>`1` = send default RF data for RfKey\<x\> using RfSync, RfLow, RfHigh and RfHost parameters<BR>`2` = learn RF data for RfKey\<x\><BR>`3` = unlearn RF data for RfKey\<x\><BR>`4` = save RF data using RfSync, RfLow, RfHigh and last RfCode parameters<BR>`5` = show default or learned RF data<a id="RfLow"></a>
@ -364,8 +364,8 @@ See also | [`SetOption28`](#SetOption28) - Set RF received data format
See [Linux Infrared Remote Control (LIRC)](http://www.lirc.org/) for more information.
|Command | Parameters
|:--- | :---
Command | Parameters
:--- | :---
IRsend | <a id="IRsend"></a>Send an IR remote control code as a decimal or hexadecimal string in a JSON payload. In order to send IR data, _**you must configure one of the free device GPIO as 'IRsend (8)'**_.<BR><BR>`{"Protocol":"<value>","Bits":<value>,"Data":<value>}`<BR><BR>`"Protocol":"NEC"\|"SONY"\|"RC5"\|"RC6"\|"DISH"\|"JVC"\|"PANASONIC"\|"SAMSUNG"`<BR>`"Bits":1..32` = required number of data bits<BR>&nbsp;&nbsp;&nbsp;&nbsp;for PANASONIC protocol this parameter is the the address, not the number of bits<BR><BR>`"Data":1..(2^32)-1` = data frame as 32 bit decimal.<BR>&nbsp;&nbsp;&nbsp;&nbsp;e.g., `IRsend {"Protocol":"NEC","Bits":32,"Data":2170978686}`<BR>**or**<BR>`"Data":0x1..0xFFFFFFFF` = data frame as 32 bit hexadecimal.<BR>&nbsp;&nbsp;&nbsp;&nbsp;e.g., `IRsend {"Protocol":"NEC","Bits":32,"Data":0x8166817E}`<BR><BR>Alternatively, you can send IR remote control codes using [RAW command encoding](IRSend-RAW-Encoding).<BR><BR>An inexpensive IR sensor such as a [TSOP1838](https://hobbyking.com/en_us/keyes-tsop1838-infra-red-37-9khz-receiver-for-arduino.html) can be connected to a device running Tasmota. Configure a free device GPIO as 'IRrecv (51)'. When Tasmota receives an IR message, the data portion of the payload has the same format as the `IRsend` parameter.<BR>&nbsp;&nbsp;&nbsp;&nbsp;`{"IrReceived":{"Protocol":"<value>","Bits":<value>,"Data":<value>}}`<BR><BR>This JSON payload can be used in a rule such as:<BR>&nbsp;&nbsp;&nbsp;&nbsp;`ON IrReceived#Data=<value> DO <command> ENDON`<a id="IRhvac"></a>
IRhvac | Send HVAC IR remote control code as JSON string<Br>`{"Vendor":"<value>","Power":<value>,"Mode":”<value>”, "FanSpeed":”<value>”,"Temp":<value>}`<BR>`"Vendor":"Toshiba"\|"Mitsubishi"\|"LG"\|"Fujitsu"`<BR>`"Power":0\|1`<BR>`"Mode":"Hot"\|"Cold"\|"Dry"\|"Auto"`<BR>`"FanSpeed":"1"\|"2"\|"3"\|"4"\|"5"\|"Auto"\|"Silence"` <BR>`"Temp":17..30`
| See also | [`SetOption29`](#SetOption29) - Set IR received data format<BR>[`SetOption58`](#SetOption58) - [IR Raw data in JSON message](https://github.com/arendst/Sonoff-Tasmota/issues/2116#issuecomment-440716483)
@ -374,7 +374,7 @@ IRhvac | Send HVAC IR remote control code as JSON string<Br>`{"Vendor":"<value>"
|Command | Parameters
:---: | :---
<a id="SetOption0"></a>SetOption0|Save power state and use after restart (=SaveState)<BR> `0` = disable<BR> `1` = enable *(default)*<a id="SetOption1"></a>
SetOption0|<a id="SetOption0"></a>Save power state and use after restart (=SaveState)<BR> `0` = disable<BR> `1` = enable *(default)*<a id="SetOption1"></a>
SetOption1|Set [button multipress](Control-other-devices) mode to<BR> `0` = allow all button actions *(default)*<BR> `1` = restrict to single, double and hold actions<a id="SetOption2"></a>
SetOption2|Add units to status messages<BR>`0` = disabled *(default)*<BR> `1` = enabled<a id="SetOption3"></a>
SetOption3|[MQTT](mqtt) <BR>`0` = disable MQTT<BR> `1` = enable MQTT *(default)* <a id="SetOption4"></a>
@ -422,9 +422,9 @@ Both Hardware and Software Serial Bridge are supported.
Hardware Serial Bridge uses GPIO1 (Tx) and GPIO3 (Rx) pins of your device.
Software Serial Bridge can use any other GPIO to be selected with command ``GPIO<x> 67``, ``GPIO<x> 68`` or in Module options by setting GPIOs to ``SerBr Tx`` and ``SerBr Rx``. Expect possible communication errors when additional sensors are configured.
|Command | Parameters
|:--- | :---
<a id="Baudrate"></a>Baudrate|`1` = set hardware serial bridge to default baudrate of 115200 bps<BR>`<value>` = set baudrate<a id="SBaudrate"></a>
Command | Parameters
:--- | :---
Baudrate|<a id="Baudrate"></a>`1` = set hardware serial bridge to default baudrate of 115200 bps<BR>`<value>` = set baudrate<a id="SBaudrate"></a>
SBaudrate|`1` = set software serial bridge to default baudrate of 9600 bps<BR>`<value>` = set baudrate<a id="SerialDelimiter"></a>
SerialDelimiter | Show current serial delimiter<a id="SerialDelimiter"></a>
SerialDelimiter|`<value>` = set serial delimiter to [escape character code](https://en.wikipedia.org/wiki/Escape_character#ASCII_escape_character) or ASCII character<a> </a>`1..127` = set serial delimiter to [decimal ASCII](http://www.asciichart.com/)<BR>`128` = only allow ASCII characters 32 to 127 in response text<BR>`129..255` = disable serial delimiter<BR>
@ -443,9 +443,9 @@ SSerialSend5|`<value>` = send hex text to software serial port. Data in serial r
The MP3 Player driver is based on the one from DF Robot. They named it [DFPlayer mini](https://www.dfrobot.com/wiki/index.php/DFPlayer_Mini_SKU:DFR0299). All MP3 Players with the identical Serial Control Command structure can be used.
|Command | Parameters
|:--- | :---
<a id="MP3DAC"></a>MP3DAC|`0` = DAC on *(default)*<BR>`1` = DAC off<a id="MP3Device"></a>
Command | Parameters
:--- | :---
MP3DAC|<a id="MP3DAC"></a>`0` = DAC on *(default)*<BR>`1` = DAC off<a id="MP3Device"></a>
MP3Device | Specify playback device<BR>`1` = USB<BR>`2` = SD Card *(default (also defaults on reset or power cycle))*<a id="MP3EQ"></a>
MP3EQ | Set equalizer mode:<BR>`0` = normal<BR>`1` = pop<BR>`2` = rock<BR>`3` = jazz<BR>`4` = classic<BR>`5` = bass)<a id="MP3Pause"></a>
MP3Pause | Pause<a id="MP3Play"></a>
@ -457,9 +457,9 @@ MP3Volume|`0..100` = set Volume
### [Domoticz](Domoticz)
|Command | Parameters
|:--- | :---
<a id="DomoticzIdx"></a>DomoticzIdx\<x\> | Show Domoticz Relay idx \<x\> (x = `1..4`)<BR>`0` = disable use of Relay idx \<x\> *(default)*<BR>`<value>` = Show Relay idx \<x\><a id="DomoticzKeyIdx"></a>
Command | Parameters
:--- | :---
DomoticzIdx\<x\> |<a id="DomoticzIdx"></a>Show Domoticz Relay idx \<x\> (x = `1..4`)<BR>`0` = disable use of Relay idx \<x\> *(default)*<BR>`<value>` = Show Relay idx \<x\><a id="DomoticzKeyIdx"></a>
DomoticzKeyIdx\<x\> | Show Domoticz Key idx \<x\> (x = `1..4`)<BR>`0` = disable use of Key idx \<x\> *(default)*<BR>`<value>` = Show Key idx \<x\> (to use enable [ButtonTopic](#buttontopic))<a id="DomoticzSensorIdx"></a>
DomoticzSensorIdx\<x\> | Show Domoticz Sensor idx \<x\> (x = `1..5`)<BR>`0` = disable use of Sensor idx \<x\> *(default)*<BR>`<value>` = Show Sensor idx \<x\> <a id="DomoticzSwitchIdx"></a>
DomoticzSwitchIdx\<x\> | Show Domoticz Switch idx \<x\> (x = `1..4`)<BR>`0` = disable use of Switch idx \<x\> *(default)*<BR>`<value>` = Show Switch idx \<x\> (to use enable [SwitchTopic](#switchtopic))<a id="DomoticzUpdateTimer"></a>
@ -468,7 +468,7 @@ DomoticzUpdateTimer | Show current update timer value in seconds<BR>`0` = disabl
Command | Parameters
:--- | :---
<a id="KnxTx_Cmnd"></a>KnxTx_Cmnd\<x\>|`0` or `1` = send command using slot \<x\> set in KNX Menu at KNX_TX <a id="KnxTx_Val"></a>
KnxTx_Cmnd\<x\>|<a id="KnxTx_Cmnd"></a>`0` or `1` = send command using slot \<x\> set in KNX Menu at KNX_TX <a id="KnxTx_Val"></a>
KnxTx_Val\<x\>|`<value>` = send float value using slot \<x\> set in KNX Menu at KNX_TX <a id="KNX_ENABLED"></a>
KNX_ENABLED | Status of KNX Communications<BR>`0` = set to Disable<BR>`1` = set to Enable <a id="KNX_ENHANCED"></a>
KNX_ENHANCED | Status of Enhanced mode for KNX Communications<BR>`0` = set to Disable<BR>`1` = set to Enable <a id="KNX_PA"></a>
@ -499,9 +499,9 @@ OPTION| OPTION Value| OPTION| OPTION Value
### [Displays](Displays)
|Command | Parameters
|:--- | :---
<a id="Display"></a>Display | Show current display setting as JSON string <a id="DisplayAddress"></a>
Command | Parameters
:--- | :---
Display |<a id="Display"></a>Show current display setting as JSON string <a id="DisplayAddress"></a>
DisplayAddress|`0..255` = set display module address <a id="DisplayDimmer"></a>
DisplayDimmer|`0` = switch the display off<BR> `1..100` = switch the display on<BR>`0..100` = set display luminosity *(only on 8x8 Dot-Matrix displays)* <a id="DisplayMode"></a>
DisplayMode|`0..5` = set to display [predefined content](#displaymode-parameters) according to display type <a id="DisplayModel"></a>