Skip to content

Latest commit

 

History

History
315 lines (314 loc) · 71.7 KB

commands.md

File metadata and controls

315 lines (314 loc) · 71.7 KB

Commands

Here is the latest, up to date command list. This file was autogenerated by running 'node scripts/getcommands.js' in the repository. All descriptions were taken from code.

Please remember that some commands might require starting a related driver first, so, for example, you must first do 'startDriver DoorSensor' and then 'DSEdge 1'. Also remember that commands can be put in autoexec.bat to run at startup (see Web Application->LittleFS tab).

Do not add anything here, as it will overwritten with next rebuild.

Command Arguments Description
AB_Map [int] Sets margines for ADC button codes. For given N margins, there are N+1 possible ADC button values (one should be reserved for 'no button').

See also AB_Map on forum.
ADCSmoother [Pindex] [TotalSamples] [SampleIntervalMS] [TargetChannelADCValue] [MarginValue] [TargetChannel0or1] Starts the ADC smoother with given configuration.

See also ADCSmoother on forum.
AddChangeHandler [Variable][Relation][Constant][Command] This can listen to change in channel value (for example channel 0 becoming 100), or for a voltage/current/power change for BL0942/BL0937. This supports multiple relations, like ==, !=, >=, < etc. The Variable name for channel is Channel0, Channel2, etc, for BL0XXX it can be 'Power', or 'Current' or 'Voltage'.

See also AddChangeHandler on forum.
AddChannel [ChannelIndex][ValueToAdd][ClampMin][ClampMax][bWrapInsteadOfClamp] Adds a given value to the channel. Can be used to change PWM brightness. Clamp min and max arguments are optional.

See also AddChannel on forum.
addClockEvent [TimerSeconds or Time or sunrise or sunset] [WeekDayFlags] [UniqueIDForRemoval][Command] Schedule command to run on given time in given day of week. NTP must be running. TimerSeconds is seconds from midnight, Time is a time like HH:mm or HH:mm:ss, WeekDayFlag is a bitflag on which day to run, 0xff mean all days, 0x01 means sunday, 0x02 monday, 0x03 sunday and monday, etc, id is an unique id so event can be removed later. (NOTE: Use of sunrise/sunset requires compiling with ENABLE_NTP_SUNRISE_SUNSET set which adds about 11k of code).

See also addClockEvent on forum.
AddEventHandler [EventName][EventArgument][CommandToRun] This can be used to trigger an action on a button click, long press, etc.

See also AddEventHandler on forum.
addI2CDevice_LCD_PCF8574 Adds a new I2C device - PCF8574.

See also addI2CDevice_LCD_PCF8574 on forum.
addI2CDevice_LCM1602 Adds a new I2C device - LCM1602.

See also addI2CDevice_LCM1602 on forum.
addI2CDevice_MCP23017 Adds a new I2C device - MCP23017.

See also addI2CDevice_MCP23017 on forum.
addI2CDevice_TC74 Adds a new I2C device - TC74.

See also addI2CDevice_TC74 on forum.
addRepeatingEvent [IntervalSeconds][RepeatsOr-1][CommandToRun] Starts a timer/interval command. Use 'backlog' to fit multiple commands in a single string.

See also addRepeatingEvent on forum.
addRepeatingEventID [IntervalSeconds][RepeatsOr-1][UserID][CommandToRun] As addRepeatingEvent, but with a given ID. You can later cancel it with cancelRepeatingEvent.

Example: addRepeatingEventID 2 -1 123 Power0 Toggle

See also addRepeatingEventID on forum.
add_dimmer [Value][AddMode] Adds a given value to current LED dimmer. AddMode 0 just adds a value (with a clamp to [0,100]), AddMode 1 will wrap around values (going under 0 goes to 100, going over 100 goes to 0), AddMode 2 will ping-pong value (going to 100 starts going back from 100 to 0, and again, going to 0 starts going up).

See also add_dimmer on forum.
add_temperature [DeltaValue][bWrapAroundInsteadOfHold] Adds a given value to current LED temperature. Function can wrap or clamp if max/min is exceeded.

See also add_temperature on forum.
AHT2X_Calibrate [DeltaTemp][DeltaHumidity] Calibrate the AHT2X Sensor as Tolerance is +/-2 degrees C.

Example: AHT2X_Calibrate -4 10
meaning -4 on current temp reading and +10 on current humidity reading

See also AHT2X_Calibrate on forum.
AHT2X_Cycle [IntervalSeconds] This is the interval between measurements in seconds, by default 1. Max is 255.

Example: AHT2X_Cycle 60
measurement is taken every 60 seconds

See also AHT2X_Cycle on forum.
AHT2X_Measure Retrieve OneShot measurement.

Example: AHT2X_Measure

See also AHT2X_Measure on forum.
AHT2X_Reinit Reinitialize sensor.

Example: AHT2X_Reinit

See also AHT2X_Reinit on forum.
alias [Alias][Command with spaces] Add an aliased command, so a command with spaces can be called with a short, nospaced alias.

See also alias on forum.
aliasMem Internal usage only. See docs for 'alias' command.

See also aliasMem on forum.
Anim PA_Cmd_Anim .

See also Anim on forum.
AnimSpeed PA_Cmd_AnimSpeed .

See also AnimSpeed on forum.
backlog [string of commands separated with ;] Run a sequence of ; separated commands.

See also backlog on forum.
Battery_cycle [int] Change cycle of measurement by default every 10 seconds.

Example: Battery_cycle 60

See also Battery_cycle on forum.
Battery_Setup [minbatt][maxbatt][V_divider][Vref][AD Bits] Measure battery based on ADC.
req. args: minbatt in mv, maxbatt in mv.
optional: V_divider(2), Vref(default 2400), ADC bits(4096).

Example: Battery_Setup 1500 3000 2 2400 4096

See also Battery_Setup on forum.
BMPI2C_Calibrate [DeltaTemp][DeltaPressure][DeltaHumidity] Calibrate the BMPI2C Sensor.

Example: BMPI2C_Calibrate -4 0 10
meaning -4 on current temp reading, 0 on current pressure reading and +10 on current humidity reading

See also BMPI2C_Calibrate on forum.
BMPI2C_Configure BMPI2C_Configure .

See also BMPI2C_Configure on forum.
BMPI2C_Cycle [IntervalSeconds] This is the interval between measurements in seconds, by default 1. Max is 255.

