mirrors
/
Tasmota
mirror of https://github.com/arendst/Tasmota.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

added tb-<name> anchors to first cells of each command table so they can be parsed by Taz. DON'T REMOVE.

jziolkowski 2019-07-26 10:58:47 +02:00
parent 63903fa129
commit c4c20a8986
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
Commands.md

@ -99,7 +99,7 @@ Simply put, other messages may precede messages published as a result of your co
### Control
Command | Parameters
<a id="tb-command">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 the status LED)**<BR> `0` = blink many times before restoring power state <BR> `1..32000` = set number of blinks<a id="BlinkTime"></a>
@ -121,7 +121,7 @@ See also | [`SetOption11`](#SetOption11) - Swap pushbutton single and double p
### Management
Command | Parameters
<a id="tb-management">Command | Parameters
:--- | :---
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>
@ -159,7 +159,7 @@ WebLog|`0` = disable web logging<BR> `1` = show only error messages<BR> `2` = sh
### [Wi-Fi](Troubleshooting#Wi-Fi-issues-arduino-core-versions-and-espressif-sdk)
|Command | Parameters
|<a id="tb-wifi">Command | Parameters
|:--- | :---
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>
@ -179,7 +179,7 @@ See also | [`SetOption55`](#Setoption55) - mDNS service control<BR>[`SetOption
### [MQTT](MQTT)
Command | Parameters
<a id="tb-mqtt">Command | Parameters
:--- | :---
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>
@ -213,7 +213,7 @@ See also | [`SetOption2`](#setoption2) - Add units to status messages<BR>[`Set
### [Rules](Rules)
Command | Parameters
<a id="tb-rules">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>
@ -243,7 +243,7 @@ When `Mode 1` or `Mode 2` is used, `Latitude` and `Longitude` become available.
Timer1 {"Arm":1,"Mode":2,"Time":"-2:23","Window":0,"Days":"11TW11S","Repeat":1,"Output":1,"Action":1}
```
Command | Parameters
<a id="tb-timers">Command | Parameters
:--- | :---
Latitude|<a id="Latitude"></a>`<value>` = set latitude<a id="Longitude"></a>
Longitude|`<value>` = set longitude<a id="Timers"></a>
@ -264,7 +264,7 @@ 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="tb-sensor">Command | Parameters
:--- | :---
AdcParam|<a id="AdcParam"></a>ADC0 analog input parameters for NTC (Temperature) or LDR (Light)<BR>`2..3` = Set default parameters based on current ADC type<BR>`2,32000,10000,3350` = Set Steinhart-Hart formula NTC parameters for Bridge Resistance, NTC Resistance, and Beta Coefficient<BR>`3,10000,12518931,-1.405` = Set parameters for Bridge Resistance, Lux Scalar, and Lux Exponent<a id="Altitude"></a>
Altitude|`-30000..30000` - altitude in meters<a id="AmpRes"></a>
@ -288,7 +288,7 @@ See also | [`SetOption8`](#SetOption8) - Show temperature in Celsius *(defaul
### [Power Monitoring](Power-Monitoring-Calibration)
Command | Parameters
<a id="tb-powermon">Command | Parameters
:--- | :---
AmpRes |<a id="AmpRes"></a>Current sensor resolution<BR>`0..3` = maximum number of decimal places<a id="CurrentHigh"></a>
CurrentHigh|`0` = disable current high threshold *(default)*<BR>`<value>` = set current high threshold value in miliamps<a id="CurrentLow"></a>
@ -320,7 +320,7 @@ See Also | [`SetOption21`](#SetOption21) - Energy monitoring when power is off
<!--- Brightness|<a id="Brightness>"></a>`0..255` = set brightness value from 0 to 255<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="tb-lights">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>`#RRGGBBCWWW` = set hex color value for RGBCCT lights (5 PWM channels)<BR><BR>[**White Blend Mode:**](white-blend-mode) _used for 4 channel (RGBW) and 5 channel (RGBWC) devices_. Enable with [`RGBWWTable`](#rgbwwtable) by setting the last PWM channel to zero (e.g., `RGBWWTable 255,255,255,<n>,0`) to lower the white channel intensity.
@ -356,7 +356,7 @@ See also | [`SetOption15`](#SetOption15) - Set PWM control<BR>[`SetOption16`](
### [Sonoff RF Bridge](Sonoff-RF-Bridge-433)
Command | Parameters
<a id="tb-rfbridge">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>
@ -371,7 +371,7 @@ See also | [`SetOption28`](#SetOption28) - Set RF received data format
See [Linux Infrared Remote Control (LIRC)](http://www.lirc.org/) for more information. Edit the [`IRremoteESP8266`](https://github.com/arendst/Sonoff-Tasmota/blob/development/lib/IRremoteESP8266-2.6.0/src/IRremoteESP8266.h#L230) header in the `lib` folder to disable (i.e., set to `false`) any unneeded/unwanted protocols and compile your own firmware. Every protocol included consumes program memory and increases the time to decode the IR signal. The air conditioner protocols are the most expensive memory-wise.
Command | Parameters
<a id="tb-irremote">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)`. GPIO01 nor GPIO03 can be used.**_<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>Information on [Receiving Infrared Data](Receiving-Infrared-Remote-Control-Data)<a id="IRhvac"></a>
IRhvac | Send HVAC IR remote control code as JSON payload<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`
@ -379,7 +379,7 @@ IRhvac | Send HVAC IR remote control code as JSON payload<Br>`{"Vendor":"<value>
### SetOption overview
|Command | Parameters
|<a id="tb-setoption">Command | Parameters
:---: | :---
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 (i.e., disable inadvertent reset due to long press)<a id="SetOption2"></a>
@ -437,7 +437,7 @@ 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="tb-serial">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>
@ -458,7 +458,7 @@ 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="tb-mp3">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>
@ -472,7 +472,7 @@ MP3Volume|`0..100` = set Volume
### [Domoticz](Domoticz)
Command | Parameters
<a id="tb-domoticz">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>
@ -481,7 +481,7 @@ DomoticzSwitchIdx\<x\> | Show Domoticz Switch idx \<x\> (x = `1..4`)<BR>`0` = di
DomoticzUpdateTimer | Show current update timer value in seconds<BR>`0` = disable sending interim Domoticz status *(default)*<BR>`1..3600` = send status to Domoticz in defined intervals
### [KNX](KNX-Features)
Command | Parameters
<a id="tb-knx">Command | Parameters
:--- | :---
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>
@ -514,7 +514,7 @@ OPTION<a id="knxJSON"></a>| OPTION Value| OPTION| OPTION Value
### [Displays](Displays)
Command | Parameters
<a id="tb-displays">Command | Parameters
:--- | :---
Display |<a id="Display"></a>Show current display setting as JSON payload <a id="DisplayAddress"></a>
DisplayAddress|`0..255` = set display module address <a id="DisplayCols"></a>