Verification Request: homebridge-agile-octopus-rates

[danieljtribe]

Plugin Name

homebridge-agile-octopus-rates

Link To GitHub Repo

https://github.com/danieljtribe/homebridge-agile-octopus

Plugin Icon (Optional)

No response

The plugin does not offer the same nor less functionality than that of any existing verified plugin.

🟢 Yes

The plugin successfully installs and does not start unless it is configured.

🟢 Yes

The plugin does not require the user to run Homebridge in a TTY or with non-standard startup parameters, even for initial configuration.

🟢 Yes

The plugin does not contain any analytics or calls that enable you to track the user.

🟢 Yes

If the plugin needs to write files to disk (cache, keys, etc.), it stores them inside the Homebridge storage directory.

🟢 Yes

The plugin does not throw unhandled exceptions, the plugin must catch and log its own errors.

🟢 Yes

More Information

Thanks for taking the time to review this plugin.

This plugin enables users to schedule electronic devices at the cheapest & greenest times on a UK energy tariff called "Agile" from Octopus Energy.
Historic versions have been for personal use but usage has increased by other Homebridge users and I will be active maintaining this project and publishing updates frequently.

[github-actions]

🔴 The following checks failed:

• Package JSON: homepage missing or does not start with https://
• Package JSON: more keywords apart from 'homebridge-plugin' should exist

---

🟢 The following checks passed:

• Installation: successfully installed
• Package JSON: bugs.url exists and seems a valid URL
• Package JSON: 'preinstall' in scripts is not present
• Package JSON: 'install' in scripts is not present
• Package JSON: 'postinstall' in scripts is not present
• Package JSON: engines.node property is compatible with Node 18
• Package JSON: engines.node property is compatible with Node 20
• Package JSON: engines.homebridge property is compatible with Homebridge 1.8.4
• Package JSON: initializer function found
• GitHub Repo: repository is public
• GitHub Repo: repository is not archived
• GitHub Repo: issues are enabled
• GitHub Repo: contains releases
• NPM Package: has not been deprecated
• Config Schema JSON: exists and is valid JSON
• Config Schema JSON: contains a valid pluginAlias
• Config Schema JSON: the pluginType is set to 'platform'
• Config Schema JSON: contains a name schema property
• Dependencies: homebridge was not installed as a dependency
• Dependencies: hap-nodejs was not installed as a dependency

---

⚠️ Please action these failures and then comment /check to run the checks again. Let us know if you need any help.

If updating your package.json and config.schema.json files, don't forget to publish a new version to NPM.

[danieljtribe]

/check

Good morning, these issues should now be resolved. Could this be checked over once more?

[bwp91]

/check

[github-actions]

• General
  • The plugin must be of type dynamic platform.
  • The plugin must not offer the same nor less functionality than that of any existing verified plugin.
• Repo
  • The plugin must be published to NPM and the source code available on a GitHub repository, with issues enabled.
  • A GitHub release should be created for every new version of your plugin, with release notes.
• Environment
  • The plugin must run on all supported LTS versions of Node.js, at the time of writing this is Node v18 and v20.
  • The plugin must successfully install and not start unless it is configured.
  • The plugin must not execute post-install scripts that modify the users' system in any way.
  • The plugin must not require the user to run Homebridge in a TTY or with non-standard startup parameters, even for initial configuration.
• Codebase
  • The plugin must implement the Homebridge Plugin Settings GUI.
  • The plugin must not contain any analytics or calls that enable you to track the user.
  • If the plugin needs to write files to disk (cache, keys, etc.), it must store them inside the Homebridge storage directory.
  • The plugin must not throw unhandled exceptions, the plugin must catch and log its own errors.

[github-actions]

🟢 The following checks passed:

• Installation: successfully installed
• Package JSON: homepage exists
• Package JSON: bugs.url exists and seems a valid URL
• Package JSON: keywords exist and contain 'homebridge-plugin'
• Package JSON: 'preinstall' in scripts is not present
• Package JSON: 'install' in scripts is not present
• Package JSON: 'postinstall' in scripts is not present
• Package JSON: engines.node property is compatible with Node 18
• Package JSON: engines.node property is compatible with Node 20
• Package JSON: engines.homebridge property is compatible with Homebridge 1.8.4
• Package JSON: initializer function found
• GitHub Repo: repository is public
• GitHub Repo: repository is not archived
• GitHub Repo: issues are enabled
• GitHub Repo: contains releases
• NPM Package: has not been deprecated
• Config Schema JSON: exists and is valid JSON
• Config Schema JSON: contains a valid pluginAlias
• Config Schema JSON: the pluginType is set to 'platform'
• Config Schema JSON: contains a name schema property
• Dependencies: homebridge was not installed as a dependency
• Dependencies: hap-nodejs was not installed as a dependency

