Files
OpenBK7231T_App/docs/commands-extended.md
Tester23 64f5e8b31d docs
2026-01-08 01:18:36 +01:00

117 KiB
Raw Blame History

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. Do not add anything here, as it will overwritten with next rebuild.

Command Arguments Description Location
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.
File: driver/drv_adcButton.c
Function: Cmd_ADCButtonMap
ACMode [Mode] Sets the climate mode (off, cool, dry, fan_only, heat, heatcool, auto).

See also ACMode on forum.
File: driver/drv_tclAC.c
Function: CMD_ACMode
ADCSmoother [Pindex] [TotalSamples] [SampleIntervalMS] [TargetChannelADCValue] [MarginValue] [TargetChannel0or1] Starts the ADC smoother with given configuration.

See also ADCSmoother on forum.
File: driver/drv_adcSmoother.c
Function: Cmd_SetupADCSmoother
AddChangeHandler [Variable][Relation][Constant][Command] Trigger based on change in channel value (for example channel 0 becoming 100), or for a voltage/current/power/frequency 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', 'Current', 'Voltage' or 'Frequency'.

Example: Values are compared as integers. This affects Current (*1000) and Frequency (*100). Example handler where Current is greather than 2Amps:
AddChangeHandler Current > 2000 SetChannel 1 0

See also AddChangeHandler on forum.
File: cmnds/cmd_eventHandlers.c
Function: CMD_AddChangeHandler
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.
File: cmnds/cmd_channels.c
Function: CMD_AddChannel
addClockEvent [TimerSeconds or Time or sunrise or sunset] [WeekDayFlags] [UniqueIDForRemoval][Command] Schedule command to run on given time in given day of week. CLOCK 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_TIME_SUNRISE_SUNSET set which adds about 11k of code).

See also addClockEvent on forum.
File: driver/drv_timed_events.c
Function: CMD_TIME_AddEvent
AddEventHandler [EventName][EventArgument][CommandToRun] This can be used to trigger an action on a button click, long press, etc.

See also AddEventHandler on forum.
File: cmnds/cmd_eventHandlers.c
Function: CMD_AddEventHandler
addI2CDevice_ADS1115 .

See also addI2CDevice_ADS1115 on forum.
File: i2c/drv_i2c_ads1115.c
Function: DRV_I2C_AddDevice_ADS1115
addI2CDevice_LCD_PCF8574 Adds a new I2C device - PCF8574.

See also addI2CDevice_LCD_PCF8574 on forum.
File: i2c/drv_i2c_lcd_pcf8574t.c
Function: DRV_I2C_AddDevice_PCF8574
addI2CDevice_LCM1602 Adds a new I2C device - LCM1602.

See also addI2CDevice_LCM1602 on forum.
File: i2c/drv_i2c_lcm1602.c
Function: DRV_I2C_AddDevice_LCM1602
addI2CDevice_MCP23017 Adds a new I2C device - MCP23017.

See also addI2CDevice_MCP23017 on forum.
File: i2c/drv_i2c_mcp23017.c
Function: DRV_I2C_AddDevice_MCP23017
addI2CDevice_TC74 Adds a new I2C device - TC74.

See also addI2CDevice_TC74 on forum.
File: i2c/drv_i2c_tc74.c
Function: DRV_I2C_AddDevice_TC74
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.
File: cmnds/cmd_repeatingEvents.c
Function: RepeatingEvents_Cmd_AddRepeatingEvent
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.
File: cmnds/cmd_repeatingEvents.c
Function: RepeatingEvents_Cmd_AddRepeatingEvent
addRepeatingEventUID [IntervalSeconds][RepeatsOr-1][UserID][CommandToRun] As addRepeatingEventID, but also automatically cancels previous events with same ID.

Example: addRepeatingEventUID 2 -1 123 Power0 Toggle

See also addRepeatingEventUID on forum.
File: cmnds/cmd_repeatingEvents.c
Function: RepeatingEvents_Cmd_AddRepeatingEvent
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.
File: cmnds/cmd_newLEDDriver.c
Function: add_dimmer
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.
File: cmnds/cmd_newLEDDriver.c
Function: add_temperature
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.
File: driver/drv_aht2x.c
Function: AHT2X_Calibrate
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.
File: driver/drv_aht2x.c
Function: AHT2X_Cycle
AHT2X_Measure Retrieve OneShot measurement.

Example: AHT2X_Measure

See also AHT2X_Measure on forum.
File: driver/drv_aht2x.c
Function: AHT2X_Force
AHT2X_Reinit Reinitialize sensor.

Example: AHT2X_Reinit

See also AHT2X_Reinit on forum.
File: driver/drv_aht2x.c
Function: AHT2X_Reinit
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.
File: cmnds/cmd_main.c
Function: CMD_CreateAliasForCommand
aliasMem Internal usage only. See docs for 'alias' command.

See also aliasMem on forum.
File: cmnds/cmd_main.c
Function: runcmd
Anim [AnimationIndex] Starts given WS2812 animation by index.

See also Anim on forum.
File: driver/drv_pixelAnim.c
Function: PA_Cmd_Anim
AnimSpeed [Interval] Sets WS2812 animation speed.

See also AnimSpeed on forum.
File: driver/drv_pixelAnim.c
Function: PA_Cmd_AnimSpeed
backlog [string of commands separated with ;] Run a sequence of ; separated commands.

See also backlog on forum.
File: cmnds/cmd_tasmota.c
Function: cmnd_backlog
Battery_cycle [int] Change cycle of measurement by default every 10 seconds.

Example: Battery_cycle 60

See also Battery_cycle on forum.
File: driver/drv_battery.c
Function: Battery_cycle
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.
File: driver/drv_battery.c
Function: Battery_Setup
berry [Berry code] Execute Berry code.

Example: berry 1+2

See also berry on forum.
File: cmnds/cmd_berry.c
Function: CMD_Berry
BL0942opts opts BL0942opts 0= default mode (as set in config Flag 26), 3= two BL0942 on both UARTs (bit0 BL0942 on UART1, bit1 BL0942 on UART2).

See also BL0942opts on forum.
File: driver/drv_bl0942.c
Function: CMD_BL0942opts
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.
File: driver/drv_bmpi2c.c
Function: BMPI2C_Calibrate
BMPI2C_Configure [Mode][TempSampling][PressureSampling][HumSampling][IIRFilter][StandbyTime] Manual sensor configuration. Modes: 0 - normal, 1 - forced, 2 - sleep. Overampling range: -1 - skipped, 2^0 to 2^4. Default is X1. IIRFilter range: 0 - off, 2^1 to 2^4 for most, up to 2^7 for BME68X, StandbyTime: 1 for 0.5ms, 63 for 62.5ms, 125, 250, 500, 1000, 2000, 4000. Mode and StandbyTime are not needed on BME68X, All values will be rounded down to closest available (like sampling 10 will choose 8x).

Example: BMPI2C_Configure 0 8 2 4 16 125


See also BMPI2C_Configure on forum.
File: driver/drv_bmpi2c.c
Function: BMPI2C_Configure
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.
File: driver/drv_bmpi2c.c
Function: BMPI2C_Cycle
BP1658CJ_Current [MaxCurrentRGB][MaxCurrentCW] Sets the maximum current limit for BP1658CJ driver.

See also BP1658CJ_Current on forum.
File: driver/drv_bp1658cj.c
Function: BP1658CJ_Current
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.
File: driver/drv_bp1658cj.c
Function: CMD_LEDDriver_Map
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.
File: driver/drv_bp1658cj.c
Function: CMD_LEDDriver_WriteRGBCW
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.
File: driver/drv_bp5758d.c
Function: BP5758D_Current
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.
File: driver/drv_bp5758d.c
Function: CMD_LEDDriver_Map
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.
File: driver/drv_bp5758d.c
Function: CMD_LEDDriver_WriteRGBCW
BridgePulseLength [FloatValue] Setup value for bridge pulse len.

See also BridgePulseLength on forum.
File: driver/drv_bridge_driver.c
Function: Bridge_Pulse_length
Buzzer CMD_Buzzer .

See also Buzzer on forum.
File: driver/drv_tclAC.c
Function: CMD_Buzzer
CAM_Show_Timestamp CMD_ShowTimestamp
Req:NTP
.

Example: CAM_Show_Timestamp 1

See also CAM_Show_Timestamp on forum.
File: driver/drv_txw81x_camera.c
Function: CMD_ShowTimestamp
cancelRepeatingEvent [UserIDInteger] Stops a given repeating event with a specified ID.

See also cancelRepeatingEvent on forum.
File: cmnds/cmd_repeatingEvents.c
Function: RepeatingEvents_Cmd_CancelRepeatingEvent
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.
File: cmnds/cmd_channels.c
Function: CMD_Ch
chart_add [ntp_time][val1][val2]...[valN] Adds data to the chart with specified variables at a specific NTP time. See tutorial.

