docs

openshwprojects · Dec 24, 2024 · cbc7995 · cbc7995
1 parent d34cd42
commit cbc7995
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 10 deletions.
diff --git a/docs/commands-extended.md b/docs/commands-extended.md
@@ -32,7 +32,7 @@ Do not add anything here, as it will overwritten with next rebuild.
 | 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 |
 | BMPI2C_Calibrate | [DeltaTemp][DeltaPressure][DeltaHumidity] | Calibrate the BMPI2C Sensor.<br/><br/>Example: BMPI2C_Calibrate -4 0 10 <br /> meaning -4 on current temp reading, 0 on current pressure reading and +10 on current humidity reading<br/><br/>See also [BMPI2C_Calibrate on forum](https://www.elektroda.com/rtvforum/find.php?q=BMPI2C_Calibrate). | File: driver/drv_bmpi2c.c<br/>Function: BMPI2C_Calibrate |
-| BMPI2C_Configure | BMPI2C_Configure | .<br/><br/>See also [BMPI2C_Configure on forum](https://www.elektroda.com/rtvforum/find.php?q=BMPI2C_Configure). | File: driver/drv_bmpi2c.c<br/>Function: NULL); |
+| BMPI2C_Configure | [Mode][TempSampling][PressureSampling][HumSampling][IIRFilter][StandbyTime] | Manual sensor configuration. Modes: 0 - normal, 1 - forced, 2 - sleep. Overampling range: -1 - skipped, 2^0 to 2^4. Default is X1. IIRFilter range: 0 - off, 2^1 to 2^4 for most, up to 2^7 for BME68X, StandbyTime: 1 for 0.5ms, 63 for 62.5ms, 125, 250, 500, 1000, 2000, 4000. Mode and StandbyTime are not needed on BME68X, All values will be rounded down to closest available (like sampling 10 will choose 8x).<br/><br/>Example: BMPI2C_Configure 0 8 2 4 16 125 <br /><br/><br/>See also [BMPI2C_Configure on forum](https://www.elektroda.com/rtvforum/find.php?q=BMPI2C_Configure). | File: driver/drv_bmpi2c.c<br/>Function: BMPI2C_Configure |
 | BMPI2C_Cycle | [IntervalSeconds] | This is the interval between measurements in seconds, by default 1. Max is 255.<br/><br/>Example: BMPI2C_Cycle 60 <br /> measurement is taken every 60 seconds<br/><br/>See also [BMPI2C_Cycle on forum](https://www.elektroda.com/rtvforum/find.php?q=BMPI2C_Cycle). | File: drv/drv_bmpi2c.c<br/>Function: BMPI2C_cycle |
 | BP1658CJ_Current | [MaxCurrentRGB][MaxCurrentCW] | Sets the maximum current limit for BP1658CJ driver.<br/><br/>See also [BP1658CJ_Current on forum](https://www.elektroda.com/rtvforum/find.php?q=BP1658CJ_Current). | File: driver/drv_bp1658cj.c<br/>Function: BP1658CJ_Current |
 | BP1658CJ_Map | [Ch0][Ch1][Ch2][Ch3][Ch4] | Maps the RGBCW values to given indices of BP1658CJ channels. This is because BP5758D channels order is not the same for some devices. Some devices are using RGBCW order and some are using GBRCW, etc, etc. Example usage: BP1658CJ_Map 0 1 2 3 4.<br/><br/>See also [BP1658CJ_Map on forum](https://www.elektroda.com/rtvforum/find.php?q=BP1658CJ_Map). | File: driver/drv_bp1658cj.c<br/>Function: BP1658CJ_Map |

diff --git a/docs/commands.md b/docs/commands.md
@@ -35,7 +35,7 @@ Do not add anything here, as it will overwritten with next rebuild.
 | 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). |
 | BMPI2C_Calibrate | [DeltaTemp][DeltaPressure][DeltaHumidity] | Calibrate the BMPI2C Sensor.<br/><br/>Example: BMPI2C_Calibrate -4 0 10 <br /> meaning -4 on current temp reading, 0 on current pressure reading and +10 on current humidity reading<br/><br/>See also [BMPI2C_Calibrate on forum](https://www.elektroda.com/rtvforum/find.php?q=BMPI2C_Calibrate). |
-| BMPI2C_Configure | BMPI2C_Configure | .<br/><br/>See also [BMPI2C_Configure on forum](https://www.elektroda.com/rtvforum/find.php?q=BMPI2C_Configure). |
+| BMPI2C_Configure | [Mode][TempSampling][PressureSampling][HumSampling][IIRFilter][StandbyTime] | Manual sensor configuration. Modes: 0 - normal, 1 - forced, 2 - sleep. Overampling range: -1 - skipped, 2^0 to 2^4. Default is X1. IIRFilter range: 0 - off, 2^1 to 2^4 for most, up to 2^7 for BME68X, StandbyTime: 1 for 0.5ms, 63 for 62.5ms, 125, 250, 500, 1000, 2000, 4000. Mode and StandbyTime are not needed on BME68X, All values will be rounded down to closest available (like sampling 10 will choose 8x).<br/><br/>Example: BMPI2C_Configure 0 8 2 4 16 125 <br /><br/><br/>See also [BMPI2C_Configure on forum](https://www.elektroda.com/rtvforum/find.php?q=BMPI2C_Configure). |
 | BMPI2C_Cycle | [IntervalSeconds] | This is the interval between measurements in seconds, by default 1. Max is 255.<br/><br/>Example: BMPI2C_Cycle 60 <br /> measurement is taken every 60 seconds<br/><br/>See also [BMPI2C_Cycle on forum](https://www.elektroda.com/rtvforum/find.php?q=BMPI2C_Cycle). |
 | BP1658CJ_Current | [MaxCurrentRGB][MaxCurrentCW] | Sets the maximum current limit for BP1658CJ driver.<br/><br/>See also [BP1658CJ_Current on forum](https://www.elektroda.com/rtvforum/find.php?q=BP1658CJ_Current). |
 | BP1658CJ_Map | [Ch0][Ch1][Ch2][Ch3][Ch4] | Maps the RGBCW values to given indices of BP1658CJ channels. This is because BP5758D channels order is not the same for some devices. Some devices are using RGBCW order and some are using GBRCW, etc, etc. Example usage: BP1658CJ_Map 0 1 2 3 4.<br/><br/>See also [BP1658CJ_Map on forum](https://www.elektroda.com/rtvforum/find.php?q=BP1658CJ_Map). |

diff --git a/docs/json/commands.json b/docs/json/commands.json
@@ -244,12 +244,12 @@
   },
   {
     "name": "BMPI2C_Configure",
-    "args": "BMPI2C_Configure",
-    "descr": "",
-    "fn": "NULL);",
+    "args": "[Mode][TempSampling][PressureSampling][HumSampling][IIRFilter][StandbyTime]",
+    "descr": "Manual sensor configuration. Modes: 0 - normal, 1 - forced, 2 - sleep. Overampling range: -1 - skipped, 2^0 to 2^4. Default is X1. IIRFilter range: 0 - off, 2^1 to 2^4 for most, up to 2^7 for BME68X, StandbyTime: 1 for 0.5ms, 63 for 62.5ms, 125, 250, 500, 1000, 2000, 4000. Mode and StandbyTime are not needed on BME68X, All values will be rounded down to closest available (like sampling 10 will choose 8x)",
+    "fn": "BMPI2C_Configure",
     "file": "driver/drv_bmpi2c.c",
     "requires": "",
-    "examples": ""
+    "examples": "BMPI2C_Configure 0 8 2 4 16 125 <br />"
   },
   {
     "name": "BMPI2C_Cycle",

diff --git a/src/driver/drv_bmpi2c.c b/src/driver/drv_bmpi2c.c
@@ -156,10 +156,7 @@ void BMPI2C_Init()
 		}
 
 		//cmddetail:{"name":"BMPI2C_Configure","args":"[Mode][TempSampling][PressureSampling][HumSampling][IIRFilter][StandbyTime]",
-		//cmddetail:"descr":"Manual sensor configuration. Modes: 0 - normal, 1 - forced, 2 - sleep. Overampling range: -1 - skipped, 2^0 to 2^4. Default is X1
-		//cmddetail:IIRFilter range: 0 - off, 2^1 to 2^4 for most, up to 2^7 for BME68X",
-		//cmddetail:StandbyTime: 1 for 0.5ms, 63 for 62.5ms, 125, 250, 500, 1000, 2000, 4000. Mode and StandbyTime are not needed on BME68X
-		//cmddetail:All values will be rounded down to closest available (like sampling 10 will choose 8x)
+		//cmddetail:"descr":"Manual sensor configuration. Modes: 0 - normal, 1 - forced, 2 - sleep. Overampling range: -1 - skipped, 2^0 to 2^4. Default is X1. IIRFilter range: 0 - off, 2^1 to 2^4 for most, up to 2^7 for BME68X, StandbyTime: 1 for 0.5ms, 63 for 62.5ms, 125, 250, 500, 1000, 2000, 4000. Mode and StandbyTime are not needed on BME68X, All values will be rounded down to closest available (like sampling 10 will choose 8x)",
 		//cmddetail:"fn":"BMPI2C_Configure","file":"driver/drv_bmpi2c.c","requires":"",
 		//cmddetail:"examples":"BMPI2C_Configure 0 8 2 4 16 125 <br />"}
 		CMD_RegisterCommand("BMPI2C_Configure", BMPI2C_Configure, NULL);