docs

openshwprojects · Dec 24, 2024 · 55b671e · 55b671e
1 parent c390303
commit 55b671e
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 18 deletions.
diff --git a/src/cmnds/cmd_main.c b/src/cmnds/cmd_main.c
@@ -848,7 +848,7 @@ void CMD_Init_Early() {
 	//cmddetail:"examples":""}
 	CMD_RegisterCommand("PWMFrequency", CMD_PWMFrequency, NULL);
 
-	//cmddetail:{"name":"IndexRefreshInterval","args":"CMD_IndexRefreshInterval",
+	//cmddetail:{"name":"IndexRefreshInterval","args":"[Interval]",
 	//cmddetail:"descr":"",
 	//cmddetail:"fn":"NULL);","file":"cmnds/cmd_main.c","requires":"",
 	//cmddetail:"examples":""}

diff --git a/src/cmnds/cmd_newLEDDriver.c b/src/cmnds/cmd_newLEDDriver.c
@@ -1638,7 +1638,7 @@ void NewLED_InitCommands(){
 	//cmddetail:"fn":"basecolor_rgb","file":"cmnds/cmd_newLEDDriver.c","requires":"",
 	//cmddetail:"examples":""}
 	CMD_RegisterCommand("Color", basecolor_rgb, NULL);
-	//cmddetail:{"name":"led_basecolor_rgbcw","args":"",
+	//cmddetail:{"name":"led_basecolor_rgbcw","args":"[HexValue]",
 	//cmddetail:"descr":"set PWN color using #RRGGBB[cw][ww]",
 	//cmddetail:"fn":"basecolor_rgbcw","file":"cmnds/cmd_newLEDDriver.c","requires":"",
 	//cmddetail:"examples":""}

diff --git a/src/cmnds/cmd_test.c b/src/cmnds/cmd_test.c
@@ -400,8 +400,8 @@ int CMD_InitTestCommands(){
 	//cmddetail:"fn":"cmnd_lfs_test3","file":"cmnds/cmd_tasmota.c","requires":"",
 	//cmddetail:"examples":""}
 	CMD_RegisterCommand("lfs_test3", cmnd_lfs_test3, NULL);
-	//cmddetail:{"name":"json_test","args":"cmnd_json_test",
-	//cmddetail:"descr":"",
+	//cmddetail:{"name":"json_test","args":"",
+	//cmddetail:"descr":"Developer-only command used to test CJSON library",
 	//cmddetail:"fn":"NULL);","file":"cmnds/cmd_test.c","requires":"",
 	//cmddetail:"examples":""}
 	CMD_RegisterCommand("json_test", cmnd_json_test, NULL);

diff --git a/src/driver/drv_mcp9808.c b/src/driver/drv_mcp9808.c
@@ -247,20 +247,20 @@ void MCP9808_Init() {
 
 	Soft_I2C_PreInit(&g_softI2C);
 
-	//cmddetail:{"name":"MCP9808_Adr","args":"MCP9808_Adr",
-	//cmddetail:"descr":"",
+	//cmddetail:{"name":"MCP9808_Adr","args":"[HexAdr]",
+	//cmddetail:"descr":"Sets the I2C address of MCP9808, like 0x30",
 	//cmddetail:"fn":"NULL);","file":"driver/drv_mcp9808.c","requires":"",
 	//cmddetail:"examples":""}
 	CMD_RegisterCommand("MCP9808_Adr", MCP9808_Adr, NULL);
 
-	//cmddetail:{"name":"MCP9808_AlertRange","args":"MCP9808_AlertRange",
-	//cmddetail:"descr":"",
+	//cmddetail:{"name":"MCP9808_AlertRange","args":"[MinT] [MaxT] [OptionalBActiveHigh]",
+	//cmddetail:"descr":"Setup MCP9809 temperature alert for range mode",
 	//cmddetail:"fn":"NULL);","file":"driver/drv_mcp9808.c","requires":"",
 	//cmddetail:"examples":""}
 	CMD_RegisterCommand("MCP9808_AlertRange", MCP9808_AlertRange, NULL);
-	//cmddetail:{"name":"MCP9808_AlertMin","args":"MCP9808_AlertMin",
-	//cmddetail:"descr":"",
-	//cmddetail:"fn":"NULL);","file":"driver/drv_mcp9808.c","requires":"",
+	//cmddetail:{"name":"MCP9808_AlertMin","args":"[MinT] [OptionalBActiveHigh]",
+	//cmddetail:"descr":"Setup MCP9809 temperature alert for min mode",
+	//cmddetail:"fn":");","file":"driver/drv_mcp9808.c","requires":"",
 	//cmddetail:"examples":""}
 	CMD_RegisterCommand("MCP9808_AlertMin", MCP9808_AlertMin, NULL);
 
@@ -271,7 +271,7 @@ void MCP9808_Init() {
 	//cmddetail:"examples":""}
 	CMD_RegisterCommand("MCP9808_Calibrate", MCP9808_Calibrate, NULL);
 	//cmddetail:{"name":"MCP9808_Cycle","args":"[DelayInSeconds]",
-	//cmddetail:"descr":"",
+	//cmddetail:"descr":"Sets MCP9808 measurement interval",
 	//cmddetail:"fn":"NULL);","file":"driver/drv_mcp9808.c","requires":"",
 	//cmddetail:"examples":""}
 	CMD_RegisterCommand("MCP9808_Cycle", MCP9808_cycle, NULL);

diff --git a/src/driver/drv_pixelAnim.c b/src/driver/drv_pixelAnim.c
@@ -215,13 +215,13 @@ commandResult_t PA_Cmd_AnimSpeed(const void *context, const char *cmd, const cha
 }
 void PixelAnim_Init() {
 
-	//cmddetail:{"name":"Anim","args":"PA_Cmd_Anim",
-	//cmddetail:"descr":"",
+	//cmddetail:{"name":"Anim","args":"[AnimationIndex]",
+	//cmddetail:"descr":"Starts given WS2812 animation by index.",
 	//cmddetail:"fn":"NULL);","file":"driver/drv_pixelAnim.c","requires":"",
 	//cmddetail:"examples":""}
 	CMD_RegisterCommand("Anim", PA_Cmd_Anim, NULL);
-	//cmddetail:{"name":"AnimSpeed","args":"PA_Cmd_AnimSpeed",
-	//cmddetail:"descr":"",
+	//cmddetail:{"name":"AnimSpeed","args":"[Interval]",
+	//cmddetail:"descr":"Sets WS2812 animation speed",
 	//cmddetail:"fn":"NULL);","file":"driver/drv_pixelAnim.c","requires":"",
 	//cmddetail:"examples":""}
 	CMD_RegisterCommand("AnimSpeed", PA_Cmd_AnimSpeed, NULL);

diff --git a/src/driver/drv_sm15155e.c b/src/driver/drv_sm15155e.c
@@ -57,7 +57,7 @@ void SM15155E_Write(float *rgbcw) {
 
 // startDriver SM15155E
 void SM15155E_Init() {
-	//cmddetail:{"name":"LED_Map","args":"CMD_LEDDriver_Map",
+	//cmddetail:{"name":"LED_Map","args":"[Ch0][Ch1][Ch2][Ch3][Ch4]",
 	//cmddetail:"descr":"",
 	//cmddetail:"fn":"NULL);","file":"driver/drv_sm15155e.c","requires":"",
 	//cmddetail:"examples":""}

diff --git a/src/i2c/drv_i2c_ads1115.c b/src/i2c/drv_i2c_ads1115.c
@@ -121,7 +121,7 @@ commandResult_t DRV_I2C_AddDevice_ADS1115(const void *context, const char *cmd,
 }
 void DRV_I2C_ADS1115_PreInit() {
 
-	//cmddetail:{"name":"addI2CDevice_ADS1115","args":"DRV_I2C_AddDevice_ADS1115",
+	//cmddetail:{"name":"addI2CDevice_ADS1115","args":"",
 	//cmddetail:"descr":"",
 	//cmddetail:"fn":"NULL);","file":"i2c/drv_i2c_ads1115.c","requires":"",
 	//cmddetail:"examples":""}