From 64f5e8b31d7582997b1d6cee5079d63384f90ddf Mon Sep 17 00:00:00 2001 From: Tester23 <85486843+openshwprojects@users.noreply.github.com> Date: Thu, 8 Jan 2026 01:18:36 +0100 Subject: [PATCH] docs --- docs/commands-extended.md | 2 +- docs/commands.md | 2 +- docs/json/commands.json | 4 ++-- src/driver/drv_tclAC.c | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/commands-extended.md b/docs/commands-extended.md index 8b628b977..285f2c329 100644 --- a/docs/commands-extended.md +++ b/docs/commands-extended.md @@ -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').

See also [AB_Map on forum](https://www.elektroda.com/rtvforum/find.php?q=AB_Map). | File: driver/drv_adcButton.c
Function: Cmd_ADCButtonMap | -| ACMode | CMD_ACMode | .

See also [ACMode on forum](https://www.elektroda.com/rtvforum/find.php?q=ACMode). | File: driver/drv_tclAC.c
Function: CMD_ACMode | +| ACMode | [Mode] | Sets the climate mode (off, cool, dry, fan_only, heat, heatcool, auto).

See also [ACMode on forum](https://www.elektroda.com/rtvforum/find.php?q=ACMode). | File: driver/drv_tclAC.c
Function: CMD_ACMode | | ADCSmoother | [Pindex] [TotalSamples] [SampleIntervalMS] [TargetChannelADCValue] [MarginValue] [TargetChannel0or1] | Starts the ADC smoother with given configuration.

See also [ADCSmoother on forum](https://www.elektroda.com/rtvforum/find.php?q=ADCSmoother). | File: driver/drv_adcSmoother.c
Function: Cmd_SetupADCSmoother | | AddChangeHandler | [Variable][Relation][Constant][Command] | Trigger based on change in channel value (for example channel 0 becoming 100), or for a voltage/current/power/frequency change for BL0942/BL0937. This supports multiple relations, like ==, !=, >=, < etc. The Variable name for channel is Channel0, Channel2, etc, for BL0XXX it can be 'Power', 'Current', 'Voltage' or 'Frequency'.

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

See also [AddChangeHandler on forum](https://www.elektroda.com/rtvforum/find.php?q=AddChangeHandler). | File: cmnds/cmd_eventHandlers.c
Function: CMD_AddChangeHandler | | AddChannel | [ChannelIndex][ValueToAdd][ClampMin][ClampMax][bWrapInsteadOfClamp] | Adds a given value to the channel. Can be used to change PWM brightness. Clamp min and max arguments are optional.

See also [AddChannel on forum](https://www.elektroda.com/rtvforum/find.php?q=AddChannel). | File: cmnds/cmd_channels.c
Function: CMD_AddChannel | diff --git a/docs/commands.md b/docs/commands.md index 0ca8562af..3d840f616 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -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').

See also [AB_Map on forum](https://www.elektroda.com/rtvforum/find.php?q=AB_Map). | -| ACMode | CMD_ACMode | .

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).

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.

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'.

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

See also [AddChangeHandler on forum](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.

See also [AddChannel on forum](https://www.elektroda.com/rtvforum/find.php?q=AddChannel). | diff --git a/docs/json/commands.json b/docs/json/commands.json index 3493dc3ef..6d13ceef7 100644 --- a/docs/json/commands.json +++ b/docs/json/commands.json @@ -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": "", diff --git a/src/driver/drv_tclAC.c b/src/driver/drv_tclAC.c index ea5212b4d..51e3a6a22 100644 --- a/src/driver/drv_tclAC.c +++ b/src/driver/drv_tclAC.c @@ -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);