v2.1.0

.vscode/settings.json

@@ -6,10 +6,10 @@
   },
   "editor.defaultFormatter": "esbenp.prettier-vscode",
   "[javascript]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
+    "editor.defaultFormatter": "vscode.typescript-language-features"
   },
   "[typescript]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
+    "editor.defaultFormatter": "vscode.typescript-language-features"
   },
   "[markdown]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
@@ -25,7 +25,7 @@
     }
   ],
   "[json]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
+    "editor.defaultFormatter": "vscode.json-language-features"
   },
   "codeQL.githubDatabase.update": "never"
 }

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file. This project uses [Semantic Versioning](https://semver.org/)
 
+## [2.1.0](https://github.com/donavanbecker/homebridge-rainbird/releases/tag/v2.1.0) (2024-08-31)
+
+### What's Changed
+- Update `rainbird` modeule to `v1.1.0`
+- Housekeeping and updated dependencies.
+
+**Full Changelog**: https://github.com/donavanbecker/homebridge-rainbird/compare/v2.0.3...v2.1.0
+
 ## [2.0.3](https://github.com/donavanbecker/homebridge-rainbird/releases/tag/v2.0.3) (2024-05-26)
 
 ### What's Changed

README.md

@@ -11,9 +11,9 @@
 <a href="https://paypal.me/donavanbecker"><img title="donavanbecker" src="https://badgen.net/badge/donavanbecker/paypal/yellow" ></a>
 <a href="https://paypal.me/Mantorok1"><img title="mantorok1" src="https://badgen.net/badge/mantorok1/paypal/yellow" ></a>
 
-<p>The Homebridge <a href="https://rainbird.com">RainBird</a> 
+<p>The Homebridge <a href="https://rainbird.com">RainBird</a>
 plugin allows you to access your RainBird Controller from HomeKit with
-  <a href="https://homebridge.io">Homebridge</a>. 
+  <a href="https://homebridge.io">Homebridge</a>.
 </p>
 
 </span>
@@ -27,28 +27,31 @@ plugin allows you to access your RainBird Controller from HomeKit with
 
 1. Set a Static IP Address to your [RainBird](https://www.rainbird.com) Controller - [How to Set Static IP Address](https://www.howtogeek.com/184310/ask-htg-should-i-be-setting-static-ip-addresses-on-my-router/).
 2. Input Static IP Address and Password for [RainBird](https://www.rainbird.com) Controller into Plugin UI Settings and restart Homebridge.
-    - If you choose to create child bridge with this plugin, do it at this time.
-    - Password is the password you used to setup the rainbird controller.
+   - If you choose to create child bridge with this plugin, do it at this time.
+   - Password is the password you used to setup the rainbird controller.
 
 ## Collaborators
 
- - Main developer of the RaindBird API:
-      - [mantorok1](https://github.com/mantorok1)
+- Main developer of the RaindBird API:
+  - [mantorok1](https://github.com/mantorok1)
 
 ## Compatiable Controllers
 
 Any controller that supports the [RainBird LNK WiFi Module](https://www.rainbird.com/products/lnk-wifi-module) should be compatible. This includes:
+
 - ESP-Me
 - ESP-TM2
 - ESP-RZXe
 - ESP-ME3
 
 ## Known Limitations
+
 - The Home app will default all sprinkler zone names to the Irrigation System's name which means it's not obvious which zone is which. The first one in the list may not necessarily be Zone 1. You'll need to use trial and error to figure out the zone and rename them appropriately.
 - Using the RainBird app while the plugin is running can cause connectivity issues.
 - The RainBird LNK WiFi Module may not support "Band Steering" and WiFi Channel 13. Try not using these on your router if you are having connectivity issues.
 - Some models do not yet have support for displaying the time remaining. If its not working for your model please log a GitHub issue and we will try to add it with your help.
 
 ## Libraries
+
 - [RainBird](https://github.com/donavanbecker/rainbird)
   - Library used to comunicate with Rainbird Controllers.

config.schema.json

@@ -21,6 +21,11 @@
           "title": "Devices",
           "type": "object",
           "properties": {
+            "configDeviceName": {
+              "title": "Device Name",
+              "type": "string",
+              "placeholder": "RainBird Controller"
+            },
             "ipaddress": {
               "title": "IP Address",
               "description": "The device's Static IP address. Recommended to set this device's IP with a Static IP.",
@@ -143,7 +148,7 @@
               }
             },
             "minValueRemainingDuration": {
-              "title": "Min Value",
+              "title": "Min Value for Ramaining Duration",
               "type": "number",
               "placeholder": 0,
               "required": false,
@@ -152,7 +157,7 @@
               }
             },
             "maxValueRemainingDuration": {
-              "title": "Max Value",
+              "title": "Max Value for Ramaining Duration",
               "type": "number",
               "placeholder": 3600,
               "required": false,
@@ -267,6 +272,11 @@
                 "enum": ["debug"]
               }
             ]
+          },
+          "allowInvalidCharacters": {
+            "title": "Allow Invalid Characters",
+            "type": "boolean",
+            "description": "If true, invalid characters will be allowed in the device name."
           }
         }
       }
@@ -281,53 +291,36 @@
       "items": [
         {
           "key": "devices",
-          "notitle": true,
-          "type": "array",
-          "orderable": false,
-          "buttonText": "Add Device",
+          "notitle": false,
+          "type": "tabarray",
+          "title": "{{ value.configDeviceName || value.ipaddress || 'New Device' }}",
+          "expandable": true,
+          "expanded": false,
+          "draggable": true,
+          "orderable": true,
           "items": [
-            {
-              "type": "div",
-              "displayFlex": true,
-              "flex-direction": "column",
-              "items": [
-                "devices[].ipaddress",
-                "devices[].password",
-                {
-                  "type": "fieldset",
-                  "title": "Device Settings",
-                  "expandable": true,
-                  "expanded": true,
-                  "items": [
-                    "devices[].external",
-                    "devices[].showRainSensor",
-                    "devices[].showValveSensor",
-                    "devices[].showProgramASwitch",
-                    "devices[].showProgramBSwitch",
-                    "devices[].showProgramCSwitch",
-                    "devices[].showProgramDSwitch",
-                    "devices[].showStopIrrigationSwitch",
-                    "devices[].showZoneValve",
-                    "devices[].includeZones",
-                    "devices[].showDelayIrrigationSwitch",
-                    "devices[].irrigationDelay",
-                    {
-                      "type": "fieldset",
-                      "title": "Remaining Duration Override",
-                      "expandable": true,
-                      "expanded": false,
-                      "items": ["devices[].minValueRemainingDuration", "devices[].maxValueRemainingDuration"]
-                    },
-                    "devices[].syncTime",
-                    "devices[].showRequestResponse",
-                    "devices[].firmware",
-                    "devices[].refreshRate",
-                    "devices[].logging",
-                    "devices[].delete"
-                  ]
-                }
-              ]
-            }
+            "devices[].configDeviceName",
+            "devices[].ipaddress",
+            "devices[].external",
+            "devices[].showRainSensor",
+            "devices[].showValveSensor",
+            "devices[].showProgramASwitch",
+            "devices[].showProgramBSwitch",
+            "devices[].showProgramCSwitch",
+            "devices[].showProgramDSwitch",
+            "devices[].showStopIrrigationSwitch",
+            "devices[].showZoneValve",
+            "devices[].includeZones",
+            "devices[].showDelayIrrigationSwitch",
+            "devices[].irrigationDelay",
+            "devices[].minValueRemainingDuration",
+            "devices[].maxValueRemainingDuration",
+            "devices[].syncTime",
+            "devices[].showRequestResponse",
+            "devices[].firmware",
+            "devices[].refreshRate",
+            "devices[].logging",
+            "devices[].delete"
           ]
         }
       ]
@@ -354,7 +347,8 @@
           "key": "options.pushRate",
           "notitle": true
         },
-        "options.logging"
+        "options.logging",
+        "options.allowInvalidCharacters"
       ]
     }
   ]

docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/assets/highlight.css

@@ -0,0 +1,22 @@
+:root {
+    --light-code-background: #FFFFFF;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --code-background: var(--dark-code-background);
+} }
+
+:root[data-theme='light'] {
+    --code-background: var(--light-code-background);
+}
+
+:root[data-theme='dark'] {
+    --code-background: var(--dark-code-background);
+}
+
+pre, code { background: var(--code-background); }