See also chart_add on forum.
File: driver/drv_charts.c
Function: CMD_Chart_Add
chart_addNow [val1][val2]...[valN] Adds data to the chart using the current NTP time. See tutorial.

See also chart_addNow on forum.
File: driver/drv_charts.c
Function: CMD_Chart_AddNow
chart_create [max_samples][num_vars][num_axes] Creates a chart with a specified number of samples, variables, and axes. See tutorial.

See also chart_create on forum.
File: driver/drv_charts.c
Function: CMD_Chart_Create
chart_setAxis [axis_index][name][flags][label] Sets up an axis with a name, flags, and label. Currently flags can be 0 (left axis) or 1 (right axis). See tutorial.

See also chart_setAxis on forum.
File: driver/drv_charts.c
Function: CMD_Chart_SetAxis
chart_setVar [var_index][title][axis] Associates a variable with a specific axis. See tutorial.

See also chart_setVar on forum.
File: driver/drv_charts.c
Function: CMD_Chart_SetVar
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.
File: cmnds/cmd_main.c
Function: CMD_Choice
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.
File: driver/drv_chargingLimit.c
Function: ChargingLimit_SetupCommand
CHT_Alert [TempDiff][HumDiff][Freq][FQ] Enable alert pin. TempDif (temperature difference is any float higher than 0.05<EFBFBD>C) = set detected difference in temperature required for device to wake. HumDiff (humidity difference is any float higher than 0.1%). Freq (time per measurement in s) = 1, 5, 10, 60, 120 (default if wrong = 1). FQ (fault queue number) = 1, 2, 4, 6 (default if wrong = 1).

Example: CHT_Alert 0.5 0 5 2
alert pin will trigger when temperature deviates by more than 0.5<EFBFBD>C. Humidity will be ignored. Sensor measures every 5s with fault queue number 2.

See also CHT_Alert on forum.
File: driver/drv_cht8305.c
Function: CHT83XX_Alert
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.
File: driver/drv_cht8305.c
Function: CHT83XX_Calibrate
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.
File: driver/drv_cht8305.c
Function: CHT83XX_Cycle
ClampChannel [ChannelIndex][Min][Max] Clamps given channel value to a range.

See also ClampChannel on forum.
File: cmnds/cmd_channels.c
Function: CMD_ClampChannel
clearAll Clears config and all remaining features, like runtime scripts, events, etc.

See also clearAll on forum.
File: cmnds/cmd_main.c
Function: CMD_ClearAll
clearAllHandlers This clears all added event handlers.

See also clearAllHandlers on forum.
File: cmnds/cmd_eventHandlers.c
Function: CMD_ClearAllHandlers
clearClockEvents Removes all set clock events.

See also clearClockEvents on forum.
File: driver/drv_timed_events.c
Function: CMD_TIME_ClearEvents
clearConfig Clears all config, including WiFi data.

See also clearConfig on forum.
File: cmnds/cmd_main.c
Function: CMD_ClearConfig
clearIO Clears all pins setting, channels settings.

See also clearIO on forum.
File: cmnds/cmd_main.c
Function: CMD_ClearIO
ClearNoPingTime Command for ping watchdog; it sets the 'time since last ping reply' to 0 again.

See also ClearNoPingTime on forum.
File: cmnds/cmd_main.c
Function: CMD_ClearNoPingTime
clearRepeatingEvents Clears all repeating events.

See also clearRepeatingEvents on forum.
File: cmnds/cmd_repeatingEvents.c
Function: RepeatingEvents_Cmd_ClearRepeatingEvents
clear_energy TODO .

See also clear_energy on forum.
File: driver/drv_hlw8112.c
Function: HLW8112_ClearEnergy
clock_calcDST Depreciated! Only for backward compatibility! Please use 'TIME_setDST' in the future! Sets DST settings.

Example: CLOCK_calcDST 0 10 1 3 0 3 1 2 1
-- DST-End: last_week(0) October(10) sunday(1) 3_o_clock(3)
-- DST-Start: last_week(0) March(3) sunday(1) 2_o_clock(2) 1_hour_DST_offset

See also clock_calcDST on forum.
File: driver/drv_deviceclock.c
Function: CMD_TIME_CalcDST
Color [HexValue] Puts the LED driver in RGB mode and sets given color.

See also Color on forum.
File: cmnds/cmd_newLEDDriver.c
Function: basecolor_rgb
ConsumptionThreshold [FloatValue] Setup value for automatic save of consumption data [1..100].

See also ConsumptionThreshold on forum.
File: driver/drv_bl_shared.c
Function: BL09XX_SetupConsumptionThreshold
crashNull Causes a crash.

See also crashNull on forum.
File: cmnds/cmd_test.c
Function: CMD_CrashNull
CT [TempValue] Sets the LED temperature. Same as led_temperature but with Tasmota syntax.

See also CT on forum.
File: cmnds/cmd_newLEDDriver.c
Function: temperature
CTRange [MinRange][MaxRange] This sets the temperature range for display. Default is 154-500.

See also CTRange on forum.
File: cmnds/cmd_newLEDDriver.c
Function: ctRange
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.
File: driver/drv_pwrCal.c
Function: CalibrateCurrent
DDP_Send IP host pixelsize delay pData .

See also DDP_Send on forum.
File: driver/drv_ddpSend.c
Function: DDP_Send
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.
File: cmnds/cmd_main.c
Function: CMD_DeepSleep
delay_ms [ValueMS] Script-only command. Pauses current script thread for given amount of ms.

See also delay_ms on forum.
File: cmnds/cmd_script.c
Function: CMD_Delay_ms
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.
File: cmnds/cmd_script.c
Function: CMD_Delay_s
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.
File: driver/drv_tasmotaDeviceGroups.c
Function: CMD_DGR_SendBrightness
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.
File: driver/drv_tasmotaDeviceGroups.c
Function: CMD_DGR_SendFixedColor
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.
File: driver/drv_tasmotaDeviceGroups.c
Function: CMD_DGR_SendPower
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.
File: driver/drv_tasmotaDeviceGroups.c
Function: CMD_DGR_SendRGBCW
Dimmer [Value] Alias for led_dimmer, added for Tasmota.

See also Dimmer on forum.
File: cmnds/cmd_newLEDDriver.c
Function: dimmer
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.
File: cmnds/cmd_newLEDDriver.c
Function: dimmerDelta
Display CMD_Display .

See also Display on forum.
File: driver/drv_tclAC.c
Function: CMD_Display
DS1820_FULL_scansensors - (Re-)Scan all GPIOs defined for DS1820 for sensors.

Example: DS1820_FULL_scansensors

See also DS1820_FULL_scansensors on forum.
File: driver/drv_ds1820_full.c
Function: CMD_DS18B20_scansensors
DS1820_FULL_SetResolution [int] Sets resolution for connected DS1820 sensor (9/10/11/12 bits).

See also DS1820_FULL_SetResolution on forum.
File: driver/drv_ds1820_full.c
Function: Cmd_DS18B20_SetResolution
DS1820_FULL_setsensor DS18B20-Addr name [channel] Sets a name [and optional channel] to a DS18B20 sensor by sensors address.

Example: DS1820_FULL_setsensor "0x28 0x01 0x02 0x03 0x04 0x05 0x06 0x07" "kitchen" 2

See also DS1820_FULL_setsensor on forum.
File: driver/drv_ds1820_full.c
Function: CMD_DS18B20_setsensor
DS1820_SetResolution [int] Sets resolution for connected DS1820 sensor (9/10/11/12 bits).

See also DS1820_SetResolution on forum.
File: driver/drv_ds1820_simple.c
Function: Cmd_SetResolution
DS3231_GetEpoch - Gets time from RTC.

See also DS3231_GetEpoch on forum.
File: driver/drv_ds3231.c
Function: DS3231_GetEpochCmd
DS3231_GetTime - Gets time from RTC.

See also DS3231_GetTime on forum.
File: driver/drv_ds3231.c
Function: DS3231_GetTimeCmd
DS3231_SetEpoch Sets RTC time (to epoch).

Example: DS3231_SetTime 3269879540

See also DS3231_SetEpoch on forum.
File: driver/drv_ds3231.c
Function: DS3231_SetEpochCmd
DS3231_SetTime Sets RTC time.

Example: DS3231_SetTime 19 50 01 13 8 25

See also DS3231_SetTime on forum.
File: driver/drv_ds3231.c
Function: DS3231_SetTimeCmd
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.
File: cmnds/cmd_main.c
Function: CMD_DeepSleep_SetEdge
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.
File: driver/drv_doorSensorWithDeepSleep.c
Function: DoorDeepSleep_SetTime
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.
File: cmnds/cmd_main.c
Function: CMD_Echo
EEPROM_Dump TODO .

