Skip to content

Commit

Permalink
docs refresh
Browse files Browse the repository at this point in the history
  • Loading branch information
@openshwprojects
openshwprojects committed Aug 16, 2023
1 parent ff9e6d9 commit c4b5803
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/commands-extended.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ Do not add anything here, as it will overwritten with next rebuild.
| cancelRepeatingEvent | [UserIDInteger] | Stops a given repeating event with a specified ID<br/>See also [cancelRepeatingEvent on forum](https://www.elektroda.com/rtvforum/find.php?q=cancelRepeatingEvent). | File: cmnds/cmd_repeatingEvents.c<br/>Function: RepeatingEvents_Cmd_CancelRepeatingEvent |
| Ch | [InputValue] | An alternate command to access channels. It returns all used channels in JSON format. The syntax is ChINDEX value, there is no space between Ch and channel index. It can be sent without value to poll channel values.<br/>See also [Ch on forum](https://www.elektroda.com/rtvforum/find.php?q=Ch). | File: cmnds/cmd_channels.c<br/>Function: CMD_Ch |
| 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/>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/>e.g.:SHT_Calibrate -4 10<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/>e.g.:CHT_Cycle 60<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 |
| CHT_Calibrate | [DeltaTemp][DeltaHumidity] | Calibrate the CHT Sensor as Tolerance is +/-2 degrees C.<br/>e.g.:SHT_Calibrate -4 10 <br /> meaning -4 on current temp reading and +10 on current humidity reading<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/>e.g.:CHT_Cycle 60 <br /> measurement is taken every 60 seconds<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/>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/>See also [clearAll on forum](https://www.elektroda.com/rtvforum/find.php?q=clearAll). | File: cmnds/cmd_main.c<br/>Function: CMD_ClearAll |
| clearAllHandlers | | This clears all added event handlers<br/>See also [clearAllHandlers on forum](https://www.elektroda.com/rtvforum/find.php?q=clearAllHandlers). | File: cmnds/cmd_eventHandlers.c<br/>Function: CMD_ClearAllHandlers |
Expand Down
4 changes: 2 additions & 2 deletions docs/commands.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ Do not add anything here, as it will overwritten with next rebuild.
| cancelRepeatingEvent | [UserIDInteger] | Stops a given repeating event with a specified ID<br/>See also [cancelRepeatingEvent on forum](https://www.elektroda.com/rtvforum/find.php?q=cancelRepeatingEvent). |
| Ch | [InputValue] | An alternate command to access channels. It returns all used channels in JSON format. The syntax is ChINDEX value, there is no space between Ch and channel index. It can be sent without value to poll channel values.<br/>See also [Ch on forum](https://www.elektroda.com/rtvforum/find.php?q=Ch). |
| 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/>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/>e.g.:SHT_Calibrate -4 10<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/>e.g.:CHT_Cycle 60<br/>See also [CHT_Cycle on forum](https://www.elektroda.com/rtvforum/find.php?q=CHT_Cycle). |
| CHT_Calibrate | [DeltaTemp][DeltaHumidity] | Calibrate the CHT Sensor as Tolerance is +/-2 degrees C.<br/>e.g.:SHT_Calibrate -4 10 <br /> meaning -4 on current temp reading and +10 on current humidity reading<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/>e.g.:CHT_Cycle 60 <br /> measurement is taken every 60 seconds<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/>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/>See also [clearAll on forum](https://www.elektroda.com/rtvforum/find.php?q=clearAll). |
| clearAllHandlers | | This clears all added event handlers<br/>See also [clearAllHandlers on forum](https://www.elektroda.com/rtvforum/find.php?q=clearAllHandlers). |
Expand Down
4 changes: 2 additions & 2 deletions docs/json/commands.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@
"fn": "CHT_Calibrate",
"file": "driver/drv_cht8305.c",
"requires": "",
"examples": "SHT_Calibrate -4 10"
"examples": "SHT_Calibrate -4 10 <br /> meaning -4 on current temp reading and +10 on current humidity reading"
},
{
"name": "CHT_Cycle",
Expand All @@ -267,7 +267,7 @@
"fn": "CHT_cycle",
"file": "drv/drv_cht8305.c",
"requires": "",
"examples": "CHT_Cycle 60"
"examples": "CHT_Cycle 60 <br /> measurement is taken every 60 seconds"
},
{
"name": "ClampChannel",
Expand Down

0 comments on commit c4b5803

Please sign in to comment.