Skip to content

Commit

Permalink
Clarify Subscribe vs Subscribe2
Browse files Browse the repository at this point in the history
  • Loading branch information
s-hadinger committed May 4, 2024
1 parent 02f6fba commit e42cee9
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/Commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ StatusRetain<a class="cmnd" id="statusretain"></a>|`0` = disable use of status M
StateText<x\><a class="cmnd" id="StateText"></a>|`<value>` = set state text (`<x>` = `1..4`)<BR>1 = `OFF` state text<BR>2 = `ON` state text<BR>3 = `TOGGLE` state text<BR>4 = `HOLD` state text<BR>
StatusRetain<a class="cmnd" id="statusretain"></a>|`0` = disable use of status MQTT retain flag *(default)*<BR>`1` = enable MQTT retain flag on status messages `tele/%topic%/STATUS[n]`
SwitchRetain<a class="cmnd" id="switchretain"></a>|`0` = disable use of MQTT retain flag *(default)*<BR>`1` = enable MQTT retain flag on switch press
Subscribe<a class="cmnd" id="subscribe"></a>|Subscribes to an MQTT topic without appended `/#` and assigns an Event name to it.<BR>`<eventName>, <mqttTopic> [, <key>]` = [Read more...](MQTT#subscribeunsubscribe)<br>` ` = list all topics currently subscribed
Subscribe<a class="cmnd" id="subscribe"></a>|Subscribes to an MQTT topic, append `/#` if not already present, and assigns an Event name to it.<BR>`<eventName>, <mqttTopic> [, <key>]` = [Read more...](MQTT#subscribeunsubscribe)<br>` ` = list all topics currently subscribed
Subscribe2<a class="cmnd" id="subscribe2"></a>|Subscribes to an MQTT topic and assigns an Event name to it.<BR>`<eventName>, <mqttTopic> [, <key>]` = [Read more...](MQTT#subscribeunsubscribe)<br>` ` = list all topics currently subscribed
SwitchTopic<a class="cmnd" id="switchtopic"></a>|`<value>` = set MQTT switch topic<BR>`0` = disable use of MQTT switch topic<BR>`1` = set MQTT switch topic to device `%topic%`<BR>`2` = reset MQTT switch topic to firmware default (`MQTT_SWITCH_TOPIC`) *(default = `0`)*<BR>[Read more](Buttons-and-Switches) about this.<BR>_If using MQTT to issue this command, if it is used with the device `GroupTopic`, the command will not be executed._
TelePeriod<a class="cmnd" id="teleperiod"></a>|See current value and force publish STATE and SENSOR message<BR>`0` = disable telemetry messages<BR>`1` = reset telemetry period to firmware default (`TELE_PERIOD`)<BR>`10..3600` = set telemetry period in seconds _(default = `300`)_
Expand Down

0 comments on commit e42cee9

Please sign in to comment.