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

Updated Commands (markdown)

Michael Ingraham 2019-09-26 11:10:34 -04:00
parent f37f07f1b5
commit 1b1ebdde53
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Commands.md

@ -106,8 +106,8 @@ Simply put, other messages may precede messages published as a result of your co
Backlog<a id="Backlog"></a>|List of commands to be executed in sequence separated by `;`<BR> See [Using Backlog](#using-backlog) for examples.
BlinkCount<a id="BlinkCount"></a>|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
BlinkTime<a id="BlinkTime"></a>|`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<a id="ButtonDebounce"></a>|**6.2.0**<BR>User control over button debounce timing <BR>`40..1000` = set button debounce time in ms. Default is `40`
Buzzer<a id="Buzzer"></a>|**6.6.0.4**<BR>`<count>,<beep>,<silence>,<tune>`<BR>All parameters are optional. The default is one 100ms beep (`1` for `<count>`, `<beep>`, and `<silence>`).<BR>The `<tune >` 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 `<beep>` and `<silence>` 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 `<tune>` parameter is specified, the `<count>` parameter is ignored. If the `<tune>` parameter is `0`, it is ignored.<BR><BR>`3` - Beep three times with 100ms duration and 100ms pause<BR>`2,3` - Beep twice with 300ms duration and 100ms pause<BR>`2,3,4` - Beep twice with 300ms duration and 400ms pause<BR>`1,2,3,0xF54` (0000 0000 0000 0000 0000 1111 0101 0100). Each `1` bit beeps for 200ms and each bounded `0` bit pauses for 300ms<BR>A device LED can be assigned as a `Buzzer` component to display a blink pattern.
ButtonDebounce<a id="ButtonDebounce"></a>|**6.2.0**<BR>User control over button debounce timing <BR>`40..1000` = set button debounce time in milliseconds. Default is `40`
Buzzer<a id="Buzzer"></a>|**6.6.0.4**<BR>`<count>,<beep>,<silence>,<tune>`<BR>All parameters are optional. The default is one 100milliseconds beep (`1` for `<count>`, `<beep>`, and `<silence>`).<BR>The `<tune >` 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 `<beep>` and `<silence>` 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 `<tune>` parameter is specified, the `<count>` parameter is ignored. If the `<tune>` parameter is `0`, it is ignored.<BR><BR>`3` - Beep three times with 100milliseconds duration and 100milliseconds pause<BR>`2,3` - Beep twice with 300milliseconds duration and 100milliseconds pause<BR>`2,3,4` - Beep twice with 300milliseconds duration and 400milliseconds pause<BR>`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<BR>A device LED can be assigned as a `Buzzer` component to display a blink pattern.
FanSpeed<a id="FanSpeed"></a>|**6.1.0**<BR>Fan speed control *(iFan02/iFan03 only)*<BR>`0` = turn fan OFF<BR>`1..3` = set fan speed<BR>`+` = increase fan speed <BR>`-` = decrease fan speed <BR>
Interlock<a id="Interlock"></a>|**6.5.0**<BR>Relay interlock mode and group selection.<BR>`0` = set self-locking mode for all relays *(default)*<BR> `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<BR> `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_) <BR> `1,2,3` = group Relay1, Relay2 and Relay3 in a single interlock group <BR>`1 3 2,4` = Relay1 is in group 1, Relay3 in group 2, Relay2 and Relay4 in group 3
@ -119,7 +119,7 @@ Power0<a id="Power0"></a>|**6.6.0.9**<BR>Control the power state simultaneously
Power\<x\><a id="Power"></a>|Control the corresponding Relay (enumerated) power state and also restart PulseTime\<x\><BR> `0` / `off` = turn OFF <BR> `1` / `on` = turn ON <BR> `2` / `toggle` = if relay is `ON` switch to `OFF` and vice versa<BR> `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)<BR> `4` / `blinkoff` = stop blink sequence and return relay power to pre-blink state
PowerOnState<a id="PowerOnState"></a>|Control relay state when the device is _**powered up**_. [More information](PowerOnState-Configuration)<BR> `0` / `OFF` = keep relay(s) OFF after power up <BR> `1` / `ON` = turn relay(s) ON after power up <BR> `2` / `TOGGLE` = toggle relay(s) from last saved state <BR> `3` = switch relay(s) to their last saved state *(default)* <BR> `4` = turn relay(s) ON and disable further relay control <BR> `5` = after a `PulseTime` period turn relay(s) ON (acts as inverted [`PulseTime`](Commands#pulsetime) mode)
PulseTime\<x\><a id="PulseTime"></a>|Display the amount of `PulseTime` remaining on the corresponding Relay (enumerated)<BR>`<value>` Set the duration to keep the corresponding Relay `ON` when `Power<x> ON` command is issued. After this amount of time, the relay will be turned `OFF`.<BR>`0` / `OFF` = disable use of PulseTime for the corresponding Relay<BR>`1..111` = set PulseTime for the corresponding Relay in 0.1 second increments<BR>`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)<BR>
SwitchDebounce<a id="SwitchDebounce"></a>|**6.2.0**<BR>User control over switch debounce timing <BR> `40..1000` = set switch debounce time in ms. Default is `40`
SwitchDebounce<a id="SwitchDebounce"></a>|**6.2.0**<BR>User control over switch debounce timing <BR> `40..1000` = set switch debounce time in milliseconds. Default is `40`
SwitchMode\<x\><a id="SwitchMode"></a>|[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<BR>[`SetOption67`](#SetOption67) - Enable/Disable Buzzer
@ -149,7 +149,7 @@ Reset<a id="Reset"></a>|`1` = reset device settings to firmware defaults and res
Restart<a id="Restart"></a>|`1` = restart device<BR>`99` = force restart device without configuration save
SaveData<a id="SaveData"></a>|`0` = save parameter changes only manually<BR>`1` = save parameter changes every second *(default)*<BR>`2..3600`= save parameter changes every x second
SerialLog<a id="SerialLog"></a>|>Disable hardware serial bridge and<BR>`0` = disable serial 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 error, info and more debug messages<BR>`5` = show all messages
Sleep<a id="Sleep"></a>|`0` = turn sleep off<BR>`1..250` = set sleep duration in mSec to enable [energy saving](energy-saving) *(default = `50`)*
Sleep<a id="Sleep"></a>|`0` = turn sleep off<BR>`1..250` = set sleep duration in milliseconds to enable [energy saving](energy-saving) *(default = `50`)*
State<a id="State"></a>|**5.12.0**<BR>Show current device state in `%prefix%/%topic%/RESULT` topic
Status<a id="Status"></a>|` ` = show abbreviated [status information](JSON-Status-Responses#basic-response)<BR>`0` = show all status information (1 - 11)<BR>`1` = show device parameters information<BR>`2` = show firmware information<BR>`3` = show logging and telemetry information<BR>`4` = show memory information<BR>`5` = show network information<BR>`6` = show MQTT information<BR>`7` = show time information<BR>`8` = show connected sensor information<BR>`9` = show power thresholds *(only on modules with power monitoring)*<BR>`10` = same as `Status 8` *(retained for backwards compatibility)*<BR>`11` = show information equal to [`TelePeriod`](#teleperiod) state message
SysLog<a id="SysLog"></a>|`0` = disable syslog 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 error, info and more debug messages<BR>`5` = show all messages
@ -178,7 +178,7 @@ Password\<x\><a id="Password"></a>|`1` = reset AP\<x\> Wi-Fi password to firmwar
Ssid\<x\><a id="Ssid"></a>|`1` = reset AP\<x\> Wi-Fi SSID to firmware default (`STA_SSID1` or `STA_SSID2`) and restart<BR>`<value>`= set AP\<x\> Wi-Fi SSID (32 char limit, **do not use special characters or white spaces in the SSID**) and restart
WebColor\<x\><a id="WebColor"></a>|**6.6.0**<BR>Web GUI colors<BR>`#RRGGBB` = Set web GUI color (x = `1..18`):<BR>`1` = Global text (Black)<BR>`2` = Global background (White)<BR>`3` = Form background (Greyish)<BR>`4` = Input text (Black)<BR>`5` = Input background (White)<BR>`6` = Console text (Black)<BR>`7` = Console background (White)<BR>`8` = Warning text (Red)<BR>`9` = Success text (Green)<BR>`10` = Button text (White)<BR>`11` = Button (Blueish)<BR>`12` = Button hovered over (Darker blueish)<BR>`13` = Restart/Reset/Delete button (Redish)<BR>`14` = Restart/Reset/Delete button hover (Darker reddish)<BR>`15` = Save button (Greenish)<BR>`16` = Save button hover (Darker greenish)<BR>`17` = Config timer tab text (White)<BR>`18` = Config timer tab background (Light grey)
WebPassword<a id="WebPassword"></a>|Show current web server password<BR>`0` = disable use of password for WebUI<BR>`1` = reset password to firmware default (`WEB_PASSWORD`)<BR>`<value>` = set WebUI password for user `WEB_USERNAME` (32 char limit)
WebRefresh<a id="WebRefresh"></a>|**6.3.0**<BR>Web page refresh<BR>`1000..10000` = set refresh time in ms. Default is 2345<BR>Default WEB_USERNAME is `admin`.
WebRefresh<a id="WebRefresh"></a>|**6.3.0**<BR>Web page refresh<BR>`1000..10000` = set refresh time in milliseconds. Default is 2345<BR>Default WEB_USERNAME is `admin`.
WebSend<a id="WebSend"></a>|**6.1.0**<BR>Send a command to Tasmota host. If a command starts with a `\` it will be used as a link.<BR>`[<host>:<port>,<user>:<password>] <command>`<BR>`<host>` = hostname or IP address.<BR>`<port>` = port for the device if not the default `80`<BR>`<user>` = enter username of the device you're sending the command to<BR>`<password>` = enter password of the device you're sending the command to<BR>`<command>` = command and payload<BR>*example: `[<ip>] POWER1 ON` sends `http://<ip>/cm?cmnd=POWER1 ON`*
WebSensor\<x\><a id="WebSensor"></a>|**6.6.0.5**<BR>Control display of sensor telemetry in the web UI<BR>`0` - Do not display sensor's telemetry<BR>`1` - Display sensor's telemetry (*default*)<BR>`<x>` = 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)<BR>`<x>` = `3` Energy telemetry<BR>Issue a `Status 4` to obtain a list of sensor types enabled in the firmware loaded on the device.
WebServer<a id="WebServer"></a>|`0` = stop web server<BR>`1` = start web server in user mode<BR>`2` = start web server in admin mode
@ -282,7 +282,7 @@ AdcParam<a id="AdcParam"></a>|**6.6.0**<BR>ADC0 analog input tuning parameters<B
Altitude<a id="Altitude"></a>|`-30000..30000` - altitude in meters
AmpRes<a id="AmpRes"></a>|Current sensor resolution<BR>`0..3` = maximum number of decimal places
Counter\<x\><a id="Counter"></a>|`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>`**_
CounterDebounce<a id="CounterDebounce"></a>|`0` = turn off counter debounce<BR> `1..3200` = set counter debounce time in msec
CounterDebounce<a id="CounterDebounce"></a>|`0` = turn off counter debounce<BR> `1..3200` = set counter debounce time in milliseconds
CounterType\<x\><a id="CounterType"></a>|`0` = set Counter\<x\> as pulse Counter<BR>`1` = set Counter\<x\> as pulse Timer
HumRes<a id="HumRes"></a>|Humidity sensor resolution<BR>`0..3` = maximum number of decimal places
PressRes<a id="PressRes"></a>|Pressure sensor resolution<BR>`0..3` = maximum number of decimal places