Example: BMPI2C_Cycle 60
measurement is taken every 60 seconds

See also BMPI2C_Cycle on forum.
BP1658CJ_Current [MaxCurrentRGB][MaxCurrentCW] Sets the maximum current limit for BP1658CJ driver.

See also BP1658CJ_Current on forum.
BP1658CJ_Map [Ch0][Ch1][Ch2][Ch3][Ch4] Maps the RGBCW values to given indices of BP1658CJ channels. This is because BP5758D channels order is not the same for some devices. Some devices are using RGBCW order and some are using GBRCW, etc, etc. Example usage: BP1658CJ_Map 0 1 2 3 4.

See also BP1658CJ_Map on forum.
BP1658CJ_RGBCW [HexColor] Don't use it. It's for direct access of BP1658CJ driver. You don't need it because LED driver automatically calls it, so just use led_basecolor_rgb.

See also BP1658CJ_RGBCW on forum.
BP5758D_Current [MaxCurrentRGB][MaxCurrentCW] Sets the maximum current limit for BP5758D driver, first value is for rgb and second for cw.

See also BP5758D_Current on forum.
BP5758D_Map [Ch0][Ch1][Ch2][Ch3][Ch4] Maps the RGBCW values to given indices of BP5758D channels. This is because BP5758D channels order is not the same for some devices. Some devices are using RGBCW order and some are using GBRCW, etc, etc. Example usage: BP5758D_Map 0 1 2 3 4.

See also BP5758D_Map on forum.
BP5758D_RGBCW [HexColor] Don't use it. It's for direct access of BP5758D driver. You don't need it because LED driver automatically calls it, so just use led_basecolor_rgb.

See also BP5758D_RGBCW on forum.
BridgePulseLength [FloatValue] Setup value for bridge pulse len.

See also BridgePulseLength on forum.
cancelRepeatingEvent [UserIDInteger] Stops a given repeating event with a specified ID.

See also cancelRepeatingEvent on forum.
Ch [InputValue] An alternate command to access channels. It returns all used channels in JSON format. The syntax is ChINDEX value, there is no space between Ch and channel index. It can be sent without value to poll channel values.

See also Ch on forum.
Choice [IndexToExecute][Option0][Option1][Option2][OptionN][etc] This will choose a given argument by index and execute it as a command. Index to execute can be a variable like $CH1.

See also Choice on forum.
chSetupLimit [limitChannelIndex] [maxAllowedLimitChannelDelta] [timeoutOr-1] [commandToRun] After executing this command, chargingLimit driver will watch channel for changes and count down timer. When a timer runs our or channel change (from the initial state) is larger than given margin, given command is run.

See also chSetupLimit on forum.
CHT_Calibrate [DeltaTemp][DeltaHumidity] Calibrate the CHT Sensor as Tolerance is +/-2 degrees C.

Example: CHT_Calibrate -4 10
meaning -4 on current temp reading and +10 on current humidity reading

See also CHT_Calibrate on forum.
CHT_Cycle [IntervalSeconds] This is the interval between measurements in seconds, by default 1. Max is 255.

Example: CHT_Cycle 60
measurement is taken every 60 seconds

See also CHT_Cycle on forum.
ClampChannel [ChannelIndex][Min][Max] Clamps given channel value to a range.

See also ClampChannel on forum.
clearAll Clears config and all remaining features, like runtime scripts, events, etc.

See also clearAll on forum.
clearAllHandlers This clears all added event handlers.

See also clearAllHandlers on forum.
clearClockEvents Removes all set clock events.

See also clearClockEvents on forum.
clearConfig Clears all config, including WiFi data.

See also clearConfig on forum.
clearIO Clears all pins setting, channels settings.

See also clearIO on forum.
ClearNoPingTime Command for ping watchdog; it sets the 'time since last ping reply' to 0 again.

See also ClearNoPingTime on forum.
clearRepeatingEvents Clears all repeating events.

See also clearRepeatingEvents on forum.
Color [HexValue] Puts the LED driver in RGB mode and sets given color.

See also Color on forum.
ConsumptionThreshold [FloatValue] Setup value for automatic save of consumption data [1..100].

See also ConsumptionThreshold on forum.
crashNull Causes a crash.

See also crashNull on forum.
CT [TempValue] Same as led_temperature.

See also CT on forum.
CTRange [MinRange][MaxRange] This sets the temperature range for display. Default is 154-500.

See also CTRange on forum.
CurrentSet Current Measure the real Current with an external, reliable power meter and enter this Current via this command to calibrate. The calibration is automatically saved in the flash memory.

See also CurrentSet on forum.
DeepSleep [Seconds] Starts deep sleep for given amount of seconds. Please remember that there is also a separate command, called PinDeepSleep, which is not using a timer, but a GPIO to wake up device.

See also DeepSleep on forum.
delay_ms [ValueMS] Script-only command. Pauses current script thread for given amount of ms.

See also delay_ms on forum.
delay_s [ValueSeconds] Script-only command. Pauses current script thread for given amount of seconds. Argument can be a floating point, so 0.1 etc will work.

See also delay_s on forum.
DGR_SendBrightness [GroupName][Brightness] Sends a Brightness message to given Tasmota Device Group with no reliability. Requires no prior setup and can control any group, but won't retransmit.

See also DGR_SendBrightness on forum.
DGR_SendFixedColor [GroupName][TasColorIndex] Sends a FixedColor message to given Tasmota Device Group with no reliability. Requires no prior setup and can control any group, but won't retransmit.

See also DGR_SendFixedColor on forum.
DGR_SendPower [GroupName][ChannelValues][ChannelsCount] Sends a POWER message to given Tasmota Device Group with no reliability. Requires no prior setup and can control any group, but won't retransmit.

See also DGR_SendPower on forum.
DGR_SendRGBCW [GroupName][HexRGBCW] Sends a RGBCW message to given Tasmota Device Group with no reliability. Requires no prior setup and can control any group, but won't retransmit. You can use this command in two ways, first is like DGR_SendRGBCW GroupName 255 255 0, etc, second is DGR_SendRGBCW GroupName FF00FF00 etc etc.

See also DGR_SendRGBCW on forum.
Dimmer [Value] Alias for led_dimmer.

See also Dimmer on forum.
DimmerDelta [DeltaValue] This sets the delta value for SmartDimmer/SmartButtonForLEDs hold event. This determines the amount of change of dimmer per hold event.

