homebridge/verified

homebridge-foxess

teh-hippo opened this issue · 7 comments

teh-hippo commented

Plugin Name

homebridge-foxess

Link To GitHub Repo

https://github.com/teh-hippo/homebridge-foxess

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

The plug-in allows users of the FoxESS solar platform, and users of other companies that utilise FoxESS, to have an indication of current solar performance in HomeKit.

I wasn't sure how this should be approached initially. There are several other plug-ins that create custom devices and rely on Eve for history. This has worked well for my own use - a set of light sensors to reflect current production and grid usage.

The plug-in initially relied on its own libraries to connect to the platform provider. I have since separated this into its own open-source library.

github-actions commented

🔴 The following pre-checks failed:

  • Package JSON: homepage missing or does not start with https://

🟢 The following pre-checks passed:

  • Installation: successfully installed
  • Package JSON: bugs.url exists
  • 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.7.0
  • 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.

teh-hippo commented

/check

github-actions commented

🟢 The following pre-checks passed:

  • Installation: successfully installed
  • Package JSON: homepage exists
  • Package JSON: bugs.url exists
  • 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.7.0
  • 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 pre-checks passed successfully, nice work! Your plugin and/or icon will now be manually reviewed by the Homebridge team.

  • 👍1
github-actions commented
  • 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 commented

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

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

verified-by-homebridge

[![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
  • 🎉1
bwp91 commented

There are several other plug-ins that create custom devices and rely on Eve for history

Using Eve is a good shout - it is still a HomeKit app!

  • 👍1
teh-hippo commented

Oh absolutely @bwp91; didn't mean to imply it wasn't! Was more saying why this worked for me. I actually want to explore the custom devices space more; haven't done much there.