See also EEPROM_Dump on forum.
File: driver/drv_simpleEEPROM.c
Function: EEPROM_DumpCmd
EEPROM_Read TODO .

See also EEPROM_Read on forum.
File: driver/drv_simpleEEPROM.c
Function: EEPROM_ReadCmd
EEPROM_WriteHex TODO .

See also EEPROM_WriteHex on forum.
File: driver/drv_simpleEEPROM.c
Function: EEPROM_WriteHexCmd
EnergyCntReset [OptionalNewValue][sensorix] 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). sensorix is used in ENABLE_BL_TWIN.

See also EnergyCntReset on forum.
File: driver/drv_bl_shared.c
Function: BL09XX_ResetEnergyCounter
exec [Filename] Exec - run autoexec.bat or other file from LFS if present.

See also exec on forum.
File: cmnds/cmd_tasmota.c
Function: cmnd_lfsexec
ExitSimulator [SIMULATOR ONLY] Exits the application instance.

See also ExitSimulator on forum.
File: cmnds/cmd_simulatorOnly.c
Function: CMD_ExitSimulator
fakeTuyaPacket [HexString] This simulates packet being sent from TuyaMCU to our OBK device.

See also fakeTuyaPacket on forum.
File: driver/drv_tuyaMCU.c
Function: TuyaMCU_FakePacket
FANMode CMD_FANMode .

See also FANMode on forum.
File: driver/drv_tclAC.c
Function: CMD_FANMode
flags [IntegerValue] Sets the device flags.

See also flags on forum.
File: cmnds/cmd_main.c
Function: CMD_Flags
FriendlyName [Name] Sets the full name of the device.

See also FriendlyName on forum.
File: cmnds/cmd_channels.c
Function: CMD_FriendlyName
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.
File: cmnds/cmd_channels.c
Function: CMD_FullBootTime
Gen Gen .

See also Gen on forum.
File: driver/drv_tclAC.c
Function: CMD_Gen
GetChannel [ChannelIndex] Prints given channel value to console.

See also GetChannel on forum.
File: cmnds/cmd_channels.c
Function: CMD_GetChannel
GetReadings Prints voltage etc readings to console.

See also GetReadings on forum.
File: cmnds/cmd_channels.c
Function: CMD_GetReadings
GirierMCU_setBaudRate TODO .

See also GirierMCU_setBaudRate on forum.
File: driver/drv_girierMCU.c
Function: GirierMCU_SetBaudRate
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.
File: cmnds/cmd_script.c
Function: CMD_GoTo
HLW8112_a TODO .

See also HLW8112_a on forum.
File: driver/drv_hlw8112.c
Function: HLW8112_a
HLW8112_c TODO .

See also HLW8112_c on forum.
File: driver/drv_hlw8112.c
Function: HLW8112_c
HLW8112_print_coeff TODO .

See also HLW8112_print_coeff on forum.
File: driver/drv_hlw8112.c
Function: HLW8112_print_coeff
HLW8112_read_reg TODO .

See also HLW8112_read_reg on forum.
File: driver/drv_hlw8112.c
Function: HLW8112_read_reg
HLW8112_SetClock TODO .

See also HLW8112_SetClock on forum.
File: driver/drv_hlw8112.c
Function: HLW8112_SetClock
HLW8112_SetEnergyStat TODO .

See also HLW8112_SetEnergyStat on forum.
File: driver/drv_hlw8112.c
Function: HLW8112_SetEnergyStat
HLW8112_SetResistorGain TODO .

See also HLW8112_SetResistorGain on forum.
File: driver/drv_hlw8112.c
Function: HLW8112_SetResistorGain
HLW8112_write_reg TODO .

See also HLW8112_write_reg on forum.
File: driver/drv_hlw8112.c
Function: HLW8112_write_reg
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.
File: cmnds/cmd_newLEDDriver.c
Function: LED_SetBaseColor_HSB
HSBColor1 [Hue] Tasmota-style colour access. Sets hue in 0 to 360 range.

See also HSBColor1 on forum.
File: cmnds/cmd_newLEDDriver.c
Function: setHue
HSBColor2 [Saturation] Tasmota-style colour access. Set saturation in 0 to 100 range.

See also HSBColor2 on forum.
File: cmnds/cmd_newLEDDriver.c
Function: setSaturation
HSBColor3 [Brightness] Tasmota-style colour access. Sets brightness in 0 to 100 range.

See also HSBColor3 on forum.
File: cmnds/cmd_newLEDDriver.c
Function: setBrightness
HT16K33_Blink HT16K33_Blink .

See also HT16K33_Blink on forum.
File: driver/drv_ht16k33.c
Function: HT16K33_Blink
HT16K33_Brightness HT16K33_Brightness .

See also HT16K33_Brightness on forum.
File: driver/drv_ht16k33.c
Function: HT16K33_Brightness
HT16K33_Char HT16K33_Char .

See also HT16K33_Char on forum.
File: driver/drv_ht16k33.c
Function: HT16K33_Char
HT16K33_Print HT16K33_Print .

See also HT16K33_Print on forum.
File: driver/drv_ht16k33.c
Function: HT16K33_Print
HT16K33_Raw HT16K33_Raw .

See also HT16K33_Raw on forum.
File: driver/drv_ht16k33.c
Function: HT16K33_Raw
HT16K33_Test HT16K33_Test .

See also HT16K33_Test on forum.
File: driver/drv_ht16k33.c
Function: HT16K33_Test
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.
File: cmnds/cmd_main.c
Function: CMD_If
IndexRefreshInterval [Interval] .

See also IndexRefreshInterval on forum.
File: cmnds/cmd_main.c
Function: CMD_IndexRefreshInterval
IRAC [TODO] Sends IR commands for HVAC control (TODO).

See also IRAC on forum.
File: driver/drv_ir_new.cpp
Function: IR_AC_Cmd
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.
File: driver/drv_ir_new.cpp
Function: IR_Enable
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.
File: driver/drv_ir_new.cpp
Function: IR_Enable
IRParam [MinSize] [Noise Threshold] Set minimal size of the message and noise threshold.

See also IRParam on forum.
File: driver/drv_ir_new.cpp
Function: IR_Param
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.
File: driver/drv_ir_new.cpp
Function: IR_Send_Cmd
IRSend [PROT-ADDR-CMD-REP] Sends IR commands in the form PROT-ADDR-CMD-REP, e.g. NEC-1-1A-0.

See also IRSend on forum.
File: driver/drv_ir_new.cpp
Function: IR_Send_Cmd
Json json array of commands A stub for Tasmota.

See also Json on forum.
File: cmnds/cmd_tasmota.c
Function: cmnd_JsonCommand
json_test Developer-only command used to test CJSON library.

See also json_test on forum.
File: cmnds/cmd_test.c
Function: cmnd_json_test
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.
File: driver/drv_kp18058.c
Function: KP18058_Current
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.
File: driver/drv_kp18058.c
Function: CMD_LEDDriver_Map
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.
File: driver/drv_kp18058.c
Function: CMD_LEDDriver_WriteRGBCW
lcd_clear Clears the LCD.

See also lcd_clear on forum.
File: i2c/drv_i2c_lcd_pcf8574t.c
Function: DRV_I2C_LCD_PCF8574_Clear
lcd_clearAndGoto Clears LCD and go to pos.

See also lcd_clearAndGoto on forum.
File: i2c/drv_i2c_lcd_pcf8574t.c
Function: DRV_I2C_LCD_PCF8574_ClearAndGoTo
lcd_goto Go to position on LCD.

See also lcd_goto on forum.
File: i2c/drv_i2c_lcd_pcf8574t.c
Function: DRV_I2C_LCD_PCF8574_GoTo
lcd_print Prints a string on the LCD.

See also lcd_print on forum.
File: i2c/drv_i2c_lcd_pcf8574t.c
Function: DRV_I2C_LCD_PCF8574_Print
lcd_printFloat Prints a float on the LCD.

See also lcd_printFloat on forum.
File: i2c/drv_i2c_lcd_pcf8574t.c
Function: DRV_I2C_LCD_PCF8574_PrintFloat
lcd_printInt Prints an omt on the LCD.

See also lcd_printInt on forum.
File: i2c/drv_i2c_lcd_pcf8574t.c
Function: DRV_I2C_LCD_PCF8574_PrintInt
led_basecolor_rgb [HexValue] Puts the LED driver in RGB mode and sets given color.

See also led_basecolor_rgb on forum.
File: cmnds/cmd_newLEDDriver.c
Function: basecolor_rgb
led_basecolor_rgbcw [HexValue] Set PWN color using #RRGGBB[cw][ww].

