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

Revert add70e507dfd16aa5c7aa0d6425481eb992d0298...7fcab6bd5f7de37874ab444be5e7297ea63f5081 on Commands

blakadder 2019-02-23 10:45:22 +01:00
parent 5ff1956bcc
commit 677064270c
1 changed files with 1 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
Commands.md

@ -90,8 +90,6 @@ When a command mentions resetting to *"firmware default"* it means the setting w
Simply put, other messages may precede messages published as a result of your commands. Simply put, other messages may precede messages published as a result of your commands.
* a `tele/%topic%/STATUS` message (sent every 300 seconds by default) may appear exactly after you issue `Power off` command and before you receive `stat/%topic%/RESULT = {"POWER":"OFF"}` message. * a `tele/%topic%/STATUS` message (sent every 300 seconds by default) may appear exactly after you issue `Power off` command and before you receive `stat/%topic%/RESULT = {"POWER":"OFF"}` message.
[Back to Top](Commands)
### Control ### Control
|Command | Parameters |Command | Parameters
@ -112,8 +110,6 @@ Simply put, other messages may precede messages published as a result of your co
<a id="SwitchMode"> </a> SwitchMode\<x\> | [Switch mode](Buttons-and-Switches#switchmode) <BR> `0` = toggle *(default)* <BR> `1` = follow (0 = off, 1 = on) <BR> `2` = inverted follow (0 = on, 1 = off) <BR> `3` = pushbutton (default 1, 0 = toggle) <BR> `4` = inverted pushbutton (default 0, 1 = toggle) <BR> `5` = pushbutton with hold (default 1, 0 = toggle, Hold = hold) <BR> `6` = inverted pushbutton with hold (default 0, 1 = toggle, hold = hold) <BR> `7` = pushbutton toggle (0 = toggle, 1 = toggle) <a id="SwitchMode"> </a> SwitchMode\<x\> | [Switch mode](Buttons-and-Switches#switchmode) <BR> `0` = toggle *(default)* <BR> `1` = follow (0 = off, 1 = on) <BR> `2` = inverted follow (0 = on, 1 = off) <BR> `3` = pushbutton (default 1, 0 = toggle) <BR> `4` = inverted pushbutton (default 0, 1 = toggle) <BR> `5` = pushbutton with hold (default 1, 0 = toggle, Hold = hold) <BR> `6` = inverted pushbutton with hold (default 0, 1 = toggle, hold = hold) <BR> `7` = pushbutton toggle (0 = toggle, 1 = toggle)
See also | [`SetOption11`](#SetOption11) - Swap pushbutton single and double press functionality<BR>[`SetOption13`](#SetOption13) - Allow immediate action on single button press<BR>[`SetOption26`](#SetOption26) - Use indexes even when only one relay is present<BR>[`SetOption31`](#SetOption31) - Disable Wi-Fi LED status blinking<BR>[`SetOption32`](#SetOption32) - Set hold interval before sending hold action See also | [`SetOption11`](#SetOption11) - Swap pushbutton single and double press functionality<BR>[`SetOption13`](#SetOption13) - Allow immediate action on single button press<BR>[`SetOption26`](#SetOption26) - Use indexes even when only one relay is present<BR>[`SetOption31`](#SetOption31) - Disable Wi-Fi LED status blinking<BR>[`SetOption32`](#SetOption32) - Set hold interval before sending hold action
[Back to Top](Commands)
### Management ### Management
Command | Parameters Command | Parameters
@ -149,8 +145,6 @@ Command | Parameters
<a id="Upgrade"> </a> Upgrade | `1` = download firmware from `OtaUrl` and restart<BR>`<value>` = download firmware from `OtaUrl` if \<value\> is higher than device version <a id="Upgrade"> </a> Upgrade | `1` = download firmware from `OtaUrl` and restart<BR>`<value>` = download firmware from `OtaUrl` if \<value\> is higher than device version
<a id="Upload"> </a> Upload | `1` = download firmware from `OtaUrl` and restart<BR>`<value>` = download firmware from `OtaUrl` if \<value\> is higher than device version <a id="Upload"> </a> Upload | `1` = download firmware from `OtaUrl` and restart<BR>`<value>` = download firmware from `OtaUrl` if \<value\> is higher than device version
<a id="WebLog"> </a> WebLog | `0` = disable web logging<BR> `1` = show only error messages<BR> `2` = show error and info messages<BR>`3` = show error, info and debug messages<BR>`4` = show all messages <a id="WebLog"> </a> WebLog | `0` = disable web logging<BR> `1` = show only error messages<BR> `2` = show error and info messages<BR>`3` = show error, info and debug messages<BR>`4` = show all messages
[Back to Top](Commands)
### Wi-Fi ### Wi-Fi
@ -172,8 +166,6 @@ Command | Parameters
<a id="WifiConfig"> </a> WifiConfig | `0` - disable Wi-Fi config but restart (used with alternate AP)<BR>`1` = start smart config for 1 minute and set as current config tool<BR>`2` = start Wi-Fi manager (web server at 192.168.4.1) and set as current config tool<BR>`3` = start WPS config for 1 minute and set as current config tool<BR>`4` = disable Wi-Fi config but retry other AP without restart<BR>`5` = disable Wi-Fi config but retry same AP without restart and flash writes <a id="WifiConfig"> </a> WifiConfig | `0` - disable Wi-Fi config but restart (used with alternate AP)<BR>`1` = start smart config for 1 minute and set as current config tool<BR>`2` = start Wi-Fi manager (web server at 192.168.4.1) and set as current config tool<BR>`3` = start WPS config for 1 minute and set as current config tool<BR>`4` = disable Wi-Fi config but retry other AP without restart<BR>`5` = disable Wi-Fi config but retry same AP without restart and flash writes
See also | [`SetOption55`](#Setoption55) - mDNS service control<BR>[`SetOption56`](#Setoption56) - Wi-Fi network scan to select strongest signal on restart<BR>[`SetOption57`](#Setoption57) - Wi-Fi network re-scan every 44 minutes with switch to +10dB stronger signal if detected See also | [`SetOption55`](#Setoption55) - mDNS service control<BR>[`SetOption56`](#Setoption56) - Wi-Fi network scan to select strongest signal on restart<BR>[`SetOption57`](#Setoption57) - Wi-Fi network re-scan every 44 minutes with switch to +10dB stronger signal if detected
[Back to Top](Commands)
### [MQTT](MQTT) ### [MQTT](MQTT)
Command | Parameters Command | Parameters
@ -207,8 +199,6 @@ Command | Parameters
<a id="Topic"> </a> Topic | `1` = reset MQTT topic to firmware default (`MQTT_TOPIC`) and restart<BR>`<value>` = set MQTT topic (32 chars max) **and** `ButtonTopic` and restart <a id="Topic"> </a> Topic | `1` = reset MQTT topic to firmware default (`MQTT_TOPIC`) and restart<BR>`<value>` = set MQTT topic (32 chars max) **and** `ButtonTopic` and restart
See also | [`SetOption2`](#setoption2) - Add units to status messages<BR>[`SetOption4`](#setoption4) - Return MQTT response as RESULT or %COMMAND% topic<BR>[`SetOption10`](#setoption10) - Main topic change behaviour See also | [`SetOption2`](#setoption2) - Add units to status messages<BR>[`SetOption4`](#setoption4) - Return MQTT response as RESULT or %COMMAND% topic<BR>[`SetOption10`](#setoption10) - Main topic change behaviour
[Back to Top](Commands)
### [Rules](Rules) ### [Rules](Rules)
|Command | Parameters |Command | Parameters
@ -223,8 +213,6 @@ See also | [`SetOption2`](#setoption2) - Add units to status messages<BR>[`Set
<a id="Scale"> </a> Scale\<x\> | Scale value from a low and high limit to another low and high limits and save in Var\<x\><BR>`v` = value: the number to scale<BR>`fl` = fromLow: the lower bound of the value’s current range<BR>`fh` = fromHigh: the upper bound of the value’s current range<BR>`tl` = toLow: the lower bound of the value’s target range<BR>`th` = toHigh: the upper bound of the value’s target range <a id="Scale"> </a> Scale\<x\> | Scale value from a low and high limit to another low and high limits and save in Var\<x\><BR>`v` = value: the number to scale<BR>`fl` = fromLow: the lower bound of the value’s current range<BR>`fh` = fromHigh: the upper bound of the value’s current range<BR>`tl` = toLow: the lower bound of the value’s target range<BR>`th` = toHigh: the upper bound of the value’s target range
<a id="CalcRes"> </a> CalcRes | `0..7` = set number of decimals to be used in `Add`, `Sub`, `Mult` and `Scale` <a id="CalcRes"> </a> CalcRes | `0..7` = set number of decimals to be used in `Add`, `Sub`, `Mult` and `Scale`
[Back to Top](Commands)
### Timers ### Timers
To control a device locally 16 timers are programmable. They can be configured with the Timer\<x\> command following by a JSON string with optional parameters. For example: To control a device locally 16 timers are programmable. They can be configured with the Timer\<x\> command following by a JSON string with optional parameters. For example:
@ -261,8 +249,6 @@ Repeat | `0` = allow timer only once<BR>`1` = repear timer execution
Output | `1..16` = select an output to be used if no rule is enabled Output | `1..16` = select an output to be used if no rule is enabled
Action | `0` = turn output OFF<BR> `1` = turn output ON<BR>`2` = TOGGLE output<BR>`3` = BLINK output using [BlinkCount](#BlinkCount) parameters or execute a rule when enabled Action | `0` = turn output OFF<BR> `1` = turn output ON<BR>`2` = TOGGLE output<BR>`3` = BLINK output using [BlinkCount](#BlinkCount) parameters or execute a rule when enabled
[Back to Top](Commands)
### [Sensor](Sensor-Configuration) ### [Sensor](Sensor-Configuration)
|Command | Parameters |Command | Parameters
@ -284,8 +270,6 @@ Action | `0` = turn output OFF<BR> `1` = turn output ON<BR>`2` = TOGGLE output
<a id="WattRes"> </a> WattRes | Power sensor resolution<BR>`0..3` = maximum number of decimal points <a id="WattRes"> </a> WattRes | Power sensor resolution<BR>`0..3` = maximum number of decimal points
See also | [`SetOption8`](#SetOption8) - Show temperature in Celsius *(default)* or Fahrenheit<BR>[`SetOption18`](#SetOption18) - Set status of signal light paired with CO<sub>2</sub> sensor See also | [`SetOption8`](#SetOption8) - Show temperature in Celsius *(default)* or Fahrenheit<BR>[`SetOption18`](#SetOption18) - Set status of signal light paired with CO<sub>2</sub> sensor
[Back to Top](Commands)
### Power Monitoring ### Power Monitoring
|Command | Parameters |Command | Parameters
@ -316,8 +300,6 @@ See also | [`SetOption8`](#SetOption8) - Show temperature in Celsius *(defaul
<a id="WattRes"> </a> WattRes | Power sensor resolution<BR>`0..3` = maximum number of decimal points <a id="WattRes"> </a> WattRes | Power sensor resolution<BR>`0..3` = maximum number of decimal points
See Also | [`SetOption8`](#SetOption8) - Energy monitoring when power is off<BR>[`SetOption33`](#SetOption33) - Configure power monitoring Max_Power_Retry count number<BR> See Also | [`SetOption8`](#SetOption8) - Energy monitoring when power is off<BR>[`SetOption33`](#SetOption33) - Configure power monitoring Max_Power_Retry count number<BR>
[Back to Top](Commands)
### Light ### Light
|Command | Parameters |Command | Parameters
@ -352,8 +334,6 @@ See Also | [`SetOption8`](#SetOption8) - Energy monitoring when power is off<B
<a id="Width4"> </a> Width4 | `0..30` = set width of the hour clock hand *(only in `Scheme 5`)* <a id="Width4"> </a> Width4 | `0..30` = set width of the hour clock hand *(only in `Scheme 5`)*
See also | [`SetOption15`](#SetOption15) - Set PWM control<BR>[`SetOption16`](#SetOption16) - Reverse Clock Scheme direction<BR>[`SetOption17`](#SetOption17) - Show [`Color`](#Color) string as hex or decimal<BR>[`SetOption20`](#SetOption20) - Update of Dimmer/Color/CT without turning power on See also | [`SetOption15`](#SetOption15) - Set PWM control<BR>[`SetOption16`](#SetOption16) - Reverse Clock Scheme direction<BR>[`SetOption17`](#SetOption17) - Show [`Color`](#Color) string as hex or decimal<BR>[`SetOption20`](#SetOption20) - Update of Dimmer/Color/CT without turning power on
[Back to Top](Commands)
### Sonoff RF Bridge ### Sonoff RF Bridge
|Command | Parameters |Command | Parameters
@ -367,8 +347,6 @@ See also | [`SetOption15`](#SetOption15) - Set PWM control<BR>[`SetOption16`](
<a id="RfSync"> </a> RfSync | `1` = reset start sync pulse time to 8470 microseconds<BR>`2..32767` = set start sync pulse time in microseconds<BR>`#2..#7FFF` = set start sync pulse time in hexadecimal microseconds <a id="RfSync"> </a> RfSync | `1` = reset start sync pulse time to 8470 microseconds<BR>`2..32767` = set start sync pulse time in microseconds<BR>`#2..#7FFF` = set start sync pulse time in hexadecimal microseconds
See also | [`SetOption28`](#SetOption28) - Set RF received data format See also | [`SetOption28`](#SetOption28) - Set RF received data format
[Back to Top](Commands)
### IRremote ### IRremote
Using IRsend it is possible to send the same IR code in decimal, hexadecimal and RAW format: Using IRsend it is possible to send the same IR code in decimal, hexadecimal and RAW format:
@ -387,8 +365,6 @@ See [Linux Infrared Remote Control (LIRC)](http://www.lirc.org/) for more inform
|<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` |<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) | 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)
[Back to Top](Commands)
### SetOption overview ### SetOption overview
|Command | Parameters |Command | Parameters
@ -432,8 +408,6 @@ See [Linux Infrared Remote Control (LIRC)](http://www.lirc.org/) for more inform
<a id="SetOption60"> SetOption60 </a> | Enable normal sleep instead of [dynamic sleep](Dynamic%20Sleep)<BR> `0` = dynamic sleep *(default)*<BR> `1` = sleep <a id="SetOption60"> SetOption60 </a> | Enable normal sleep instead of [dynamic sleep](Dynamic%20Sleep)<BR> `0` = dynamic sleep *(default)*<BR> `1` = sleep
<a id="SetOption61"> SetOption61 </a> | Force [local operation](https://github.com/arendst/Sonoff-Tasmota/pull/4562#issuecomment-446230001) when [`ButtonTopic`](#ButtonTopic) or [`SwitchTopic`](#SwitchTopic) is set. Introduced in 6.4.1.17<BR>`0` = disable *(default)*<BR> `1` = enable <a id="SetOption61"> SetOption61 </a> | Force [local operation](https://github.com/arendst/Sonoff-Tasmota/pull/4562#issuecomment-446230001) when [`ButtonTopic`](#ButtonTopic) or [`SwitchTopic`](#SwitchTopic) is set. Introduced in 6.4.1.17<BR>`0` = disable *(default)*<BR> `1` = enable
[Back to Top](Commands)
### Serial Bridge ### Serial Bridge
Both Hardware and Software Serial Bridge are supported. Both Hardware and Software Serial Bridge are supported.
@ -458,8 +432,6 @@ Software Serial Bridge can use any other GPIO to be selected with command ``GPIO
<a id="SSerialSend4"> </a> SSerialSend4 | `<value>` = send binary data to software serial port. Data in serial response messages is encoded as hex strings. <a id="SSerialSend4"> </a> SSerialSend4 | `<value>` = send binary data to software serial port. Data in serial response messages is encoded as hex strings.
<a id="SSerialSend5"> </a> SSerialSend5 | `<value>` = send hex text to software serial port. Data in serial response messages is encoded as hex strings. <a id="SSerialSend5"> </a> SSerialSend5 | `<value>` = send hex text to software serial port. Data in serial response messages is encoded as hex strings.
[Back to Top](Commands)
### MP3 Player ### MP3 Player
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. 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.
@ -476,8 +448,6 @@ The MP3 Player driver is based on the one from DF Robot. They named it [DFPlayer
<a id="MP3Track"> </a> MP3Track | `x` = play track \<x\> <a id="MP3Track"> </a> MP3Track | `x` = play track \<x\>
<a id="MP3Volume"> </a> MP3Volume | `0..100` = set Volume <a id="MP3Volume"> </a> MP3Volume | `0..100` = set Volume
[Back to Top](Commands)
### Domoticz ### Domoticz
|Command | Parameters |Command | Parameters
@ -487,9 +457,6 @@ The MP3 Player driver is based on the one from DF Robot. They named it [DFPlayer
<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="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="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> DomoticzUpdateTimer | Show current update timer value in seconds<BR>`0` = disable sending interrim Domoticz status *(default)*<BR>`1..3600` = send status to Domoticz in defined intervals <a id="DomoticzUpdateTimer"> </a> DomoticzUpdateTimer | Show current update timer value in seconds<BR>`0` = disable sending interrim Domoticz status *(default)*<BR>`1..3600` = send status to Domoticz in defined intervals
[Back to Top](Commands)
### [KNX](KNX-Features) ### [KNX](KNX-Features)
Command | Parameters Command | Parameters
@ -521,6 +488,4 @@ OPTION | OPTION Value | OPTION | OPTION Value
13 | Button 5 | 29 | KNX_SLOT4 13 | Button 5 | 29 | KNX_SLOT4
14 | Button 6 | 30 | KNX_SLOT5 14 | Button 6 | 30 | KNX_SLOT5
15 | Button 7 | 255 | EMPTY 15 | Button 7 | 255 | EMPTY
16 | Button 8 | 16 | Button 8 |
[Back to Top](Commands)