See also DimmerDelta on forum.
DSEdge [edgeCode][optionalPinIndex] DeepSleep (PinDeepSleep) wake configuration command. 0 means always wake up on rising edge, 1 means on falling, 2 means if state is high, use falling edge, if low, use rising. Default is 2. Second argument is optional and allows to set per-pin DSEdge instead of setting it for all pins.

See also DSEdge on forum.
DSTime [timeSeconds][optionalAutoWakeUpTimeSeconds] DoorSensor driver configuration command. Time to keep device running before next sleep after last door sensor change. In future we may add also an option to automatically sleep after MQTT confirms door state receival. You can also use this to extend current awake time (at runtime) with syntax: 'DSTime +10', this will make device stay awake 10 seconds longer. You can also restart current value of awake counter by 'DSTime clear', this will make counter go from 0 again.

See also DSTime on forum.
echo [Message] Sends given message back to console. This command expands variables, so writing $CH12 will print value of channel 12, etc. Remember that you can also use special channel indices to access persistant flash variables and to access LED variables like dimmer, etc.

See also echo on forum.
EnergyCntReset [OptionalNewValue] Resets the total Energy Counter, the one that is usually kept after device reboots. After this commands, the counter will start again from 0 (or from the value you specified).

See also EnergyCntReset on forum.
exec [Filename] Exec - run autoexec.bat or other file from LFS if present.

See also exec on forum.
ExitSimulator [SIMULATOR ONLY] Exits the application instance.

See also ExitSimulator on forum.
fakeTuyaPacket [HexString] This simulates packet being sent from TuyaMCU to our OBK device.

See also fakeTuyaPacket on forum.
flags [IntegerValue] Sets the device flags.

See also flags on forum.
FriendlyName [Name] Sets the full name of the device.

See also FriendlyName on forum.
FullBootTime [Value] Sets time in seconds after which boot is marked as valid. This is related to emergency AP mode which is enabled by powering on/off device 5 times quickly.

See also FullBootTime on forum.
GetChannel [ChannelIndex] Prints given channel value to console.

See also GetChannel on forum.
GetReadings Prints voltage etc readings to console.

See also GetReadings on forum.
goto [LabelStr] Script-only command. IF single argument is given, then goes to given label from within current script file. If two arguments are given, then jumps to any other script file by label - first argument is file, second label.

See also goto on forum.
HSBColor [H][S][B] Tasmota-style colour access. Hue in 0-360 range, saturation in 0-100 and brightness in 0-100 range. .

See also HSBColor on forum.
HSBColor1 [Hue] Tasmota-style colour access. Sets hue in 0 to 360 range.

See also HSBColor1 on forum.
HSBColor2 [Saturation] Tasmota-style colour access. Set saturation in 0 to 100 range.

See also HSBColor2 on forum.
HSBColor3 [Brightness] Tasmota-style colour access. Sets brightness in 0 to 100 range.

See also HSBColor3 on forum.
HT16K33_Blink HT16K33_Blink .

See also HT16K33_Blink on forum.
HT16K33_Brightness HT16K33_Brightness .

See also HT16K33_Brightness on forum.
HT16K33_Char HT16K33_Char .

See also HT16K33_Char on forum.
HT16K33_Print HT16K33_Print .

See also HT16K33_Print on forum.
HT16K33_Raw HT16K33_Raw .

See also HT16K33_Raw on forum.
HT16K33_Test HT16K33_Test .

See also HT16K33_Test on forum.
if [Condition]['then'][CommandA]['else'][CommandB] Executed a conditional. Condition should be single line. You must always use 'then' after condition. 'else' is optional. Use aliases or quotes for commands with spaces.

See also if on forum.
IREnable [Str][1or0] Enable/disable aspects of IR. IREnable RXTX 0/1 - enable Rx whilst Tx. IREnable [protocolname] 0/1 - enable/disable a specified protocol.

See also IREnable on forum.
IRSend [PROT-ADDR-CMD-REP-BITS] Sends IR commands in the form PROT-ADDR-CMD-REP-BITS, e.g. NEC-1-1A-0-0, note that -BITS is optional, it can be 0 for default one, so you can just do NEC-1-1A-0.

See also IRSend on forum.
json_test cmnd_json_test .

See also json_test on forum.
KP18058_Current [RGBLimit][CWLimit] Sets the maximum current for LED driver. Values 0-31. Example usage: KP18058_Current 14 30.

See also KP18058_Current on forum.
KP18058_Map [Ch0][Ch1][Ch2][Ch3][Ch4] Maps KP18058_Map RGBCW values to given indices of KP18058 channels. This is because KP18058 channels order is not the same for some devices. Some devices are using RGBCW order and some are using GBRCW, etc, etc. Example usage: KP18058_Map 0 1 2 3 4.

See also KP18058_Map on forum.
KP18058_RGBCW [HexColor] Don't use it. It's for direct access of KP18058 driver. You don't need it because LED driver automatically calls it, so just use led_basecolor_rgb.

See also KP18058_RGBCW on forum.
lcd_clear Clears the LCD.

See also lcd_clear on forum.
lcd_clearAndGoto Clears LCD and go to pos.

See also lcd_clearAndGoto on forum.
lcd_goto Go to position on LCD.

See also lcd_goto on forum.
lcd_print Prints a string on the LCD.

See also lcd_print on forum.
lcd_printFloat Prints a float on the LCD.

See also lcd_printFloat on forum.
lcd_printInt Prints an omt on the LCD.

See also lcd_printInt on forum.
led_basecolor_rgb [HexValue] Puts the LED driver in RGB mode and sets given color.

See also led_basecolor_rgb on forum.
led_basecolor_rgbcw Set PWN color using #RRGGBB[cw][ww].

See also led_basecolor_rgbcw on forum.
led_colorMult [Value] Internal usage.

See also led_colorMult on forum.
led_dimmer [Value] Set output dimmer 0..100.

See also led_dimmer on forum.
led_enableAll [1or0orToggle] Power on/off LED but remember the RGB(CW) values.

See also led_enableAll on forum.
led_finishFullLerp This will force-finish LED color interpolation. You can call it after setting the colour to skip the interpolation/smooth transition time. Of course, it makes only sense if you enabled smooth colour transitions.

See also led_finishFullLerp on forum.
led_gammaCtrl sub-cmd [par] Control LED Gamma Correction and Calibration.