See also led_basecolor_rgbcw on forum.
File: cmnds/cmd_newLEDDriver.c
Function: basecolor_rgbcw
led_colorMult [Value] Internal usage.

See also led_colorMult on forum.
File: cmnds/cmd_newLEDDriver.c
Function: colorMult
led_dimmer [Value] Set output dimmer 0..100.

See also led_dimmer on forum.
File: cmnds/cmd_newLEDDriver.c
Function: dimmer
led_dimmerScale [Scale] Led_dimmerScale is a simple way of decreasing LED bulbs heating. led_dimmerScale expects argument in 0-1 range. For example, if you set led_dimmerScale to 0.8, then OBK/Home Assistant dimmer at 100% will in reality translate to 80% PWM duty cycle, so LEDs will be slightly darker, but they will heat less and it will prolong LEDs life..

See also led_dimmerScale on forum.
File: cmnds/cmd_newLEDDriver.c
Function: cmdDimmerScale
led_enableAll [1or0orToggle] Power on/off LED but remember the RGB(CW) values.

See also led_enableAll on forum.
File: cmnds/cmd_newLEDDriver.c
Function: enableAll
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.
File: cmnds/cmd_newLEDDriver.c
Function: led_finishFullLerp
led_gammaCtrl sub-cmd [par] Control LED Gamma Correction and Calibration.

Example: led_gammaCtrl on

See also led_gammaCtrl on forum.
File: cmnds/cmd_newLEDDriver.c
Function: led_gamma_control
led_hue [Value] This is an alternate way to set the LED color.

See also led_hue on forum.
File: cmnds/cmd_newLEDDriver.c
Function: setHue
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.
File: cmnds/cmd_newLEDDriver.c
Function: lerpSpeed
LED_Map [Ch0][Ch1][Ch2][Ch3][Ch4] .

See also LED_Map on forum.
File: driver/drv_sm15155e.c
Function: CMD_LEDDriver_Map
led_nextColor Sets the next color from predefined colours list. Our list is the same as in Tasmota.

See also led_nextColor on forum.
File: cmnds/cmd_newLEDDriver.c
Function: nextColor
led_saturation [Value] This is an alternate way to set the LED color.

See also led_saturation on forum.
File: cmnds/cmd_newLEDDriver.c
Function: setSaturation
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.
File: cmnds/cmd_newLEDDriver.c
Function: cmdSaveStateIfModifiedInterval
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.
File: cmnds/cmd_newLEDDriver.c
Function: temperature
lfs_append [FileName][String] Appends a string to LFS file.

See also lfs_append on forum.
File: littlefs/our_lfs.c
Function: CMD_LFS_Append
lfs_appendFloat [FileName][Float] Appends a float to LFS file.

See also lfs_appendFloat on forum.
File: littlefs/our_lfs.c
Function: CMD_LFS_AppendFloat
lfs_appendInt [FileName][Int] Appends a Int to LFS file.

See also lfs_appendInt on forum.
File: littlefs/our_lfs.c
Function: CMD_LFS_AppendInt
lfs_appendLine [FileName][String] Appends a string to LFS file with a next line marker.

See also lfs_appendLine on forum.
File: littlefs/our_lfs.c
Function: CMD_LFS_AppendLine
lfs_format Unmount and format LFS. Optionally add new size as argument.

See also lfs_format on forum.
File: littlefs/our_lfs.c
Function: CMD_LFS_Format
lfs_mkdir CMD_LFS_MakeDirectory .

See also lfs_mkdir on forum.
File: littlefs/our_lfs.c
Function: CMD_LFS_MakeDirectory
lfs_mount Mount LFS.

See also lfs_mount on forum.
File: littlefs/our_lfs.c
Function: CMD_LFS_Mount
lfs_remove [FileName] Deletes a LittleFS file.

See also lfs_remove on forum.
File: littlefs/our_lfs.c
Function: CMD_LFS_Remove
lfs_size [MaxSize] Log or Set LFS size - will apply and re-format next boot, usage setlfssize 0x10000.

See also lfs_size on forum.
File: littlefs/our_lfs.c
Function: CMD_LFS_Size
lfs_test1 [FileName] Tests the LFS file reading feature.

See also lfs_test1 on forum.
File: cmnds/cmd_test.c
Function: cmnd_lfs_test1
lfs_test2 [FileName] Tests the LFS file reading feature.

See also lfs_test2 on forum.
File: cmnds/cmd_test.c
Function: cmnd_lfs_test2
lfs_test3 [FileName] Tests the LFS file reading feature.

See also lfs_test3 on forum.
File: cmnds/cmd_test.c
Function: cmnd_lfs_test3
lfs_unmount Un-mount LFS.

See also lfs_unmount on forum.
File: littlefs/our_lfs.c
Function: CMD_LFS_Unmount
lfs_write [FileName][String] Resets a LFS file and writes a new string to it.

See also lfs_write on forum.
File: littlefs/our_lfs.c
Function: CMD_LFS_Write
lfs_writeLine [FileName][String] Resets a LFS file and writes a new string to it with newline.

See also lfs_writeLine on forum.
File: littlefs/our_lfs.c
Function: CMD_LFS_WriteLine
linkGirierMCUOutputToChannel TODO .

See also linkGirierMCUOutputToChannel on forum.
File: driver/drv_girierMCU.c
Function: GirierMCU_LinkGirierMCUOutputToChannel
linkTuyaMCUOutputToChannel [dpId][varType][channelID][obkFlags-Optional][mult-optional][bInverse-Optional][delta-Optional][delta2][delta3] Used to map between TuyaMCU dpIDs and our internal channels. Mult, inverse and delta are for calibration, they are optional. obkFlags is also optional, 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.
File: driver/drv_tuyaMCU.c
Function: TuyaMCU_LinkTuyaMCUOutputToChannel
listClockEvents Print the complete set clock events list.

See also listClockEvents on forum.
File: driver/drv_timed_events.c
Function: CMD_TIME_ListEvents
listEventHandlers Prints full list of added event handlers.

See also listEventHandlers on forum.
File: cmnds/cmd_eventHandlers.c
Function: CMD_ListEventHandlers
listRepeatingEvents Lists all repeating events.

See also listRepeatingEvents on forum.
File: cmnds/cmd_repeatingEvents.c
Function: RepeatingEvents_Cmd_ListRepeatingEvents
listScripts Lists all running scripts.

See also listScripts on forum.
File: cmnds/cmd_script.c
Function: CMD_ListScripts
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.
File: logging/logging.c
Function: log_command
logfeature [Index][1or0] Set log feature filter, as an index and a 1 or 0.

See also logfeature on forum.
File: logging/logging.c
Function: log_command
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.
File: logging/logging.c
Function: log_command
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.
File: logging/logging.c
Function: log_port
logtype [TypeStr] Logtype direct thread
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.
File: cmnds/cmd_channels.c
Function: CMD_Map
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.
File: cmnds/cmd_channels.c
Function: CMD_MapRanges
MAX72XXClock_Animate TODO .

See also MAX72XXClock_Animate on forum.
File: driver/drv_max72xx_clock.c
Function: DRV_MAX72XX_Clock_Animate
MAX72XX_Clear TODO .

See also MAX72XX_Clear on forum.
File: driver/drv_max72xx_single.c
Function: DRV_MAX72XX_Clear
MAX72XX_Print DRV_MAX72XX_Print .

See also MAX72XX_Print on forum.
File: driver/drv_max72xx_single.c
Function: DRV_MAX72XX_Print
MAX72XX_refresh TODO .

See also MAX72XX_refresh on forum.
File: driver/drv_max72xx_single.c
Function: DRV_MAX72XX_Show
MAX72XX_Scroll DRV_MAX72XX_Scroll .

See also MAX72XX_Scroll on forum.
File: driver/drv_max72xx_single.c
Function: DRV_MAX72XX_Scroll
MAX72XX_SetPixel TODO .

See also MAX72XX_SetPixel on forum.
File: driver/drv_max72xx_single.c
Function: DRV_MAX72XX_SetPixel
MAX72XX_Setup [clk][cs][din][segments] Sets the maximum current for LED driver.

See also MAX72XX_Setup on forum.
File: driver/drv_max72xx_single.c
Function: DRV_MAX72XX_Setup
MCP23017_MapPinToChannel Maps port expander bit to OBK channel.

See also MCP23017_MapPinToChannel on forum.
File: i2c/drv_i2c_mcp23017.c
Function: DRV_I2C_MCP23017_MapPinToChannel
MCP9808_Adr [HexAdr] Sets the I2C address of MCP9808, like 0x30.

See also MCP9808_Adr on forum.
File: driver/drv_mcp9808.c
Function: MCP9808_Adr
MCP9808_AlertMin [MinT] [OptionalBActiveHigh] Setup MCP9809 temperature alert for min mode.

