ButtonRetain |
|
ButtonRetain |
0 / off |
(default) Disable use of MQTT retain flag |
ButtonRetain |
1 / on |
Set ButtonTopic to Topic and enable MQTT retain flag on button press |
ButtonTopic |
|
ButtonTopic |
0 / off |
Disable use of MQTT button topic |
ButtonTopic |
1 |
Set MQTT button topic to Topic |
ButtonTopic |
|
Set MQTT button topic (32 chars max) |
FullTopic |
|
FullTopic |
1 |
Reset MQTT fulltopic to user_config.h (MQTT_FULLTOPIC) and restart |
FullTopic |
|
Set MQTT fulltopic (100 chars max) using optional %topic% and %prefix% and restart |
GroupTopic |
|
GroupTopic |
1 |
Reset MQTT group topic to user_config.h (MQTT_GRPTOPIC) and restart |
GroupTopic |
|
Set MQTT group topic (32 chars max) and restart |
MqttClient |
|
MqttClient |
1 |
Reset MQTT client to user_config.h (MQTT_CLIENT_ID) and restart |
MqttClient |
|
Set MQTT client (32 chars max) and restart. May use wildcard %06X to be replaced by last six characters of MAC address |
MqttFingerprint |
|
MqttFingerprint |
|
(TLS only) Set current fingerprint as 20 space separated bytes (59 chars max) |
MqttHost |
|
MqttHost |
0 |
Clear MQTT host field and allow mDNS to find MQTT host |
MqttHost |
1 |
Reset MQTT host to user_config.h (MQTT_HOST) and restart |
MqttHost |
|
Set MQTT host (32 chars max) and restart |
MqttPassword |
|
MqttPassword |
0 |
Set MQTT password to none |
MqttPassword |
1 |
Reset MQTT password to user_config.h (MQTT_PASS) and restart |
MqttPassword |
|
Set MQTT password (32 chars max) and restart |
MqttPort |
|
MqttPort |
1 |
Reset MQTT port to user_config.h (MQTT_PORT) and restart |
MqttPort |
|
Set MQTT port between 2 and 32766 and restart |
MqttResponse |
|
MqttRetry |
|
MqttRetry |
10 |
(default) Set MQTT connection retry timer in seconds |
MqttRetry |
10..32000 |
Set MQTT connection retry timer in seconds |
MqttUser |
|
MqttUser |
0 |
Set MQTT user name to none |
MqttUser |
1 |
Reset MQTT user name to user_config.h (MQTT_USER) and restart |
MqttUser |
|
Set MQTT user name (32 chars max) and restart |
PowerRetain |
|
PowerRetain |
0 / off |
(default) Disable MQTT power retain on status update |
PowerRetain |
1 / on |
Enable MQTT power retain on status update |
Prefix1 |
|
Prefix1 |
1 |
Reset MQTT command subscription prefix to user_config.h (SUB_PREFIX) and restart |
Prefix1 |
|
Set MQTT command subscription prefix (10 chars max) and restart |
Prefix2 |
|
Prefix2 |
1 |
Reset MQTT status prefix to user_config.h (PUB_PREFIX) and restart |
Prefix2 |
|
Set MQTT status prefix (10 chars max) and restart |
Prefix3 |
|
Prefix3 |
1 |
Reset MQTT telemetry prefix to user_config.h (PUB_PREFIX2) and restart |
Prefix3 |
|
Set MQTT telemetry prefix (10 chars max) and restart |
Publish |
|
Publish any topic and optional payload |
SensorRetain |
|
SensorRetain |
0 / off |
(default) Disable use of sensor MQTT retain flag |
SensorRetain |
1 / on |
Enable MQTT retain flag on message tele/sonoff/SENSOR |
SetOption2 |
|
SetOption2 |
0 / off |
(default) Do not show units to messages |
SetOption2 |
1 / on |
Add units to messages |
SetOption3 |
|
SetOption3 |
0 / off |
Disable MQTT |
SetOption3 |
1 / on |
Enable MQTT |
SetOption4 |
|
SetOption4 |
0 / off |
Return response as RESULT topic |
SetOption4 |
1 / on |
Return response as Command topic |
SetOption10 |
|
SetOption10 |
0 / off |
(default) When topic changes drop retained old topic LWT |
SetOption10 |
1 / on |
When topic changes send old topic retained LWT offline |
StateText1 |
|
StateText1 |
|
Set Off state text (10 chars max) |
StateText2 |
|
StateText2 |
|
Set On state text (10 chars max) |
StateText3 |
|
StateText3 |
|
Set Toggle state text (10 chars max) |
StateText4 |
|
StateText4 |
|
Set button Hold state text (10 chars max) |
SwitchRetain |
|
SwitchRetain |
0 / off |
(default) Disable use of MQTT retain flag |
SwitchRetain |
1 / on |
Set ButtonTopic to Topic and enable MQTT retain flag on button press |
SwitchTopic |
|
SwitchTopic |
0 / off |
Disable use of MQTT switch topic |
SwitchTopic |
1 |
Set MQTT switch topic to Topic |
SwitchTopic |
|
Set MQTT switch topic (32 chars max) |
TelePeriod |
|
TelePeriod |
0 / off |
Disable telemetry messages |
TelePeriod |
1 |
Reset telemetry period to user_config.h (TELE_PERIOD) |
TelePeriod |
|
Set telemetry period between 10 and 3600 seconds |
Topic |
|
Topic |
1 |
Reset MQTT topic to user_config.h (MQTT_TOPIC) and restart |
Topic |
|
Set MQTT topic (32 chars max) AND button topic and restart |
Units |
|