Example: led_gammaCtrl on

See also led_gammaCtrl on forum.
led_hue [Value] This is an alternate way to set the LED color.

See also led_hue on forum.
led_lerpSpeed [LerpSpeed] Sets the speed of colour interpolation, where speed is defined as a number of RGB units per second, so 255 will lerp from 0 to 255 in one second.

See also led_lerpSpeed on forum.
LED_Map CMD_LEDDriver_Map .

See also LED_Map on forum.
led_nextColor Sets the next color from predefined colours list. Our list is the same as in Tasmota.

See also led_nextColor on forum.
led_saturation [Value] This is an alternate way to set the LED color.

See also led_saturation on forum.
led_saveInterval [IntervalSeconds] This determines how often LED state can be saved to flash memory. The state is saved only if it was modified and if the flag for LED state save is enabled. Set this to higher value if you are changing LED states very often, for example from xLights. Saving too often could wear out flash memory too fast.

See also led_saveInterval on forum.
led_temperature [TempValue] Toggles LED driver into temperature mode and sets given temperature. It using Home Assistant temperature range (in the range from 154-500 defined in homeassistant/util/color.py as HASS_COLOR_MIN and HASS_COLOR_MAX).

See also led_temperature on forum.
lfs_append [FileName][String] Appends a string to LFS file.

See also lfs_append on forum.
lfs_appendFloat [FileName][Float] Appends a float to LFS file.

See also lfs_appendFloat on forum.
lfs_appendInt [FileName][Int] Appends a Int to LFS file.

See also lfs_appendInt on forum.
lfs_appendLine [FileName][String] Appends a string to LFS file with a next line marker.

See also lfs_appendLine on forum.
lfs_format Unmount and format LFS. Optionally add new size as argument.

See also lfs_format on forum.
lfs_mount Mount LFS.

See also lfs_mount on forum.
lfs_remove [FileName] Deletes a LittleFS file.

See also lfs_remove on forum.
lfs_size [MaxSize] Log or Set LFS size - will apply and re-format next boot, usage setlfssize 0x10000.

See also lfs_size on forum.
lfs_test1 [FileName] Tests the LFS file reading feature.

See also lfs_test1 on forum.
lfs_test2 [FileName] Tests the LFS file reading feature.

See also lfs_test2 on forum.
lfs_test3 [FileName] Tests the LFS file reading feature.

See also lfs_test3 on forum.
lfs_unmount Un-mount LFS.

See also lfs_unmount on forum.
lfs_write [FileName][String] Resets a LFS file and writes a new string to it.

See also lfs_write on forum.
lfs_writeLine [FileName][String] Resets a LFS file and writes a new string to it with newline.

See also lfs_writeLine on forum.
linkTuyaMCUOutputToChannel [dpId][varType][channelID][bDPCache-Optional][mult-optional][bInverse] Used to map between TuyaMCU dpIDs and our internal channels. Last argument is optional and 0 by default. You can set it to 1 for battery powered devices, so a variable is set with DPCache, for example a sampling interval for humidity/temperature sensor. Mapping works both ways. DpIDs are per-device, you can get them by sniffing UART communication. Vartypes can also be sniffed from Tuya. VarTypes can be following: 0-raw, 1-bool, 2-value, 3-string, 4-enum, 5-bitmap. Please see Tuya Docs for info about TuyaMCU. You can also see our TuyaMCU Analyzer Tool.

See also linkTuyaMCUOutputToChannel on forum.
listClockEvents Print the complete set clock events list.

See also listClockEvents on forum.
listEventHandlers Prints full list of added event handlers.

See also listEventHandlers on forum.
listRepeatingEvents Lists all repeating events.

See also listRepeatingEvents on forum.
listScripts Lists all running scripts.

See also listScripts on forum.
logdelay [Value] Value is a number of ms. This will add an artificial delay in each log call. Useful for debugging. This way you can see step by step what happens.

See also logdelay on forum.
logfeature [Index][1or0] Set log feature filter, as an index and a 1 or 0.

See also logfeature on forum.
loglevel [Value] Correct values are 0 to 7. Default is 3. Higher value includes more logs. Log levels are: ERROR = 1, WARN = 2, INFO = 3, DEBUG = 4, EXTRADEBUG = 5. WARNING: you also must separately select logging level filter on web panel in order for more logs to show up there.

See also loglevel on forum.
logport [Index] Allows you to change log output port. On Beken, the UART1 is used for flashing and for TuyaMCU/BL0942, while UART2 is for log. Sometimes it might be easier for you to have log on UART1, so now you can just use this command like backlog uartInit 115200; logport 1 to enable logging on UART1..

See also logport on forum.
logtype [TypeStr] Logtype direct
Map [TargetChannel][InputValue][InMin][InMax][OutMin][OutMax] Used to convert a value from one range into a proportional value of another range.

See also Map on forum.
MapRanges [TargetChannel][InputValue][RangeVal0][RangeVal1][RangeValN] This will set given channel to an index showing where given input value is within given range sections. For example, MapRanges 10 0.5 0.3 0.6 0.9 will set channel 10 to 1 because 0.5 value is between 0.3 and 0.6.

See also MapRanges on forum.
MAX72XX_Print DRV_MAX72XX_Print .

See also MAX72XX_Print on forum.
MAX72XX_Scroll DRV_MAX72XX_Scroll .

See also MAX72XX_Scroll on forum.
MAX72XX_Setup [Value] Sets the maximum current for LED driver.

See also MAX72XX_Setup on forum.
MCP23017_MapPinToChannel Maps port expander bit to OBK channel.

See also MCP23017_MapPinToChannel on forum.
MCP9808_Adr MCP9808_Adr .

See also MCP9808_Adr on forum.
MCP9808_AlertMin MCP9808_AlertMin .

See also MCP9808_AlertMin on forum.
MCP9808_AlertRange MCP9808_AlertRange .

See also MCP9808_AlertRange on forum.
MCP9808_Calibrate [DeltaTemperature] .

See also MCP9808_Calibrate on forum.
MCP9808_Cycle [DelayInSeconds] .

See also MCP9808_Cycle on forum.
MqttClient [ValueString] Sets the MQTT client. Command keeps Tasmota syntax.

See also MqttClient on forum.
MqttHost [ValueString] Sets the MQTT host. Command keeps Tasmota syntax.

