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-05-01 13:08:26 -04:00
parent 0d29a971d6
commit 7cc16ad56d
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Commands.md

@ -180,7 +180,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>
ButtonTopic<x>|`0` = disable use of MQTT button topic<BR>`1` = set MQTT button topic to `<topic>`<BR>`2` = set MQTT button topic to firmware default (`MQTT_BUTTON_TOPIC`)<BR>`<value>` = set MQTT button topic (32 chars max)<a id="FullTopic"></a>
ButtonTopic\<x>|`0` = disable use of MQTT button topic<BR>`1` = set MQTT button topic to `<topic>`<BR>`2` = set MQTT button topic to firmware default (`MQTT_BUTTON_TOPIC`)<BR>`<value>` = set MQTT button topic (32 chars max)<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>
MqttClient|`1` = reset MQTT client to firmware config (`MQTT_CLIENT_ID`) and restart<BR>`<value>` = set MQTT client (32 chars max) and restart.<BR>You can use wildcard `%06X` to replace with last six characters of MAC address.<a id="MqttFingerprint"></a>
@ -203,7 +203,7 @@ StateText2|`<value>` = set `ON` state text (10 chars max)<a id="StateText3"></a>
StateText3|`<value>` = set `TOGGLE` state text (10 chars max)<a id="StateText4"></a>
StateText4|`<value>` = set `HOLD` state text (10 chars max)<a id="SwitchRetain"></a>
SwitchRetain|`0` = disable use of MQTT retain flag *(default)*<BR>`1` = enable MQTT retain flag on switch press<a id="SwitchTopic"></a>
SwitchTopic<x>|`0` = disable use of MQTT switch topic<BR>`1` = set MQTT switch topic to device MQTT `<topic>`<BR>`2` = set MQTT switch topic to firmware default `MQTT_SWITCH_TOPIC`<ul><li>_Typically `MQTT_SWITCH_TOPIC` is set to `0` unless you compile your own firmware and change this value in `user_config_override.h`. If `MQTT_SWITCH_TOPIC` is set to a string, then this command will have the same behavior as outlined below._</li></ul>`<value>` = set MQTT switch topic (32 chars max)<a id="TelePeriod"></a>
SwitchTopic\<x>|`0` = disable use of MQTT switch topic<BR>`1` = set MQTT switch topic to device MQTT `<topic>`<BR>`2` = set MQTT switch topic to firmware default `MQTT_SWITCH_TOPIC`<ul><li>_Typically `MQTT_SWITCH_TOPIC` is set to `0` unless you compile your own firmware and change this value in `user_config_override.h`. If `MQTT_SWITCH_TOPIC` is set to a string, then this command will have the same behavior as outlined below._</li></ul>`<value>` = set MQTT switch topic (32 chars max)<a id="TelePeriod"></a>
TelePeriod|`0` = disable telemetry messages<BR>`1` = reset telemetry period to firmware default (`TELE_PERIOD`)<BR>`10..3600` = set telemetry period in seconds *(default = `300`)*<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