mirror of
https://github.com/openshwprojects/OpenBK7231T_App.git
synced 2026-02-04 17:55:34 +00:00
docs
This commit is contained in:
@ -11,7 +11,7 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| 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.<br/><br/>See also [AddChannel on forum](https://www.elektroda.com/rtvforum/find.php?q=AddChannel). | File: cmnds/cmd_channels.c<br/>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. 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).<br/><br/>See also [addClockEvent on forum](https://www.elektroda.com/rtvforum/find.php?q=addClockEvent). | File: driver/drv_ntp_events.c<br/>Function: CMD_NTP_AddClockEvent |
|
||||
| AddEventHandler | [EventName][EventArgument][CommandToRun] | This can be used to trigger an action on a button click, long press, etc.<br/><br/>See also [AddEventHandler on forum](https://www.elektroda.com/rtvforum/find.php?q=AddEventHandler). | File: cmnds/cmd_eventHandlers.c<br/>Function: CMD_AddEventHandler |
|
||||
| addI2CDevice_ADS1115 | DRV_I2C_AddDevice_ADS1115 | .<br/><br/>See also [addI2CDevice_ADS1115 on forum](https://www.elektroda.com/rtvforum/find.php?q=addI2CDevice_ADS1115). | File: i2c/drv_i2c_ads1115.c<br/>Function: NULL); |
|
||||
| addI2CDevice_ADS1115 | | .<br/><br/>See also [addI2CDevice_ADS1115 on forum](https://www.elektroda.com/rtvforum/find.php?q=addI2CDevice_ADS1115). | File: i2c/drv_i2c_ads1115.c<br/>Function: NULL); |
|
||||
| addI2CDevice_LCD_PCF8574 | | Adds a new I2C device - PCF8574.<br/><br/>See also [addI2CDevice_LCD_PCF8574 on forum](https://www.elektroda.com/rtvforum/find.php?q=addI2CDevice_LCD_PCF8574). | File: i2c/drv_i2c_main.c<br/>Function: DRV_I2C_AddDevice_PCF8574 |
|
||||
| addI2CDevice_LCM1602 | | Adds a new I2C device - LCM1602.<br/><br/>See also [addI2CDevice_LCM1602 on forum](https://www.elektroda.com/rtvforum/find.php?q=addI2CDevice_LCM1602). | File: i2c/drv_i2c_main.c<br/>Function: DRV_I2C_AddDevice_LCM1602 |
|
||||
| addI2CDevice_MCP23017 | | Adds a new I2C device - MCP23017.<br/><br/>See also [addI2CDevice_MCP23017 on forum](https://www.elektroda.com/rtvforum/find.php?q=addI2CDevice_MCP23017). | File: i2c/drv_i2c_main.c<br/>Function: DRV_I2C_AddDevice_MCP23017 |
|
||||
@ -26,8 +26,8 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| AHT2X_Reinit | | Reinitialize sensor.<br/><br/>Example: AHT2X_Reinit<br/><br/>See also [AHT2X_Reinit on forum](https://www.elektroda.com/rtvforum/find.php?q=AHT2X_Reinit). | File: drv/drv_aht2X.c<br/>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.<br/><br/>See also [alias on forum](https://www.elektroda.com/rtvforum/find.php?q=alias). | File: cmnds/cmd_test.c<br/>Function: alias |
|
||||
| aliasMem | | Internal usage only. See docs for 'alias' command.<br/><br/>See also [aliasMem on forum](https://www.elektroda.com/rtvforum/find.php?q=aliasMem). | File: cmnds/cmd_test.c<br/>Function: runcmd |
|
||||
| Anim | PA_Cmd_Anim | .<br/><br/>See also [Anim on forum](https://www.elektroda.com/rtvforum/find.php?q=Anim). | File: driver/drv_pixelAnim.c<br/>Function: NULL); |
|
||||
| AnimSpeed | PA_Cmd_AnimSpeed | .<br/><br/>See also [AnimSpeed on forum](https://www.elektroda.com/rtvforum/find.php?q=AnimSpeed). | File: driver/drv_pixelAnim.c<br/>Function: NULL); |
|
||||
| Anim | [AnimationIndex] | Starts given WS2812 animation by index.<br/><br/>See also [Anim on forum](https://www.elektroda.com/rtvforum/find.php?q=Anim). | File: driver/drv_pixelAnim.c<br/>Function: NULL); |
|
||||
| AnimSpeed | [Interval] | Sets WS2812 animation speed.<br/><br/>See also [AnimSpeed on forum](https://www.elektroda.com/rtvforum/find.php?q=AnimSpeed). | File: driver/drv_pixelAnim.c<br/>Function: NULL); |
|
||||
| backlog | [string of commands separated with ;] | Run a sequence of ; separated commands.<br/><br/>See also [backlog on forum](https://www.elektroda.com/rtvforum/find.php?q=backlog). | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_backlog |
|
||||
| Battery_cycle | [int] | Change cycle of measurement by default every 10 seconds.<br/><br/>Example: Battery_cycle 60<br/><br/>See also [Battery_cycle on forum](https://www.elektroda.com/rtvforum/find.php?q=Battery_cycle). | File: drv/drv_battery.c<br/>Function: Battery_cycle |
|
||||
| Battery_Setup | [minbatt][maxbatt][V_divider][Vref][AD Bits] | Measure battery based on ADC. <br />req. args: minbatt in mv, maxbatt in mv. <br />optional: V_divider(2), Vref(default 2400), ADC bits(4096).<br/><br/>Example: Battery_Setup 1500 3000 2 2400 4096<br/><br/>See also [Battery_Setup on forum](https://www.elektroda.com/rtvforum/find.php?q=Battery_Setup). | File: drv/drv_battery.c<br/>Function: Battery_Setup |
|
||||
@ -100,10 +100,10 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| HT16K33_Raw | HT16K33_Raw | .<br/><br/>See also [HT16K33_Raw on forum](https://www.elektroda.com/rtvforum/find.php?q=HT16K33_Raw). | File: driver/drv_ht16k33.c<br/>Function: NULL); |
|
||||
| HT16K33_Test | HT16K33_Test | .<br/><br/>See also [HT16K33_Test on forum](https://www.elektroda.com/rtvforum/find.php?q=HT16K33_Test). | File: driver/drv_ht16k33.c<br/>Function: NULL); |
|
||||
| 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.<br/><br/>See also [if on forum](https://www.elektroda.com/rtvforum/find.php?q=if). | File: cmnds/cmd_main.c<br/>Function: CMD_If |
|
||||
| IndexRefreshInterval | CMD_IndexRefreshInterval | .<br/><br/>See also [IndexRefreshInterval on forum](https://www.elektroda.com/rtvforum/find.php?q=IndexRefreshInterval). | File: cmnds/cmd_main.c<br/>Function: NULL); |
|
||||
| IndexRefreshInterval | [Interval] | .<br/><br/>See also [IndexRefreshInterval on forum](https://www.elektroda.com/rtvforum/find.php?q=IndexRefreshInterval). | File: cmnds/cmd_main.c<br/>Function: NULL); |
|
||||
| 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.<br/><br/>See also [IREnable on forum](https://www.elektroda.com/rtvforum/find.php?q=IREnable). | File: driver/drv_ir.cpp<br/>Function: IR_Enable |
|
||||
| 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.<br/><br/>See also [IRSend on forum](https://www.elektroda.com/rtvforum/find.php?q=IRSend). | File: driver/drv_ir.cpp<br/>Function: IR_Send_Cmd |
|
||||
| json_test | cmnd_json_test | .<br/><br/>See also [json_test on forum](https://www.elektroda.com/rtvforum/find.php?q=json_test). | File: cmnds/cmd_test.c<br/>Function: NULL); |
|
||||
| json_test | | Developer-only command used to test CJSON library.<br/><br/>See also [json_test on forum](https://www.elektroda.com/rtvforum/find.php?q=json_test). | File: cmnds/cmd_test.c<br/>Function: NULL); |
|
||||
| KP18058_Current | [RGBLimit][CWLimit] | Sets the maximum current for LED driver. Values 0-31. Example usage: KP18058_Current 14 30.<br/><br/>See also [KP18058_Current on forum](https://www.elektroda.com/rtvforum/find.php?q=KP18058_Current). | File: driver/drv_kp18058.c<br/>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.<br/><br/>See also [KP18058_Map on forum](https://www.elektroda.com/rtvforum/find.php?q=KP18058_Map). | File: driver/drv_kp18058.c<br/>Function: KP18058_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.<br/><br/>See also [KP18058_RGBCW on forum](https://www.elektroda.com/rtvforum/find.php?q=KP18058_RGBCW). | File: driver/drv_kp18058.c<br/>Function: KP18058_RGBCW |
|
||||
@ -114,7 +114,7 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| lcd_printFloat | | Prints a float on the LCD.<br/><br/>See also [lcd_printFloat on forum](https://www.elektroda.com/rtvforum/find.php?q=lcd_printFloat). | File: i2c/drv_i2c_lcd_pcf8574t.c<br/>Function: DRV_I2C_LCD_PCF8574_PrintFloat |
|
||||
| lcd_printInt | | Prints an omt on the LCD.<br/><br/>See also [lcd_printInt on forum](https://www.elektroda.com/rtvforum/find.php?q=lcd_printInt). | File: i2c/drv_i2c_lcd_pcf8574t.c<br/>Function: DRV_I2C_LCD_PCF8574_PrintInt |
|
||||
| led_basecolor_rgb | [HexValue] | Puts the LED driver in RGB mode and sets given color.<br/><br/>See also [led_basecolor_rgb on forum](https://www.elektroda.com/rtvforum/find.php?q=led_basecolor_rgb). | File: cmnds/cmd_newLEDDriver.c<br/>Function: basecolor_rgb |
|
||||
| led_basecolor_rgbcw | | Set PWN color using #RRGGBB[cw][ww].<br/><br/>See also [led_basecolor_rgbcw on forum](https://www.elektroda.com/rtvforum/find.php?q=led_basecolor_rgbcw). | File: cmnds/cmd_newLEDDriver.c<br/>Function: basecolor_rgbcw |
|
||||
| led_basecolor_rgbcw | [HexValue] | Set PWN color using #RRGGBB[cw][ww].<br/><br/>See also [led_basecolor_rgbcw on forum](https://www.elektroda.com/rtvforum/find.php?q=led_basecolor_rgbcw). | File: cmnds/cmd_newLEDDriver.c<br/>Function: basecolor_rgbcw |
|
||||
| led_colorMult | [Value] | Internal usage.<br/><br/>See also [led_colorMult on forum](https://www.elektroda.com/rtvforum/find.php?q=led_colorMult). | File: cmnds/cmd_newLEDDriver.c<br/>Function: colorMult |
|
||||
| led_dimmer | [Value] | Set output dimmer 0..100.<br/><br/>See also [led_dimmer on forum](https://www.elektroda.com/rtvforum/find.php?q=led_dimmer). | File: cmnds/cmd_newLEDDriver.c<br/>Function: dimmer |
|
||||
| led_enableAll | [1or0orToggle] | Power on/off LED but remember the RGB(CW) values.<br/><br/>See also [led_enableAll on forum](https://www.elektroda.com/rtvforum/find.php?q=led_enableAll). | File: cmnds/cmd_newLEDDriver.c<br/>Function: enableAll |
|
||||
@ -122,7 +122,7 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| led_gammaCtrl | sub-cmd [par] | Control LED Gamma Correction and Calibration.<br/><br/>Example: led_gammaCtrl on<br/><br/>See also [led_gammaCtrl on forum](https://www.elektroda.com/rtvforum/find.php?q=led_gammaCtrl). | File: cmnds/cmd_rgbGamma.c<br/>Function: rgb_gamma_control |
|
||||
| led_hue | [Value] | This is an alternate way to set the LED color.<br/><br/>See also [led_hue on forum](https://www.elektroda.com/rtvforum/find.php?q=led_hue). | File: cmnds/cmd_newLEDDriver.c<br/>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.<br/><br/>See also [led_lerpSpeed on forum](https://www.elektroda.com/rtvforum/find.php?q=led_lerpSpeed). | File: cmnds/cmd_newLEDDriver.c<br/>Function: lerpSpeed |
|
||||
| LED_Map | CMD_LEDDriver_Map | .<br/><br/>See also [LED_Map on forum](https://www.elektroda.com/rtvforum/find.php?q=LED_Map). | File: driver/drv_sm15155e.c<br/>Function: NULL); |
|
||||
| LED_Map | [Ch0][Ch1][Ch2][Ch3][Ch4] | .<br/><br/>See also [LED_Map on forum](https://www.elektroda.com/rtvforum/find.php?q=LED_Map). | File: driver/drv_sm15155e.c<br/>Function: NULL); |
|
||||
| led_nextColor | | Sets the next color from predefined colours list. Our list is the same as in Tasmota.<br/><br/>See also [led_nextColor on forum](https://www.elektroda.com/rtvforum/find.php?q=led_nextColor). | File: cmnds/cmd_newLEDDriver.c<br/>Function: nextColor |
|
||||
| led_saturation | [Value] | This is an alternate way to set the LED color.<br/><br/>See also [led_saturation on forum](https://www.elektroda.com/rtvforum/find.php?q=led_saturation). | File: cmnds/cmd_newLEDDriver.c<br/>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.<br/><br/>See also [led_saveInterval on forum](https://www.elektroda.com/rtvforum/find.php?q=led_saveInterval). | File: cmnds/cmd_newLEDDriver.c<br/>Function: cmdSaveStateIfModifiedInterval |
|
||||
@ -157,11 +157,11 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| MAX72XX_Scroll | DRV_MAX72XX_Scroll | .<br/><br/>See also [MAX72XX_Scroll on forum](https://www.elektroda.com/rtvforum/find.php?q=MAX72XX_Scroll). | File: driver/drv_max72xx_single.c<br/>Function: NULL); |
|
||||
| MAX72XX_Setup | [Value] | Sets the maximum current for LED driver.<br/><br/>See also [MAX72XX_Setup on forum](https://www.elektroda.com/rtvforum/find.php?q=MAX72XX_Setup). | File: driver/drv_sm2135.c<br/>Function: SM2135_Current |
|
||||
| MCP23017_MapPinToChannel | | Maps port expander bit to OBK channel.<br/><br/>See also [MCP23017_MapPinToChannel on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP23017_MapPinToChannel). | File: i2c/drv_i2c_main.c<br/>Function: DRV_I2C_MCP23017_MapPinToChannel |
|
||||
| MCP9808_Adr | MCP9808_Adr | .<br/><br/>See also [MCP9808_Adr on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP9808_Adr). | File: driver/drv_mcp9808.c<br/>Function: NULL); |
|
||||
| MCP9808_AlertMin | MCP9808_AlertMin | .<br/><br/>See also [MCP9808_AlertMin on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP9808_AlertMin). | File: driver/drv_mcp9808.c<br/>Function: NULL); |
|
||||
| MCP9808_AlertRange | MCP9808_AlertRange | .<br/><br/>See also [MCP9808_AlertRange on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP9808_AlertRange). | File: driver/drv_mcp9808.c<br/>Function: NULL); |
|
||||
| MCP9808_Adr | [HexAdr] | Sets the I2C address of MCP9808, like 0x30.<br/><br/>See also [MCP9808_Adr on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP9808_Adr). | File: driver/drv_mcp9808.c<br/>Function: NULL); |
|
||||
| MCP9808_AlertMin | [MinT] [OptionalBActiveHigh] | Setup MCP9809 temperature alert for min mode.<br/><br/>See also [MCP9808_AlertMin on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP9808_AlertMin). | File: driver/drv_mcp9808.c<br/>Function: ); |
|
||||
| MCP9808_AlertRange | [MinT] [MaxT] [OptionalBActiveHigh] | Setup MCP9809 temperature alert for range mode.<br/><br/>See also [MCP9808_AlertRange on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP9808_AlertRange). | File: driver/drv_mcp9808.c<br/>Function: NULL); |
|
||||
| MCP9808_Calibrate | [DeltaTemperature] | .<br/><br/>See also [MCP9808_Calibrate on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP9808_Calibrate). | File: driver/drv_mcp9808.c<br/>Function: NULL); |
|
||||
| MCP9808_Cycle | [DelayInSeconds] | .<br/><br/>See also [MCP9808_Cycle on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP9808_Cycle). | File: driver/drv_mcp9808.c<br/>Function: NULL); |
|
||||
| MCP9808_Cycle | [DelayInSeconds] | Sets MCP9808 measurement interval.<br/><br/>See also [MCP9808_Cycle on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP9808_Cycle). | File: driver/drv_mcp9808.c<br/>Function: NULL); |
|
||||
| MqttClient | [ValueString] | Sets the MQTT client. Command keeps Tasmota syntax.<br/><br/>See also [MqttClient on forum](https://www.elektroda.com/rtvforum/find.php?q=MqttClient). | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_MqttClient |
|
||||
| MqttHost | [ValueString] | Sets the MQTT host. Command keeps Tasmota syntax.<br/><br/>See also [MqttHost on forum](https://www.elektroda.com/rtvforum/find.php?q=MqttHost). | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_MqttHost |
|
||||
| MqttPassword | [ValueString] | Sets the MQTT pass. Command keeps Tasmota syntax.<br/><br/>See also [MqttPassword on forum](https://www.elektroda.com/rtvforum/find.php?q=MqttPassword). | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_MqttPassword |
|
||||
@ -175,16 +175,16 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| obkDeviceList | | Generate the SSDP list of OpenBeken devices found on the network.<br/><br/>See also [obkDeviceList on forum](https://www.elektroda.com/rtvforum/find.php?q=obkDeviceList). | File: driver/drv_ssdp.c<br/>Function: Cmd_obkDeviceList |
|
||||
| OpenAP | | Temporarily disconnects from programmed WiFi network and opens Access Point.<br/><br/>See also [OpenAP on forum](https://www.elektroda.com/rtvforum/find.php?q=OpenAP). | File: cmnds/cmd_main.c<br/>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).<br/><br/>See also [ota_http on forum](https://www.elektroda.com/rtvforum/find.php?q=ota_http). | File: cmnds/cmd_main.c<br/>Function: CMD_HTTPOTA |
|
||||
| owm_channels | CMD_OWM_Channels | .<br/><br/>See also [owm_channels on forum](https://www.elektroda.com/rtvforum/find.php?q=owm_channels). | File: driver/drv_openWeatherMap.c<br/>Function: NULL); |
|
||||
| owm_request | CMD_OWM_Request | .<br/><br/>See also [owm_request on forum](https://www.elektroda.com/rtvforum/find.php?q=owm_request). | File: driver/drv_openWeatherMap.c<br/>Function: NULL); |
|
||||
| owm_setup | CMD_OWM_Setup | .<br/><br/>See also [owm_setup on forum](https://www.elektroda.com/rtvforum/find.php?q=owm_setup). | File: driver/drv_openWeatherMap.c<br/>Function: NULL); |
|
||||
| owm_channels | [temperature][humidity][pressure] | Sets channels that will be used to store OWM response results.<br/><br/>See also [owm_channels on forum](https://www.elektroda.com/rtvforum/find.php?q=owm_channels). | File: driver/drv_openWeatherMap.c<br/>Function: NULL); |
|
||||
| owm_request | | Sends OWM request to the API. Do not use it too often, as API may have limits.<br/><br/>See also [owm_request on forum](https://www.elektroda.com/rtvforum/find.php?q=owm_request). | File: driver/drv_openWeatherMap.c<br/>Function: NULL); |
|
||||
| owm_setup | [lat][lng][api_key] | Setups OWM driver for your location and API key.<br/><br/>See also [owm_setup on forum](https://www.elektroda.com/rtvforum/find.php?q=owm_setup). | File: driver/drv_openWeatherMap.c<br/>Function: NULL); |
|
||||
| Password1 | [ValueString] | Sets the Pass of target WiFi. Command keeps Tasmota syntax.<br/><br/>See also [Password1 on forum](https://www.elektroda.com/rtvforum/find.php?q=Password1). | File: cmnds/cmd_tasmota.c<br/>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](https://www.elektroda.com/rtvforum/topic4041971.html).<br/><br/>See also [PinDeepSleep on forum](https://www.elektroda.com/rtvforum/find.php?q=PinDeepSleep). | File: cmnds/cmd_channels.c<br/>Function: CMD_PinDeepSleep |
|
||||
| PingHost | [IPStr] | Sets the host to ping by IP watchdog.<br/><br/>See also [PingHost on forum](https://www.elektroda.com/rtvforum/find.php?q=PingHost). | File: cmnds/cmd_main.c<br/>Function: CMD_PingHost |
|
||||
| PingInterval | [IntegerSeconds] | Sets the interval between ping attempts for ping watchdog mechanism.<br/><br/>See also [PingInterval on forum](https://www.elektroda.com/rtvforum/find.php?q=PingInterval). | File: cmnds/cmd_main.c<br/>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.<br/><br/>See also [power on forum](https://www.elektroda.com/rtvforum/find.php?q=power). | File: cmnds/cmd_tasmota.c<br/>Function: power |
|
||||
| powerAll | | Set all outputs.<br/><br/>See also [powerAll on forum](https://www.elektroda.com/rtvforum/find.php?q=powerAll). | File: cmnds/cmd_tasmota.c<br/>Function: powerAll |
|
||||
| PowerMax | BL0937_PowerMax | .<br/><br/>See also [PowerMax on forum](https://www.elektroda.com/rtvforum/find.php?q=PowerMax). | File: driver/drv_bl0937.c<br/>Function: NULL); |
|
||||
| PowerMax | [MaxPowerInW] | Sets the maximum power limit for BL measurement used to filter incorrect values.<br/><br/>See also [PowerMax on forum](https://www.elektroda.com/rtvforum/find.php?q=PowerMax). | File: driver/drv_bl0937.c<br/>Function: NULL); |
|
||||
| PowerSave | [Optional 1 or 0, by default 1 is assumed] | Enables dynamic power saving mode on Beken N/T, BL602, W600, W800 and LN882H. In the case of LN882H PowerSave will not work as a startup command, so use in autoexec. 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.<br/><br/>See also [PowerSave on forum](https://www.elektroda.com/rtvforum/find.php?q=PowerSave). | File: cmnds/cmd_main.c<br/>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.<br/><br/>See also [PowerSet on forum](https://www.elektroda.com/rtvforum/find.php?q=PowerSet). | File: driver/drv_pwrCal.c<br/>Function: NULL); |
|
||||
| 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.<br/><br/>See also [publish on forum](https://www.elektroda.com/rtvforum/find.php?q=publish). | File: mqtt/new_mqtt.c<br/>Function: MQTT_PublishCommand |
|
||||
@ -232,7 +232,7 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| 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).<br/><br/>See also [setStartupSSIDChannel on forum](https://www.elektroda.com/rtvforum/find.php?q=setStartupSSIDChannel). | File: new_pins.c<br/>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'.<br/><br/>See also [SetStartValue on forum](https://www.elektroda.com/rtvforum/find.php?q=SetStartValue). | File: cmnds/cmd_main.c<br/>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.<br/><br/>See also [SetupEnergyStats on forum](https://www.elektroda.com/rtvforum/find.php?q=SetupEnergyStats). | File: driver/drv_bl_shared.c<br/>Function: BL09XX_SetupEnergyStatistic |
|
||||
| SetupIR2 | CMD_IR2_SetupIR2 | .<br/><br/>See also [SetupIR2 on forum](https://www.elektroda.com/rtvforum/find.php?q=SetupIR2). | File: driver/drv_ir2.c<br/>Function: NULL); |
|
||||
| SetupIR2 | [myPeriodUs] [dutyOnFrac] [dutyOffFrac] [txPin] | Init IR2 pin and interrupt.<br/><br/>See also [SetupIR2 on forum](https://www.elektroda.com/rtvforum/find.php?q=SetupIR2). | File: driver/drv_ir2.c<br/>Function: NULL); |
|
||||
| SetupTestPower | [fakeVoltage] [FakeCurrent] [FakePower] [bAllowRandom] | Starts the fake power metering driver.<br/><br/>See also [SetupTestPower on forum](https://www.elektroda.com/rtvforum/find.php?q=SetupTestPower). | File: driver/drv_test_drivers.c<br/>Function: TestPower_Setup |
|
||||
| SGP_cycle | [int] | Change cycle of measurement by default every 10 seconds 0 to deactivate.<br/><br/>Example: SGP_Cycle 60<br/><br/>See also [SGP_cycle on forum](https://www.elektroda.com/rtvforum/find.php?q=SGP_cycle). | File: drv/drv_sgp.c<br/>Function: SGP_cycle |
|
||||
| SGP_GetBaseline | | SGP Get baseline.<br/><br/>Example: SGP_GetBaseline<br/><br/>See also [SGP_GetBaseline on forum](https://www.elektroda.com/rtvforum/find.php?q=SGP_GetBaseline). | File: drv/drv_sgp.c<br/>Function: SGP_GetBaseline |
|
||||
@ -253,7 +253,7 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| SHT_SetAlert | [temp_high, temp_low, hum_high, hum_low]<br/>Req:all | Set Sensor alert configuration.<br/><br/>Example: SHT_SetAlertCmd<br/><br/>See also [SHT_SetAlert on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_SetAlert). | File: driver/drv_sht3x.c<br/>Function: SHT3X_SetAlertcmd |
|
||||
| SHT_StopPer | | Stop periodical capture for SHT Sensor.<br/><br/>See also [SHT_StopPer on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_StopPer). | File: driver/drv_sht3x.c<br/>Function: SHT3X_StopPerCmd |
|
||||
| simonirtest | | Simons Special Test.<br/><br/>See also [simonirtest on forum](https://www.elektroda.com/rtvforum/find.php?q=simonirtest). | File: cmnds/cmd_main.c<br/>Function: CMD_SimonTest |
|
||||
| SimSaveArgs | CMD_SelfTest_SaveArgs | .<br/><br/>See also [SimSaveArgs on forum](https://www.elektroda.com/rtvforum/find.php?q=SimSaveArgs). | File: selftest/selftest_cfg_via_http.c<br/>Function: 0); |
|
||||
| SimSaveArgs | | Internal usage only. Command for OBK self-test in Simulator.<br/><br/>See also [SimSaveArgs on forum](https://www.elektroda.com/rtvforum/find.php?q=SimSaveArgs). | File: selftest/selftest_cfg_via_http.c<br/>Function: 0); |
|
||||
| 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](https://www.elektroda.com/rtvforum/topic4036716.html).<br/><br/>See also [SM16703P_Init on forum](https://www.elektroda.com/rtvforum/find.php?q=SM16703P_Init). | File: driver/drv_sm16703P.c<br/>Function: NULL); |
|
||||
| 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](https://www.elektroda.com/rtvforum/topic4036716.html).<br/><br/>See also [SM16703P_SetPixel on forum](https://www.elektroda.com/rtvforum/find.php?q=SM16703P_SetPixel). | File: driver/drv_sm16703P.c<br/>Function: NULL); |
|
||||
| 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](https://www.elektroda.com/rtvforum/topic4036716.html).<br/><br/>See also [SM16703P_SetRaw on forum](https://www.elektroda.com/rtvforum/find.php?q=SM16703P_SetRaw). | File: driver/drv_sm16703P.c<br/>Function: NULL); |
|
||||
@ -329,6 +329,6 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| 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).<br/><br/>See also [VCPPublishThreshold on forum](https://www.elektroda.com/rtvforum/find.php?q=VCPPublishThreshold). | File: driver/drv_bl_shared.c<br/>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.<br/><br/>See also [VoltageSet on forum](https://www.elektroda.com/rtvforum/find.php?q=VoltageSet). | File: driver/drv_pwrCal.c<br/>Function: NULL); |
|
||||
| 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.<br/><br/>See also [waitFor on forum](https://www.elektroda.com/rtvforum/find.php?q=waitFor). | File: cmnds/cmd_script.c<br/>Function: CMD_waitFor |
|
||||
| widget_clearAll | CMD_Widget_ClearAll | .<br/><br/>See also [widget_clearAll on forum](https://www.elektroda.com/rtvforum/find.php?q=widget_clearAll). | File: driver/drv_widget.c<br/>Function: NULL); |
|
||||
| widget_create | CMD_Widget_Create | .<br/><br/>See also [widget_create on forum](https://www.elektroda.com/rtvforum/find.php?q=widget_create). | File: driver/drv_widget.c<br/>Function: NULL); |
|
||||
| widget_clearAll | | Removes all registered widgets.<br/><br/>See also [widget_clearAll on forum](https://www.elektroda.com/rtvforum/find.php?q=widget_clearAll). | File: driver/drv_widget.c<br/>Function: NULL); |
|
||||
| widget_create | [LocationIndex][bAllowCache][FileName] | .<br/><br/>See also [widget_create on forum](https://www.elektroda.com/rtvforum/find.php?q=widget_create). | File: driver/drv_widget.c<br/>Function: NULL); |
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| 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.<br/><br/>See also [AddChannel on forum](https://www.elektroda.com/rtvforum/find.php?q=AddChannel). |
|
||||
| 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).<br/><br/>See also [addClockEvent on forum](https://www.elektroda.com/rtvforum/find.php?q=addClockEvent). |
|
||||
| AddEventHandler | [EventName][EventArgument][CommandToRun] | This can be used to trigger an action on a button click, long press, etc.<br/><br/>See also [AddEventHandler on forum](https://www.elektroda.com/rtvforum/find.php?q=AddEventHandler). |
|
||||
| addI2CDevice_ADS1115 | DRV_I2C_AddDevice_ADS1115 | .<br/><br/>See also [addI2CDevice_ADS1115 on forum](https://www.elektroda.com/rtvforum/find.php?q=addI2CDevice_ADS1115). |
|
||||
| addI2CDevice_ADS1115 | | .<br/><br/>See also [addI2CDevice_ADS1115 on forum](https://www.elektroda.com/rtvforum/find.php?q=addI2CDevice_ADS1115). |
|
||||
| addI2CDevice_LCD_PCF8574 | | Adds a new I2C device - PCF8574.<br/><br/>See also [addI2CDevice_LCD_PCF8574 on forum](https://www.elektroda.com/rtvforum/find.php?q=addI2CDevice_LCD_PCF8574). |
|
||||
| addI2CDevice_LCM1602 | | Adds a new I2C device - LCM1602.<br/><br/>See also [addI2CDevice_LCM1602 on forum](https://www.elektroda.com/rtvforum/find.php?q=addI2CDevice_LCM1602). |
|
||||
| addI2CDevice_MCP23017 | | Adds a new I2C device - MCP23017.<br/><br/>See also [addI2CDevice_MCP23017 on forum](https://www.elektroda.com/rtvforum/find.php?q=addI2CDevice_MCP23017). |
|
||||
@ -29,8 +29,8 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| AHT2X_Reinit | | Reinitialize sensor.<br/><br/>Example: AHT2X_Reinit<br/><br/>See also [AHT2X_Reinit on forum](https://www.elektroda.com/rtvforum/find.php?q=AHT2X_Reinit). |
|
||||
| alias | [Alias][Command with spaces] | Add an aliased command, so a command with spaces can be called with a short, nospaced alias.<br/><br/>See also [alias on forum](https://www.elektroda.com/rtvforum/find.php?q=alias). |
|
||||
| aliasMem | | Internal usage only. See docs for 'alias' command.<br/><br/>See also [aliasMem on forum](https://www.elektroda.com/rtvforum/find.php?q=aliasMem). |
|
||||
| Anim | PA_Cmd_Anim | .<br/><br/>See also [Anim on forum](https://www.elektroda.com/rtvforum/find.php?q=Anim). |
|
||||
| AnimSpeed | PA_Cmd_AnimSpeed | .<br/><br/>See also [AnimSpeed on forum](https://www.elektroda.com/rtvforum/find.php?q=AnimSpeed). |
|
||||
| Anim | [AnimationIndex] | Starts given WS2812 animation by index.<br/><br/>See also [Anim on forum](https://www.elektroda.com/rtvforum/find.php?q=Anim). |
|
||||
| AnimSpeed | [Interval] | Sets WS2812 animation speed.<br/><br/>See also [AnimSpeed on forum](https://www.elektroda.com/rtvforum/find.php?q=AnimSpeed). |
|
||||
| backlog | [string of commands separated with ;] | Run a sequence of ; separated commands.<br/><br/>See also [backlog on forum](https://www.elektroda.com/rtvforum/find.php?q=backlog). |
|
||||
| Battery_cycle | [int] | Change cycle of measurement by default every 10 seconds.<br/><br/>Example: Battery_cycle 60<br/><br/>See also [Battery_cycle on forum](https://www.elektroda.com/rtvforum/find.php?q=Battery_cycle). |
|
||||
| Battery_Setup | [minbatt][maxbatt][V_divider][Vref][AD Bits] | Measure battery based on ADC. <br />req. args: minbatt in mv, maxbatt in mv. <br />optional: V_divider(2), Vref(default 2400), ADC bits(4096).<br/><br/>Example: Battery_Setup 1500 3000 2 2400 4096<br/><br/>See also [Battery_Setup on forum](https://www.elektroda.com/rtvforum/find.php?q=Battery_Setup). |
|
||||
@ -103,10 +103,10 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| HT16K33_Raw | HT16K33_Raw | .<br/><br/>See also [HT16K33_Raw on forum](https://www.elektroda.com/rtvforum/find.php?q=HT16K33_Raw). |
|
||||
| HT16K33_Test | HT16K33_Test | .<br/><br/>See also [HT16K33_Test on forum](https://www.elektroda.com/rtvforum/find.php?q=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.<br/><br/>See also [if on forum](https://www.elektroda.com/rtvforum/find.php?q=if). |
|
||||
| IndexRefreshInterval | CMD_IndexRefreshInterval | .<br/><br/>See also [IndexRefreshInterval on forum](https://www.elektroda.com/rtvforum/find.php?q=IndexRefreshInterval). |
|
||||
| IndexRefreshInterval | [Interval] | .<br/><br/>See also [IndexRefreshInterval on forum](https://www.elektroda.com/rtvforum/find.php?q=IndexRefreshInterval). |
|
||||
| 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.<br/><br/>See also [IREnable on forum](https://www.elektroda.com/rtvforum/find.php?q=IREnable). |
|
||||
| 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.<br/><br/>See also [IRSend on forum](https://www.elektroda.com/rtvforum/find.php?q=IRSend). |
|
||||
| json_test | cmnd_json_test | .<br/><br/>See also [json_test on forum](https://www.elektroda.com/rtvforum/find.php?q=json_test). |
|
||||
| json_test | | Developer-only command used to test CJSON library.<br/><br/>See also [json_test on forum](https://www.elektroda.com/rtvforum/find.php?q=json_test). |
|
||||
| KP18058_Current | [RGBLimit][CWLimit] | Sets the maximum current for LED driver. Values 0-31. Example usage: KP18058_Current 14 30.<br/><br/>See also [KP18058_Current on forum](https://www.elektroda.com/rtvforum/find.php?q=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.<br/><br/>See also [KP18058_Map on forum](https://www.elektroda.com/rtvforum/find.php?q=KP18058_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.<br/><br/>See also [KP18058_RGBCW on forum](https://www.elektroda.com/rtvforum/find.php?q=KP18058_RGBCW). |
|
||||
@ -117,7 +117,7 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| lcd_printFloat | | Prints a float on the LCD.<br/><br/>See also [lcd_printFloat on forum](https://www.elektroda.com/rtvforum/find.php?q=lcd_printFloat). |
|
||||
| lcd_printInt | | Prints an omt on the LCD.<br/><br/>See also [lcd_printInt on forum](https://www.elektroda.com/rtvforum/find.php?q=lcd_printInt). |
|
||||
| led_basecolor_rgb | [HexValue] | Puts the LED driver in RGB mode and sets given color.<br/><br/>See also [led_basecolor_rgb on forum](https://www.elektroda.com/rtvforum/find.php?q=led_basecolor_rgb). |
|
||||
| led_basecolor_rgbcw | | Set PWN color using #RRGGBB[cw][ww].<br/><br/>See also [led_basecolor_rgbcw on forum](https://www.elektroda.com/rtvforum/find.php?q=led_basecolor_rgbcw). |
|
||||
| led_basecolor_rgbcw | [HexValue] | Set PWN color using #RRGGBB[cw][ww].<br/><br/>See also [led_basecolor_rgbcw on forum](https://www.elektroda.com/rtvforum/find.php?q=led_basecolor_rgbcw). |
|
||||
| led_colorMult | [Value] | Internal usage.<br/><br/>See also [led_colorMult on forum](https://www.elektroda.com/rtvforum/find.php?q=led_colorMult). |
|
||||
| led_dimmer | [Value] | Set output dimmer 0..100.<br/><br/>See also [led_dimmer on forum](https://www.elektroda.com/rtvforum/find.php?q=led_dimmer). |
|
||||
| led_enableAll | [1or0orToggle] | Power on/off LED but remember the RGB(CW) values.<br/><br/>See also [led_enableAll on forum](https://www.elektroda.com/rtvforum/find.php?q=led_enableAll). |
|
||||
@ -125,7 +125,7 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| led_gammaCtrl | sub-cmd [par] | Control LED Gamma Correction and Calibration.<br/><br/>Example: led_gammaCtrl on<br/><br/>See also [led_gammaCtrl on forum](https://www.elektroda.com/rtvforum/find.php?q=led_gammaCtrl). |
|
||||
| led_hue | [Value] | This is an alternate way to set the LED color.<br/><br/>See also [led_hue on forum](https://www.elektroda.com/rtvforum/find.php?q=led_hue). |
|
||||
| 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.<br/><br/>See also [led_lerpSpeed on forum](https://www.elektroda.com/rtvforum/find.php?q=led_lerpSpeed). |
|
||||
| LED_Map | CMD_LEDDriver_Map | .<br/><br/>See also [LED_Map on forum](https://www.elektroda.com/rtvforum/find.php?q=LED_Map). |
|
||||
| LED_Map | [Ch0][Ch1][Ch2][Ch3][Ch4] | .<br/><br/>See also [LED_Map on forum](https://www.elektroda.com/rtvforum/find.php?q=LED_Map). |
|
||||
| led_nextColor | | Sets the next color from predefined colours list. Our list is the same as in Tasmota.<br/><br/>See also [led_nextColor on forum](https://www.elektroda.com/rtvforum/find.php?q=led_nextColor). |
|
||||
| led_saturation | [Value] | This is an alternate way to set the LED color.<br/><br/>See also [led_saturation on forum](https://www.elektroda.com/rtvforum/find.php?q=led_saturation). |
|
||||
| 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.<br/><br/>See also [led_saveInterval on forum](https://www.elektroda.com/rtvforum/find.php?q=led_saveInterval). |
|
||||
@ -160,11 +160,11 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| MAX72XX_Scroll | DRV_MAX72XX_Scroll | .<br/><br/>See also [MAX72XX_Scroll on forum](https://www.elektroda.com/rtvforum/find.php?q=MAX72XX_Scroll). |
|
||||
| MAX72XX_Setup | [Value] | Sets the maximum current for LED driver.<br/><br/>See also [MAX72XX_Setup on forum](https://www.elektroda.com/rtvforum/find.php?q=MAX72XX_Setup). |
|
||||
| MCP23017_MapPinToChannel | | Maps port expander bit to OBK channel.<br/><br/>See also [MCP23017_MapPinToChannel on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP23017_MapPinToChannel). |
|
||||
| MCP9808_Adr | MCP9808_Adr | .<br/><br/>See also [MCP9808_Adr on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP9808_Adr). |
|
||||
| MCP9808_AlertMin | MCP9808_AlertMin | .<br/><br/>See also [MCP9808_AlertMin on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP9808_AlertMin). |
|
||||
| MCP9808_AlertRange | MCP9808_AlertRange | .<br/><br/>See also [MCP9808_AlertRange on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP9808_AlertRange). |
|
||||
| MCP9808_Adr | [HexAdr] | Sets the I2C address of MCP9808, like 0x30.<br/><br/>See also [MCP9808_Adr on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP9808_Adr). |
|
||||
| MCP9808_AlertMin | [MinT] [OptionalBActiveHigh] | Setup MCP9809 temperature alert for min mode.<br/><br/>See also [MCP9808_AlertMin on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP9808_AlertMin). |
|
||||
| MCP9808_AlertRange | [MinT] [MaxT] [OptionalBActiveHigh] | Setup MCP9809 temperature alert for range mode.<br/><br/>See also [MCP9808_AlertRange on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP9808_AlertRange). |
|
||||
| MCP9808_Calibrate | [DeltaTemperature] | .<br/><br/>See also [MCP9808_Calibrate on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP9808_Calibrate). |
|
||||
| MCP9808_Cycle | [DelayInSeconds] | .<br/><br/>See also [MCP9808_Cycle on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP9808_Cycle). |
|
||||
| MCP9808_Cycle | [DelayInSeconds] | Sets MCP9808 measurement interval.<br/><br/>See also [MCP9808_Cycle on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP9808_Cycle). |
|
||||
| MqttClient | [ValueString] | Sets the MQTT client. Command keeps Tasmota syntax.<br/><br/>See also [MqttClient on forum](https://www.elektroda.com/rtvforum/find.php?q=MqttClient). |
|
||||
| MqttHost | [ValueString] | Sets the MQTT host. Command keeps Tasmota syntax.<br/><br/>See also [MqttHost on forum](https://www.elektroda.com/rtvforum/find.php?q=MqttHost). |
|
||||
| MqttPassword | [ValueString] | Sets the MQTT pass. Command keeps Tasmota syntax.<br/><br/>See also [MqttPassword on forum](https://www.elektroda.com/rtvforum/find.php?q=MqttPassword). |
|
||||
@ -178,16 +178,16 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| obkDeviceList | | Generate the SSDP list of OpenBeken devices found on the network.<br/><br/>See also [obkDeviceList on forum](https://www.elektroda.com/rtvforum/find.php?q=obkDeviceList). |
|
||||
| OpenAP | | Temporarily disconnects from programmed WiFi network and opens Access Point.<br/><br/>See also [OpenAP on forum](https://www.elektroda.com/rtvforum/find.php?q=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).<br/><br/>See also [ota_http on forum](https://www.elektroda.com/rtvforum/find.php?q=ota_http). |
|
||||
| owm_channels | CMD_OWM_Channels | .<br/><br/>See also [owm_channels on forum](https://www.elektroda.com/rtvforum/find.php?q=owm_channels). |
|
||||
| owm_request | CMD_OWM_Request | .<br/><br/>See also [owm_request on forum](https://www.elektroda.com/rtvforum/find.php?q=owm_request). |
|
||||
| owm_setup | CMD_OWM_Setup | .<br/><br/>See also [owm_setup on forum](https://www.elektroda.com/rtvforum/find.php?q=owm_setup). |
|
||||
| owm_channels | [temperature][humidity][pressure] | Sets channels that will be used to store OWM response results.<br/><br/>See also [owm_channels on forum](https://www.elektroda.com/rtvforum/find.php?q=owm_channels). |
|
||||
| owm_request | | Sends OWM request to the API. Do not use it too often, as API may have limits.<br/><br/>See also [owm_request on forum](https://www.elektroda.com/rtvforum/find.php?q=owm_request). |
|
||||
| owm_setup | [lat][lng][api_key] | Setups OWM driver for your location and API key.<br/><br/>See also [owm_setup on forum](https://www.elektroda.com/rtvforum/find.php?q=owm_setup). |
|
||||
| Password1 | [ValueString] | Sets the Pass of target WiFi. Command keeps Tasmota syntax.<br/><br/>See also [Password1 on forum](https://www.elektroda.com/rtvforum/find.php?q=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](https://www.elektroda.com/rtvforum/topic4041971.html).<br/><br/>See also [PinDeepSleep on forum](https://www.elektroda.com/rtvforum/find.php?q=PinDeepSleep). |
|
||||
| PingHost | [IPStr] | Sets the host to ping by IP watchdog.<br/><br/>See also [PingHost on forum](https://www.elektroda.com/rtvforum/find.php?q=PingHost). |
|
||||
| PingInterval | [IntegerSeconds] | Sets the interval between ping attempts for ping watchdog mechanism.<br/><br/>See also [PingInterval on forum](https://www.elektroda.com/rtvforum/find.php?q=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.<br/><br/>See also [power on forum](https://www.elektroda.com/rtvforum/find.php?q=power). |
|
||||
| powerAll | | Set all outputs.<br/><br/>See also [powerAll on forum](https://www.elektroda.com/rtvforum/find.php?q=powerAll). |
|
||||
| PowerMax | BL0937_PowerMax | .<br/><br/>See also [PowerMax on forum](https://www.elektroda.com/rtvforum/find.php?q=PowerMax). |
|
||||
| PowerMax | [MaxPowerInW] | Sets the maximum power limit for BL measurement used to filter incorrect values.<br/><br/>See also [PowerMax on forum](https://www.elektroda.com/rtvforum/find.php?q=PowerMax). |
|
||||
| PowerSave | [Optional 1 or 0, by default 1 is assumed] | Enables dynamic power saving mode on Beken N/T, BL602, W600, W800 and LN882H. In the case of LN882H PowerSave will not work as a startup command, so use in autoexec. 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.<br/><br/>See also [PowerSave on forum](https://www.elektroda.com/rtvforum/find.php?q=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.<br/><br/>See also [PowerSet on forum](https://www.elektroda.com/rtvforum/find.php?q=PowerSet). |
|
||||
| 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.<br/><br/>See also [publish on forum](https://www.elektroda.com/rtvforum/find.php?q=publish). |
|
||||
@ -235,7 +235,7 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| 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).<br/><br/>See also [setStartupSSIDChannel on forum](https://www.elektroda.com/rtvforum/find.php?q=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'.<br/><br/>See also [SetStartValue on forum](https://www.elektroda.com/rtvforum/find.php?q=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.<br/><br/>See also [SetupEnergyStats on forum](https://www.elektroda.com/rtvforum/find.php?q=SetupEnergyStats). |
|
||||
| SetupIR2 | CMD_IR2_SetupIR2 | .<br/><br/>See also [SetupIR2 on forum](https://www.elektroda.com/rtvforum/find.php?q=SetupIR2). |
|
||||
| SetupIR2 | [myPeriodUs] [dutyOnFrac] [dutyOffFrac] [txPin] | Init IR2 pin and interrupt.<br/><br/>See also [SetupIR2 on forum](https://www.elektroda.com/rtvforum/find.php?q=SetupIR2). |
|
||||
| SetupTestPower | [fakeVoltage] [FakeCurrent] [FakePower] [bAllowRandom] | Starts the fake power metering driver.<br/><br/>See also [SetupTestPower on forum](https://www.elektroda.com/rtvforum/find.php?q=SetupTestPower). |
|
||||
| SGP_cycle | [int] | Change cycle of measurement by default every 10 seconds 0 to deactivate.<br/><br/>Example: SGP_Cycle 60<br/><br/>See also [SGP_cycle on forum](https://www.elektroda.com/rtvforum/find.php?q=SGP_cycle). |
|
||||
| SGP_GetBaseline | | SGP Get baseline.<br/><br/>Example: SGP_GetBaseline<br/><br/>See also [SGP_GetBaseline on forum](https://www.elektroda.com/rtvforum/find.php?q=SGP_GetBaseline). |
|
||||
@ -256,7 +256,7 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| SHT_SetAlert | [temp_high, temp_low, hum_high, hum_low]<br/>Req:all | Set Sensor alert configuration.<br/><br/>Example: SHT_SetAlertCmd<br/><br/>See also [SHT_SetAlert on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_SetAlert). |
|
||||
| SHT_StopPer | | Stop periodical capture for SHT Sensor.<br/><br/>See also [SHT_StopPer on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_StopPer). |
|
||||
| simonirtest | | Simons Special Test.<br/><br/>See also [simonirtest on forum](https://www.elektroda.com/rtvforum/find.php?q=simonirtest). |
|
||||
| SimSaveArgs | CMD_SelfTest_SaveArgs | .<br/><br/>See also [SimSaveArgs on forum](https://www.elektroda.com/rtvforum/find.php?q=SimSaveArgs). |
|
||||
| SimSaveArgs | | Internal usage only. Command for OBK self-test in Simulator.<br/><br/>See also [SimSaveArgs on forum](https://www.elektroda.com/rtvforum/find.php?q=SimSaveArgs). |
|
||||
| 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](https://www.elektroda.com/rtvforum/topic4036716.html).<br/><br/>See also [SM16703P_Init on forum](https://www.elektroda.com/rtvforum/find.php?q=SM16703P_Init). |
|
||||
| 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](https://www.elektroda.com/rtvforum/topic4036716.html).<br/><br/>See also [SM16703P_SetPixel on forum](https://www.elektroda.com/rtvforum/find.php?q=SM16703P_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](https://www.elektroda.com/rtvforum/topic4036716.html).<br/><br/>See also [SM16703P_SetRaw on forum](https://www.elektroda.com/rtvforum/find.php?q=SM16703P_SetRaw). |
|
||||
@ -332,6 +332,6 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| 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).<br/><br/>See also [VCPPublishThreshold on forum](https://www.elektroda.com/rtvforum/find.php?q=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.<br/><br/>See also [VoltageSet on forum](https://www.elektroda.com/rtvforum/find.php?q=VoltageSet). |
|
||||
| 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.<br/><br/>See also [waitFor on forum](https://www.elektroda.com/rtvforum/find.php?q=waitFor). |
|
||||
| widget_clearAll | CMD_Widget_ClearAll | .<br/><br/>See also [widget_clearAll on forum](https://www.elektroda.com/rtvforum/find.php?q=widget_clearAll). |
|
||||
| widget_create | CMD_Widget_Create | .<br/><br/>See also [widget_create on forum](https://www.elektroda.com/rtvforum/find.php?q=widget_create). |
|
||||
| widget_clearAll | | Removes all registered widgets.<br/><br/>See also [widget_clearAll on forum](https://www.elektroda.com/rtvforum/find.php?q=widget_clearAll). |
|
||||
| widget_create | [LocationIndex][bAllowCache][FileName] | .<br/><br/>See also [widget_create on forum](https://www.elektroda.com/rtvforum/find.php?q=widget_create). |
|
||||
|
||||
|
||||
@ -22,16 +22,16 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| TESTPOWER | This is a fake POWER measuring socket driver, only for testing.<br/>See also [TESTPOWER on forum](https://www.elektroda.com/rtvforum/find.php?q=TESTPOWER). |
|
||||
| TESTLED | This is a fake I2C LED driver, only for testing.<br/>See also [TESTLED on forum](https://www.elektroda.com/rtvforum/find.php?q=TESTLED). |
|
||||
| I2C | Generic I2C, not used for LED drivers, but may be useful for displays or port expanders. Supports both hardware and software I2C.<br/>See also [I2C on forum](https://www.elektroda.com/rtvforum/find.php?q=I2C). |
|
||||
| RN8209 | Bqqqqqqqqqq .<br/>See also [RN8209 on forum](https://www.elektroda.com/rtvforum/find.php?q=RN8209). |
|
||||
| RN8209 | WIP driver for power-metering chip RN8209 found in one of Zmai-90 versions.<br/>See also [RN8209 on forum](https://www.elektroda.com/rtvforum/find.php?q=RN8209). |
|
||||
| BL0942 | BL0942 is a power-metering chip which uses UART protocol for communication. It's usually connected to TX1/RX1 port of BK. You need to calibrate power metering once, just like in Tasmota. See [LSPA9 teardown example](https://www.elektroda.com/rtvforum/topic3887748.html). By default, it uses 4800 baud, but you can also enable it with baud 9600 by using 'startDriver BL0942 9600', see [related topic](https://www.elektroda.com/rtvforum/viewtopic.php?p=20957896#20957896).<br/>See also [BL0942 on forum](https://www.elektroda.com/rtvforum/find.php?q=BL0942). |
|
||||
| PWMG | .<br/>See also [PWMG on forum](https://www.elektroda.com/rtvforum/find.php?q=PWMG). |
|
||||
| PWMG | PWM Groups (synchronized PWMs) driver for OpenBeken.<br/>See also [PWMG on forum](https://www.elektroda.com/rtvforum/find.php?q=PWMG). |
|
||||
| BL0942SPI | BL0942 driver version for SPI protocol. It's usually connected to SPI1 port of BK. You need to calibrate power metering once, just like in Tasmota. See [PZIOT-E01 teardown example](https://www.elektroda.com/rtvforum/topic3945667.html). .<br/>See also [BL0942SPI on forum](https://www.elektroda.com/rtvforum/find.php?q=BL0942SPI). |
|
||||
| ChargingLimit | Mechanism to perform an action based on a max. delta value and max time. Used to control Electric Vehicle chargers. See [discussion](https://github.com/openshwprojects/OpenBK7231T_App/issues/892).<br/>See also [ChargingLimit on forum](https://www.elektroda.com/rtvforum/find.php?q=ChargingLimit). |
|
||||
| BL0937 | BL0937 is a power-metering chip which uses custom protocol to report data. It requires setting 3 pins in pin config: CF, CF1 and SEL.<br/>See also [BL0937 on forum](https://www.elektroda.com/rtvforum/find.php?q=BL0937). |
|
||||
| CSE7766 | CSE7766 is a power-metering chip which uses UART protocol for communication. It's usually connected to TX1/RX1 port of BK.<br/>See also [CSE7766 on forum](https://www.elektroda.com/rtvforum/find.php?q=CSE7766). |
|
||||
| MAX6675 | Thermocouple driver for measuring high temperatures, see [presentation](https://www.elektroda.com/rtvforum/topic4055231.html).<br/>See also [MAX6675 on forum](https://www.elektroda.com/rtvforum/find.php?q=MAX6675). |
|
||||
| PT6523 | Car radio LCD driver, see [teardown and presentation](https://www.elektroda.com/rtvforum/topic3983111.html).<br/>See also [PT6523 on forum](https://www.elektroda.com/rtvforum/find.php?q=PT6523). |
|
||||
| TextScroller | BQQQK.<br/>See also [TextScroller on forum](https://www.elektroda.com/rtvforum/find.php?q=TextScroller). |
|
||||
| TextScroller | Wrapper utility that can do text scrolling animation on implemented displays (WIP).<br/>See also [TextScroller on forum](https://www.elektroda.com/rtvforum/find.php?q=TextScroller). |
|
||||
| SM16703P | SM16703P is an individually addressable LEDs controller like WS2812B. Currently SM16703P LEDs are supported through hardware SPI, LEDs data should be connected to P16 (MOSI), [here you can read](https://www.elektroda.com/rtvforum/topic4005865.html) how to break it out on CB2S.<br/>See also [SM16703P on forum](https://www.elektroda.com/rtvforum/find.php?q=SM16703P). |
|
||||
| SM15155E | SM15155E is a WS2812B-like single wire LED controller. It's also always using P16 (SPI out) on Beken. See [reverse-engineering topic](https://www.elektroda.com/rtvforum/topic4060227.html).<br/>See also [SM15155E on forum](https://www.elektroda.com/rtvforum/find.php?q=SM15155E). |
|
||||
| IR | IRLibrary wrapper, so you can receive remote signals and send them. See [forum discussion here](https://www.elektroda.com/rtvforum/topic3920360.html), also see [LED strip and IR YT video](https://www.youtube.com/watch?v=KU0tDwtjfjw).<br/>See also [IR on forum](https://www.elektroda.com/rtvforum/find.php?q=IR). |
|
||||
@ -55,7 +55,7 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| CHT83XX | CHT8305, CHT8310 and CHT8315 are a Temperature and Humidity sensors with I2C interface.<br/>See also [CHT83XX on forum](https://www.elektroda.com/rtvforum/find.php?q=CHT83XX). |
|
||||
| MCP9808 | MCP9808 is a Temperature sensor with I2C interface and an external wakeup pin, see [docs](https://www.elektroda.pl/rtvforum/topic3988466.html).<br/>See also [MCP9808 on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP9808). |
|
||||
| KP18058 | KP18058 I2C LED driver. Supports also KP18068. Working, see reverse-engineering [topic](https://www.elektroda.pl/rtvforum/topic3991620.html).<br/>See also [KP18058 on forum](https://www.elektroda.com/rtvforum/find.php?q=KP18058). |
|
||||
| ADCSmoother | Qq.<br/>See also [ADCSmoother on forum](https://www.elektroda.com/rtvforum/find.php?q=ADCSmoother). |
|
||||
| ADCSmoother | ADCSmoother is used for 3-way stairs switches synchronized via extra wire.<br/>See also [ADCSmoother on forum](https://www.elektroda.com/rtvforum/find.php?q=ADCSmoother). |
|
||||
| SHT3X | Humidity/temperature sensor. See [SHT Sensor tutorial topic here](https://www.elektroda.com/rtvforum/topic3958369.html), also see [this sensor teardown](https://www.elektroda.com/rtvforum/topic3945688.html).<br/>See also [SHT3X on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT3X). |
|
||||
| SGP | SGP Air Quality sensor with I2C interface. See [this DIY sensor](https://www.elektroda.com/rtvforum/topic3967174.html) for setup information.<br/>See also [SGP on forum](https://www.elektroda.com/rtvforum/find.php?q=SGP). |
|
||||
| ShiftRegister | Simple Shift Register driver that allows you to map channels to shift register output. See [related topic](https://www.elektroda.com/rtvforum/viewtopic.php?p=20533505#20533505).<br/>See also [ShiftRegister on forum](https://www.elektroda.com/rtvforum/find.php?q=ShiftRegister). |
|
||||
|
||||
@ -55,7 +55,7 @@
|
||||
},
|
||||
{
|
||||
"name": "addI2CDevice_ADS1115",
|
||||
"args": "DRV_I2C_AddDevice_ADS1115",
|
||||
"args": "",
|
||||
"descr": "",
|
||||
"fn": "NULL);",
|
||||
"file": "i2c/drv_i2c_ads1115.c",
|
||||
@ -190,8 +190,8 @@
|
||||
},
|
||||
{
|
||||
"name": "Anim",
|
||||
"args": "PA_Cmd_Anim",
|
||||
"descr": "",
|
||||
"args": "[AnimationIndex]",
|
||||
"descr": "Starts given WS2812 animation by index.",
|
||||
"fn": "NULL);",
|
||||
"file": "driver/drv_pixelAnim.c",
|
||||
"requires": "",
|
||||
@ -199,8 +199,8 @@
|
||||
},
|
||||
{
|
||||
"name": "AnimSpeed",
|
||||
"args": "PA_Cmd_AnimSpeed",
|
||||
"descr": "",
|
||||
"args": "[Interval]",
|
||||
"descr": "Sets WS2812 animation speed",
|
||||
"fn": "NULL);",
|
||||
"file": "driver/drv_pixelAnim.c",
|
||||
"requires": "",
|
||||
@ -856,7 +856,7 @@
|
||||
},
|
||||
{
|
||||
"name": "IndexRefreshInterval",
|
||||
"args": "CMD_IndexRefreshInterval",
|
||||
"args": "[Interval]",
|
||||
"descr": "",
|
||||
"fn": "NULL);",
|
||||
"file": "cmnds/cmd_main.c",
|
||||
@ -883,8 +883,8 @@
|
||||
},
|
||||
{
|
||||
"name": "json_test",
|
||||
"args": "cmnd_json_test",
|
||||
"descr": "",
|
||||
"args": "",
|
||||
"descr": "Developer-only command used to test CJSON library",
|
||||
"fn": "NULL);",
|
||||
"file": "cmnds/cmd_test.c",
|
||||
"requires": "",
|
||||
@ -982,7 +982,7 @@
|
||||
},
|
||||
{
|
||||
"name": "led_basecolor_rgbcw",
|
||||
"args": "",
|
||||
"args": "[HexValue]",
|
||||
"descr": "set PWN color using #RRGGBB[cw][ww]",
|
||||
"fn": "basecolor_rgbcw",
|
||||
"file": "cmnds/cmd_newLEDDriver.c",
|
||||
@ -1054,7 +1054,7 @@
|
||||
},
|
||||
{
|
||||
"name": "LED_Map",
|
||||
"args": "CMD_LEDDriver_Map",
|
||||
"args": "[Ch0][Ch1][Ch2][Ch3][Ch4]",
|
||||
"descr": "",
|
||||
"fn": "NULL);",
|
||||
"file": "driver/drv_sm15155e.c",
|
||||
@ -1369,8 +1369,8 @@
|
||||
},
|
||||
{
|
||||
"name": "MCP9808_Adr",
|
||||
"args": "MCP9808_Adr",
|
||||
"descr": "",
|
||||
"args": "[HexAdr]",
|
||||
"descr": "Sets the I2C address of MCP9808, like 0x30",
|
||||
"fn": "NULL);",
|
||||
"file": "driver/drv_mcp9808.c",
|
||||
"requires": "",
|
||||
@ -1378,17 +1378,17 @@
|
||||
},
|
||||
{
|
||||
"name": "MCP9808_AlertMin",
|
||||
"args": "MCP9808_AlertMin",
|
||||
"descr": "",
|
||||
"fn": "NULL);",
|
||||
"args": "[MinT] [OptionalBActiveHigh]",
|
||||
"descr": "Setup MCP9809 temperature alert for min mode",
|
||||
"fn": ");",
|
||||
"file": "driver/drv_mcp9808.c",
|
||||
"requires": "",
|
||||
"examples": ""
|
||||
},
|
||||
{
|
||||
"name": "MCP9808_AlertRange",
|
||||
"args": "MCP9808_AlertRange",
|
||||
"descr": "",
|
||||
"args": "[MinT] [MaxT] [OptionalBActiveHigh]",
|
||||
"descr": "Setup MCP9809 temperature alert for range mode",
|
||||
"fn": "NULL);",
|
||||
"file": "driver/drv_mcp9808.c",
|
||||
"requires": "",
|
||||
@ -1406,7 +1406,7 @@
|
||||
{
|
||||
"name": "MCP9808_Cycle",
|
||||
"args": "[DelayInSeconds]",
|
||||
"descr": "",
|
||||
"descr": "Sets MCP9808 measurement interval",
|
||||
"fn": "NULL);",
|
||||
"file": "driver/drv_mcp9808.c",
|
||||
"requires": "",
|
||||
@ -1531,8 +1531,8 @@
|
||||
},
|
||||
{
|
||||
"name": "owm_channels",
|
||||
"args": "CMD_OWM_Channels",
|
||||
"descr": "",
|
||||
"args": "[temperature][humidity][pressure]",
|
||||
"descr": "Sets channels that will be used to store OWM response results",
|
||||
"fn": "NULL);",
|
||||
"file": "driver/drv_openWeatherMap.c",
|
||||
"requires": "",
|
||||
@ -1540,8 +1540,8 @@
|
||||
},
|
||||
{
|
||||
"name": "owm_request",
|
||||
"args": "CMD_OWM_Request",
|
||||
"descr": "",
|
||||
"args": "",
|
||||
"descr": "Sends OWM request to the API. Do not use it too often, as API may have limits",
|
||||
"fn": "NULL);",
|
||||
"file": "driver/drv_openWeatherMap.c",
|
||||
"requires": "",
|
||||
@ -1549,8 +1549,8 @@
|
||||
},
|
||||
{
|
||||
"name": "owm_setup",
|
||||
"args": "CMD_OWM_Setup",
|
||||
"descr": "",
|
||||
"args": "[lat][lng][api_key]",
|
||||
"descr": "Setups OWM driver for your location and API key",
|
||||
"fn": "NULL);",
|
||||
"file": "driver/drv_openWeatherMap.c",
|
||||
"requires": "",
|
||||
@ -1612,8 +1612,8 @@
|
||||
},
|
||||
{
|
||||
"name": "PowerMax",
|
||||
"args": "BL0937_PowerMax",
|
||||
"descr": "",
|
||||
"args": "[MaxPowerInW]",
|
||||
"descr": "Sets the maximum power limit for BL measurement used to filter incorrect values",
|
||||
"fn": "NULL);",
|
||||
"file": "driver/drv_bl0937.c",
|
||||
"requires": "",
|
||||
@ -2044,8 +2044,8 @@
|
||||
},
|
||||
{
|
||||
"name": "SetupIR2",
|
||||
"args": "CMD_IR2_SetupIR2",
|
||||
"descr": "",
|
||||
"args": "[myPeriodUs] [dutyOnFrac] [dutyOffFrac] [txPin]",
|
||||
"descr": "Init IR2 pin and interrupt",
|
||||
"fn": "NULL);",
|
||||
"file": "driver/drv_ir2.c",
|
||||
"requires": "",
|
||||
@ -2233,8 +2233,8 @@
|
||||
},
|
||||
{
|
||||
"name": "SimSaveArgs",
|
||||
"args": "CMD_SelfTest_SaveArgs",
|
||||
"descr": "",
|
||||
"args": "",
|
||||
"descr": "Internal usage only. Command for OBK self-test in Simulator",
|
||||
"fn": "0);",
|
||||
"file": "selftest/selftest_cfg_via_http.c",
|
||||
"requires": "",
|
||||
@ -2917,8 +2917,8 @@
|
||||
},
|
||||
{
|
||||
"name": "widget_clearAll",
|
||||
"args": "CMD_Widget_ClearAll",
|
||||
"descr": "",
|
||||
"args": "",
|
||||
"descr": "Removes all registered widgets",
|
||||
"fn": "NULL);",
|
||||
"file": "driver/drv_widget.c",
|
||||
"requires": "",
|
||||
@ -2926,7 +2926,7 @@
|
||||
},
|
||||
{
|
||||
"name": "widget_create",
|
||||
"args": "CMD_Widget_Create",
|
||||
"args": "[LocationIndex][bAllowCache][FileName]",
|
||||
"descr": "",
|
||||
"fn": "NULL);",
|
||||
"file": "driver/drv_widget.c",
|
||||
|
||||
@ -92,7 +92,7 @@
|
||||
{
|
||||
"name": "RN8209",
|
||||
"title": "TODO",
|
||||
"descr": "Bqqqqqqqqqq ",
|
||||
"descr": "WIP driver for power-metering chip RN8209 found in one of Zmai-90 versions.",
|
||||
"requires": ""
|
||||
},
|
||||
{
|
||||
@ -104,7 +104,7 @@
|
||||
{
|
||||
"name": "PWMG",
|
||||
"title": "TODO",
|
||||
"descr": " ",
|
||||
"descr": "PWM Groups (synchronized PWMs) driver for OpenBeken.",
|
||||
"requires": ""
|
||||
},
|
||||
{
|
||||
@ -146,7 +146,7 @@
|
||||
{
|
||||
"name": "TextScroller",
|
||||
"title": "TODO",
|
||||
"descr": "BQQQK",
|
||||
"descr": "Wrapper utility that can do text scrolling animation on implemented displays (WIP)",
|
||||
"requires": ""
|
||||
},
|
||||
{
|
||||
@ -290,7 +290,7 @@
|
||||
{
|
||||
"name": "ADCSmoother",
|
||||
"title": "TODO",
|
||||
"descr": "qq",
|
||||
"descr": "ADCSmoother is used for 3-way stairs switches synchronized via extra wire.",
|
||||
"requires": ""
|
||||
},
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user