See also MqttHost on forum.
MqttPassword [ValueString] Sets the MQTT pass. Command keeps Tasmota syntax.

See also MqttPassword on forum.
MqttUser [ValueString] Sets the MQTT user. Command keeps Tasmota syntax.

See also MqttUser on forum.
mqtt_broadcastInterval [ValueSeconds] If broadcast self state every 60 seconds/minute is enabled in flags, this value allows you to change the delay, change this 60 seconds to any other value in seconds. This value is not saved, you must use autoexec.bat or short startup command to execute it on every reboot.

See also mqtt_broadcastInterval on forum.
mqtt_broadcastItemsPerSec [PublishCountPerSecond] If broadcast self state (this option in flags) is started, then gradually device info is published, with a speed of N publishes per second. Do not set too high value, it may overload LWIP MQTT library. This value is not saved, you must use autoexec.bat or short startup command to execute it on every reboot.

See also mqtt_broadcastItemsPerSec on forum.
ntp_info Display NTP related settings.

See also ntp_info on forum.
ntp_setLatLong [Latlong] Sets the NTP latitude and longitude.

Example: NTP_SetLatlong -34.911498 138.809488

See also ntp_setLatLong on forum.
ntp_setServer [ServerIP] Sets the NTP server.

See also ntp_setServer on forum.
ntp_timeZoneOfs [Value] Sets the time zone offset in hours. Also supports HH:MM syntax if you want to specify value in minutes. For negative values, use -HH:MM syntax, for example -5:30 will shift time by 5 hours and 30 minutes negative.

See also ntp_timeZoneOfs on forum.
obkDeviceList Generate the SSDP list of OpenBeken devices found on the network.

See also obkDeviceList on forum.
OpenAP Temporarily disconnects from programmed WiFi network and opens Access Point.

See also OpenAP on forum.
ota_http [HTTP_URL] Starts the firmware update procedure, the argument should be a reachable HTTP server file. You can easily setup HTTP server with Xampp, or Visual Code, or Python, etc. Make sure you are using OTA file for a correct platform (getting N platform RBL on T will brick device, etc etc).

See also ota_http on forum.
Password1 [ValueString] Sets the Pass of target WiFi. Command keeps Tasmota syntax.

See also Password1 on forum.
PinDeepSleep [OptionalTimerForWakeup] Starts a pin deep sleep (deep sleep that can be interrupted by external IO events like a button press). The argument is an optional extra time to wake up also by timer. See tutorial.

See also PinDeepSleep on forum.
PingHost [IPStr] Sets the host to ping by IP watchdog.

See also PingHost on forum.
PingInterval [IntegerSeconds] Sets the interval between ping attempts for ping watchdog mechanism.

See also PingInterval on forum.
power [OnorOfforToggle] Tasmota-style POWER command. Should work for both LEDs and relay-based devices. You can write POWER0, POWER1, etc to access specific relays.

See also power on forum.
powerAll Set all outputs.

See also powerAll on forum.
PowerMax BL0937_PowerMax .

See also PowerMax on forum.
PowerSave [Optional 1 or 0, by default 1 is assumed] Enables dynamic power saving mode on BK and W600. You can also disable power saving with PowerSave 0.

See also PowerSave on forum.
PowerSet Power Measure the real Power with an external, reliable power meter and enter this Power via this command to calibrate. The calibration is automatically saved in the flash memory.

See also PowerSet on forum.
publish [Topic][Value][bOptionalSkipPrefixAndSuffix] Publishes data by MQTT. The final topic will be obk0696FB33/[Topic]/get, but you can also publish under raw topic, by adding third argument - '1'. You can use argument expansion here, so $CH11 will change to value of the channel 11.

See also publish on forum.
publishAll Starts the step by step publish of all available values.

See also publishAll on forum.
publishBenchmark .

See also publishBenchmark on forum.
publishChannel [ChannelIndex] Forces publish of given channel.

See also publishChannel on forum.
publishChannels Starts the step by step publish of all channel values.

See also publishChannels on forum.
publishFile [Topic][Value][bOptionalSkipPrefixAndSuffix] Publishes data read from LFS file by MQTT. The final topic will be obk0696FB33/[Topic]/get, but you can also publish under raw topic, by adding third argument - '1'.

See also publishFile on forum.
publishFloat [Topic][Value][bOptionalSkipPrefixAndSuffix] Publishes data by MQTT. The final topic will be obk0696FB33/[Topic]/get, but you can also publish under raw topic, by adding third argument - '1'.. You can use argument expansion here, so $CH11 will change to value of the channel 11. This version of command publishes an float, so you can also use math expressions like $CH10*0.0, etc.

See also publishFloat on forum.
publishInt [Topic][Value][bOptionalSkipPrefixAndSuffix] Publishes data by MQTT. The final topic will be obk0696FB33/[Topic]/get, but you can also publish under raw topic, by adding third argument - '1'.. You can use argument expansion here, so $CH11 will change to value of the channel 11. This version of command publishes an integer, so you can also use math expressions like $CH10*10, etc.

See also publishInt on forum.
PWMFrequency [FrequencyInHz] Sets the global PWM frequency.

See also PWMFrequency on forum.
PWMG_Raw PWM grouping (synchronous PWM).

See also PWMG_Raw on forum.
PWMG_Set Duty1Percent Duty2Percent DeadTimePercent Frequency PinA PinB PWM grouping (synchronous PWM).

See also PWMG_Set on forum.
reboot Same as restart. Needed for bkWriter 1.60 which sends 'reboot' cmd before trying to get bus via UART. Thanks to this, if you enable command line on UART1, you don't need to manually reboot while flashing via UART.

See also reboot on forum.
removeClockEvent [ID] Removes clock event wtih given ID.

See also removeClockEvent on forum.
resetSVM Resets all SVM and clears all scripts.

See also resetSVM on forum.
restart Reboots the module.

See also restart on forum.
return Script-only command. Currently it just stops totally current script thread.

See also return on forum.
SafeMode [OptionalDelayBeforeRestart] Forces device reboot into safe mode (open ap with disabled drivers). Argument is a delay to restart in seconds, optional, minimal delay is 1.

See also SafeMode on forum.
scanI2C [Soft/I2C1/I2C2] Scans given I2C line for addresses. I2C driver must be started first.