See also MCP9808_AlertMin on forum.
File: driver/drv_mcp9808.c
Function: MCP9808_AlertMin
MCP9808_AlertRange [MinT] [MaxT] [OptionalBActiveHigh] Setup MCP9809 temperature alert for range mode.

See also MCP9808_AlertRange on forum.
File: driver/drv_mcp9808.c
Function: MCP9808_AlertRange
MCP9808_Calibrate [DeltaTemperature] .

See also MCP9808_Calibrate on forum.
File: driver/drv_mcp9808.c
Function: MCP9808_Calibrate
MCP9808_Cycle [DelayInSeconds] Sets MCP9808 measurement interval.

See also MCP9808_Cycle on forum.
File: driver/drv_mcp9808.c
Function: MCP9808_cycle
MqttClient [ValueString] Sets the MQTT client. Command keeps Tasmota syntax.

See also MqttClient on forum.
File: cmnds/cmd_tasmota.c
Function: cmnd_MqttClient
MqttGroup [ValueString] Sets the MQTT Group topic. Command keeps Tasmota syntax.

See also MqttGroup on forum.
File: cmnds/cmd_tasmota.c
Function: cmnd_MqttGroup
MqttHost [ValueString] Sets the MQTT host. Command keeps Tasmota syntax.

See also MqttHost on forum.
File: cmnds/cmd_tasmota.c
Function: cmnd_MqttHost
MqttPassword [ValueString] Sets the MQTT pass. Command keeps Tasmota syntax.

See also MqttPassword on forum.
File: cmnds/cmd_tasmota.c
Function: cmnd_MqttPassword
MqttUser [ValueString] Sets the MQTT user. Command keeps Tasmota syntax.

See also MqttUser on forum.
File: cmnds/cmd_tasmota.c
Function: cmnd_MqttUser
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.
File: mqtt/new_mqtt.c
Function: MQTT_SetBroadcastInterval
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.
File: mqtt/new_mqtt.c
Function: MQTT_SetMaxBroadcastItemsPublishedPerSecond
ntp_info Display NTP related settings.

See also ntp_info on forum.
File: driver/drv_ntp.c
Function: NTP_Info
ntp_setLatLong [Latlong] Depreciated! Only for backward compatibility! Please use 'time_setLatLong' in the future!.

Example: ntp_SetLatlong -34.911498 138.809488

See also ntp_setLatLong on forum.
File: driver/drv_deviceclock.c
Function: TIME_SetLatlong
ntp_setServer [ServerIP] Sets the NTP server.

See also ntp_setServer on forum.
File: driver/drv_ntp.c
Function: NTP_SetServer
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.
File: driver/drv_ntp.c
Function: SetTimeZoneOfs
obkDeviceList Generate the SSDP list of OpenBeken devices found on the network.

See also obkDeviceList on forum.
File: driver/drv_ssdp.c
Function: Cmd_obkDeviceList
OpenAP Temporarily disconnects from programmed WiFi network and opens Access Point.

See also OpenAP on forum.
File: cmnds/cmd_main.c
Function: CMD_OpenAP
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.
File: cmnds/cmd_main.c
Function: CMD_HTTPOTA
owm_channels [temperature][humidity][pressure] Sets channels that will be used to store OWM response results.

See also owm_channels on forum.
File: driver/drv_openWeatherMap.c
Function: CMD_OWM_Channels
owm_request Sends OWM request to the API. Do not use it too often, as API may have limits.

See also owm_request on forum.
File: driver/drv_openWeatherMap.c
Function: CMD_OWM_Request
owm_setup [lat][lng][api_key] Setups OWM driver for your location and API key.

See also owm_setup on forum.
File: driver/drv_openWeatherMap.c
Function: CMD_OWM_Setup
Password1 [ValueString] Sets the Pass of target WiFi. Command keeps Tasmota syntax.

See also Password1 on forum.
File: cmnds/cmd_tasmota.c
Function: cmnd_Password1
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.
File: cmnds/cmd_channels.c
Function: CMD_PinDeepSleep
PingHost [IPStr] Sets the host to ping by IP watchdog.

See also PingHost on forum.
File: cmnds/cmd_main.c
Function: CMD_PingHost
PingInterval [IntegerSeconds] Sets the interval between ping attempts for ping watchdog mechanism.

See also PingInterval on forum.
File: cmnds/cmd_main.c
Function: CMD_PingInterval
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.
File: cmnds/cmd_tasmota.c
Function: power
powerAll Set all outputs.

See also powerAll on forum.
File: cmnds/cmd_tasmota.c
Function: powerAll
PowerMax [MaxPowerInW] Sets the maximum power limit for BL measurement used to filter incorrect values.

See also PowerMax on forum.
File: driver/drv_bl0937.c
Function: BL0937_PowerMax
PowerSave [Optional 1 or 0, by default 1 is assumed] Enables dynamic power saving mode on all platforms with the exception of TR6260. On LN882H PowerSave 1 = light sleep and Powersave >1 (eg PowerSave 2) = deeper sleep. On LN882H PowerSave 1 should be used if BL0937 metering is present. On all supported platforms PowerSave 0 can be used to disable power saving.

See also PowerSave on forum.
File: cmnds/cmd_main.c
Function: CMD_PowerSave
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.
File: driver/drv_pwrCal.c
Function: CalibratePower
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.
File: mqtt/new_mqtt.c
Function: MQTT_PublishCommand
publishAll Starts the step by step publish of all available values.

See also publishAll on forum.
File: mqtt/new_mqtt.c
Function: MQTT_PublishAll
publishBenchmark .

See also publishBenchmark on forum.
File: mqtt/new_mqtt.c
Function: MQTT_StartMQTTTestThread
publishChannel [ChannelIndex] Forces publish of given channel.

See also publishChannel on forum.
File: mqtt/new_mqtt.c
Function: MQTT_PublishChannel
publishChannels Starts the step by step publish of all channel values.

See also publishChannels on forum.
File: mqtt/new_mqtt.c
Function: MQTT_PublishChannels
publishDriver TODO .

See also publishDriver on forum.
File: mqtt/new_mqtt.c
Function: MQTT_PublishCommandDriver
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.
File: mqtt/new_mqtt.c
Function: MQTT_PublishFile
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.
File: mqtt/new_mqtt.c
Function: MQTT_PublishCommandFloat
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.
File: mqtt/new_mqtt.c
Function: MQTT_PublishCommandInteger
PWMFrequency [FrequencyInHz] Sets the global PWM frequency.

See also PWMFrequency on forum.
File: cmnds/cmd_main.c
Function: CMD_PWMFrequency
PWMG_Raw PWM grouping (synchronous PWM).

See also PWMG_Raw on forum.
File: driver/drv_pwm_groups.c
Function: CMD_PWMG_Raw
PWMG_Set Duty1Percent Duty2Percent DeadTimePercent Frequency PinA PinB PWM grouping (synchronous PWM).

See also PWMG_Set on forum.
File: driver/drv_pwm_groups.c
Function: CMD_PWMG_Set
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.
File: cmnds/cmd_main.c
Function: CMD_Restart
removeClockEvent [ID] Removes clock event with given ID.

See also removeClockEvent on forum.
File: driver/drv_timed_events.c
Function: CMD_TIME_RemoveEvent
resetSVM Resets all SVM and clears all scripts.

See also resetSVM on forum.
File: cmnds/cmd_script.c
Function: CMD_resetSVM
restart Reboots the module.

See also restart on forum.
File: cmnds/cmd_main.c
Function: CMD_Restart
Result NULL A stub for Tasmota.

See also Result on forum.
File: cmnds/cmd_tasmota.c
Function: cmnd_stub
return Script-only command. Currently it just stops totally current script thread.

See also return on forum.
File: cmnds/cmd_script.c
Function: CMD_Return
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.
File: cmnds/cmd_main.c
Function: CMD_SafeMode
scanI2C [Soft/I2C1/I2C2] Scans given I2C line for addresses. I2C driver must be started first.

See also scanI2C on forum.
File: i2c/drv_i2c_main.c
Function: DRV_I2C_Scan
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.
File: cmnds/cmd_main.c
Function: CMD_ScheduleHADiscovery
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.
File: cmnds/cmd_send.c
Function: CMD_SendGET
SendIR2 CMD_IR2_SendIR2 .

See also SendIR2 on forum.
File: driver/drv_ir2.c
Function: CMD_IR2_SendIR2
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.
File: cmnds/cmd_send.c
Function: CMD_SendPOST
Sensor NULL A stub for Tasmota.

See also Sensor on forum.
File: cmnds/cmd_tasmota.c
Function: cmnd_stub
setButtonColor [ButtonIndex][Color] Sets the colour of custom scriptable HTTP page button.

See also setButtonColor on forum.
File: driver/drv_httpButtons.c
Function: CMD_setButtonColor
setButtonCommand [ButtonIndex][Command] Sets the command of custom scriptable HTTP page button.