---

🎉 All checks passed successfully, nice work! Your plugin and/or icon will now be manually reviewed by the Homebridge team.

[bwp91]

Hi @danieljtribe

I have installed the plugin into a child bridge and have a minimal config of

        {
            "name": "Agile Octopus",
            "platform": "AgileOctopusRates",
            "_bridge": {
                "username": "0E:86:73:5D:5C:85",
                "port": 54483
            }
        }

This is leading to a crash loop with the following error:

[22/09/2024, 09:49:53] [Agile Octopus] Executed didFinishLaunching callback
[22/09/2024, 09:49:53] [Agile Octopus] Restoring existing accessory from cache: Octopus Rates
[22/09/2024, 09:49:53] Homebridge v2.0.0-beta.21 (HAP v1.1.1-beta.6) (Agile Octopus) is running on port 54483.

/usr/local/lib/node_modules/homebridge-agile-octopus-rates/node_modules/got/dist/source/as-promise/index.js:118
                    request._beforeError(new types_1.HTTPError(response));
                                         ^
HTTPError: Response code 404 (Not Found)
    at Request.<anonymous> (/usr/local/lib/node_modules/homebridge-agile-octopus-rates/node_modules/got/dist/source/as-promise/index.js:118:42)
    at processTicksAndRejections (node:internal/process/task_queues:105:5)
[22/09/2024, 09:49:53] [Agile Octopus] Child bridge ended (code 1, signal null). The child bridge ended unexpectedly, which is normally due to the plugin not catching its errors properly. Please report this to the plugin developer by clicking on the 'Report An Issue' option in the plugin menu dropdown from the Homebridge UI. If there are related logs shown above, please include them in your report.
[22/09/2024, 09:49:53] [Agile Octopus] Child bridge will automatically restart in 40 seconds (restart attempt 4 of 4).

Errors like this should be caught and dealt with appropriately!

[danieljtribe]

Hi @bwp91 ,

Thank you so much for taking the time to check this plugin and for the feedback on the error above. I have updated the plugin tis morning as version 1.2.9 with both validation of required config keys and error handling for invalid API responses from the Octopus Energy API to prevent the crash loop described above.

Would you mind giving this a check over with this amendment?

Thanks again,
Dan

[danieljtribe]

/check

[github-actions]

🟢 The following checks passed:

• Installation: successfully installed
• Package JSON: homepage exists
• Package JSON: bugs.url exists and seems a valid URL
• Package JSON: keywords exist and contain 'homebridge-plugin'
• Package JSON: 'preinstall' in scripts is not present
• Package JSON: 'install' in scripts is not present
• Package JSON: 'postinstall' in scripts is not present
• Package JSON: engines.node property is compatible with Node 18
• Package JSON: engines.node property is compatible with Node 20
• Package JSON: engines.homebridge property is compatible with Homebridge 1.8.4
• Package JSON: initializer function found
• GitHub Repo: repository is public
• GitHub Repo: repository is not archived
• GitHub Repo: issues are enabled
• GitHub Repo: contains releases
• NPM Package: has not been deprecated
• Config Schema JSON: exists and is valid JSON
• Config Schema JSON: contains a valid pluginAlias
• Config Schema JSON: the pluginType is set to 'platform'
• Config Schema JSON: contains a name schema property
• Dependencies: homebridge was not installed as a dependency
• Dependencies: hap-nodejs was not installed as a dependency

---

🎉 All checks passed successfully, nice work! Your plugin and/or icon will now be manually reviewed by the Homebridge team.

[github-actions]

Congratulations! Your plugin has been verified!

You can now add one of the Verified by Homebridge badges to your plugin's README:

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

[![verified-by-homebridge](https://img.shields.io/badge/homebridge-verified-blueviolet?color=%23491F59&style=for-the-badge&logoColor=%23FFFFFF&logo=homebridge)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)

Your plugin is now also eligible to display a ❤️ Donate button on its tile in the Homebridge UI. See https://github.com/homebridge/homebridge/wiki/Donation-Links for instructions.

If for any reason in the future you can no longer maintain your plugin, please consider transferring it to our unmaintained plugins repo. We can take ownership until another willing developer comes along.

Don't forget to join the official Homebridge Discord server, where plugin developers can get tips and advice from other developers and the Homebridge project team in the #plugin-development channel!

As a verified plugin, you can request a channel in the Discord server to discuss your plugin with users and other developers. Just ask in the #plugin-development channel.

Thank you for your contribution to the Homebridge community.

• The Homebridge Team

[bwp91]

thanks for making those changes, happy to verify this now 😃

[danieljtribe]

Thanks @bwp91 ! 😃