mirror of
https://github.com/openshwprojects/OpenBK7231T_App.git
synced 2026-02-05 09:05:49 +00:00
a bit better docs
This commit is contained in:
Tester23
@ -41,7 +41,7 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| 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.<br/><br/>See also [Ch on forum](https://www.elektroda.com/rtvforum/find.php?q=Ch). | File: cmnds/cmd_channels.c<br/>Function: CMD_Ch |
|
||||
| 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.<br/><br/>See also [Choice on forum](https://www.elektroda.com/rtvforum/find.php?q=Choice). | File: cmnds/cmd_main.c<br/>Function: NULL); |
|
||||
| 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.<br/><br/>See also [chSetupLimit on forum](https://www.elektroda.com/rtvforum/find.php?q=chSetupLimit). | File: driver/drv_chargingLimit.c<br/>Function: ChargingLimit_SetupCommand); |
|
||||
| CHT_Calibrate | [DeltaTemp][DeltaHumidity] | Calibrate the CHT Sensor as Tolerance is +/-2 degrees C.<br/><br/>Example: SHT_Calibrate -4 10 <br /> meaning -4 on current temp reading and +10 on current humidity reading<br/><br/>See also [CHT_Calibrate on forum](https://www.elektroda.com/rtvforum/find.php?q=CHT_Calibrate). | File: driver/drv_cht8305.c<br/>Function: CHT_Calibrate |
|
||||
| CHT_Calibrate | [DeltaTemp][DeltaHumidity] | Calibrate the CHT Sensor as Tolerance is +/-2 degrees C.<br/><br/>Example: CHT_Calibrate -4 10 <br /> meaning -4 on current temp reading and +10 on current humidity reading<br/><br/>See also [CHT_Calibrate on forum](https://www.elektroda.com/rtvforum/find.php?q=CHT_Calibrate). | File: driver/drv_cht8305.c<br/>Function: CHT_Calibrate |
|
||||
| CHT_Cycle | [IntervalSeconds] | This is the interval between measurements in seconds, by default 1. Max is 255.<br/><br/>Example: CHT_Cycle 60 <br /> measurement is taken every 60 seconds<br/><br/>See also [CHT_Cycle on forum](https://www.elektroda.com/rtvforum/find.php?q=CHT_Cycle). | File: drv/drv_cht8305.c<br/>Function: CHT_cycle |
|
||||
| ClampChannel | [ChannelIndex][Min][Max] | Clamps given channel value to a range.<br/><br/>See also [ClampChannel on forum](https://www.elektroda.com/rtvforum/find.php?q=ClampChannel). | File: cmnds/cmd_channels.c<br/>Function: CMD_ClampChannel |
|
||||
| clearAll | | Clears config and all remaining features, like runtime scripts, events, etc.<br/><br/>See also [clearAll on forum](https://www.elektroda.com/rtvforum/find.php?q=clearAll). | File: cmnds/cmd_main.c<br/>Function: CMD_ClearAll |
|
||||
@ -67,7 +67,7 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| Dimmer | [Value] | Alias for led_dimmer.<br/><br/>See also [Dimmer on forum](https://www.elektroda.com/rtvforum/find.php?q=Dimmer). | File: cmnds/cmd_newLEDDriver.c<br/>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.<br/><br/>See also [DimmerDelta on forum](https://www.elektroda.com/rtvforum/find.php?q=DimmerDelta). | File: cmnds/cmd_newLEDDriver.c<br/>Function: dimmerDelta |
|
||||
| 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.<br/><br/>See also [DSEdge on forum](https://www.elektroda.com/rtvforum/find.php?q=DSEdge). | File: drv/drv_doorSensorWithDeepSleep.c<br/>Function: CMD_DeepSleep_SetEdge |
|
||||
| DSTime | [timeSeconds] | 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.<br/><br/>See also [DSTime on forum](https://www.elektroda.com/rtvforum/find.php?q=DSTime). | File: drv/drv_doorSensorWithDeepSleep.c<br/>Function: DoorDeepSleep_SetTime |
|
||||
| DSTime | [timeSeconds] | 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.<br/><br/>See also [DSTime on forum](https://www.elektroda.com/rtvforum/find.php?q=DSTime). | File: drv/drv_doorSensorWithDeepSleep.c<br/>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.<br/><br/>See also [echo on forum](https://www.elektroda.com/rtvforum/find.php?q=echo). | File: cmnds/cmd_main.c<br/>Function: CMD_Echo |
|
||||
| EnergyCntReset | [OptionalNewValue] | Resets the total Energy Counter, the one that is usually kept after device reboots. After this commands, the counter will start again from 0 (or from the value you specified).<br/><br/>See also [EnergyCntReset on forum](https://www.elektroda.com/rtvforum/find.php?q=EnergyCntReset). | File: driver/drv_bl_shared.c<br/>Function: BL09XX_ResetEnergyCounter |
|
||||
| exec | [Filename] | Exec <file> - run autoexec.bat or other file from LFS if present.<br/><br/>See also [exec on forum](https://www.elektroda.com/rtvforum/find.php?q=exec). | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_lfsexec |
|
||||
@ -180,10 +180,10 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| 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'.<br/><br/>See also [publishFile on forum](https://www.elektroda.com/rtvforum/find.php?q=publishFile). | File: mqtt/new_mqtt.c<br/>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.<br/><br/>See also [publishFloat on forum](https://www.elektroda.com/rtvforum/find.php?q=publishFloat). | File: mqtt/new_mqtt.c<br/>Function: MQTT_PublishCommand |
|
||||
| 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.<br/><br/>See also [publishInt on forum](https://www.elektroda.com/rtvforum/find.php?q=publishInt). | File: mqtt/new_mqtt.c<br/>Function: MQTT_PublishCommand |
|
||||
| PWMFrequency | CMD_PWMFrequency | .<br/><br/>See also [PWMFrequency on forum](https://www.elektroda.com/rtvforum/find.php?q=PWMFrequency). | File: cmnds/cmd_main.c<br/>Function: NULL); |
|
||||
| PWMG_Raw | CMD_PWMG_Raw | .<br/><br/>See also [PWMG_Raw on forum](https://www.elektroda.com/rtvforum/find.php?q=PWMG_Raw). | File: driver/drv_pwm_groups.c<br/>Function: NULL); |
|
||||
| PWMG_Set | CMD_PWMG_Set | .<br/><br/>See also [PWMG_Set on forum](https://www.elektroda.com/rtvforum/find.php?q=PWMG_Set). | File: driver/drv_pwm_groups.c<br/>Function: NULL); |
|
||||
| reboot | | Same as restart. Needed for bkWriter 1.60 which sends 'reboot' cmd before trying to get bus.<br/><br/>See also [reboot on forum](https://www.elektroda.com/rtvforum/find.php?q=reboot). | File: cmnds/cmd_main.c<br/>Function: CMD_Restart |
|
||||
| PWMFrequency | [FrequencyInHz] | Sets the global PWM frequency.<br/><br/>See also [PWMFrequency on forum](https://www.elektroda.com/rtvforum/find.php?q=PWMFrequency). | File: cmnds/cmd_main.c<br/>Function: NULL); |
|
||||
| PWMG_Raw | | PWM grouping (synchronous PWM).<br/><br/>See also [PWMG_Raw on forum](https://www.elektroda.com/rtvforum/find.php?q=PWMG_Raw). | File: driver/drv_pwm_groups.c<br/>Function: NULL); |
|
||||
| PWMG_Set | Duty1Percent Duty2Percent DeadTimePercent Frequency PinA PinB | PWM grouping (synchronous PWM).<br/><br/>See also [PWMG_Set on forum](https://www.elektroda.com/rtvforum/find.php?q=PWMG_Set). | File: driver/drv_pwm_groups.c<br/>Function: NULL); |
|
||||
| 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.<br/><br/>See also [reboot on forum](https://www.elektroda.com/rtvforum/find.php?q=reboot). | File: cmnds/cmd_main.c<br/>Function: CMD_Restart |
|
||||
| removeClockEvent | [ID] | Removes clock event wtih given ID.<br/><br/>See also [removeClockEvent on forum](https://www.elektroda.com/rtvforum/find.php?q=removeClockEvent). | File: driver/drv_ntp_events.c<br/>Function: CMD_NTP_RemoveClockEvent |
|
||||
| resetSVM | | Resets all SVM and clears all scripts.<br/><br/>See also [resetSVM on forum](https://www.elektroda.com/rtvforum/find.php?q=resetSVM). | File: cmnds/cmd_script.c<br/>Function: CMD_resetSVM |
|
||||
| restart | | Reboots the module.<br/><br/>See also [restart on forum](https://www.elektroda.com/rtvforum/find.php?q=restart). | File: cmnds/cmd_main.c<br/>Function: CMD_Restart |
|
||||
@ -218,11 +218,11 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| ShortName | [Name] | Sets the short name of the device.<br/><br/>See also [ShortName on forum](https://www.elektroda.com/rtvforum/find.php?q=ShortName). | File: cmnds/cmd_channels.c<br/>Function: CMD_ShortName |
|
||||
| showChannelValues | | Log channel values.<br/><br/>See also [showChannelValues on forum](https://www.elektroda.com/rtvforum/find.php?q=showChannelValues). | File: new_pins.c<br/>Function: CMD_ShowChannelValues |
|
||||
| showgpi | NULL | Log stat of all GPIs.<br/><br/>See also [showgpi on forum](https://www.elektroda.com/rtvforum/find.php?q=showgpi). | File: new_pins.c<br/>Function: showgpi |
|
||||
| SHT_Calibrate | | Calibrate the SHT Sensor as Tolerance is +/-2 degrees C.<br/><br/>Example: SHT_Calibrate -4 10<br/><br/>See also [SHT_Calibrate on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_Calibrate). | File: driver/drv_sht3x.c<br/>Function: SHT3X_Calibrate |
|
||||
| SHT_Calibrate | [DeltaTemp][DeltaHumidity] | Calibrate the SHT Sensor as Tolerance is +/-2 degrees C.<br/><br/>Example: SHT_Calibrate -4 10<br/><br/>See also [SHT_Calibrate on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_Calibrate). | File: driver/drv_sht3x.c<br/>Function: SHT3X_Calibrate |
|
||||
| SHT_ClearStatus | | Clear Sensor Status.<br/><br/>Example: SHT_ClearStatusCmd<br/><br/>See also [SHT_ClearStatus on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_ClearStatus). | File: driver/drv_sht3x.c<br/>Function: SHT3X_ClearStatus |
|
||||
| SHT_cycle | [int] | This is the interval between measurements in seconds, by default 10. Max is 255.<br/><br/>Example: SHT_Cycle 60<br/><br/>See also [SHT_cycle on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_cycle). | File: drv/drv_sht3x.c<br/>Function: SHT_cycle |
|
||||
| SHT_GetStatus | | Get Sensor Status.<br/><br/>Example: SHT_GetStatusCmd<br/><br/>See also [SHT_GetStatus on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_GetStatus). | File: driver/drv_sht3x.c<br/>Function: SHT3X_GetStatus |
|
||||
| SHT_Heater | | Activate or Deactivate Heater (0 / 1).<br/><br/>Example: SHT_Heater 1<br/><br/>See also [SHT_Heater on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_Heater). | File: driver/drv_sht3x.c<br/>Function: SHT3X_Heater |
|
||||
| SHT_Heater | [1or0] | Activate or Deactivate Heater (0 / 1).<br/><br/>Example: SHT_Heater 1<br/><br/>See also [SHT_Heater on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_Heater). | File: driver/drv_sht3x.c<br/>Function: SHT3X_Heater |
|
||||
| SHT_LaunchPer | [msb][lsb] | Launch/Change periodical capture for SHT Sensor.<br/><br/>Example: SHT_LaunchPer 0x23 0x22<br/><br/>See also [SHT_LaunchPer on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_LaunchPer). | File: driver/drv_sht3x.c<br/>Function: SHT3X_ChangePer |
|
||||
| SHT_Measure | | Retrieve OneShot measurement for SHT.<br/><br/>Example: SHT_Measure<br/><br/>See also [SHT_Measure on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_Measure). | File: driver/drv_sht3x.c<br/>Function: SHT3X_Measure |
|
||||
| SHT_MeasurePer | | Retrieve Periodical measurement for SHT.<br/><br/>Example: SHT_Measure<br/><br/>See also [SHT_MeasurePer on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_MeasurePer). | File: driver/drv_sht3x.c<br/>Function: SHT3X_MeasurePer |
|
||||
|
||||
@ -44,7 +44,7 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| 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.<br/><br/>See also [Ch on forum](https://www.elektroda.com/rtvforum/find.php?q=Ch). |
|
||||
| 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.<br/><br/>See also [Choice on forum](https://www.elektroda.com/rtvforum/find.php?q=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.<br/><br/>See also [chSetupLimit on forum](https://www.elektroda.com/rtvforum/find.php?q=chSetupLimit). |
|
||||
| CHT_Calibrate | [DeltaTemp][DeltaHumidity] | Calibrate the CHT Sensor as Tolerance is +/-2 degrees C.<br/><br/>Example: SHT_Calibrate -4 10 <br /> meaning -4 on current temp reading and +10 on current humidity reading<br/><br/>See also [CHT_Calibrate on forum](https://www.elektroda.com/rtvforum/find.php?q=CHT_Calibrate). |
|
||||
| CHT_Calibrate | [DeltaTemp][DeltaHumidity] | Calibrate the CHT Sensor as Tolerance is +/-2 degrees C.<br/><br/>Example: CHT_Calibrate -4 10 <br /> meaning -4 on current temp reading and +10 on current humidity reading<br/><br/>See also [CHT_Calibrate on forum](https://www.elektroda.com/rtvforum/find.php?q=CHT_Calibrate). |
|
||||
| CHT_Cycle | [IntervalSeconds] | This is the interval between measurements in seconds, by default 1. Max is 255.<br/><br/>Example: CHT_Cycle 60 <br /> measurement is taken every 60 seconds<br/><br/>See also [CHT_Cycle on forum](https://www.elektroda.com/rtvforum/find.php?q=CHT_Cycle). |
|
||||
| ClampChannel | [ChannelIndex][Min][Max] | Clamps given channel value to a range.<br/><br/>See also [ClampChannel on forum](https://www.elektroda.com/rtvforum/find.php?q=ClampChannel). |
|
||||
| clearAll | | Clears config and all remaining features, like runtime scripts, events, etc.<br/><br/>See also [clearAll on forum](https://www.elektroda.com/rtvforum/find.php?q=clearAll). |
|
||||
@ -70,7 +70,7 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| Dimmer | [Value] | Alias for led_dimmer.<br/><br/>See also [Dimmer on forum](https://www.elektroda.com/rtvforum/find.php?q=Dimmer). |
|
||||
| DimmerDelta | [DeltaValue] | This sets the delta value for SmartDimmer/SmartButtonForLEDs hold event. This determines the amount of change of dimmer per hold event.<br/><br/>See also [DimmerDelta on forum](https://www.elektroda.com/rtvforum/find.php?q=DimmerDelta). |
|
||||
| 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.<br/><br/>See also [DSEdge on forum](https://www.elektroda.com/rtvforum/find.php?q=DSEdge). |
|
||||
| DSTime | [timeSeconds] | 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.<br/><br/>See also [DSTime on forum](https://www.elektroda.com/rtvforum/find.php?q=DSTime). |
|
||||
| DSTime | [timeSeconds] | 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.<br/><br/>See also [DSTime on forum](https://www.elektroda.com/rtvforum/find.php?q=DSTime). |
|
||||
| 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.<br/><br/>See also [echo on forum](https://www.elektroda.com/rtvforum/find.php?q=echo). |
|
||||
| EnergyCntReset | [OptionalNewValue] | Resets the total Energy Counter, the one that is usually kept after device reboots. After this commands, the counter will start again from 0 (or from the value you specified).<br/><br/>See also [EnergyCntReset on forum](https://www.elektroda.com/rtvforum/find.php?q=EnergyCntReset). |
|
||||
| exec | [Filename] | Exec <file> - run autoexec.bat or other file from LFS if present.<br/><br/>See also [exec on forum](https://www.elektroda.com/rtvforum/find.php?q=exec). |
|
||||
@ -183,10 +183,10 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| 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'.<br/><br/>See also [publishFile on forum](https://www.elektroda.com/rtvforum/find.php?q=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.<br/><br/>See also [publishFloat on forum](https://www.elektroda.com/rtvforum/find.php?q=publishFloat). |
|
||||
| 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.<br/><br/>See also [publishInt on forum](https://www.elektroda.com/rtvforum/find.php?q=publishInt). |
|
||||
| PWMFrequency | CMD_PWMFrequency | .<br/><br/>See also [PWMFrequency on forum](https://www.elektroda.com/rtvforum/find.php?q=PWMFrequency). |
|
||||
| PWMG_Raw | CMD_PWMG_Raw | .<br/><br/>See also [PWMG_Raw on forum](https://www.elektroda.com/rtvforum/find.php?q=PWMG_Raw). |
|
||||
| PWMG_Set | CMD_PWMG_Set | .<br/><br/>See also [PWMG_Set on forum](https://www.elektroda.com/rtvforum/find.php?q=PWMG_Set). |
|
||||
| reboot | | Same as restart. Needed for bkWriter 1.60 which sends 'reboot' cmd before trying to get bus.<br/><br/>See also [reboot on forum](https://www.elektroda.com/rtvforum/find.php?q=reboot). |
|
||||
| PWMFrequency | [FrequencyInHz] | Sets the global PWM frequency.<br/><br/>See also [PWMFrequency on forum](https://www.elektroda.com/rtvforum/find.php?q=PWMFrequency). |
|
||||
| PWMG_Raw | | PWM grouping (synchronous PWM).<br/><br/>See also [PWMG_Raw on forum](https://www.elektroda.com/rtvforum/find.php?q=PWMG_Raw). |
|
||||
| PWMG_Set | Duty1Percent Duty2Percent DeadTimePercent Frequency PinA PinB | PWM grouping (synchronous PWM).<br/><br/>See also [PWMG_Set on forum](https://www.elektroda.com/rtvforum/find.php?q=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.<br/><br/>See also [reboot on forum](https://www.elektroda.com/rtvforum/find.php?q=reboot). |
|
||||
| removeClockEvent | [ID] | Removes clock event wtih given ID.<br/><br/>See also [removeClockEvent on forum](https://www.elektroda.com/rtvforum/find.php?q=removeClockEvent). |
|
||||
| resetSVM | | Resets all SVM and clears all scripts.<br/><br/>See also [resetSVM on forum](https://www.elektroda.com/rtvforum/find.php?q=resetSVM). |
|
||||
| restart | | Reboots the module.<br/><br/>See also [restart on forum](https://www.elektroda.com/rtvforum/find.php?q=restart). |
|
||||
@ -221,11 +221,11 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| ShortName | [Name] | Sets the short name of the device.<br/><br/>See also [ShortName on forum](https://www.elektroda.com/rtvforum/find.php?q=ShortName). |
|
||||
| showChannelValues | | Log channel values.<br/><br/>See also [showChannelValues on forum](https://www.elektroda.com/rtvforum/find.php?q=showChannelValues). |
|
||||
| showgpi | NULL | Log stat of all GPIs.<br/><br/>See also [showgpi on forum](https://www.elektroda.com/rtvforum/find.php?q=showgpi). |
|
||||
| SHT_Calibrate | | Calibrate the SHT Sensor as Tolerance is +/-2 degrees C.<br/><br/>Example: SHT_Calibrate -4 10<br/><br/>See also [SHT_Calibrate on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_Calibrate). |
|
||||
| SHT_Calibrate | [DeltaTemp][DeltaHumidity] | Calibrate the SHT Sensor as Tolerance is +/-2 degrees C.<br/><br/>Example: SHT_Calibrate -4 10<br/><br/>See also [SHT_Calibrate on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_Calibrate). |
|
||||
| SHT_ClearStatus | | Clear Sensor Status.<br/><br/>Example: SHT_ClearStatusCmd<br/><br/>See also [SHT_ClearStatus on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_ClearStatus). |
|
||||
| SHT_cycle | [int] | This is the interval between measurements in seconds, by default 10. Max is 255.<br/><br/>Example: SHT_Cycle 60<br/><br/>See also [SHT_cycle on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_cycle). |
|
||||
| SHT_GetStatus | | Get Sensor Status.<br/><br/>Example: SHT_GetStatusCmd<br/><br/>See also [SHT_GetStatus on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_GetStatus). |
|
||||
| SHT_Heater | | Activate or Deactivate Heater (0 / 1).<br/><br/>Example: SHT_Heater 1<br/><br/>See also [SHT_Heater on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_Heater). |
|
||||
| SHT_Heater | [1or0] | Activate or Deactivate Heater (0 / 1).<br/><br/>Example: SHT_Heater 1<br/><br/>See also [SHT_Heater on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_Heater). |
|
||||
| SHT_LaunchPer | [msb][lsb] | Launch/Change periodical capture for SHT Sensor.<br/><br/>Example: SHT_LaunchPer 0x23 0x22<br/><br/>See also [SHT_LaunchPer on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_LaunchPer). |
|
||||
| SHT_Measure | | Retrieve OneShot measurement for SHT.<br/><br/>Example: SHT_Measure<br/><br/>See also [SHT_Measure on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_Measure). |
|
||||
| SHT_MeasurePer | | Retrieve Periodical measurement for SHT.<br/><br/>Example: SHT_Measure<br/><br/>See also [SHT_MeasurePer on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_MeasurePer). |
|
||||
|
||||
@ -330,7 +330,7 @@
|
||||
"fn": "CHT_Calibrate",
|
||||
"file": "driver/drv_cht8305.c",
|
||||
"requires": "",
|
||||
"examples": "SHT_Calibrate -4 10 <br /> meaning -4 on current temp reading and +10 on current humidity reading"
|
||||
"examples": "CHT_Calibrate -4 10 <br /> meaning -4 on current temp reading and +10 on current humidity reading"
|
||||
},
|
||||
{
|
||||
"name": "CHT_Cycle",
|
||||
@ -560,7 +560,7 @@
|
||||
{
|
||||
"name": "DSTime",
|
||||
"args": "[timeSeconds]",
|
||||
"descr": "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",
|
||||
"descr": "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.",
|
||||
"fn": "DoorDeepSleep_SetTime",
|
||||
"file": "drv/drv_doorSensorWithDeepSleep.c",
|
||||
"requires": "",
|
||||
@ -1576,8 +1576,8 @@
|
||||
},
|
||||
{
|
||||
"name": "PWMFrequency",
|
||||
"args": "CMD_PWMFrequency",
|
||||
"descr": "",
|
||||
"args": "[FrequencyInHz]",
|
||||
"descr": "Sets the global PWM frequency.",
|
||||
"fn": "NULL);",
|
||||
"file": "cmnds/cmd_main.c",
|
||||
"requires": "",
|
||||
@ -1585,8 +1585,8 @@
|
||||
},
|
||||
{
|
||||
"name": "PWMG_Raw",
|
||||
"args": "CMD_PWMG_Raw",
|
||||
"descr": "",
|
||||
"args": "",
|
||||
"descr": "PWM grouping (synchronous PWM)",
|
||||
"fn": "NULL);",
|
||||
"file": "driver/drv_pwm_groups.c",
|
||||
"requires": "",
|
||||
@ -1594,8 +1594,8 @@
|
||||
},
|
||||
{
|
||||
"name": "PWMG_Set",
|
||||
"args": "CMD_PWMG_Set",
|
||||
"descr": "",
|
||||
"args": "Duty1Percent Duty2Percent DeadTimePercent Frequency PinA PinB",
|
||||
"descr": "PWM grouping (synchronous PWM)",
|
||||
"fn": "NULL);",
|
||||
"file": "driver/drv_pwm_groups.c",
|
||||
"requires": "",
|
||||
@ -1604,7 +1604,7 @@
|
||||
{
|
||||
"name": "reboot",
|
||||
"args": "",
|
||||
"descr": "Same as restart. Needed for bkWriter 1.60 which sends 'reboot' cmd before trying to get bus",
|
||||
"descr": "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.",
|
||||
"fn": "CMD_Restart",
|
||||
"file": "cmnds/cmd_main.c",
|
||||
"requires": "",
|
||||
@ -1918,7 +1918,7 @@
|
||||
},
|
||||
{
|
||||
"name": "SHT_Calibrate",
|
||||
"args": "",
|
||||
"args": "[DeltaTemp][DeltaHumidity]",
|
||||
"descr": "Calibrate the SHT Sensor as Tolerance is +/-2 degrees C.",
|
||||
"fn": "SHT3X_Calibrate",
|
||||
"file": "driver/drv_sht3x.c",
|
||||
@ -1954,7 +1954,7 @@
|
||||
},
|
||||
{
|
||||
"name": "SHT_Heater",
|
||||
"args": "",
|
||||
"args": "[1or0]",
|
||||
"descr": "Activate or Deactivate Heater (0 / 1)",
|
||||
"fn": "SHT3X_Heater",
|
||||
"file": "driver/drv_sht3x.c",
|
||||
|
||||
@ -696,7 +696,7 @@ void CMD_Init_Early() {
|
||||
//cmddetail:"examples":""}
|
||||
CMD_RegisterCommand("restart", CMD_Restart, NULL);
|
||||
//cmddetail:{"name":"reboot","args":"",
|
||||
//cmddetail:"descr":"Same as restart. Needed for bkWriter 1.60 which sends 'reboot' cmd before trying to get bus",
|
||||
//cmddetail:"descr":"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.",
|
||||
//cmddetail:"fn":"CMD_Restart","file":"cmnds/cmd_main.c","requires":"",
|
||||
//cmddetail:"examples":""}
|
||||
CMD_RegisterCommand("reboot", CMD_Restart, NULL);
|
||||
@ -818,8 +818,8 @@ void CMD_Init_Early() {
|
||||
//cmddetail:"examples":""}
|
||||
CMD_RegisterCommand("TimeSize", CMD_TimeSize, NULL);
|
||||
|
||||
//cmddetail:{"name":"PWMFrequency","args":"CMD_PWMFrequency",
|
||||
//cmddetail:"descr":"",
|
||||
//cmddetail:{"name":"PWMFrequency","args":"[FrequencyInHz]",
|
||||
//cmddetail:"descr":"Sets the global PWM frequency.",
|
||||
//cmddetail:"fn":"NULL);","file":"cmnds/cmd_main.c","requires":"",
|
||||
//cmddetail:"examples":""}
|
||||
CMD_RegisterCommand("PWMFrequency", CMD_PWMFrequency, NULL);
|
||||
|
||||
@ -157,7 +157,7 @@ void CHT8305_Init() {
|
||||
//cmddetail:{"name":"CHT_Calibrate","args":"[DeltaTemp][DeltaHumidity]",
|
||||
//cmddetail:"descr":"Calibrate the CHT Sensor as Tolerance is +/-2 degrees C.",
|
||||
//cmddetail:"fn":"CHT_Calibrate","file":"driver/drv_cht8305.c","requires":"",
|
||||
//cmddetail:"examples":"SHT_Calibrate -4 10 <br /> meaning -4 on current temp reading and +10 on current humidity reading"}
|
||||
//cmddetail:"examples":"CHT_Calibrate -4 10 <br /> meaning -4 on current temp reading and +10 on current humidity reading"}
|
||||
CMD_RegisterCommand("CHT_Calibrate", CHT_Calibrate, NULL);
|
||||
//cmddetail:{"name":"CHT_Cycle","args":"[IntervalSeconds]",
|
||||
//cmddetail:"descr":"This is the interval between measurements in seconds, by default 1. Max is 255.",
|
||||
|
||||
@ -35,323 +35,272 @@ static driver_t g_drivers[] = {
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"TuyaMCU is a protocol used for communication between WiFI module and external MCU. This protocol is using usually RX1/TX1 port of BK chips. See [TuyaMCU dimmer example](https://www.elektroda.com/rtvforum/topic3929151.html), see [TH06 LCD humidity/temperature sensor example](https://www.elektroda.com/rtvforum/topic3942730.html), see [fan controller example](https://www.elektroda.com/rtvforum/topic3908093.html), see [simple switch example](https://www.elektroda.com/rtvforum/topic3906443.html)",
|
||||
//drvdetail:"requires":""}
|
||||
{ "TuyaMCU", TuyaMCU_Init, TuyaMCU_RunEverySecond, NULL, TuyaMCU_RunFrame, NULL, NULL, false },
|
||||
//drvdetail:{"name":"tmSensor",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"The tmSensor must be used only when TuyaMCU is already started. tmSensor is a TuyaMcu Sensor, it's used for Low Power TuyaMCU communication on devices like TuyaMCU door sensor, or TuyaMCU humidity sensor. After device reboots, tmSensor uses TuyaMCU to request data update from the sensor and reports it on MQTT. Then MCU turns off WiFi module again and goes back to sleep. See an [example door sensor here](https://www.elektroda.com/rtvforum/topic3914412.html).",
|
||||
//drvdetail:"requires":""}
|
||||
{ "tmSensor", TuyaMCU_Sensor_Init, TuyaMCU_Sensor_RunEverySecond, NULL, NULL, NULL, NULL, false },
|
||||
#endif
|
||||
#if ENABLE_DRIVER_FREEZE
|
||||
//drvdetail:{"name":"FREEZE",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"Freeze is a test driver for watchdog. Enabling this will freeze device main loop.",
|
||||
//drvdetail:"requires":""}
|
||||
{ "Freeze", Freeze_Init, Freeze_OnEverySecond, NULL, Freeze_RunFrame, NULL, NULL, false },
|
||||
#endif
|
||||
#if ENABLE_DRIVER_PIXELANIM
|
||||
//drvdetail:{"name":"PixelAnim",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"PixelAnim provides a simple set of WS2812B animations",
|
||||
//drvdetail:"requires":""}
|
||||
{ "PixelAnim", PixelAnim_Init, NULL, NULL, PixelAnim_SetAnimQuickTick, NULL, NULL, false },
|
||||
#endif
|
||||
|
||||
#if ENABLE_NTP
|
||||
//drvdetail:{"name":"NTP",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"NTP driver is required to get current time and date from web. Without it, there is no correct datetime. Put 'startDriver NTP' in short startup line or autoexec.bat to run it on start.",
|
||||
//drvdetail:"requires":""}
|
||||
{ "NTP", NTP_Init, NTP_OnEverySecond, NTP_AppendInformationToHTTPIndexPage, NULL, NULL, NULL, false },
|
||||
#endif
|
||||
#if ENABLE_HTTPBUTTONS
|
||||
//drvdetail:{"name":"HTTPButtons",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"This driver allows you to create custom, scriptable buttons on main WWW page. You can create those buttons in autoexec.bat and assign commands to them",
|
||||
//drvdetail:"requires":""}
|
||||
{ "HTTPButtons", DRV_InitHTTPButtons, NULL, NULL, NULL, NULL, NULL, false },
|
||||
#endif
|
||||
#if ENABLE_TEST_DRIVERS
|
||||
//drvdetail:{"name":"TESTPOWER",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"This is a fake POWER measuring socket driver, only for testing",
|
||||
//drvdetail:"requires":""}
|
||||
{ "TESTPOWER", Test_Power_Init, Test_Power_RunEverySecond, BL09XX_AppendInformationToHTTPIndexPage, NULL, NULL, NULL, false },
|
||||
//drvdetail:{"name":"TESTLED",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"This is a fake I2C LED driver, only for testing",
|
||||
//drvdetail:"requires":""}
|
||||
{ "TESTLED", Test_LED_Driver_Init, Test_LED_Driver_RunEverySecond, NULL, NULL, NULL, Test_LED_Driver_OnChannelChanged, false },
|
||||
#endif
|
||||
#if ENABLE_I2C
|
||||
//drvdetail:{"name":"I2C",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"Generic I2C, not used for LED drivers, but may be useful for displays or port expanders. Supports both hardware and software I2C.",
|
||||
//drvdetail:"requires":""}
|
||||
{ "I2C", DRV_I2C_Init, DRV_I2C_EverySecond, NULL, NULL, NULL, NULL, false },
|
||||
#endif
|
||||
#if ENABLE_DRIVER_BL0942
|
||||
//drvdetail:{"name":"qq",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"Bqqqqqqqqqq ",
|
||||
//drvdetail:"requires":""}
|
||||
{ "RN8209", RN8209_Init, RN8029_RunEverySecond, BL09XX_AppendInformationToHTTPIndexPage, NULL, NULL, NULL, false },
|
||||
#endif
|
||||
#if ENABLE_DRIVER_BL0942
|
||||
//drvdetail:{"name":"BL0942",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"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)",
|
||||
//drvdetail:"requires":""}
|
||||
{ "BL0942", BL0942_UART_Init, BL0942_UART_RunEverySecond, BL09XX_AppendInformationToHTTPIndexPage, NULL, NULL, NULL, false },
|
||||
#endif
|
||||
#if ENABLE_DRIVER_PWM_GROUP
|
||||
//drvdetail:{"name":"PWMG",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":" ",
|
||||
//drvdetail:"requires":""}
|
||||
{ "PWMG", PWMG_Init, NULL, NULL, NULL, NULL, NULL, false },
|
||||
#endif
|
||||
#if ENABLE_DRIVER_BL0942SPI
|
||||
//drvdetail:{"name":"BL0942SPI",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"BL0942 is a power-metering chip which uses SPI protocol for communication. 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). ",
|
||||
//drvdetail:"requires":""}
|
||||
{ "BL0942SPI", BL0942_SPI_Init, BL0942_SPI_RunEverySecond, BL09XX_AppendInformationToHTTPIndexPage, NULL, NULL, NULL, false },
|
||||
#endif
|
||||
#if ENABLE_DRIVER_CHARGINGLIMIT
|
||||
//drvdetail:{"name":"ChargingLimit",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"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).",
|
||||
//drvdetail:"requires":""}
|
||||
{ "ChargingLimit", ChargingLimit_Init, ChargingLimit_OnEverySecond, ChargingLimit_AppendInformationToHTTPIndexPage, NULL, NULL, NULL, false },
|
||||
#endif
|
||||
#if ENABLE_DRIVER_BL0937
|
||||
//drvdetail:{"name":"BL0937",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"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",
|
||||
//drvdetail:"requires":""}
|
||||
{ "BL0937", BL0937_Init, BL0937_RunEverySecond, BL09XX_AppendInformationToHTTPIndexPage, NULL, NULL, NULL, false },
|
||||
#endif
|
||||
#if ENABLE_DRIVER_CSE7766
|
||||
//drvdetail:{"name":"CSE7766",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"BL0942 is a power-metering chip which uses UART protocol for communication. It's usually connected to TX1/RX1 port of BK",
|
||||
//drvdetail:"requires":""}
|
||||
{ "CSE7766", CSE7766_Init, CSE7766_RunEverySecond, BL09XX_AppendInformationToHTTPIndexPage, NULL, NULL, NULL, false },
|
||||
#endif
|
||||
#if ENABLE_DRIVER_MAX6675
|
||||
//drvdetail:{"name":"MAX6675",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"BQQQK",
|
||||
//drvdetail:"requires":""}
|
||||
{ "MAX6675", MAX6675_Init, MAX6675_RunEverySecond, NULL, NULL, NULL, NULL, false },
|
||||
#endif
|
||||
#if ENABLE_DRIVER_PT6523
|
||||
//drvdetail:{"name":"PT6523",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"BQQQK",
|
||||
//drvdetail:"requires":""}
|
||||
{ "PT6523", PT6523_Init, PT6523_RunFrame, NULL, NULL, NULL, NULL, false },
|
||||
#endif
|
||||
#if ENABLE_DRIVER_TEXTSCROLLER
|
||||
//drvdetail:{"name":"TextScroller",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"BQQQK",
|
||||
//drvdetail:"requires":""}
|
||||
{ "TextScroller", TS_Init, NULL, NULL, TS_RunQuickTick, NULL, NULL, false },
|
||||
#endif
|
||||
#if ENABLE_DRIVER_SM16703P
|
||||
//drvdetail:{"name":"SM16703P",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"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.",
|
||||
//drvdetail:"requires":""}
|
||||
{ "SM16703P", SM16703P_Init, NULL, NULL, NULL, NULL, NULL, false },
|
||||
#endif
|
||||
#if PLATFORM_BEKEN
|
||||
//drvdetail:{"name":"IR",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"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)",
|
||||
//drvdetail:"requires":""}
|
||||
{ "IR", DRV_IR_Init, NULL, NULL, DRV_IR_RunFrame, NULL, NULL, false },
|
||||
#endif
|
||||
#if defined(PLATFORM_BEKEN) || defined(WINDOWS) || defined(PLATFORM_BL602)
|
||||
//drvdetail:{"name":"DDP",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"DDP is a LED control protocol that is using UDP. You can use xLights or any other app to control OBK LEDs that way.",
|
||||
//drvdetail:"requires":""}
|
||||
{ "DDP", DRV_DDP_Init, NULL, DRV_DDP_AppendInformationToHTTPIndexPage, DRV_DDP_RunFrame, DRV_DDP_Shutdown, NULL, false },
|
||||
//drvdetail:{"name":"SSDP",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"SSDP is a discovery protocol, so BK devices can show up in, for example, Windows network section",
|
||||
//drvdetail:"requires":""}
|
||||
{ "SSDP", DRV_SSDP_Init, DRV_SSDP_RunEverySecond, NULL, DRV_SSDP_RunQuickTick, DRV_SSDP_Shutdown, NULL, false },
|
||||
//drvdetail:{"name":"DGR",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"Tasmota Device groups driver. See [forum example](https://www.elektroda.com/rtvforum/topic3925472.html) and [video tutorial](https://www.youtube.com/watch?v=e1xcq3OUR5M&ab_channel=Elektrodacom)",
|
||||
//drvdetail:"requires":""}
|
||||
{ "DGR", DRV_DGR_Init, DRV_DGR_RunEverySecond, DRV_DGR_AppendInformationToHTTPIndexPage, DRV_DGR_RunQuickTick, DRV_DGR_Shutdown, DRV_DGR_OnChannelChanged, false },
|
||||
#endif
|
||||
#if ENABLE_DRIVER_WEMO
|
||||
//drvdetail:{"name":"Wemo",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"Wemo emulation for Alexa. You must also start SSDP so it can run, because it depends on SSDP discovery.",
|
||||
//drvdetail:"requires":""}
|
||||
{ "Wemo", WEMO_Init, NULL, WEMO_AppendInformationToHTTPIndexPage, NULL, NULL, NULL, false },
|
||||
#endif
|
||||
#if ENABLE_DRIVER_HUE
|
||||
//drvdetail:{"name":"Hue",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"Hue emulation for Alexa. You must also start SSDP so it can run, because it depends on SSDP discovery.",
|
||||
//drvdetail:"requires":""}
|
||||
{ "Hue", HUE_Init, NULL, HUE_AppendInformationToHTTPIndexPage, NULL, NULL, NULL, false },
|
||||
#endif
|
||||
#if defined(PLATFORM_BEKEN) || defined(WINDOWS)
|
||||
//drvdetail:{"name":"PWMToggler",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"PWMToggler is a custom abstraction layer that can run on top of raw PWM channels. It provides ability to turn off/on the PWM while keeping it's value, which is not possible by direct channel operations. It can be used for some custom devices with extra lights/lasers. See example [here](https://www.elektroda.com/rtvforum/topic3939064.html).",
|
||||
//drvdetail:"requires":""}
|
||||
{ "PWMToggler", DRV_InitPWMToggler, NULL, DRV_Toggler_AppendInformationToHTTPIndexPage, NULL, NULL, NULL, false },
|
||||
//drvdetail:{"name":"DoorSensor",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"DoorSensor is using deep sleep to preserve battery. This is used for devices without TuyaMCU, where BK deep sleep and wakeup on GPIO is used. This drives requires you to set a DoorSensor pin. Change on door sensor pin wakes up the device. If there are no changes for some time, device goes to sleep. See example [here](https://www.elektroda.com/rtvforum/topic3960149.html). If your door sensor does not wake up in certain pos, please use DSEdge command (try all 3 options, default is 2). ",
|
||||
//drvdetail:"requires":""}
|
||||
{ "DoorSensor", DoorDeepSleep_Init, DoorDeepSleep_OnEverySecond, DoorDeepSleep_AppendInformationToHTTPIndexPage, NULL, NULL, DoorDeepSleep_OnChannelChanged, false },
|
||||
|
||||
#if ENABLE_DRIVER_MAX72XX
|
||||
//drvdetail:{"name":"MAX72XX_Clock",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"Simple hardcoded driver for MAX72XX clock. Requires manual start of MAX72XX driver with MAX72XX setup and NTP start.",
|
||||
//drvdetail:"requires":""}
|
||||
{ "MAX72XX_Clock", DRV_MAX72XX_Clock_Init, DRV_MAX72XX_Clock_OnEverySecond, NULL, DRV_MAX72XX_Clock_RunFrame, NULL, NULL, false },
|
||||
#endif
|
||||
//drvdetail:{"name":"ADCButton",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"This allows you to connect multiple buttons on single ADC pin. Each button must have a different resistor value, this works by probing the voltage on ADC from a resistor divider. You need to select AB_Map first. See forum post for [details](https://www.elektroda.com/rtvforum/viewtopic.php?p=20541973#20541973).",
|
||||
//drvdetail:"requires":""}
|
||||
{ "ADCButton", DRV_ADCButton_Init, NULL, NULL, DRV_ADCButton_RunFrame, NULL, NULL, false },
|
||||
#endif
|
||||
#if ENABLE_DRIVER_LED
|
||||
//drvdetail:{"name":"SM2135",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"SM2135 custom-'I2C' LED driver for RGBCW lights. This will start automatically if you set both SM2135 pin roles. This may need you to remap the RGBCW indexes with SM2135_Map command",
|
||||
//drvdetail:"requires":""}
|
||||
{ "SM2135", SM2135_Init, NULL, NULL, NULL, NULL, NULL, false },
|
||||
//drvdetail:{"name":"BP5758D",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"BP5758D custom-'I2C' LED driver for RGBCW lights. This will start automatically if you set both BP5758D pin roles. This may need you to remap the RGBCW indexes with BP5758D_Map command. This driver is used in some of BL602/Sonoff bulbs, see [video flashing tutorial here](https://www.youtube.com/watch?v=L6d42IMGhHw)",
|
||||
//drvdetail:"requires":""}
|
||||
{ "BP5758D", BP5758D_Init, NULL, NULL, NULL, NULL, NULL, false },
|
||||
//drvdetail:{"name":"BP1658CJ",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"BP1658CJ custom-'I2C' LED driver for RGBCW lights. This will start automatically if you set both BP1658CJ pin roles. This may need you to remap the RGBCW indexes with BP1658CJ_Map command",
|
||||
//drvdetail:"requires":""}
|
||||
{ "BP1658CJ", BP1658CJ_Init, NULL, NULL, NULL, NULL, NULL, false },
|
||||
//drvdetail:{"name":"SM2235",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"SM2335 andd SM2235 custom-'I2C' LED driver for RGBCW lights. This will start automatically if you set both SM2235 pin roles. This may need you to remap the RGBCW indexes with SM2235_Map command. This driver also works for SM2185N.",
|
||||
//drvdetail:"requires":""}
|
||||
{ "SM2235", SM2235_Init, NULL, NULL, NULL, NULL, NULL, false },
|
||||
#endif
|
||||
|
||||
#if ENABLE_DRIVER_BMP280
|
||||
//drvdetail:{"name":"BMP280",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"BMP280 is a Temperature and Pressure sensor with I2C interface.",
|
||||
//drvdetail:"requires":""}
|
||||
{ "BMP280", BMP280_Init, BMP280_OnEverySecond, BMP280_AppendInformationToHTTPIndexPage, NULL, NULL, NULL, false },
|
||||
#endif
|
||||
#if defined(PLATFORM_BEKEN) || defined(WINDOWS)
|
||||
//drvdetail:{"name":"CHT8305",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"CHT8305 is a Temperature and Humidity sensor with I2C interface.",
|
||||
//drvdetail:"requires":""}
|
||||
{ "CHT8305", CHT8305_Init, CHT8305_OnEverySecond, CHT8305_AppendInformationToHTTPIndexPage, NULL, NULL, NULL, false },
|
||||
//drvdetail:{"name":"MCP9808",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"MCP9808 is a Temperature sensor with I2C interface and an external wakeup pin, see [docs](https://www.elektroda.pl/rtvforum/topic3988466.html).",
|
||||
//drvdetail:"requires":""}
|
||||
{ "MCP9808", MCP9808_Init, MCP9808_OnEverySecond, MCP9808_AppendInformationToHTTPIndexPage, NULL, NULL, NULL, false },
|
||||
//drvdetail:{"name":"KP18058",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"KP18058 I2C LED driver. Supports also KP18068. Working, see reverse-engineering [topic](https://www.elektroda.pl/rtvforum/topic3991620.html)",
|
||||
//drvdetail:"requires":""}
|
||||
{ "KP18058", KP18058_Init, NULL, NULL, NULL, NULL, NULL, false },
|
||||
#if ENABLE_DRIVER_MAX72XX
|
||||
//drvdetail:{"name":"MAX72XX",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"MAX72XX LED matrix display driver with font and simple script interface. See [protocol explanation](https://www.elektroda.pl/rtvforum/viewtopic.php?p=18040628#18040628)",
|
||||
//drvdetail:"requires":""}
|
||||
{ "MAX72XX", DRV_MAX72XX_Init, NULL, NULL, NULL, NULL, NULL, false },
|
||||
#endif
|
||||
//drvdetail:{"name":"ADCSmoother",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"qq",
|
||||
//drvdetail:"requires":""}
|
||||
{ "ADCSmoother", DRV_ADCSmoother_Init, NULL, NULL, DRV_ADCSmoother_RunFrame, NULL, NULL, false },
|
||||
//drvdetail:{"name":"SHT3X",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"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)",
|
||||
//drvdetail:"requires":""}
|
||||
{ "SHT3X", SHT3X_Init, SHT3X_OnEverySecond, SHT3X_AppendInformationToHTTPIndexPage, NULL, SHT3X_StopDriver, NULL, false },
|
||||
//drvdetail:{"name":"SGP",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"SGP Air Quality sensor with I2C interface. See [this DIY sensor](https://www.elektroda.com/rtvforum/topic3967174.html) for setup information.",
|
||||
//drvdetail:"requires":""}
|
||||
{ "SGP", SGP_Init, SGP_OnEverySecond, SGP_AppendInformationToHTTPIndexPage, NULL, SGP_StopDriver, NULL, false },
|
||||
#if ENABLE_DRIVER_AHT2X
|
||||
//drvdetail:{"name":"AHT2X",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"AHT Humidity/temperature sensor. Supported sensors are: AHT10, AHT2X, AHT30.",
|
||||
//drvdetail:"requires":""}
|
||||
{ "AHT2X", AHT2X_Init, AHT2X_OnEverySecond, AHT2X_AppendInformationToHTTPIndexPage, NULL, AHT2X_StopDriver, NULL, false },
|
||||
#endif
|
||||
//drvdetail:{"name":"ShiftRegister",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"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)",
|
||||
//drvdetail:"requires":""}
|
||||
{ "ShiftRegister", Shift_Init, Shift_OnEverySecond, NULL, NULL, NULL, Shift_OnChannelChanged, false },
|
||||
#endif
|
||||
#if ENABLE_DRIVER_HT16K33
|
||||
//drvdetail:{"name":"HT16K33",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"Driver for 16-segment LED display with I2C. See [protocol explanation](https://www.elektroda.pl/rtvforum/topic3984616.html)",
|
||||
//drvdetail:"requires":""}
|
||||
{ "HT16K33", HT16K33_Init, NULL, NULL, NULL,NULL, NULL, false },
|
||||
#endif
|
||||
// Shared driver for TM1637, GN6932, TM1638 - TM_GN_Display_SharedInit
|
||||
// Shared driver for TM1637, GN6932, TM1638 - TM_GN_Display_SharedInit
|
||||
#if ENABLE_DRIVER_TMGN
|
||||
//drvdetail:{"name":"TM1637",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"Driver for 7-segment LED display with DIO/CLK interface.",
|
||||
//drvdetail:"requires":""}
|
||||
{ "TM1637", TM1637_Init, NULL, NULL, TMGN_RunQuickTick,NULL, NULL, false },
|
||||
//drvdetail:{"name":"GN6932",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"Driver for 7-segment LED display with DIO/CLK/STB interface. See [this topic](https://www.elektroda.com/rtvforum/topic3971252.html) for details.",
|
||||
//drvdetail:"requires":""}
|
||||
{ "GN6932", GN6932_Init, NULL, NULL, TMGN_RunQuickTick, NULL, NULL, false },
|
||||
//drvdetail:{"name":"TM1638",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"Driver for 7-segment LED display with DIO/CLK/STB interface. TM1638 is very similiar to GN6932 and TM1637. See [this topic](https://www.elektroda.com/rtvforum/viewtopic.php?p=20553628#20553628) for details.",
|
||||
//drvdetail:"requires":""}
|
||||
{ "TM1638", TM1638_Init, NULL, NULL, TMGN_RunQuickTick,NULL, NULL, false },
|
||||
|
||||
//drvdetail:{"name":"HD2015",
|
||||
//drvdetail:"title":"HD2015",
|
||||
//drvdetail:"descr":"TODO",
|
||||
//drvdetail:"requires":""}
|
||||
{ "HD2015", HD2015_Init, NULL, NULL, TMGN_RunQuickTick,NULL, NULL, false },
|
||||
|
||||
#endif
|
||||
#if ENABLE_DRIVER_BATTERY
|
||||
//drvdetail:{"name":"Battery",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"Custom mechanism to measure battery level with ADC and an optional relay. See [example here](https://www.elektroda.com/rtvforum/topic3959103.html).",
|
||||
//drvdetail:"requires":""}
|
||||
{ "Battery", Batt_Init, Batt_OnEverySecond, Batt_AppendInformationToHTTPIndexPage, NULL, Batt_StopDriver, NULL, false },
|
||||
#endif
|
||||
#if ENABLE_DRIVER_BRIDGE
|
||||
//drvdetail:{"name":"Bridge",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"A bridge relay driver, added for [TONGOU TO-Q-SY1-JWT Din Rail Switch](https://www.elektroda.com/rtvforum/topic3934580.html). See linked topic for info.",
|
||||
//drvdetail:"requires":""}
|
||||
{ "Bridge", Bridge_driver_Init, NULL, NULL, Bridge_driver_QuickFrame, Bridge_driver_DeInit, Bridge_driver_OnChannelChanged, false }
|
||||
#endif
|
||||
};
|
||||
|
||||
|
||||
@ -95,13 +95,13 @@ static commandResult_t CMD_PWMG_Raw(const void* context, const char* cmd, const
|
||||
// backlog startDriver PWMG; PWMG_Set 10 10 10 1000
|
||||
void PWMG_Init() {
|
||||
|
||||
//cmddetail:{"name":"PWMG_Raw","args":"CMD_PWMG_Raw",
|
||||
//cmddetail:"descr":"",
|
||||
//cmddetail:{"name":"PWMG_Raw","args":"",
|
||||
//cmddetail:"descr":"PWM grouping (synchronous PWM)",
|
||||
//cmddetail:"fn":"NULL);","file":"driver/drv_pwm_groups.c","requires":"",
|
||||
//cmddetail:"examples":""}
|
||||
CMD_RegisterCommand("PWMG_Raw", CMD_PWMG_Raw, NULL);
|
||||
//cmddetail:{"name":"PWMG_Set","args":"CMD_PWMG_Set",
|
||||
//cmddetail:"descr":"",
|
||||
//cmddetail:{"name":"PWMG_Set","args":"Duty1Percent Duty2Percent DeadTimePercent Frequency PinA PinB",
|
||||
//cmddetail:"descr":"PWM grouping (synchronous PWM)",
|
||||
//cmddetail:"fn":"NULL);","file":"driver/drv_pwm_groups.c","requires":"",
|
||||
//cmddetail:"examples":""}
|
||||
CMD_RegisterCommand("PWMG_Set", CMD_PWMG_Set, NULL);
|
||||
|
||||
@ -447,7 +447,7 @@ void SHT3X_Init() {
|
||||
//cmddetail:"fn":"SHT_cycle","file":"drv/drv_sht3x.c","requires":"",
|
||||
//cmddetail:"examples":"SHT_Cycle 60"}
|
||||
CMD_RegisterCommand("SHT_cycle", SHT_cycle, NULL);
|
||||
//cmddetail:{"name":"SHT_Calibrate","args":"",
|
||||
//cmddetail:{"name":"SHT_Calibrate","args":"[DeltaTemp][DeltaHumidity]",
|
||||
//cmddetail:"descr":"Calibrate the SHT Sensor as Tolerance is +/-2 degrees C.",
|
||||
//cmddetail:"fn":"SHT3X_Calibrate","file":"driver/drv_sht3x.c","requires":"",
|
||||
//cmddetail:"examples":"SHT_Calibrate -4 10"}
|
||||
@ -472,7 +472,7 @@ void SHT3X_Init() {
|
||||
//cmddetail:"fn":"SHT3X_Measure","file":"driver/drv_sht3x.c","requires":"",
|
||||
//cmddetail:"examples":"SHT_Measure"}
|
||||
CMD_RegisterCommand("SHT_Measure", SHT3X_Measure, NULL);
|
||||
//cmddetail:{"name":"SHT_Heater","args":"",
|
||||
//cmddetail:{"name":"SHT_Heater","args":"[1or0]",
|
||||
//cmddetail:"descr":"Activate or Deactivate Heater (0 / 1)",
|
||||
//cmddetail:"fn":"SHT3X_Heater","file":"driver/drv_sht3x.c","requires":"",
|
||||
//cmddetail:"examples":"SHT_Heater 1"}
|
||||
|
||||
Reference in New Issue
Block a user