homebridge-spruce-irrigation

[waltmoorhouse]

Link To GitHub Repo

https://github.com/waltmoorhouse/homebridge-spruce-irrigation/

Link To NPM Package

https://www.npmjs.com/package/homebridge-spruce-irrigation

[github-actions]

✅ Pre-checks completed successfully.

[bwp91]

• - The plugin must successfully install.
• - The plugin must implement the Homebridge Plugin Settings GUI.
• - The plugin must not start unless it is configured.
• - The plugin must not execute post-install scripts that modify the user's system in any way.
• - The plugin must not contain any analytics or calls that enable you to track the user.
• - The plugin must not throw unhandled exceptions, the plugin must catch and log its own errors.
• - The plugin must be published to npm and the source code available on GitHub.
• - GitHub releases should be created for every new version of your plugin, with patch notes.
• - The plugin must run on all Active LTS versions of Node.js, at the time of writing this is Node.js v14, v16 and v18.
• - The plugin must not require the user to run Homebridge in a TTY or with non-standard startup parameters, even for initial configuration.
• - If the plugin needs to write files to disk (cache, keys, etc.), it must store them inside the Homebridge storage directory.

---

If I configure an auth token that is invalid, this crashes the plugin and sends homebridge into a restart loop:

Config:

        {
            "pollSeconds": 30,
            "runMinutes": 15,
            "lowBatteryLevel": 2.7,
            "authToken": "kjljhklhjkljl",
            "_bridge": {
                "username": "0E:7E:83:52:E6:60",
                "port": 40442
            },
            "platform": "HomeBridgeSpruceIrrigation"
        }

Result:

}
[10/04/2023, 16:28:47] [homebridge-spruce-irrigation] Discovery action completed

/usr/local/lib/node_modules/homebridge-spruce-irrigation/node_modules/axios/lib/core/settle.js:19
    reject(new AxiosError(
           ^
AxiosError: Request failed with status code 401
    at settle (/usr/local/lib/node_modules/homebridge-spruce-irrigation/node_modules/axios/lib/core/settle.js:19:12)
    at IncomingMessage.handleStreamEnd (/usr/local/lib/node_modules/homebridge-spruce-irrigation/node_modules/axios/lib/adapters/http.js:556:11)
    at IncomingMessage.emit (node:events:525:35)
    at endReadableNT (node:internal/streams/readable:1359:12)
    at processTicksAndRejections (node:internal/process/task_queues:82:21)
[10/04/2023, 16:28:47] [homebridge-spruce-irrigation] Child bridge process ended
[10/04/2023, 16:28:47] [homebridge-spruce-irrigation] Process Ended. Code: 1, Signal: null

[bwp91]

This is not part of the verification, but I would like to recommend a name property within the config schema, to let users change the 'name' of the plugin as shown in the homebridge log.

Something like:

  "schema": {
    "type": "object",
    "properties": {
      "name": {
      "title": "Plugin name as shown in Homebridge Log",
      "default": "SpruceIrrigation"
      },
...

[waltmoorhouse]

Once I add that to the config, where do I tell the logger to use it when logging?
Do I do log.prefix = config.name?

[bwp91]

You don’t need to do anything extra, it should use it automatically

[waltmoorhouse]

Ok, v1.1.1 just published should address both these items. Thanks

[bwp91]

/check

[github-actions]

✅ Pre-checks completed successfully.

[bwp91]

Plugin is no longer crashing homebridge with an invalid token - so good!

I noticed that I still get these constant log entries when the token is invalid - so I assume some interval is running.

[11/04/2023, 18:13:39] [HBSpruce] Updating controller readings.

is this interval necessary when the token is invalid? Was just a thought of mine - is out of the scope for verification.

[bwp91]

Congratulations! Your plugin has been verified.

You can now add the Verified by Homebridge badge to your plugin's README:

[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)

Your plugin is now also eligible to display a ❤️ Donate button on it's tile in the Homebridge UI. See https://github.com/oznu/homebridge-config-ui-x/wiki/Developers:-Donation-Links for instructions.

Thank you for your contribution to the Homebridge Community.
https://homebridge.io

[waltmoorhouse]

Plugin is no longer crashing homebridge with an invalid token - so good!

I noticed that I still get these constant log entries when the token is invalid - so I assume some interval is running.

[11/04/2023, 18:13:39] [HBSpruce] Updating controller readings.

is this interval necessary when the token is invalid? Was just a thought of mine - is out of the scope for verification.

If the token was ever valid, the interval will keep updating HomeKit with last known values. If it was never valid, then yeah it's a bit useless. I'll make a note to look into it for the next version.

Thanks for the help getting me verified.