Commands

Commands can be issued using MQTT, web requests, webUI console and serial

How to use commands~

Every command used without a parameter (payload) returns the current setting.

Power returns the status of first defined power output (usually Relay1)

Instead of 0 you can use off or false and instead of 1 you can use on or true.

Power ON turns first defined power output (usually Relay1) on

Power1 1 also turns first defined power output (usually Relay1) on dela Power1 True also turns first defined power output (usually Relay1) on

Replace <x> in a command with the appropriate index number. Leave it empty to use the first available.

Power1 and Power both control first defined power output (usually Relay1)

In commands with x..y value parameters use a number from x to y range.

When a command mentions resetting to "firmware default" it means the setting will revert to the one in the flashed binary file. If you used user_config_override.h at compile time it will revert to those.

with MQTT~

To send commands and view responses you'll need an MQTT client.

Commands over MQTT are issued by using topic cmnd/%topic%/<command> and payload <parameter> where %topic% is the topic of the device you're sending the command to. If there is no <parameter> (an empty MQTT message/payload), a query is sent for current status of the <command>.

See MQTT article to find out more.

with Web Requests~

Commands can be executed via web (HTTP) requests, for example:

http://<ip>/cm?cmnd=Power%20TOGGLE
http://<ip>/cm?cmnd=Power%20On
http://<ip>/cm?cmnd=Power%20off
http://<ip>/cm?user=admin&password=joker&cmnd=Power%20Toggle

If you have set a password for web user interface access, this must be included (in plaintext) in the URL of the HTTP request, like so:

http://<ip>/cm?user=<username>&password=<password>&cmnd=Power%20On

in Console in the Web UI~

Console menu in the web UI is a convenient place to send commands and it behaves similar to a terminal connection via serial bridge.

over Serial Bridge~

If you flashed the device via serial method you can connect to it with a terminal application (e.g. Termite or Arduino IDE Serial Monitor) to issue commands and follow responses. This is a practical way to do a Backlog setup of your new device.

the Power of Backlog~

Backlog command allows executing up to 30 consecutive commands with a single command line. Each command is separated by a semicolon (";"). Backlog is a useful feature to avoid numerous restarts when setting up a new device. You can use it to:

Set up both Wi-Fi AP's

Backlog SSID1 <myssid>; Password1 <mypassword>; SSID2 <myssid2>; Password2 <mypassword2>

Backlog MqttHost <yourhost>; MqttUser <user>; MqttPassword <password>; Topic <customtopic>; SetOption53 1; PowerRetain on

Backlog Status 1; Power2 on; Delay 20; Power2 off; Status 4

http://<ip>/cm?user=admin&password=joker&cmnd=Backlog%20Power%20Toggle%3BPower1%20off

A Backlog command without an argument clears an possible existing Backlog queue.

Commands List~

Control~

Management~