See also scanI2C on forum.
scheduleHADiscovery [Seconds] This will schedule HA discovery, the discovery will happen with given number of seconds, but timer only counts when MQTT is connected. It will not work without MQTT online, so you must set MQTT credentials first.

See also scheduleHADiscovery on forum.
sendGet [TargetURL] Sends a HTTP GET request to target URL. May include GET arguments. Can be used to control devices by Tasmota HTTP protocol. Command supports argument expansion, so $CH11 changes to value of channel 11, etc, etc.

See also sendGet on forum.
sendPOST [TargetURL] [HTTP Port] [Content Type] [Post Content] Sends a HTTP POST request to target URL. Arguments can contain variable expansion.

See also sendPOST on forum.
setButtonColor [ButtonIndex][Color] Sets the colour of custom scriptable HTTP page button.

See also setButtonColor on forum.
setButtonCommand [ButtonIndex][Command] Sets the command of custom scriptable HTTP page button.

See also setButtonCommand on forum.
setButtonEnabled [ButtonIndex][1or0] Sets the visibility of custom scriptable HTTP page button.

See also setButtonEnabled on forum.
setButtonHoldRepeat [Value] Sets just the hold button repeat time, given value is times 100ms, so write 1 for 100ms, 2 for 200ms, etc.

See also setButtonHoldRepeat on forum.
setButtonLabel [ButtonIndex][Label] Sets the label of custom scriptable HTTP page button.

See also setButtonLabel on forum.
setButtonTimes [ValLongPress][ValShortPress][ValRepeat] Each value is times 100ms, so: SetButtonTimes 2 1 1 means 200ms long press, 100ms short and 100ms repeat.

See also setButtonTimes on forum.
SetChannel [ChannelIndex][ChannelValue] Sets a raw channel to given value. Relay channels are using 1 and 0 values. PWM channels are within [0,100] range. Do not use this for LED control, because there is a better and more advanced LED driver with dimming and configuration memory (remembers setting after on/off), LED driver commands has 'led_' prefix.

See also SetChannel on forum.
SetChannelEnum [ChannelIndex][Value,Title][Value,Title] Creates a custom channel enumeration.

See also SetChannelEnum on forum.
SetChannelFloat [ChannelIndex][ChannelValue] Sets a raw channel to given float value. Currently only used for LED PWM channels.

See also SetChannelFloat on forum.
SetChannelLabel [ChannelIndex][Str][bHideTogglePrefix] Sets a channel label for UI and default entity name for Home Assistant discovery. If you use 1 for bHideTogglePrefix, then the 'Toggle ' prefix from UI button will be omitted.

See also SetChannelLabel on forum.
SetChannelPrivate [ChannelIndex][bPrivate] Channels marked as private are NEVER published via MQTT and excluded from Home Assistant discovery.

See also SetChannelPrivate on forum.
setChannelType [ChannelIndex][TypeString] Sets a custom type for channel. Types are mostly used to determine how to display channel value on GUI.

See also setChannelType on forum.
SetChannelVisible [ChannelIndex][bVisible] This allows you to force-hide a certain channel from HTTP gui. The channel will still work, but will not show up as a button, or a toggle, etc...

See also SetChannelVisible on forum.
SetFlag [FlagIndex][0or1] Sets given flag.

See also SetFlag on forum.
SetPinChannel [PinIndex][ChannelIndex][optionalChannel2Index] This allows you to set a channel linked to pin from console. Usually it's easier to do this through WWW panel, so you don't have to use this command.

See also SetPinChannel on forum.
SetPinRole [PinRole][RoleIndexOrName] This allows you to set a pin role, for example a Relay role, or Button, etc. Usually it's easier to do this through WWW panel, so you don't have to use this command.

See also SetPinRole on forum.
SetStartValue [Channel][Value] Sets the startup value for a channel. Used for start values for relays. Use 1 for High, 0 for low and -1 for 'remember last state'.

See also SetStartValue on forum.
SetupEnergyStats [Enable1or0][SampleTime][SampleCount][JSonEnable] Setup Energy Statistic Parameters: [enable 0 or 1] [sample_time[10..90]] [sample_count[10..180]] [JsonEnable 0 or 1]. JSONEnable is optional.

See also SetupEnergyStats on forum.
SetupTestPower [fakeVoltage] [FakeCurrent] [FakePower] [bAllowRandom] Starts the fake power metering driver.

See also SetupTestPower on forum.
SGP_cycle [int] Change cycle of measurement by default every 10 seconds 0 to deactivate.

Example: SGP_Cycle 60

See also SGP_cycle on forum.
SGP_GetBaseline SGP Get baseline.

Example: SGP_GetBaseline

See also SGP_GetBaseline on forum.
SGP_GetVersion SGP : get version.

Example: SGP_GetVersion

See also SGP_GetVersion on forum.
SGP_SoftReset SGP i2C soft reset.

Example: SGP_SoftReset

See also SGP_SoftReset on forum.
ShortName [Name] Sets the short name of the device.

See also ShortName on forum.
showChannelValues Log channel values.

See also showChannelValues on forum.
showgpi NULL Log stat of all GPIs.

See also showgpi on forum.
SHT_Calibrate [DeltaTemp][DeltaHumidity] Calibrate the SHT Sensor as Tolerance is +/-2 degrees C.

Example: SHT_Calibrate -4 10

See also SHT_Calibrate on forum.
SHT_ClearStatus Clear Sensor Status.

Example: SHT_ClearStatusCmd

See also SHT_ClearStatus on forum.
SHT_cycle [int] This is the interval between measurements in seconds, by default 10. Max is 255.

Example: SHT_Cycle 60

See also SHT_cycle on forum.
SHT_GetStatus Get Sensor Status.

Example: SHT_GetStatusCmd

See also SHT_GetStatus on forum.
SHT_Heater [1or0] Activate or Deactivate Heater (0 / 1).

Example: SHT_Heater 1

See also SHT_Heater on forum.
SHT_LaunchPer [msb][lsb] Launch/Change periodical capture for SHT Sensor.

Example: SHT_LaunchPer 0x23 0x22

See also SHT_LaunchPer on forum.
SHT_Measure Retrieve OneShot measurement for SHT.

Example: SHT_Measure

See also SHT_Measure on forum.
SHT_MeasurePer Retrieve Periodical measurement for SHT.

Example: SHT_Measure

See also SHT_MeasurePer on forum.
SHT_ReadAlert Get Sensor alert configuration.

Example: SHT_ReadAlertCmd