See also setButtonCommand on forum.
File: driver/drv_httpButtons.c
Function: CMD_setButtonCommand
setButtonEnabled [ButtonIndex][1or0] Sets the visibility of custom scriptable HTTP page button.

See also setButtonEnabled on forum.
File: driver/drv_httpButtons.c
Function: CMD_setButtonEnabled
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.
File: new_pins.c
Function: CMD_setButtonHoldRepeat
setButtonLabel [ButtonIndex][Label] Sets the label of custom scriptable HTTP page button.

See also setButtonLabel on forum.
File: driver/drv_httpButtons.c
Function: CMD_setButtonLabel
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.
File: new_pins.c
Function: CMD_SetButtonTimes
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.
File: cmnds/cmd_channels.c
Function: CMD_SetChannel
SetChannelEnum [ChannelIndex][Value:Title][Value:Title] Creates a channel enumeration type. Channel type must be set to Enum or ReadOnlyEnum. e.g. SetChannelEnum 1:One "2:Enum Two" 5:Five.

See also SetChannelEnum on forum.
File: cmnds/cmd_channels.c
Function: CMD_SetChannelEnum
SetChannelFloat [ChannelIndex][ChannelValue] Sets a raw channel to given float value. Currently only used for LED PWM channels.

See also SetChannelFloat on forum.
File: cmnds/cmd_channels.c
Function: CMD_SetChannelFloat
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.
File: cmnds/cmd_channels.c
Function: CMD_SetChannelLabel
SetChannelPrivate [ChannelIndex][bPrivate] Channels marked as private are NEVER published via MQTT and excluded from Home Assistant discovery.

See also SetChannelPrivate on forum.
File: cmnds/cmd_channels.c
Function: CMD_SetChannelPrivate
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.
File: new_pins.c
Function: CMD_SetChannelType
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.
File: cmnds/cmd_channels.c
Function: CMD_SetChannelVisible
SetFlag [FlagIndex][0or1] Sets given flag.

See also SetFlag on forum.
File: cmnds/cmd_main.c
Function: CMD_SetFlag
SetFlash [FlashIndex][FlashValue] Sets a a flashVars channel directly (if you are using remember state for given channel, it will overwrite, it uses same space for channels memory).

See also SetFlash on forum.
File: cmnds/cmd_channels.c
Function: CMD_SetFlash
setMovingAvg MovingAvg Moving average value for power and current. <=1 disable, >=2 count of avg values. The setting is temporary and need to be set at startup.

See also setMovingAvg on forum.
File: new_pins.c
Function: CMD_setMovingAvg
setMutex CMD_setMutex Pinmutex driver (potentially for shutters).

See also setMutex on forum.
File: driver/drv_pinMutex.c
Function: CMD_setMutex
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.
File: cmnds/cmd_channels.c
Function: CMD_SetPinChannel
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.
File: cmnds/cmd_channels.c
Function: CMD_SetPinRole
setStartupSSID [Value] Sets startup SSID, 0 (SSID0) 1 (SSID1).

See also setStartupSSID on forum.
File: new_pins.c
Function: CMD_setStartupSSID
setStartupSSIDChannel [Value] Sets retain channel number to store last used SSID, 0..MAX_RETAIN_CHANNELS-1, -1 to disable. Suggested channel number is 7 (MAXMAX_RETAIN_CHANNELS-5).

See also setStartupSSIDChannel on forum.
File: new_pins.c
Function: CMD_setStartupSSIDChannel
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.
File: cmnds/cmd_main.c
Function: CMD_SetStartValue
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.
File: driver/drv_bl_shared.c
Function: BL09XX_SetupEnergyStatistic
SetupIR2 [myPeriodUs] [dutyOnFrac] [dutyOffFrac] [txPin] Init IR2 pin and interrupt.

See also SetupIR2 on forum.
File: driver/drv_ir2.c
Function: CMD_IR2_SetupIR2
SetupTestPower [fakeVoltage] [FakeCurrent] [FakePower] [FakeFrequency] [bAllowRandom] Starts the fake power metering driver.

See also SetupTestPower on forum.
File: driver/drv_test_drivers.c
Function: TestPower_Setup
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.
File: driver/drv_sgp.c
Function: SGP_cycle
SGP_GetBaseline SGP Get baseline.

Example: SGP_GetBaseline

See also SGP_GetBaseline on forum.
File: driver/drv_sgp.c
Function: SGP_GetBaselinecmd
SGP_GetVersion SGP : get version.

Example: SGP_GetVersion

See also SGP_GetVersion on forum.
File: driver/drv_sgp.c
Function: SGP_GetVersioncmd
SGP_SoftReset SGP i2C soft reset.

Example: SGP_SoftReset

See also SGP_SoftReset on forum.
File: driver/drv_sgp.c
Function: SGP_SoftResetcmd
ShortName [Name] Sets the short name of the device. This is used as topic for MQTT, for example, for cmnd/obk123121/power etc MQTT calls.

See also ShortName on forum.
File: cmnds/cmd_channels.c
Function: CMD_ShortName
showChannelValues Log channel values.

See also showChannelValues on forum.
File: new_pins.c
Function: CMD_ShowChannelValues
showgpi NULL Log stat of all GPIs.

See also showgpi on forum.
File: new_pins.c
Function: showgpi
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.
File: driver/drv_sht3x.c
Function: SHT3X_Calibrate
SHT_ClearStatus Clear Sensor Status.

Example: SHT_ClearStatusCmd

See also SHT_ClearStatus on forum.
File: driver/drv_sht3x.c
Function: SHT3X_ClearStatusCmd
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.
File: driver/drv_sht3x.c
Function: SHT_cycle
SHT_GetStatus Get Sensor Status.

Example: SHT_GetStatusCmd

See also SHT_GetStatus on forum.
File: driver/drv_sht3x.c
Function: SHT3X_GetStatusCmd
SHT_Heater [1or0] Activate or Deactivate Heater (0 / 1).

Example: SHT_Heater 1

See also SHT_Heater on forum.
File: driver/drv_sht3x.c
Function: SHT3X_Heater
SHT_LaunchPer [msb][lsb] Launch/Change periodical capture for SHT Sensor.

Example: SHT_LaunchPer 0x23 0x22

See also SHT_LaunchPer on forum.
File: driver/drv_sht3x.c
Function: SHT3X_ChangePer
SHT_Measure Retrieve OneShot measurement for SHT.

Example: SHT_Measure

See also SHT_Measure on forum.
File: driver/drv_sht3x.c
Function: SHT3X_Measure
SHT_MeasurePer Retrieve Periodical measurement for SHT.

Example: SHT_Measure

See also SHT_MeasurePer on forum.
File: driver/drv_sht3x.c
Function: SHT3X_MeasurePer
SHT_ReadAlert Get Sensor alert configuration.

Example: SHT_ReadAlertCmd

See also SHT_ReadAlert on forum.
File: driver/drv_sht3x.c
Function: SHT3X_ReadAlertCmd
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.
File: driver/drv_sht3x.c
Function: SHT3X_SetAlertCmd
SHT_StopPer Stop periodical capture for SHT Sensor.

See also SHT_StopPer on forum.
File: driver/drv_sht3x.c
Function: SHT3X_StopPerCmd
simonirtest Simons Special Test.

See also simonirtest on forum.
File: cmnds/cmd_test.c
Function: CMD_SimonTest
SimSaveArgs Internal usage only. Command for OBK self-test in Simulator.

See also SimSaveArgs on forum.
File: selftest/selftest_cfg_via_http.c
Function: CMD_SelfTest_SaveArgs
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 can be any combination of R, G, B, C and W (e.g. RGBW or GRBWC, default is RGB). See tutorial.

See also SM16703P_Init on forum.
File: driver/drv_leds_shared.c
Function: Strip_CMD_InitForLEDCount
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.
File: driver/drv_leds_shared.c
Function: Strip_CMD_setPixel
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.
File: driver/drv_leds_shared.c
Function: Strip_CMD_setRaw
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.
File: driver/drv_leds_shared.c
Function: Strip_CMD_StartTX
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.
File: driver/drv_sm2135.c
Function: SM2135_Current
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.
File: driver/drv_sm2135.c
Function: CMD_LEDDriver_Map
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.
File: driver/drv_sm2135.c
Function: CMD_LEDDriver_WriteRGBCW
SM2235_Current [Value] Sets the maximum current for LED driver.

See also SM2235_Current on forum.
File: driver/drv_sm2235.c
Function: SM2235_Current
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.
File: driver/drv_sm2235.c
Function: CMD_LEDDriver_Map
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.
File: driver/drv_sm2235.c
Function: CMD_LEDDriver_WriteRGBCW
SPC [Index][RGB] Sets Palette Color by index.