Command	Parameters
Delay	2..3600 = set a delay between two backlog commands with 0.1 second increment. Not recommended for precision timing!
DeepSleepTime	Time to enter deep sleep mode 0 = disable deep sleep mode (default) 11..86400 = set deep sleep mode time period in seconds
DeviceName	Device name displayed in the webUI and used for HA autodiscovery. <value> = set device name (default = FriendlyName1 value)
Emulation	0 = disable emulation (default) 1 = enable Belkin WeMo emulation for Alexa 2 = enable Hue Bridge emulation for Alexa
FriendlyName<x>	1 = Reset friendly name to firmware default <value> = set friendly name (32 char limit)
Gpios	Show list of available components by name and index 255 / All Show list of all components by name and index
Gpio	Show current component assignments of the Module's configurable GPIO 255 / All Show component assignments for all the devices available GPIO
Gpio<x>	<component> = assign a component to Gpio<x>
I2Cscan	Scan I2C bus and show addresses for found devices
I2CDriver	Enable / Disable I2C sensor drivers. Read more...
LogHost	1 = reset syslog host to firmware default (SYS_LOG_HOST) <value> = set syslog host
LogPort	1 = reset syslog port to firmware default (SYS_LOG_PORT) 2..32766 = set syslog port
Modules	Show available modules by name and index
Module	Displays active module by name and index <value> = switch to module <value> and restart 0 = switch to defined template and restart
Module2	Displays active fast reboot fallback module by name and index <value> = set fast reboot fallback module to <value> 0 = set fast reboot fallback module to defined template
MqttLog	0 = disable logging via MQTT (default) 1 = show only error messages 2 = show error and info messages 3 = show error, info and debug messages 4 = show error, info and more debug messsages
NtpServer<x>	NTP server setup (x= 1..3) 0 = clear NtpServer<x> settings 1 = reset NtpServer<x> settings to firmware defaults <value> = set NtpServer<x> host or IP address (32 char limit)
OtaUrl	Display current OTA URL 1 = Reset OtaUrl to firmware default url = set address for OTA (100 char limit)
Pwm<x>	0..1023 = set PWM value for channel
PwmFrequency	1 = reset PWM frequency to 223Hz 40..4000 or 40..50000 = set PWM frequency (40Hz to 4kHz on ESP 82xx / 40-50kHz on ESP32) As of v8.3.0 the default frequency changed to 977Hz
PwmRange	1 = reset maximum PWM range to 1023 255..1023 = set maximum PWM range
Reset	1 = reset device settings to firmware defaults and restart (see warning below) 2 = erase flash, reset device settings to firmware defaults and restart 3 = erase System Parameter Area in flash (Wi-Fi calibration and related data) and restart (see warning below) 4 = reset device settings to firmware defaults but retain Wi-Fi credentials and restart 5 = erase all flash and reset parameters to firmware defaults but keep Wi-Fi settings and restart 6 = erase all flash and reset parameters to firmware defaults but keep Wi-Fi and MQTT settings and restart (Erase of flash can take a few seconds to complete and there is no output during the erase process on the serial or web console) 99 = reset device bootcount to zero For reset 3and reset 1, device must be power-cycled in order to load new Wifi System parameters.
Restart	1 = restart device with configuration saved to flash 2 = halt system (needs hardware reset or power cycle to restart) 99 = force restart device without configuration save For debug and testing stack trace dumps only: -1 = force an Exception (28) crash -2 = force a Soft WDT reset (after a freeze of 2 seconds) -3 = force an OS watchdog reset (after a freeze of 120 seconds, caution!)
SaveData	0 = save parameter changes only manually, e.g. with Restart 1 1 = save parameter changes every second (default) 2..3600 = save parameter changes every x second
SerialLog	Disable hardware serial bridge and 0 = disable serial logging 1 = show only error messages 2 = show error and info messages (default) 3 = show error, info and debug messages 4 = show error, info and more debug messages SerialLog will be disabled automatically 10 minutes after the device reboots.
Sleep	0 = turn sleep off 1..250 = set sleep duration in milliseconds to enable energy saving (default = 50)
State	Display current device state and publish to %prefix%/%topic%/RESULT topic
Status	= show abbreviated status information 0 = show all status information (1 - 11) 1 = show device parameters information 2 = show firmware information 3 = show logging and telemetry information 4 = show memory information 5 = show network information 6 = show MQTT information 7 = show time information 8 = show connected sensor information (retained for backwards compatibility) 9 = show power thresholds (only on modules with power monitoring) 10 = show connected sensor information (replaces 'Status 8') 11 = show information equal to TelePeriod state message 12 = in case of crash to dump the call stack saved in RT memory
Status0	0 = show all status information in a single line
SysLog	0 = disable syslog logging (default) 1 = show only error messages 2 = show error and info messages 3 = show error, info and debug messages 4 = show error, info and more debug messages
Template	Show current Template 0 = create template from active module x = create template from a supported module 255 = merge current module and template settings into new template { ... } = store template in a JSON payload Does not activate the template. To activate use Module 0.
Time	0 = enable NTP (default) 1 = format JSON message timestamp in ISO format 2 = format JSON message timestamp in both ISO and Epoch format 3 = format JSON message timestamp in Epoch format 4 = format JSON message timestamp in milliseconds <value> = disable NTP and set UTC time as epoch value if greater than 1451602800 (January 1, 2016)
TimeStd TimeDst	Set policies for the beginning of daylight saving time (Dst) and return back to standard time (Std)  0 = reset parameters to firmware defaults H,W,M,D,h,T H = hemisphere (0 = northern hemisphere / 1 = southern hemisphere) W = week (0 = last week of month, 1..4 = first .. fourth) M = month (1..12) D = day of week (1..7 1 = sunday 7 = saturday) h = hour (0..23) T = timezone (-780..780) (offset from UTC in MINUTES - 780min / 60min=13hrs) Example: TIMEDST 1,1,10,1,2,660 _If timezone is NOT 99, DST is not used (even if displayed) see
Timezone	-13..+13 = set timezone offset from UTC in hours -13:00..+13:00 = set timezone offset from UTC in hours and minutes 99 = use timezone configured with TimeDst and TimeStd
Ufs	Universal File System commands read more...
UfsDelete	Delete SD card or Flash FS file if only of them available
UfsDelete2	Deleten only Flash FS file if available
UfsFree	Filesystem free size in kb
UfsRename	Rename SD card or Flash FS file if only of them available
UfsRename2	Rename only Flash FS file if available
UfsRun	Run file
UfsSize	Filesystem size in kb
UfsType	Get filesystem type 0 = none 1 = SD card 2 = Flash file
Upgrade	1 = download firmware from OtaUrl and restart <value> = download firmware from OtaUrl if <value> is higher than device version
Upload	1 = download firmware from OtaUrl and restart <value> = download firmware from OtaUrl if <value> is higher than device version
WebLog	0 = disable web logging 1 = show only error messages 2 = show error and info messages (default) 3 = show error, info and debug messages 4 = show error, info and more debug messages
See also	SetOption68 - PWM Channel control SetOption76 - DeepSleep disable bootcount incrementing