See also SHT_ReadAlert on forum.
SHT_SetAlert [temp_high, temp_low, hum_high, hum_low]
Req:all
Set Sensor alert configuration.

Example: SHT_SetAlertCmd

See also SHT_SetAlert on forum.
SHT_StopPer Stop periodical capture for SHT Sensor.

See also SHT_StopPer on forum.
simonirtest Simons Special Test.

See also simonirtest on forum.
SM16703P_Init [NumberOfLEDs][ColorOrder] This will setup LED driver for a strip with given number of LEDs. Please note that it also works for WS2812B and similiar LEDs. You can optionally set the color order with either RGB, RBG, BRG, BGB, GRB or GBR (default RGB). See tutorial.

See also SM16703P_Init on forum.
SM16703P_SetPixel [index/all] [R] [G] [B] Sets a pixel for LED strip. Index can be a number or 'all' keyword to set all. Then, 3 integer values for R, G and B. Please note that it also works for WS2812B and similiar LEDs. See tutorial.

See also SM16703P_SetPixel on forum.
SM16703P_SetRaw [bUpdate] [byteOfs] [HexData] Sets the raw data bytes for SPI DMA LED driver at the given offset. Hex data should be as a hex string, for example, FF00AA, etc. The bUpdate, if set to 1, will run SM16703P_Start automatically after setting data. Please note that it also works for WS2812B and similiar LEDs. See tutorial.

See also SM16703P_SetRaw on forum.
SM16703P_Start This will send the currently set data to the strip. Please note that it also works for WS2812B and similiar LEDs. See tutorial.

See also SM16703P_Start on forum.
SM2135_Current [RGBLimit][CWLimit] Sets the maximum current for LED driver. Please note that arguments are using SM2135 codes, see full list of codes here.

See also SM2135_Current on forum.
SM2135_Map [Ch0][Ch1][Ch2][Ch3][Ch4] Maps the RGBCW values to given indices of SM2135 channels. This is because SM2135 channels order is not the same for some devices. Some devices are using RGBCW order and some are using GBRCW, etc, etc. Example usage: SM2135_Map 0 1 2 3 4.

See also SM2135_Map on forum.
SM2135_RGBCW [HexColor] Don't use it. It's for direct access of SM2135 driver. You don't need it because LED driver automatically calls it, so just use led_basecolor_rgb.

See also SM2135_RGBCW on forum.
SM2235_Current [Value] Sets the maximum current for LED driver.

See also SM2235_Current on forum.
SM2235_Map [Ch0][Ch1][Ch2][Ch3][Ch4] Maps the RGBCW values to given indices of SM2235 channels. This is because SM2235 channels order is not the same for some devices. Some devices are using RGBCW order and some are using GBRCW, etc, etc. Example usage: SM2235_Map 0 1 2 3 4.

See also SM2235_Map on forum.
SM2235_RGBCW [HexColor] Don't use it. It's for direct access of SM2235 driver. You don't need it because LED driver automatically calls it, so just use led_basecolor_rgb.

See also SM2235_RGBCW on forum.
SPC [Index][RGB] Sets Palette Color by index.

See also SPC on forum.
SPITestFlash_Erase CMD_SPITestFlash_Erase .

See also SPITestFlash_Erase on forum.
SPITestFlash_ReadData CMD_SPITestFlash_ReadData .

See also SPITestFlash_ReadData on forum.
SPITestFlash_ReadID CMD_SPITestFlash_ReadID .

See also SPITestFlash_ReadID on forum.
SPITestFlash_WriteStr CMD_SPITestFlash_WriteStr .

See also SPITestFlash_WriteStr on forum.
SSID1 [ValueString] Sets the SSID of target WiFi. Command keeps Tasmota syntax.

See also SSID1 on forum.
stackOverflow Causes a stack overflow.

See also stackOverflow on forum.
startDriver [DriverName] Starts driver.

See also startDriver on forum.
startScript [FileName][Label][UniqueID] Starts a script thread from given file, at given label - can be * for whole file, with given unique ID.

See also startScript on forum.
StartupCommand [Command in quotation marks][bRunAfter] Sets the new startup command (short startup command, the one stored in config) to given string. Second argument is optional, if set to 1, command will be also executed after setting.

See also StartupCommand on forum.
State NULL NULL.

See also State on forum.
stopAllScripts Stops all running scripts.

See also stopAllScripts on forum.
stopDriver [DriverName] Stops driver.

See also stopDriver on forum.
stopScript [UniqueID] Force-stop given script thread by ID.

See also stopScript on forum.
TasTeleInterval [SensorInterval][StateInterval] This allows you to configure Tasmota TELE publish intervals, only if you have TELE flag enabled. First argument is interval for sensor publish (energy metering, etc), second is interval for State tele publish.

See also TasTeleInterval on forum.
testArgs Test tokenizer for args and print back all the given args to console.

See also testArgs on forum.
testFloats Do some more test printfs with floating point numbers.

See also testFloats on forum.
testJSON Test the JSON library.

See also testJSON on forum.
testLog Do some test printfs to log with integer and a float.

See also testLog on forum.
testMallocFree Test malloc and free functionality to see if the device crashes.

See also testMallocFree on forum.
testRealloc Test realloc and free functions to see if the device crashes.

See also testRealloc on forum.
testStrdup Test strdup function to see if it allocs news string correctly, also test freeing the string.

See also testStrdup on forum.
TimeSize Prints the size of time_t on current platform - sizeof(time_t), only for testing purposes.

See also TimeSize on forum.
TM1650_Test CMD_TM1650_Test .

See also TM1650_Test on forum.
TMGN_Brightness [Brigthness0to7][bOn] This allows you to change brightness and state of TM1637/GN932/etc display.

See also TMGN_Brightness on forum.
TMGN_Char [CharIndex] [CharCode] This allows you to set binary code for given char, valid chars range is 0 to 15, because this is 7-seg display.

See also TMGN_Char on forum.
TMGN_Clear This clears the TM1637/GN932/etc display.

See also TMGN_Clear on forum.
TMGN_Map [Map0][Map1, etc] This allows you to remap characters order for TM1637/GN932/etc. My TM1637 module from Aliexpress has a strange characters order.

See also TMGN_Map on forum.
TMGN_Print [StartOfs] [MaxLenOr0] [StringText] [optionalBClampWithZeroesForClock] This allows you to print string on TM1637/GN932/etc display, it supports variables expansion.

