Add usermod help links for AR, 4LD and weather

ewoudwijma · ewoudwijma · commit 949373df9179 · 2022-12-19T16:42:07.000+01:00
Other usermods: 

void appendConfigData()
{
... 
 oappend(SET_F("addInfo('&lt;modname&gt;:help',0,'&lt;a href=\"https:// \"&gt;Help&lt;/a&gt;');"));
   ...
}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "wled",
-  "version": "0.14.0.11",
+  "version": "0.14.0.12",
   "description": "Tools for WLED project",
   "main": "tools/cdata.js",
   "directories": {
diff --git a/usermods/audioreactive/audio_reactive.h b/usermods/audioreactive/audio_reactive.h
@@ -2047,6 +2047,7 @@ class AudioReactive : public Usermod {
       oappend(SET_F("addOption(dd,'Off',0);"));
       oappend(SET_F("addOption(dd,'Send',1);"));
       oappend(SET_F("addOption(dd,'Receive',2);"));
+      oappend(SET_F("addInfo('AudioReactive:help',0,'<a href=\"https://moonmodules.github.io/WLED-Docs/soundreactive/Sound-Settings\">Help</a>');"));  // 0 is field type, 1 is actual field
       oappend(SET_F("addInfo('AudioReactive:digitalmic:type',1,'<i>requires reboot!</i>');"));  // 0 is field type, 1 is actual field
     #ifdef I2S_SDPIN
       oappend(SET_F("addInfo('AudioReactive:digitalmic:pin[]',0,'<i>sd/data/dout, &#9100; ")); oappendi(I2S_SDPIN); oappend("</i>','I2S SD');");
diff --git a/usermods/customeffects/usermod_v2_customeffects.h b/usermods/customeffects/usermod_v2_customeffects.h
@@ -124,12 +124,6 @@ class CustomEffectsUserMod : public Usermod {
      */
     void addToJsonInfo(JsonObject& root)
     {
-      JsonObject user = root["u"];
-      if (user.isNull()) user = root.createNestedObject("u");
-
-      JsonArray infoArr = user.createNestedArray(FPSTR(_name));
-      infoArr.add(errorMessage); //value
-      // infoArr.add(""); //unit
     }
 
 
@@ -139,13 +133,13 @@ class CustomEffectsUserMod : public Usermod {
      */
     void addToJsonState(JsonObject& root)
     {
-      //root["user0"] = userVar0;
-      if (!initDone) return;  // prevent crash on boot applyPreset()
-      JsonObject usermod = root[FPSTR(_name)];
-      if (usermod.isNull()) {
-        usermod = root.createNestedObject(FPSTR(_name));
-      }
-      usermod["on"] = enabled;
+      // //root["user0"] = userVar0;
+      // if (!initDone) return;  // prevent crash on boot applyPreset()
+      // JsonObject usermod = root[FPSTR(_name)];
+      // if (usermod.isNull()) {
+      //   usermod = root.createNestedObject(FPSTR(_name));
+      // }
+      // usermod["on"] = enabled;
     }
 
 
diff --git a/usermods/usermod_v2_four_line_display_ALT/usermod_v2_four_line_display_ALT.h b/usermods/usermod_v2_four_line_display_ALT/usermod_v2_four_line_display_ALT.h
@@ -1036,6 +1036,7 @@ class FourLineDisplayUsermod : public Usermod {
     //}
 
     void appendConfigData() {
+      oappend(SET_F("addInfo('4LineDisplay:help',0,'<a href=\"https://moonmodules.github.io/WLED-Docs/usermods/four-line-display\">Help</a>');"));  // 0 is field type, 1 is actual field
       oappend(SET_F("dd=addDropdown('4LineDisplay','type');"));
       oappend(SET_F("addOption(dd,'None',0);"));
       oappend(SET_F("addOption(dd,'SSD1306',1);"));
diff --git a/usermods/usermod_v2_weather/usermod_v2_weather.h b/usermods/usermod_v2_weather/usermod_v2_weather.h
@@ -317,6 +317,7 @@ class WeatherUsermod : public Usermod {
 
     void appendConfigData()
     {
+      oappend(SET_F("addInfo('WeatherUserMod:help',0,'<a href=\"https://moonmodules.github.io/WLED-Docs/moonmodules/weather-usermod\">Help</a>');"));  // 0 is field type, 1 is actual field
       oappend(SET_F("dd=addDropdown('WeatherUserMod','units');"));
       oappend(SET_F("addOption(dd,'Kelvin',0);"));
       oappend(SET_F("addOption(dd,'Celcius',1);"));
diff --git a/wled00/data/settings_um.htm b/wled00/data/settings_um.htm
@@ -215,7 +215,7 @@
                 const userMod = urlParams.get('um')
                 for (const [k,o] of Object.entries(umCfg)) {
                     if (userMod == k) {
-                        urows += `<hr><h3>${k}</h3>`;
+                        urows += `<hr><h3>${k}</h3><div name="${k}:help"></div>`;
                         addField(k,'unknown',o);
                     }
                 }
diff --git a/wled00/html_other.h b/wled00/html_other.h
@@ -44,7 +44,7 @@ const char PAGE_dmxmap[] PROGMEM = R"=====()=====";
 const uint16_t PAGE_update_length = 602;
 const uint8_t PAGE_update[] PROGMEM = {
   0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0x13, 0x75, 0x53, 0xd1, 0x6e, 0xd3, 0x30,
-  0x14, 0x7d, 0xcf, 0x57, 0x78, 0x7e, 0x6a, 0x25, 0x66, 0x33, 0xc4, 0x0b, 0x23, 0xc9, 0x50, 0xd9,
+  0x14, 0x7d, 0xcf, 0x57, 0x78, 0x7e, 0x6a, 0x25, 0x66, 0xc3, 0xc4, 0x0b, 0x23, 0xc9, 0x50, 0xd9,
   0x84, 0x90, 0x98, 0x36, 0x69, 0x1b, 0x88, 0x27, 0xe4, 0xc4, 0x37, 0x8d, 0xa9, 0x63, 0x67, 0xf6,
   0x4d, 0xab, 0x0a, 0xed, 0xdf, 0xb9, 0x76, 0xda, 0x81, 0x34, 0x78, 0x89, 0xea, 0xf8, 0xdc, 0x93,
   0x73, 0xcf, 0x39, 0x2d, 0x4f, 0x2e, 0x6f, 0x3e, 0xde, 0x7f, 0xbf, 0xbd, 0x62, 0x3d, 0x0e, 0xb6,
@@ -60,13 +60,13 @@ const uint8_t PAGE_update[] PROGMEM = {
   0xda, 0x8a, 0xcb, 0x08, 0x88, 0xc6, 0xad, 0xa3, 0x8c, 0xe2, 0x67, 0xbc, 0x18, 0xab, 0x77, 0xbc,
   0xfe, 0x0b, 0x99, 0xa8, 0xea, 0xe2, 0x83, 0x19, 0x92, 0x01, 0x6c, 0x0a, 0x76, 0xc1, 0x67, 0xfa,
   0x36, 0x46, 0xbe, 0x7c, 0x4f, 0xc8, 0x8c, 0x28, 0xe5, 0x6c, 0x69, 0xe3, 0xf5, 0x9e, 0x79, 0x67,
-  0xbd, 0xd2, 0x15, 0xff, 0x04, 0xf8, 0x75, 0xb1, 0x24, 0xba, 0xfe, 0x4d, 0x5d, 0x5c, 0x7b, 0xef,
-  0xae, 0xbd, 0x66, 0xd9, 0xba, 0x3b, 0xdf, 0xe1, 0x4e, 0x05, 0x78, 0xf6, 0x90, 0x10, 0x65, 0xe7,
-  0xc3, 0xc0, 0x28, 0x93, 0xde, 0xd3, 0xec, 0xed, 0xcd, 0xdd, 0x3d, 0x67, 0x2a, 0xdb, 0x44, 0x22,
-  0xa7, 0x8c, 0xe3, 0xcc, 0xd0, 0x15, 0xf9, 0xc2, 0x0a, 0x20, 0x07, 0xf7, 0x23, 0x85, 0x33, 0x4c,
-  0x16, 0xcd, 0xa8, 0x02, 0xca, 0x34, 0x7f, 0x4a, 0x30, 0xc5, 0x49, 0x41, 0x9c, 0x9a, 0xc1, 0x50,
-  0xaa, 0x0f, 0x59, 0x40, 0x1c, 0x95, 0x63, 0xad, 0x55, 0x31, 0x56, 0x3c, 0x9a, 0x91, 0xd7, 0xaf,
-  0xc5, 0xd9, 0x5b, 0x41, 0x8f, 0x33, 0x5a, 0x80, 0xee, 0x28, 0xd8, 0x26, 0xd4, 0x97, 0x7e, 0x97,
+  0xbd, 0xd2, 0x15, 0xff, 0x04, 0xf8, 0x75, 0xb1, 0x24, 0xba, 0xfe, 0xac, 0x2e, 0xae, 0xbd, 0x77,
+  0xd7, 0x5e, 0xb3, 0x6c, 0xdd, 0x9d, 0xef, 0x70, 0xa7, 0x02, 0x3c, 0x7b, 0x48, 0x88, 0xb2, 0xf3,
+  0x61, 0x60, 0x94, 0x49, 0xef, 0x69, 0xf6, 0xf6, 0xe6, 0xee, 0x9e, 0x33, 0x95, 0x6d, 0x22, 0x91,
+  0x53, 0xc6, 0x71, 0x66, 0xe8, 0x8a, 0x7c, 0x61, 0x05, 0x90, 0x83, 0xfb, 0x91, 0xc2, 0x19, 0x26,
+  0x8b, 0x66, 0x54, 0x01, 0x65, 0x9a, 0x3f, 0x25, 0x98, 0xe2, 0xa4, 0x20, 0x4e, 0xcd, 0x60, 0x28,
+  0xd5, 0x87, 0x2c, 0x20, 0x8e, 0xca, 0xb1, 0xd6, 0xaa, 0x18, 0x2b, 0x1e, 0xcd, 0xc8, 0xeb, 0xd7,
+  0xe2, 0xcd, 0x5b, 0x41, 0x8f, 0x33, 0x5a, 0x80, 0xee, 0x28, 0xd8, 0x26, 0xd4, 0x97, 0x7e, 0x97,
   0x95, 0x33, 0xec, 0x81, 0x59, 0xfa, 0x5e, 0x44, 0x16, 0xc0, 0x82, 0x8a, 0x70, 0xce, 0x4a, 0xc5,
   0x8a, 0x3e, 0x40, 0x57, 0xf1, 0x1e, 0x71, 0x8c, 0xe7, 0x52, 0xae, 0x0d, 0xf6, 0x53, 0x23, 0x5a,
   0x3f, 0xc8, 0xc3, 0x72, 0x93, 0x85, 0x28, 0xd3, 0x82, 0xf2, 0x30, 0x16, 0x39, 0x43, 0x15, 0x28,
@@ -80,7 +80,7 @@ const uint8_t PAGE_update[] PROGMEM = {
   0x5d, 0xea, 0x27, 0xd1, 0xd4, 0x99, 0x9d, 0x4a, 0x27, 0x84, 0x20, 0x70, 0x26, 0xbf, 0xcd, 0xdb,
   0x32, 0xed, 0x99, 0xf3, 0x48, 0x59, 0x79, 0x3a, 0xf8, 0x40, 0x5a, 0xbb, 0x00, 0xb1, 0xcf, 0x91,
   0x8c, 0x6a, 0x0d, 0xec, 0x7c, 0x59, 0x4a, 0xe2, 0x4b, 0xeb, 0xa6, 0xb2, 0xa5, 0xe6, 0xa5, 0xbf,
-  0xf4, 0x6f, 0x9c, 0xb1, 0xcb, 0xd7, 0xe8, 0x03, 0x00, 0x00
+  0xf4, 0x6f, 0xa1, 0xaf, 0xa7, 0xdc, 0xe8, 0x03, 0x00, 0x00
 };
 
 
diff --git a/wled00/html_settings.h b/wled00/html_settings.h

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "wled",`
`3`		`- "version": "0.14.0.11",`
	`3`	`+ "version": "0.14.0.12",`
`4`	`4`	`"description": "Tools for WLED project",`
`5`	`5`	`"main": "tools/cdata.js",`
`6`	`6`	`"directories": {`
Original file line number	Diff line number	Diff line change
`@@ -317,6 +317,7 @@ class WeatherUsermod : public Usermod {`
`317`	`317`
`318`	`318`	`void appendConfigData()`
`319`	`319`	`{`
	`320`	`+ oappend(SET_F("addInfo('WeatherUserMod:help',0,'<a href=\"https://moonmodules.github.io/WLED-Docs/moonmodules/weather-usermod\">Help</a>');")); // 0 is field type, 1 is actual field`
`320`	`321`	`oappend(SET_F("dd=addDropdown('WeatherUserMod','units');"));`
`321`	`322`	`oappend(SET_F("addOption(dd,'Kelvin',0);"));`
`322`	`323`	`oappend(SET_F("addOption(dd,'Celcius',1);"));`
Original file line number	Diff line number	Diff line change
`@@ -215,7 +215,7 @@`
`215`	`215`	`const userMod = urlParams.get('um')`
`216`	`216`	`for (const [k,o] of Object.entries(umCfg)) {`
`217`	`217`	`if (userMod == k) {`
`218`		- urows += `<hr><h3>${k}</h3>`;
	`218`	+ urows += `<hr><h3>${k}</h3><div name="${k}:help"></div>`;
`219`	`219`	`addField(k,'unknown',o);`
`220`	`220`	`}`
`221`	`221`	`}`