Wi-Fi~

MQTT~

Rules~

Timers~

Sensors~

Power Monitoring~

Light~

Device Groups~

SetOptions~

Command	Parameters
SetOption0	Save power state and use after restart (=SaveState) 0 = disable (see note below) 1 = enable (default) Note: Power state means on/off state of eg. relays, lights, but other parameters like color, color temperature, brightness, dimmer, etc. are still saved when changed. To disable saving other parameters see SaveData.
SetOption1	Set button multipress mode to 0 = allow all button actions (default) 1 = restrict to single to penta press and hold actions (i.e., disable inadvertent reset due to long press)
SetOption3	MQTT 0 = disable MQTT 1 = enable MQTT (default)
SetOption4	Return MQTT response as 0 = RESULT topic (default) 1 = %COMMAND% topic
SetOption8	Show temperature in 0= Celsius (default) 1 = Fahrenheit
SetOption10	When the device MQTT topic changes 0 = remove retained message on old topic LWT (default) 1 = send "Offline" to old topic LWT
SetOption11	Swap button single and double press functionality 0 = disable (default) 1 = enable
SetOption12	Configuration saving to flash option 0 = allow dynamic flash save slot rotation (default) 1 = use fixed eeprom flash slot
SetOption13	Allow immediate action on single button press 0 = single, multi-press and hold button actions (default) 1 = only single press action for immediate response (i.e., disable multipress detection). Disable by holding for 4 x button hold time (see SetOption32).
SetOption15	Set PWM control for LED lights 0 = basic PWM control 1 = control with Color or Dimmer commands (default)
SetOption16	Set addressable LED Clock scheme parameter 0 = clock-wise mode (default) 1 = counter-clock-wise mode
SetOption17	Show Color string as 0 = hex string (default) 1 = comma-separated decimal string
SetOption18	Set status of signal light paired with CO2 sensor 0 = disable light (default) 1 = enable light The light will be green below CO2_LOW and red above CO2_HIGH (transition yellow/orange between). The default levels are: 800ppm for low and 1200ppm for high but these can be set in user_config_override.h.
SetOption19	Set Home Assistant discovery protocol. 0 = use Tasmota integration (default) 1 = use MQTT discovery
SetOption20	Update of Dimmer/Color/CT without turning power on 0 = disable (default) 1 = enable
SetOption21	Energy monitoring when power is off 0 = disable (default) 1 = enable
SetOption24	Set pressure units 0 = hPa (default) 1 = mmHg
SetOption26	Use indexes even when only one relay is present 0 = messages use POWER (default) 1 = messages use POWER1
SetOption28	RF received data format 0 = hex (default) 1 = decimal
SetOption29	IR received data format 0 = hex (default) 1 = decimal
SetOption30	Enforce Home Assistant auto-discovery as light 0 = relays are announced as a switch and PWM as a light (default) 1 = both relays and PWM are announced as light
SetOption31	Set status LED blinking during Wi-Fi and MQTT connection problems. LedPower must be set to 0 for this feature to work 0 = Enabled (default) 1 = Disabled
SetOption32	Number of 0.1 seconds to hold button before sending HOLD action message. 1..100 to set button hold time (default = 40). This option also affects the time required to perform a firmware defaults reset (10x HOLD action time)
SetOption33	Number of seconds for which the maximum power limit can be exceeded before the power is turned off 1..250 = set number of seconds (default = 5)
SetOption34	0..255 = set Backlog inter-command delay in milliseconds (default = 200)
SetOption36	Boot loop defaults restoration control. 0 = disable boot loop control 1..200 = set number of boot loops (a restart caused by any exception or watchdog timer within less than BOOT_LOOP_TIME (default 10 seconds) before beginning to restore settings (default = 1). Once this number is reached, subsequent restarts will: 1st restart: disable ESP8285 generic GPIOs interfering with flash SPI 2nd restart: disable rules causing boot loop 3rd restart: disable all rules (and autoexec.bat) 4th restart: reset user defined GPIOs to disable any attached peripherals 5th restart: reset module to Sonoff Basic (1)
SetOption38	6..255 = set IRReceive protocol detection sensitivity minimizing UNKNOWN protocols
SetOption39	Control handling of invalid power measurements. Read more... 0 = reset to default on next restart 1..255 = number of invalid power readings before reporting no load (default =128).
SetOption40	Stop detecting input change on the button GPIO. Solves #5449 Active only when SetOption1 1 and SetOption13 0. This disables all long press functionality. 0..250 = button hold time in 0.1 seconds after which button functionality is disabled.(default =1) Example: Backlog SetOption1 1; SetOption13 0; SetOption40 10 = discard any button press over 1 second
SetOption41	0 = Disable ARP (default) <x> = Force sending gratuitous ARP (Wi-Fi keep alive) every <x> seconds (default = 0) If <x> is below 100 it is the number of seconds, if <x> is above 100, it is the number of minutes after substracting 100. Ex: 105 is every 5 minutes, while 90 is every 90 seconds.
SetOption42	0..255 = set over-temperature (Celsius only) threshold resulting in power off on all energy monitoring devices (default = 90)
SetOption43	0..255 = to control Rotary step. Details #10407
SetOption51	Enable GPIO9 and GPIO10 component selections in Module Configuration WARNING Do not use on ESP8266 devices! 0 = disable (default) 1 = enable
SetOption52	Control display of optional time offset from UTC in JSON payloads 0 = disable (default) 1 = enable
SetOption53	Display hostname and IP address in GUI 0 = disable (default) 1 = enable
SetOption54	Apply SetOption20 settings to commands from Tuya device 0 = disable (default) 1 = enable
SetOption55	mDNS service 0 = disable (default) 1 = enable
SetOption56	Wi-Fi network scan to select strongest signal on restart (network has to be visible) 0 = disable (default) 1 = enable
SetOption57	Wi-Fi network re-scan every 44 minutes with alternate to +10dB stronger signal if detected (only visible networks) 0 = disable 1 = enable (default)
SetOption58	IR Raw data in JSON payload 0 = disable (default) 1 = enable
SetOption59	Send tele/%topic%/STATE in addition to stat/%topic%/RESULT for commands: State, Power and any command causing a light to be turned on. 0 = disable (default) 1 = enable
SetOption60	Set sleep mode 0 = dynamic sleep (default) 1 = normal sleep
SetOption61	Force local operation when ButtonTopic or SwitchTopic is set. 0 = disable (default) 1 = enable
SetOption62	Set retain on Button or Switch hold messages 0 = disable (default) 1 = don't use retain flag on HOLD messages
SetOption63	Set relay state feedback scan at restart (#5594, #5663) 0 = Scan power state at restart (default) 1 = Disable power state scanning at restart
SetOption64	Switch between - or _ as sensor name separator 0 = sensor name index separator is - (hyphen) (default) 1 = sensor name index separator is _ (underscore) Affects DS18X20, DHT, BMP and SHT3X sensor names in tele messages
SetOption65	Device recovery using fast power cycle detection 0 = enabled (default) 1 = disabled
SetOption66	Set publishing TuyaReceived to MQTT 0 = disable publishing TuyaReceived over MQTT (default) 1 = enable publishing TuyaReceived over MQTT
SetOption69	Deprecated in favor of DimmerRange By default Tuya dimmers won't dim below 10% because some don't function very well that way. 0 = disable Tuya dimmer 10% lower limit 1 = enable Tuya dimmer 10% lower limit (default)
SetOption71	Set DDS238 Modbus register for active energy 0 = set primary register (default) 1 = set alternate register
SetOption72	Set reference used for total energy 0 = use firmware counter (default) 1 = use energy monitor (e.g., PZEM-0xx, SDM120, SDM630, DDS238, DDSU666) hardware counter
SetOption73	Detach buttons from relays and send multi-press and hold MQTT messages instead 0 = disable (default) 1 = enable Example message: {"Button1":{"Action":"SINGLE"}}
SetOption74	Enable internal pullup for single DS18x20 sensor 0 = disable (default) 1 = internal pullup enabled
SetOption75	Set grouptopic behaviour (#6779) 0 = GroupTopic using FullTopic replacing %topic% (default) 1 = GroupTopic is cmnd/%grouptopic%/
SetOption76	Bootcount incrementing when DeepSleep is enabled (#6930) 0 = disable bootcount incrementing (default) 1 = enable bootcount incrementing
SetOption77	Do not power off if a slider is moved to far left 0 = disable (default) 1 = enable
SetOption79	Reset counters at TelePeriod time 0 = disable (default) 1 = enable
SetOption80	Blinds and shutters support 0 = disable blinds and shutters support (default) 1 = enable blinds and shutters support
SetOption81	Set PCF8574 component behavior for all ports 0 = set as regular state (default) 1 = set as inverted state
SetOption82	Reduce the CT range from 153..500 to 200.380 to accomodate with Alexa range 0 = CT ranges from 153 to 500 (default) 1 = CT ranges from 200 to 380 (although you can still set in from 153 to 500)
SetOption83	Uses Zigbee device friendly name instead of 16 bits short addresses as JSON key when reporting values and commands 0 = JSON key as short address 1 = JSON key as friendly name See ZbName <device>,<name>
SetOption84	(Experimental) When using AWS IoT, sends a device shadow update (alternative to retained) 0 = don't update device shadow (default) 1 = update device shadow Note: if the Topic contains '/' they are replaced with '_'
SetOption85	Device group support 0 = disable (default) 1 = enable
SetOption86	PWM Dimmer only! Turn brightness LED's off 5 seconds after last change 0 = disable (default) 1 = enable
SetOption87	PWM Dimmer only! Turn red LED on when powered off 0 = disable (default) 1 = enable
SetOption88	Make each relay part of a separate device group. Relay 1 updates are sent to/received from device group 1, relay 2 updates are sent to/received from device group 2, etc. For the PWM Dimmer module, make each button be associated with a different device group. 0 = disable (default) 1 = enable
SetOption90	Disable sending MQTT with non-JSON messages 0 = send all MQTT (default) 1 = send only MQTT messages with JSON payloads
SetOption93	Control caching of compressed rules 0 = Disable memory caching of uncompressed rules 1 = Keep uncompressed rules in memory to avoid CPU load of uncompressing at each tick (default)
SetOption94	Select MAX31855 or MAX6675 thermocouple support 0 = Use MAX31855 protocol (default) 1 = Use simpler MAX6675 protocol instead of MAX31855
SetOption97	Set TuyaMCU serial baudrate 0 = 9600 bps (default) 1 = 115200 bps
SetOption98	Provide rotary dimmer rule triggers 0 = disable (default) 1 = enable
SetOption99	Enable zero-cross capable AC dimmer 0 = no zero-cross AC dimmer connected (default) 1 = zero-cross AC dimmer attached. Focus on raising edge and sync frequency
SetOption101	Add Zigbee source endpoint as suffix to attributes 0 = disable (default) 1 = enable e.g. Power3 instead of Power if sent from endpoint 3.
SetOption103	Set TLS mode 0 = disable TLS 1 = enable TLS
SetOption104	Disable MQTT retained messages (some brokers don't support them) 0 = retained messages enabled (default) 1 = retained messages disabled
SetOption107	Set virtual CT channel light type (experimental feature) 0 = Warm White 1 = Cold White
SetOption108	0 = Teleinfo telemetry only sent into Energy MQTT JSON (default) 1 = Each Teleinfo received frame is also sent by MQTT (mainly to be able to display real time data)
SetOption109	0 = (default) 1 = force gen1 Alexa mode, for Echo Dot 2nd gen devices only
SetOption113	works only with rotary dial button 0 = (default) 1 = set dimmer low on rotary dial after power off
SetOption114	Detach switches from relays and send MQTT messages instead 0 = disable (default) 1 = enable Example result: {"Switch1":{"Action":"ON"}}
SetOption115	ESP32 MI32 BLE 0 = disable (default) 1 = enable
SetOption116	Auto-query of lights and devices 1 = disable
SetOption117	Run fade at fixed duration instead of fixed slew rate 1 = enable
SetOption123	Wiegand tag number output in hex format 1 = enable
SetOption124	Wiegand key pad stroke format 0 = single char (default) 1 = one tag (ending char #)
SetOption125	ZbBridge only Hide bridge topic from zigbee topic (use with SetOption89) 1 = enable
SetOption126	Enable arithmetic mean over teleperiod for JSON temperature for DS18x20 sensors 1 = enable
SetOption127	Set Wifi to no-sleep mode. Normally this mode is only enabled when Sleep 0. This option fixes some Wifi unresponsiveness for some users. 1 = enable

TuyaMCU~

Serial Bridge~

Hardware Serial Bridge uses GPIO1 (Tx) and GPIO3 (Rx) or GPIO13 (Tx) and GPIO15 (Rx) pins of your device. Software Serial Bridge can use any other GPIO to be configured as components Serial Tx and Serial Rx (or SerBr Tx and SerBr Rx). If Tx and Rx components are not assigned in the Template or Module, GPIO1 and GPIO3 will be used. Note that changing serial logging (SerialLog 0) will disable the hardware Serial Bridge.

Information received by Tasmota over the serial bridge is captured automatically. Before data will be received, a properly formatted SerialSend<x> or SSerialSend<x> command must be executed. This must be done any time the device restarts (e.g., via a System#Boot triggered rule). This command is required in order to set how the expected serial data will be formatted and interpreted (i.e., which <x> option). A {"SSerialReceived":{"Data":"<string>"}} message will be posted. You can use a rule to process the string which will be contained in SSerialReceived#Data.

Expect possible communication errors when additional sensors are configured.

RF Bridge~

RF Transciever~

IR Remote~

The standard Tasmota builds have reduced support for IR protocols: RC5, RC6 and NEC. Use Tasmota-IR to have access to full protocols.

Tasmota-IR enabled with all protocols

Displays~

Shutters~

Zigbee~

See Zigbee article for more information

Command	Parameters
<device>	As <device> in following commands you can use interchangeably: <shortaddr> = short address of the Zigbee device on the network, example: 0x1234 <longaddr> = permanent IEEE address of the Zigbee device (64 bits), example: 0x00158D00041160C5 <index> = number of the device in the internal list (starts at 1), ideal for enumerating devices, example: 3 for third device in the list <name> = friendly name. Only when previously set with ZbName
ZbBind	Binds one Zigbee device to another device or to a group. This allows one device to directly send commands (f.e. a remote to a bulb) without any action on the coordinator. Command structure: {"Device":"<device>", "Endpoint":<endpoint>, "Cluster":<cluster>, "ToDevice":"<to_device>", "ToEndpoint":<to_endpoint>, "ToGroup":<to_group> } <device> = device sending messages (mandatory) <endpoint> = source endpoint (mandatory) <cluster> = source cluster id (mandatory) <to_device> = target device (optional) <to_endpoint> = target endpoint  (optional if it can be inferred from ZbStatus3) <to_group> = target group id (optional) You must specify either "ToDevice" or "ToGroup" but not both Zigbee2Tasmota must know the IEEE address of target device, see ZbStatus2 to verify and ZbProbe to have Zigbee2Tasmota query the address
ZbBindState<n>	Asks the device for its internal binding states <device> the device to query <n> the start index for the request, 1 is the default. This is used to scan through all bindings.
ZbConfig	display the current Zigbee configuration Example or result: {"ZbConfig":{"Channel":11,"PanID":"0x1A63","ExtPanID":"0xCCCCCCCCCCCCCCCC","KeyL":"0x0F0D0B0907050301","KeyH":"0x0D0C0A0806040200"}}
ZbConfig <json>	change the configuration and restart if any change was applied. Warning: change in configuration causes a reset of the CC2530/ZBBridge and requires devices to be re-paired. "Channel":<channel>: Zigbee radio channel (11-26) "PanID":<panid>: identifier of the Zigbee Network "ExtPanID":<extpanid>: unique identifier of the Zigbee Network (ExtPanID features are not supported in Z2T but this parameter needs to be set) "KeyL":<key_l>,"KeyH":<key_h>: 128 bits encryption key, split into 2 64 bits values (Low and High) "TXRadio":<txradio>: radion power in dBm (1-20) only for ZBBridge All parameters are optional and only the ones specified are changed. The command always displays the complete configuration after the change Example of command: ZbConfig {"Channel":22,"PanID":"0x1A69","ExtPanID":"0xDDCCCCCCCCCCCCCC","KeyL":"0xFF0D0B0907050301","KeyH":"0xED0C0A0806040200"} The following command creates a highly secure Network key based on a hardware random generator: ZbConfig {"KeyL":"","KeyH":""}
ZbData	feature in development
ZbDeviceTopic SetOption89	Configure MQTT topic for Zigbee devices (also see SensorRetain) 0 = single tele/%topic%/SENSOR topic (default) 1 = unique device topic based on Zigbee device ShortAddr Example: tele/Zigbee/5ADF/SENSOR = {"ZbReceived":{"0x5ADF":{"Dimmer":254,"Endpoint":1,"LinkQuality":70}}}
EndpointTopic SetOption101	Add Zigbee source endpoint as suffix to attributes 0 = disable (default) 1 = enable e.g. Power3 instead of Power if sent from endpoint 3.
ZbEndpointSuffix SetOption120	Add the Zigbee endpoint as suffix in topic when using SetOption89 1 0 = disable (default) 1 = enable
ZbForget	Used for devices that are unused but still visible in ZbStatus <device> = Remove a device from the Tasmota flash memory. It does not un-pair the device nor deleting the device information in the CC2530/ZBBridge.
ZbLight	Sets or reads the light type to be emulated in Zigbee Hue Emulation with Alexa. <device>,<light_type> sets the light type using an integer 0..5 corresponding to the number of channels (from one channel (on/off) to 5 channel (RGBCCT) lights) <device>,-1 removes the device from Philips Hue emulation <device> displays the current status of the Light (Zigbee2Tasmota tracks all changes to the light)
ZbListen<x> <group>	(EZSP ZBBridge only)Listens to a multicast group address. By default EZSP will not report group messages unless you subscribe to the group. <x>: slot in the array of group addresses, 1..15 <group>: group address to listen to, 0..0xFFFF At start-up, Z2T automatically listns to groupe 0 in slot 0. CC2530 does not need this command and always report all group messages.
ZbMap<n>	Asks the device for its view of the Zigbee topology <device> the device to query <n> the start index for the request, 1 is the default. This is used to scan through all values since devices usually return only 3 values per request.
ZbName	Sets or reads the Zigbee device friendly name (up to 32 characters). <device>,<name> sets the new friendly name <device>, (empty name) clears the friendly name <device> displays the current friendly name Also see SetOption83 1 to enable friendly names as JSON keys instead of ShortAddr.
ZbNameKey SetOption83	Uses Zigbee device friendly name instead of 16 bits short addresses as JSON key when reporting values and commands 0 = JSON key as short address 1 = JSON key as friendly name See ZbName <device>,<name>
ZbNameTopic SetOption112	0 = (default) 1 = use friendly name in Zigbee topic (use with ZbDeviceTopic)
ZbNoAutoBind SetOption110	0 = (default) 1 = disable Zigbee auto-binding and auto-attribute reporting when pairing a new device. Use only if you want to manually configure devices
ZbNoPrefix SetOption100	remove Zigbee ZbReceived value from {"ZbReceived":{xxx:yyy}} JSON message 0 = disable (default) 1 = enable
ZbOccupancy	Configure the time-out after "Occupancy":1 to send a synthetic "Occupancy":0 for Zigbee motion sensors <device>,<x> - set occupancy timeout for <device> Possible values for <x> 0: no time-out, the device actually generates "Occupancy":0 n: the number of seconds. The possible values are 15, 30, 45, 60, 75, 90, 105, 120. If the number is different, it is rounded up -1: apply the default of 90 seconds
ZbOmitDevice SetOption119	Remove device addr from JSON payload 0 = disable (default) 1 = enable
ZbPermitJoin	Sets pairing mode for new device discovery 0 = disable pairing mode 1 = enable pairing mode for 60 seconds 99 = enable pairing until device reboots (CC2530 only) Leaving Zigbee network open to join will allow any Zigbee device to connect and retrieve your network encryption key. This can lead to a compromise of your Zigbee network.
ZbPing	<device> = test availability of Zigbee device. If the device is connected and not sleeping, you should receive a ZbPing message within the next second. Example: ZbPing 0x5ADF responds with: {"ZbPing":{"Device":"0x5ADF","IEEEAddr":"0x90FD9FFFFE03B051"}}
ZbReceivedTopic SetOption118	Move ZbReceived from JSON message into the subtopic replacing "SENSOR" default 0 = disable (default) 1 = enable
ZbSend	Command structure: {"Device":"<shortaddr>", "Endpoint":"<endpoint>", "Manuf":<manuf>, "Send":{"<sendcmd>":<sendparam>}} <shortaddr> = short address of the Zigbee device on the network <endpoint> = target endpoint on the device (understanding endpoints) <manuf> = (optional) forces a specific ManufacturerId in the ZCL frame (required by some Xiaomi devices) "<sendcmd>":<sendparam> = command and parameters to send (Zigbee Device Commands) _Use ZbZNPSend to send a raw form low-level message on CC253x gateways _ Example: ZbSend { "Device":"0x1234", "Endpoint":"0x03", "Send":{"Power":"on"} }
ZbScan	Do an energy scan on each radio channel
ZbStatus<x>	Display Zigbee devices seen on the network since boot <device> (optional) = all devices This command provides three levels of increasing detail according to <x> ZbStatus1 Display Short Address, and Friendly Name ZbStatus2 Also include Manufacturer ID and Model ID ZbStatus3 Also include a list of endpoints and the clusterIds supported by each endpoint Example: ZbStatus3 1 requests all details for device number 1 Requested information may exceed maximum result size allowed by Tasmota. In this case, the output will be truncated. To get all of the desired information, request results for a specific device individually.
ZbUnbind	Unbinds one Zigbee device from another or from a group. {"Device":"<device>", "Endpoint":<endpoint>, "Cluster":<cluster>, "ToDevice":"<to_device>", "ToEndpoint":<to_endpoint>, "ToGroup":<to_group> } <device> = the device sending the messages (mandatory) <endpoint> = the source endpoint (mandatory) <cluster> = the source cluster id (mandatory) <to_device> = the target device (optional) <to_endpoint> = the target endpoint (optional if it can be inferred from ZbStatus3) <to_group> = the target group id (optional) You must specify either "ToDevice" or "ToGroup" but not both Zigbee2Tasmota must know the IEEE address of the target device, use ZbStatus2 to verify and ZbProbe to query the address.
See also	SetOption83, SetOption89, SetOption100, SetOption101

Zigbee Debug Functions~

Do not use unless you know exactly what you are doing.

Command	Parameters
ZbModelId	Manually force the ModelId field of a Zigbee device. This is used to simulate devicesnot physically present on the network, for debugging only. <device>,<modelid> = set new ModelId <device>, = (empty modelid) clear ModelId <device> = display current ModelId (also displayed in ZbStatus2)
ZbProbe	<device>= probe a Zigbee device to get additional information including its IEEEaddress, vendor and model names, endpoints, and supported clusters per endpoint. Device probe is performed automatically when a new Zigbee device connects. Battery powered Zigbee devices can not be probed in general because they are usually in sleep mode.
ZbRead	Removed in favor of ZbSend with "Read" attribute.
ZbReset	1 = perform a factory reset and reconfiguration of the CC2530 chip. You will need to re-pair all Zigbee devices
ZbRestore	Restores a device configuration previously dumped with ZbStatus2. This command does not pair a device, but lets you get back device configuration like ModelId or IEEEAddress. <json> = json contains the fields dumped with ZbStatus2. <json> can contain multiple devices (if they fit).
ZbSave <hex>	Forces saving the Zigbee device information to Flash. Auto-saving happens 10 seconds after a new Device parameter was changed, this command is normally not useful
ZbZNPSend <hex>	(CC2530 only) Send a raw ZCL message to a Zigbee device. This is a low-level command, and requires to manually build the ZCL parameters. Most common usage will be provided as high-level functions.
ZbZNPReceive	(CC2530 only) Simulates a received message <hex> = hex string of the simulated message, same format as ZbZNPReceived debug logs
ZbEZSPSend<x> <hex>	(EZSP only) Send a raw EZSP message. This is a low-level command, and requires to manually build the ZCL parameters. Most common usage will be provided as high-level functions. <x>: 1=high-level EZSP command, 2=low-level EZSP frame, 3=low-level EZSP/ASH frame <hex> = hex string of the message
ZbEZSPReceive<x> <hex>	(EZSP only) Simulates a received message <x>: 1=high-level EZSP command, 2=low-level EZSP frame, 3=low-level EZSP/ASH frame <hex> = hex string of the simulated message, same format as ZbZNPReceived debug logs

Bluetooth~

Stepper Motors~

MP3 Player~

The MP3 Player driver is based on the one from DFRobot. They named it DFPlayer mini. All MP3 Players with the identical Serial Control Command structure can be used.

Thermostat~

Domoticz~

KNX~

ESP32~

BLE ESP32~

BLE MI Sensors~

Camera~

Ethernet~