mirror/OpenBK7231T_App
3
0
Fork 0
mirror of https://github.com/openshwprojects/OpenBK7231T_App.git synced 2026-02-04 07:35:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
Tester23
2026-01-08 01:18:36 +01:00
parent 5f840a6181
commit 64f5e8b31d
4 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/commands-extended.md
View File

@ -6,7 +6,7 @@ Do not add anything here, as it will overwritten with next rebuild.
| Command | Arguments | Description | Location |
|:------------- |:-------------:|:----- | ------:|
| AB_Map | [int] | Sets margines for ADC button codes. For given N margins, there are N+1 possible ADC button values (one should be reserved for 'no button').<br/><br/>See also [AB_Map on forum](https://www.elektroda.com/rtvforum/find.php?q=AB_Map). | File: driver/drv_adcButton.c<br/>Function: Cmd_ADCButtonMap |
| ACMode | CMD_ACMode | .<br/><br/>See also [ACMode on forum](https://www.elektroda.com/rtvforum/find.php?q=ACMode). | File: driver/drv_tclAC.c<br/>Function: CMD_ACMode |
| ACMode | [Mode] | Sets the climate mode (off, cool, dry, fan_only, heat, heatcool, auto).<br/><br/>See also [ACMode on forum](https://www.elektroda.com/rtvforum/find.php?q=ACMode). | File: driver/drv_tclAC.c<br/>Function: CMD_ACMode |
| ADCSmoother | [Pindex] [TotalSamples] [SampleIntervalMS] [TargetChannelADCValue] [MarginValue] [TargetChannel0or1] | Starts the ADC smoother with given configuration.<br/><br/>See also [ADCSmoother on forum](https://www.elektroda.com/rtvforum/find.php?q=ADCSmoother). | File: driver/drv_adcSmoother.c<br/>Function: Cmd_SetupADCSmoother |
| AddChangeHandler | [Variable][Relation][Constant][Command] | Trigger based on change in channel value (for example channel 0 becoming 100), or for a voltage/current/power/frequency change for BL0942/BL0937. This supports multiple relations, like ==, !=, >=, < etc. The Variable name for channel is Channel0, Channel2, etc, for BL0XXX it can be 'Power', 'Current', 'Voltage' or 'Frequency'.<br/><br/>Example: Values are compared as integers. This affects Current (*1000) and Frequency (*100). Example handler where Current is greather than 2Amps:<br/> `AddChangeHandler Current > 2000 SetChannel 1 0`<br/><br/>See also [AddChangeHandler on forum](https://www.elektroda.com/rtvforum/find.php?q=AddChangeHandler). | File: cmnds/cmd_eventHandlers.c<br/>Function: CMD_AddChangeHandler |
| AddChannel | [ChannelIndex][ValueToAdd][ClampMin][ClampMax][bWrapInsteadOfClamp] | Adds a given value to the channel. Can be used to change PWM brightness. Clamp min and max arguments are optional.<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 |

2
docs/commands.md
View File

@ -9,7 +9,7 @@ Do not add anything here, as it will overwritten with next rebuild.
| Command | Arguments | Description |
|:------------- |:------------- |:----- |
| AB_Map | [int] | Sets margines for ADC button codes. For given N margins, there are N+1 possible ADC button values (one should be reserved for 'no button').<br/><br/>See also [AB_Map on forum](https://www.elektroda.com/rtvforum/find.php?q=AB_Map). |
| ACMode | CMD_ACMode | .<br/><br/>See also [ACMode on forum](https://www.elektroda.com/rtvforum/find.php?q=ACMode). |
| ACMode | [Mode] | Sets the climate mode (off, cool, dry, fan_only, heat, heatcool, auto).<br/><br/>See also [ACMode on forum](https://www.elektroda.com/rtvforum/find.php?q=ACMode). |
| ADCSmoother | [Pindex] [TotalSamples] [SampleIntervalMS] [TargetChannelADCValue] [MarginValue] [TargetChannel0or1] | Starts the ADC smoother with given configuration.<br/><br/>See also [ADCSmoother on forum](https://www.elektroda.com/rtvforum/find.php?q=ADCSmoother). |
| AddChangeHandler | [Variable][Relation][Constant][Command] | Trigger based on change in channel value (for example channel 0 becoming 100), or for a voltage/current/power/frequency change for BL0942/BL0937. This supports multiple relations, like ==, !=, >=, < etc. The Variable name for channel is Channel0, Channel2, etc, for BL0XXX it can be 'Power', 'Current', 'Voltage' or 'Frequency'.<br/><br/>Example: Values are compared as integers. This affects Current (*1000) and Frequency (*100). Example handler where Current is greather than 2Amps:<br/> `AddChangeHandler Current > 2000 SetChannel 1 0`<br/><br/>See also [AddChangeHandler on forum](https://www.elektroda.com/rtvforum/find.php?q=AddChangeHandler). |
| AddChannel | [ChannelIndex][ValueToAdd][ClampMin][ClampMax][bWrapInsteadOfClamp] | Adds a given value to the channel. Can be used to change PWM brightness. Clamp min and max arguments are optional.<br/><br/>See also [AddChannel on forum](https://www.elektroda.com/rtvforum/find.php?q=AddChannel). |

4
docs/json/commands.json
View File

@ -10,8 +10,8 @@
},
{
"name": "ACMode",
"args": "CMD_ACMode",
"descr": "",
"args": "[Mode]",
"descr": "Sets the climate mode (off, cool, dry, fan_only, heat, heatcool, auto)",
"fn": "CMD_ACMode",
"file": "driver/drv_tclAC.c",
"requires": "",

4
src/driver/drv_tclAC.c
View File

@ -754,8 +754,8 @@ void TCL_Init(void) {
UART_InitUART(TCL_baudRate, 2, false);
UART_InitReceiveRingBuffer(TCL_UART_RECEIVE_BUFFER_SIZE);
//cmddetail:{"name":"ACMode","args":"CMD_ACMode",
//cmddetail:"descr":"",
//cmddetail:{"name":"ACMode","args":"[Mode]",
//cmddetail:"descr":"Sets the climate mode (off, cool, dry, fan_only, heat, heatcool, auto)",
//cmddetail:"fn":"CMD_ACMode","file":"driver/drv_tclAC.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("ACMode", CMD_ACMode, NULL);