Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Verification Request: homebridge-http-sensors-switches #755

Closed
kreso975 opened this issue Sep 1, 2024 · 16 comments
Closed

Verification Request: homebridge-http-sensors-switches #755

kreso975 opened this issue Sep 1, 2024 · 16 comments
Labels
verified use when a plugin meets the criteria - adds the verified badge text

Comments

@kreso975
Copy link

kreso975 commented Sep 1, 2024

Plugin Name

homebridge-http-sensors-switches

Link To GitHub Repo

https://github.com/kreso975/homebridge-http-sensors-switches

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

Hi,

This is simple HTTP plugin covering Interaction with Switch and reading Sensor JSON data. Each accessory can be adjusted inside config (see Config example).
Main reason i have wrote this code is not to be dependent on non maintained plugins which were causing my homebridge to crash.
I'm using it on iot devices built by my self.

There are similar plugins out there but none of them are verified. I'm new to this kind of process, I hope i did it OK :)

Best regards,
Kreso

@kreso975 kreso975 added the pending the label given to a new verification/icon request label Sep 1, 2024
Copy link

github-actions bot commented Sep 1, 2024

🔴 The following checks failed:

  • Package JSON: more keywords apart from 'homebridge-plugin' should exist

🟢 The following checks passed:

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

@github-actions github-actions bot added awaiting-changes use after review has started - awaiting user to make changes to plugin and removed pending the label given to a new verification/icon request labels Sep 1, 2024
@kreso975
Copy link
Author

kreso975 commented Sep 1, 2024

/check

@github-actions github-actions bot added pending the label given to a new verification/icon request and removed awaiting-changes use after review has started - awaiting user to make changes to plugin labels Sep 1, 2024
Copy link

github-actions bot commented Sep 1, 2024

🟢 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 bwp91 added currently-reviewing use for starting a review - adds a comment with the verification list with empty checkboxes and removed pending the label given to a new verification/icon request labels Sep 22, 2024
Copy link

github-actions bot commented Sep 22, 2024

  • 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.

@bwp91
Copy link
Contributor

bwp91 commented Sep 22, 2024

/check

@github-actions github-actions bot added pending the label given to a new verification/icon request and removed currently-reviewing use for starting a review - adds a comment with the verification list with empty checkboxes labels Sep 22, 2024
@bwp91 bwp91 added currently-reviewing use for starting a review - adds a comment with the verification list with empty checkboxes and removed pending the label given to a new verification/icon request labels Sep 22, 2024
Copy link

github-actions bot commented Sep 22, 2024

  • 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.

Copy link

🟢 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 github-actions bot added the pending the label given to a new verification/icon request label Sep 22, 2024
@bwp91
Copy link
Contributor

bwp91 commented Sep 22, 2024

Hi @kreso975 I think your config.schema.json file isn't quite right, and it is only showing the name and description fields in the UI settings.

Screenshot 2024-09-22 at 09 55 08

I think you need to move this devices up into schema.properties

https://github.com/kreso975/homebridge-http-sensors-switches/blob/e4e622a742bff97414ccbc16a753129850b6c2c8/config.schema.json#L19

@bwp91 bwp91 added awaiting-changes use after review has started - awaiting user to make changes to plugin and removed pending the label given to a new verification/icon request currently-reviewing use for starting a review - adds a comment with the verification list with empty checkboxes labels Sep 22, 2024
@kreso975
Copy link
Author

Hi @bwp91,

Thank you for taking the time to check my plugin. To be honest, I somewhat forgot to properly set up the schema. I wasn’t sure what the best approach would be to get it right. I’ll dig into it, make the necessary adjustments, and let you know.

Thanks again for your time.

Kreso

@kreso975
Copy link
Author

Hi @bwp91,
“I have rewritten config.schema.json and released an update. It should work now. Please check it and let me know if everything is OK.

@bwp91
Copy link
Contributor

bwp91 commented Sep 25, 2024

/test

@bwp91
Copy link
Contributor

bwp91 commented Sep 25, 2024

/check

@github-actions github-actions bot added pending the label given to a new verification/icon request and removed awaiting-changes use after review has started - awaiting user to make changes to plugin labels Sep 25, 2024
Copy link

🟢 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 bwp91 added verified use when a plugin meets the criteria - adds the verified badge text and removed pending the label given to a new verification/icon request labels Sep 25, 2024
bwp91 added a commit that referenced this issue Sep 25, 2024
Copy link

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

@bwp91
Copy link
Contributor

bwp91 commented Sep 25, 2024

config screen looks better now!

@bwp91 bwp91 closed this as completed Sep 25, 2024
@kreso975
Copy link
Author

Thanks a lot @bwp91

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
verified use when a plugin meets the criteria - adds the verified badge text
Projects
None yet
Development

No branches or pull requests

2 participants