See also SPC on forum.
File: cmnds/cmd_newLEDDriver.c
Function: commandSetPaletteColor
SPITestFlash_Erase CMD_SPITestFlash_Erase .

See also SPITestFlash_Erase on forum.
File: driver/drv_spi_flash.c
Function: CMD_SPITestFlash_Erase
SPITestFlash_ReadData CMD_SPITestFlash_ReadData .

See also SPITestFlash_ReadData on forum.
File: driver/drv_spi_flash.c
Function: CMD_SPITestFlash_ReadData
SPITestFlash_ReadID CMD_SPITestFlash_ReadID .

See also SPITestFlash_ReadID on forum.
File: driver/drv_spi_flash.c
Function: CMD_SPITestFlash_ReadID
SPITestFlash_Test CMD_SPITestFlash_TestPages TODO.

See also SPITestFlash_Test on forum.
File: driver/drv_spi_flash.c
Function: CMD_SPITestFlash_TestPages
SPITestFlash_WriteStr CMD_SPITestFlash_WriteStr .

See also SPITestFlash_WriteStr on forum.
File: driver/drv_spi_flash.c
Function: CMD_SPITestFlash_WriteStr
SSID1 [ValueString] Sets the SSID of target WiFi. Command keeps Tasmota syntax.

See also SSID1 on forum.
File: cmnds/cmd_tasmota.c
Function: cmnd_SSID1
stackOverflow Causes a stack overflow.

See also stackOverflow on forum.
File: cmnds/cmd_test.c
Function: CMD_StackOverflow
startDriver [DriverName] Starts driver.

See also startDriver on forum.
File: driver/drv_main.c
Function: DRV_Start
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.
File: cmnds/cmd_script.c
Function: CMD_StartScript
StartTest Test_Cmd_Start .

See also StartTest on forum.
File: driver/drv_test.c
Function: Test_Cmd_Start
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.
File: cmnds/cmd_main.c
Function: CMD_StartupCommand
State NULL A stub for Tasmota.

See also State on forum.
File: cmnds/cmd_tasmota.c
Function: cmnd_stub
Status NULL A stub for Tasmota.

See also Status on forum.
File: cmnds/cmd_tasmota.c
Function: cmnd_stub
stopAllScripts Stops all running scripts.

See also stopAllScripts on forum.
File: cmnds/cmd_script.c
Function: CMD_StopAllScripts
stopBerry [Berry code] Stop Berry VM.

Example: stopBerry

See also stopBerry on forum.
File: cmnds/cmd_berry.c
Function: CMD_StopBerryCommand
stopDriver [DriverName] Stops driver.

See also stopDriver on forum.
File: driver/drv_main.c
Function: DRV_Stop
stopScript [UniqueID] Force-stop given script thread by ID.

See also stopScript on forum.
File: cmnds/cmd_script.c
Function: CMD_StopScript
SwingH CMD_SwingH .

See also SwingH on forum.
File: driver/drv_tclAC.c
Function: CMD_SwingH
SwingV CMD_SwingV .

See also SwingV on forum.
File: driver/drv_tclAC.c
Function: CMD_SwingV
TargetTemperature CMD_TargetTemperature .

See also TargetTemperature on forum.
File: driver/drv_tclAC.c
Function: CMD_TargetTemperature
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.
File: mqtt/new_mqtt.c
Function: MQTT_SetTasTeleIntervals
testArgs Test tokenizer for args and print back all the given args to console.

See also testArgs on forum.
File: cmnds/cmd_test.c
Function: testArgs
testAtoi Test atoi function.

See also testAtoi on forum.
File: cmnds/cmd_test.c
Function: testAtoi
TestChannelSetToExpression CMD_TestChannelSetToExpression .

See also TestChannelSetToExpression on forum.
File: cmnds/cmd_test.c
Function: CMD_TestChannelSetToExpression
testFloats Do some more test printfs with floating point numbers.

See also testFloats on forum.
File: cmnds/cmd_test.c
Function: testFloats
TestIPtoStr CMD_TestIPtoStr .

See also TestIPtoStr on forum.
File: cmnds/cmd_test.c
Function: CMD_TestIPtoStr
testJSON Test the JSON library.

See also testJSON on forum.
File: cmnds/cmd_test.c
Function: testJSON
testLog Do some test printfs to log with integer and a float.

See also testLog on forum.
File: cmnds/cmd_test.c
Function: testLog
testMallocFree Test malloc and free functionality to see if the device crashes.

See also testMallocFree on forum.
File: cmnds/cmd_test.c
Function: testMallocFree
TestMemcmp CMD_TestMemcmp .

See also TestMemcmp on forum.
File: cmnds/cmd_test.c
Function: CMD_TestMemcmp
TestMemcpy CMD_TestMemcpy .

See also TestMemcpy on forum.
File: cmnds/cmd_test.c
Function: CMD_TestMemcpy
TestMemset CMD_TestMemset .

See also TestMemset on forum.
File: cmnds/cmd_test.c
Function: CMD_TestMemset
TestParseIP CMD_TestParseIP .

See also TestParseIP on forum.
File: cmnds/cmd_test.c
Function: CMD_TestParseIP
testRealloc Test realloc and free functions to see if the device crashes.

See also testRealloc on forum.
File: cmnds/cmd_test.c
Function: testRealloc
TestSprintfForFloat CMD_TestSprintfForFloat .

See also TestSprintfForFloat on forum.
File: cmnds/cmd_test.c
Function: CMD_TestSprintfForFloat
TestSprintfForHex CMD_TestSprintfForHex .

See also TestSprintfForHex on forum.
File: cmnds/cmd_test.c
Function: CMD_TestSprintfForHex
TestSprintfForInteger CMD_TestSprintfForInteger .

See also TestSprintfForInteger on forum.
File: cmnds/cmd_test.c
Function: CMD_TestSprintfForInteger
TestStrcat CMD_TestStrcat .

See also TestStrcat on forum.
File: cmnds/cmd_test.c
Function: CMD_TestStrcat
TestStrcmp CMD_TestStrcmp .

See also TestStrcmp on forum.
File: cmnds/cmd_test.c
Function: CMD_TestStrcmp
TestStrcpy CMD_TestStrcpy .

See also TestStrcpy on forum.
File: cmnds/cmd_test.c
Function: CMD_TestStrcpy
testStrdup Test strdup function to see if it allocs news string correctly, also test freeing the string.

See also testStrdup on forum.
File: cmnds/cmd_test.c
Function: testStrdup
TestStrlen CMD_TestStrlen .

See also TestStrlen on forum.
File: cmnds/cmd_test.c
Function: CMD_TestStrlen
TestStrncpy CMD_TestStrncpy .

See also TestStrncpy on forum.
File: cmnds/cmd_test.c
Function: CMD_TestStrncpy
testus pin <testval 1 in us> [...] Tests usleep on given pin .

Example: testus 11 5 2 4 6 10 20 50 100 200 500

See also testus on forum.
File: driver/drv_ds1820_common.c
Function: CMD_OW_testus
TimeSize Prints the size of time_t on current platform - sizeof(time_t), only for testing purposes.

See also TimeSize on forum.
File: cmnds/cmd_test.c
Function: CMD_TimeSize
time_setDST Rule# [1/2] nthWeek month day hour DSToffset [additional minutes after this Point: for 'start' of DST, 0 for 'end' of DST] Sets daylight saving time (DST).

Example: TIME_setDST 0 3 1 2 1 0 10 1 3 0
-- 1st rule: last_week March sunday 2_o_clock 1_hour_DST_after_this_time
-- 2nd_rule: last_week October sunday 3_o_clock 0_hours_DST_after_this_time

See also time_setDST on forum.
File: driver/drv_deviceclock.c
Function: CMD_TIME_SetDST
time_setLatLong [Latlong] Sets the devices latitude and longitude.

Example: TIME_SetLatlong -34.911498 138.809488

See also time_setLatLong on forum.
File: driver/drv_deviceclock.c
Function: TIME_SetLatlong
time_setTime [Value] Sets the time of device in seconds after 19700101.