See also TMGN_Print on forum.
TMGN_Read Executes a single buttons read on TM/GN LED driver.

See also TMGN_Read on forum.
TMGN_SetBit [CharIndex] [BitIndex] [BitValue] Set given bit of given digit to 1 or 0.

See also TMGN_SetBit on forum.
TMGN_SetupButtons [Interval] Setups periodic buttons read on TM/GN LED driver.

See also TMGN_SetupButtons on forum.
TMGN_Test .

See also TMGN_Test on forum.
ToggleChannel [ChannelIndex] Toggles given channel value. Non-zero becomes zero, zero becomes 1.

See also ToggleChannel on forum.
toggler_channel [ChannelIndex] Handles toggler_channel0, toggler_channel1. Sets channel linked to given toggler slot.

See also toggler_channel on forum.
toggler_enable [1or0] Sets the given output ON or OFF. handles toggler_enable0, toggler_enable1, etc.

See also toggler_enable on forum.
toggler_name Handles toggler_name0, toggler_name1, etc. Sets the name of a toggler for GUI.

See also toggler_name on forum.
toggler_set [Value] Sets the VALUE of given output. Handles toggler_set0, toggler_set1, etc. The last digit after command name is changed to slot index. It can also add to current value if you write value like +25 and subtract if you prefix it with - like -25.

See also toggler_set on forum.
TS_Clear Clears the text scroller buffer.

See also TS_Clear on forum.
TS_Print [StartOfs] [MaxLenOr0] [StringText] [optionalBClampWithZeroesForClock] Prints a text to the text scroller buffer.

See also TS_Print on forum.
tuyaMcu_defWiFiState Command sets the default WiFi state for TuyaMCU when device is not online. It may be required for some devices to work, because Tuya designs them to ignore touch buttons or beep when not paired. Please see values table and description here.

See also tuyaMcu_defWiFiState on forum.
tuyaMcu_sendCmd TuyaMCU_SendUserCmd .

See also tuyaMcu_sendCmd on forum.
tuyaMcu_sendColor [dpID] [red01] [green01] [blue01] [tuyaRGBformat] This sends a TuyaMCU color string of given format for given RGB values, where each value is in [0,1] range as float.

See also tuyaMcu_sendColor on forum.
tuyaMcu_sendCurTime Sends a current date by TuyaMCU to clock/callendar MCU. Time is taken from NTP driver, so NTP also should be already running.

See also tuyaMcu_sendCurTime on forum.
tuyaMcu_sendHeartbeat Send heartbeat to TuyaMCU.

See also tuyaMcu_sendHeartbeat on forum.
tuyaMcu_sendMCUConf Send MCU conf command.

See also tuyaMcu_sendMCUConf on forum.
tuyaMcu_sendProductInformation Send query packet (0x01). No arguments needed.

See also tuyaMcu_sendProductInformation on forum.
tuyaMcu_sendQueryState Send query state command. No arguments needed.

See also tuyaMcu_sendQueryState on forum.
tuyaMcu_sendRSSI Command sends the specific RSSI value to TuyaMCU (it will send current RSSI if no argument is set).

See also tuyaMcu_sendRSSI on forum.
tuyaMcu_sendState [dpID][dpType][dpValue] Manually send set state command. Do not use it. Use mapping, so communication is bidirectional and automatic.

See also tuyaMcu_sendState on forum.
tuyaMcu_setBaudRate [BaudValue] Sets the baud rate used by TuyaMCU UART communication. Default value is 9600. Some other devices require 115200.

See also tuyaMcu_setBaudRate on forum.
tuyaMcu_setDimmerRange [Min][Max] Set dimmer range used by TuyaMCU.

See also tuyaMcu_setDimmerRange on forum.
tuyaMcu_setupLED [dpIDColor] [TasFormat] [dpIDPower] Setups the TuyaMCU LED driver for given color dpID and power dpID. Also allows you to choose color format.

See also tuyaMcu_setupLED on forum.
tuyaMcu_testSendTime Sends a example date by TuyaMCU to clock/callendar MCU.

See also tuyaMcu_testSendTime on forum.
uartFakeHex [HexString] Spoofs a fake hex packet so it looks like TuyaMCU send that to us. Used for testing.

See also uartFakeHex on forum.
uartInit [BaudRate] Manually starts UART1 port. Keep in mind that you don't need to do it for TuyaMCU and BL0942, those drivers do it automatically.

See also uartInit on forum.
uartSendASCII [AsciiString] Sends given string by UART.

See also uartSendASCII on forum.
uartSendHex [HexString] Sends raw data by UART, can be used to send TuyaMCU data, but you must write whole packet with checksum yourself.

See also uartSendHex on forum.
UCS1912_Test .

See also UCS1912_Test on forum.
VCPPrecision [VoltageDigits][CurrentDigitsAmpers][PowerDigitsWats][EnergyDigitsWh] Sets the number of digits after decimal point for power metering publishes. Default is BL09XX_VCPPrecision 1 3 2 3. This works for OBK-style publishes.

See also VCPPrecision on forum.
VCPPublishIntervals [MinDelayBetweenPublishes][ForcedPublishInterval] First argument is minimal allowed interval in second between Voltage/Current/Power/Energy publishes (even if there is a large change), second value is an interval in which V/C/P/E is always published, even if there is no change.

See also VCPPublishIntervals on forum.
VCPPublishThreshold [VoltageDeltaVolts][CurrentDeltaAmpers][PowerDeltaWats][EnergyDeltaWh] Sets the minimal change between previous reported value over MQTT and next reported value over MQTT. Very useful for BL0942, BL0937, etc. So, if you set, VCPPublishThreshold 0.5 0.001 0.5, it will only report voltage again if the delta from previous reported value is largen than 0.5V. Remember, that the device will also ALWAYS force-report values every N seconds (default 60).

See also VCPPublishThreshold on forum.
VoltageSet Voltage Measure the real voltage with an external, reliable power meter and enter this voltage via this command to calibrate. The calibration is automatically saved in the flash memory.

See also VoltageSet on forum.
waitFor [EventName] [Argument] Wait forever for event. Can be used within script. For example, you can do: waitFor MQTTState 1 or waitFor NTPState 1. You can also do waitFor NoPingTime 600 to wait for 600 seconds without ping watchdog getting successful reply.

See also waitFor on forum.