See also time_setTime on forum.
File: driver/drv_deviceclock.c
Function: SetDeviceTime
time_setTZ [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 time_setTZ on forum.
File: driver/drv_deviceclock.c
Function: SetTimeZoneOfs
TM1650_Test CMD_TM1650_Test .

See also TM1650_Test on forum.
File: driver/drv_tm_gn_display_shared.c
Function: CMD_TM1650_Test
TMGN_Brightness [Brigthness0to7][bOn] This allows you to change brightness and state of TM1637/GN932/etc display.

See also TMGN_Brightness on forum.
File: driver/drv_tm_gn_display_shared.c
Function: CMD_TMGN_Brightness
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.
File: driver/drv_tm_gn_display_shared.c
Function: CMD_TMGN_Char
TMGN_Clear This clears the TM1637/GN932/etc display.

See also TMGN_Clear on forum.
File: driver/drv_tm_gn_display_shared.c
Function: CMD_TMGN_Clear
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.
File: driver/drv_tm_gn_display_shared.c
Function: CMD_TMGN_Map
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.
File: driver/drv_tm_gn_display_shared.c
Function: CMD_TMGN_Print
TMGN_Read Executes a single buttons read on TM/GN LED driver.

See also TMGN_Read on forum.
File: driver/drv_tm_gn_display_shared.c
Function: CMD_TMGN_Read
TMGN_SetBit [CharIndex] [BitIndex] [BitValue] Set given bit of given digit to 1 or 0.

See also TMGN_SetBit on forum.
File: driver/drv_tm_gn_display_shared.c
Function: CMD_TMGN_SetBit
TMGN_SetupButtons [Interval] Setups periodic buttons read on TM/GN LED driver.

See also TMGN_SetupButtons on forum.
File: driver/drv_tm_gn_display_shared.c
Function: CMD_TMGN_SetupButtons
TMGN_Test .

See also TMGN_Test on forum.
File: driver/drv_tm_gn_display_shared.c
Function: CMD_TMGN_Test
ToggleChannel [ChannelIndex] Toggles given channel value. Non-zero becomes zero, zero becomes 1.

See also ToggleChannel on forum.
File: cmnds/cmd_channels.c
Function: CMD_ToggleChannel
toggler_channel [ChannelIndex] Handles toggler_channel0, toggler_channel1. Sets channel linked to given toggler slot.

See also toggler_channel on forum.
File: driver/drv_pwmToggler.c
Function: Toggler_ChannelX
toggler_enable [1or0] Sets the given output ON or OFF. handles toggler_enable0, toggler_enable1, etc.

See also toggler_enable on forum.
File: driver/drv_pwmToggler.c
Function: Toggler_EnableX
toggler_name Handles toggler_name0, toggler_name1, etc. Sets the name of a toggler for GUI.

See also toggler_name on forum.
File: driver/drv_pwmToggler.c
Function: Toggler_NameX
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.
File: driver/drv_pwmToggler.c
Function: Toggler_SetX
TS_Clear Clears the text scroller buffer.

See also TS_Clear on forum.
File: driver/drv_textScroller.c
Function: CMD_TS_Clear
TS_Print [StartOfs] [MaxLenOr0] [StringText] [optionalBClampWithZeroesForClock] Prints a text to the text scroller buffer.

See also TS_Print on forum.
File: driver/drv_textScroller.c
Function: CMD_TS_Print
tuyaMcu_batteryPoweredMode [Optional 1 or 0, by default 1 is assumed] Enables battery mode communications for version 3 TuyaMCU. tuyaMcu_batteryPoweredMode 0 can be used to disable the mode.

Example: tuyaMcu_batteryPoweredMode

See also tuyaMcu_batteryPoweredMode on forum.
File: driver/drv_tuyaMCU.c
Function: Cmd_TuyaMCU_BatteryPoweredMode
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.
File: driver/drv_tuyaMCU.c
Function: Cmd_TuyaMCU_Set_DefaultWiFiState
tuyaMcu_enableAutoSend [0/1] Enable or disable automatic sending of commands to TuyaMCU during boot/initialization. Use 0 to disable, 1 to enable.

Example: tuyaMcu_enableAutoSend 0

See also tuyaMcu_enableAutoSend on forum.
File: driver/drv_tuyaMCU.c
Function: Cmd_TuyaMCU_EnableAutoSend
tuyaMcu_sendCmd [CommandIndex] [HexPayloadNBytes] This will automatically calculate TuyaMCU checksum and length for given command ID and payload, then it will send a command. It's better to use it than uartSendHex.

See also tuyaMcu_sendCmd on forum.
File: driver/drv_tuyaMCU.c
Function: TuyaMCU_SendUserCmd
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.
File: driver/drv_tuyaMCU.c
Function: Cmd_TuyaMCU_SendColor
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.
File: driver/drv_tuyaMCU.c
Function: TuyaMCU_Send_SetTime_Current
tuyaMcu_sendHeartbeat Send heartbeat to TuyaMCU.

See also tuyaMcu_sendHeartbeat on forum.
File: driver/drv_tuyaMCU.c
Function: TuyaMCU_SendHeartbeat
tuyaMcu_sendMCUConf Send MCU conf command.

See also tuyaMcu_sendMCUConf on forum.
File: driver/drv_tuyaMCU.c
Function: TuyaMCU_SendMCUConf
tuyaMcu_sendProductInformation Send query packet (0x01). No arguments needed.

See also tuyaMcu_sendProductInformation on forum.
File: driver/drv_tuyaMCU.c
Function: TuyaMCU_SendQueryProductInformation
tuyaMcu_sendQueryState Send query state command. No arguments needed.

See also tuyaMcu_sendQueryState on forum.
File: driver/drv_tuyaMCU.c
Function: TuyaMCU_SendQueryState
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.
File: driver/drv_tuyaMCU.c
Function: Cmd_TuyaMCU_Send_RSSI
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.
File: driver/drv_tuyaMCU.c
Function: TuyaMCU_SendStateCmd
tuyaMcu_setBatteryAckDelay [ackDelay] Defines the delay before the ACK is sent to TuyaMCU sending the device to sleep. Default value is 0 seconds.

See also tuyaMcu_setBatteryAckDelay on forum.
File: driver/drv_tuyaMCU.c
Function: Cmd_TuyaMCU_SetBatteryAckDelay
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.
File: driver/drv_tuyaMCU.c
Function: TuyaMCU_SetBaudRate
tuyaMcu_setDimmerRange [Min][Max] Set dimmer range used by TuyaMCU.

See also tuyaMcu_setDimmerRange on forum.
File: driver/drv_tuyaMCU.c
Function: TuyaMCU_SetDimmerRange
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.
File: driver/drv_tuyaMCU.c
Function: Cmd_TuyaMCU_SetupLED
tuyaMcu_testSendTime Sends a example date by TuyaMCU to clock/callendar MCU.

See also tuyaMcu_testSendTime on forum.
File: driver/drv_tuyaMCU.c
Function: TuyaMCU_Send_SetTime_Example
uartFakeHex [HexString] Spoofs a fake hex packet so it looks like TuyaMCU send that to us. Used for testing.

See also uartFakeHex on forum.
File: driver/drv_uart.c
Function: CMD_UART_FakeHex
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.
File: driver/drv_uart.c
Function: CMD_UART_Init
uartSendASCII [AsciiString] Sends given string by UART.

See also uartSendASCII on forum.
File: driver/drv_uart.c
Function: CMD_UART_Send_ASCII
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.
File: driver/drv_uart.c
Function: CMD_UART_Send_Hex
UCS1912_Test .

See also UCS1912_Test on forum.
File: driver/drv_ucs1912.c
Function: UCS1912_Test
VCPPrecision [VoltageDigits][CurrentDigitsAmpers][PowerDigitsWats][EnergyDigitsWh][Frequency] Sets the number of digits after decimal point for power metering publishes for BL09XX. Default is VCPPrecision 1 3 2 3 3. This works for OBK-style publishes. Only the first argument is required, others are optional.

See also VCPPrecision on forum.
File: driver/drv_bl_shared.c
Function: BL09XX_VCPPrecision
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. Frequency is published with Voltage.

See also VCPPublishIntervals on forum.
File: driver/drv_bl_shared.c
Function: BL09XX_VCPPublishIntervals
VCPPublishThreshold [VoltageDeltaVolts][CurrentDeltaAmpers][PowerDeltaWats][EnergyDeltaWh][Frequency] 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.25 0.002 0.5 0.25 0.25 0.01 (the default), it will only report voltage again if the delta from previous reported value is larger than 0.25V. Remember, that the device will also ALWAYS force-report values every N seconds (default 60). The last there arugments are optional.

Example: VCPPublishThreshold 0.5 0.02 1

See also VCPPublishThreshold on forum.
File: driver/drv_bl_shared.c
Function: BL09XX_VCPPublishThreshold
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.
File: driver/drv_pwrCal.c
Function: CalibrateVoltage
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.
File: cmnds/cmd_script.c
Function: CMD_waitFor
WebServer [0 - Stop / 1 - Start] Setting state of WebServer.

See also WebServer on forum.
File: cmnds/cmd_main.c
Function: CMD_WebServer
widget_clearAll Removes all registered widgets.

See also widget_clearAll on forum.
File: driver/drv_widget.c
Function: CMD_Widget_ClearAll
widget_create [LocationIndex][bAllowCache][FileName] .

See also widget_create on forum.
File: driver/drv_widget.c
Function: CMD_Widget_Create