Verification Request: @vandubois/homebridge-virtual-switch #752

Plankske · 2024-08-28T01:33:16Z

Plugin Name

@vandubois/homebridge-virtual-switch

Link To GitHub Repo

https://github.com/Plankske/hb-virtual-switch

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 plugin is Homebridge 2.0 compliant and provides for virtual switches. The primary novelty is that the plugin can be used to monitor the Homebridge log file for user defined keywords (e.g. warning/alert messages that a plugin has lost API connection) . When they occur in the log file, a virtual switch is set (stateful or not, normally closed or not). These switches can then be used in advanced HomeKit automations (e.g. to send messages to the admin via Pushover, blow a horn, blink a light, etc.). This increases the practicality and reliability of Homebridge integrations of other (IoT) plugins greatly. Lastly, the plugin also allows for the creation of a variety of traditional virtual switches.

github-actions · 2024-08-28T01:33:58Z

🔴 The following checks failed:

Package JSON: engines.node property is not compatible with Node 18
GitHub Repo: should have issues enabled
GitHub Repo: should contain releases
Config Schema JSON: does not contain a name schema property

🟢 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 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
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'
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.

Plankske · 2024-08-28T02:30:40Z

/check

github-actions · 2024-08-28T02:31:31Z

🔴 The following checks failed:

GitHub Repo: should have issues enabled
GitHub Repo: should contain releases

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

Plankske · 2024-08-28T02:48:35Z

/check

github-actions · 2024-08-28T02:49:15Z

🟢 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 · 2024-09-22T09:18:51Z

/check

github-actions · 2024-09-22T09:19:29Z

🟢 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 · 2024-09-22T09:20:19Z

bwp91 · 2024-09-22T09:27:16Z

Hi @Plankske i'm happy to verify the plugin, however i wondered if this situation could have a more helpful error message for the user.

I have a minimal default config of this:

        {
            "devices": [
                {
                    "NormallyClosed": false,
                    "SwitchStayOn": false,
                    "Time": 5000,
                    "UseLogFile": false,
                    "LogFilePath": "/var/lib/homebridge/homebridge.log",
                    "EnableStartupDelay": false,
                    "StartupDelay": 10000,
                    "RememberState": false
                }
            ],
            "name": "HomebridgeVirtualSwitches",
            "platform": "HomebridgeVirtualSwitches",
            "_bridge": {
                "username": "0E:E9:1B:29:78:5B",
                "port": 37196
            }
        }

and this is leading to a (correctly caught) error of this:

[22/09/2024, 10:23:20] [HomebridgeVirtualSwitches] DEBUG: Executed didFinishLaunching callback
[22/09/2024, 10:23:20] [HomebridgeVirtualSwitches] DEBUG: Device config: {"SwitchStayOn":false,"Time":5000,"UseLogFile":false,"LogFilePath":"/var/lib/homebridge/homebridge.log","Keywords":[],"EnableStartupDelay":false,"StartupDelay":10000,"NormallyClosed":false,"RememberState":false}
[22/09/2024, 10:23:20] [HomebridgeVirtualSwitches] ERROR: Failed to load dependencies: TypeError: The "data" argument must be of type string or an instance of Buffer, TypedArray, or DataView. Received undefined
    at Hash.update (node:internal/crypto/hash:115:11)
    at Object.generate (/usr/local/lib/node_modules/homebridge/node_modules/hap-nodejs/src/lib/util/uuid.ts:11:11)
    at HomebridgeVirtualSwitchesPlatform.discoverDevices (file:///usr/local/lib/node_modules/@vandubois/homebridge-virtual-switch/src/platform.ts:97:38)
    at file:///usr/local/lib/node_modules/@vandubois/homebridge-virtual-switch/src/platform.ts:47:14 {
  code: 'ERR_INVALID_ARG_TYPE'
}
[22/09/2024, 10:23:20] Homebridge v2.0.0-beta.21 (HAP v1.1.1-beta.6) (HomebridgeVirtualSwitches) is running on port 37196.

I just wondered if this is a config-issue then the resolution could be made clearer to the user.

github-actions · 2024-09-22T09:27:33Z

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

#752

Plankske · 2024-09-26T17:42:27Z

Hi! Thanks for the verification! Made an update to alert the user about the error and how to resolve. Keep up the good work! Very much appreciated! Best Regards, Dirk From: Ben ***@***.***> Sent: Sunday, September 22, 2024 5:28 AM To: homebridge/verified ***@***.***> Cc: Plankske ***@***.***>; Mention ***@***.***> Subject: Re: [homebridge/verified] Verification Request: @vandubois/homebridge-virtual-switch (Issue #752) Hi @Plankske<https://github.com/Plankske> i'm happy to verify the plugin, however i wondered if this situation could have a more helpful error message for the user. I have a minimal default config of this: { "devices": [ { "NormallyClosed": false, "SwitchStayOn": false, "Time": 5000, "UseLogFile": false, "LogFilePath": "/var/lib/homebridge/homebridge.log", "EnableStartupDelay": false, "StartupDelay": 10000, "RememberState": false } ], "name": "HomebridgeVirtualSwitches", "platform": "HomebridgeVirtualSwitches", "_bridge": { "username": "0E:E9:1B:29:78:5B", "port": 37196 } } and this is leading to a (correctly caught) error of this: [22/09/2024, 10:23:20] [HomebridgeVirtualSwitches] DEBUG: Executed didFinishLaunching callback [22/09/2024, 10:23:20] [HomebridgeVirtualSwitches] DEBUG: Device config: {"SwitchStayOn":false,"Time":5000,"UseLogFile":false,"LogFilePath":"/var/lib/homebridge/homebridge.log","Keywords":[],"EnableStartupDelay":false,"StartupDelay":10000,"NormallyClosed":false,"RememberState":false} [22/09/2024, 10:23:20] [HomebridgeVirtualSwitches] ERROR: Failed to load dependencies: TypeError: The "data" argument must be of type string or an instance of Buffer, TypedArray, or DataView. Received undefined at Hash.update (node:internal/crypto/hash:115:11) at Object.generate (/usr/local/lib/node_modules/homebridge/node_modules/hap-nodejs/src/lib/util/uuid.ts:11:11) at HomebridgeVirtualSwitchesPlatform.discoverDevices ***@***.***/homebridge-virtual-switch/src/platform.ts:97:38) at ***@***.***/homebridge-virtual-switch/src/platform.ts:47:14 { code: 'ERR_INVALID_ARG_TYPE' } [22/09/2024, 10:23:20] Homebridge v2.0.0-beta.21 (HAP v1.1.1-beta.6) (HomebridgeVirtualSwitches) is running on port 37196. I just wondered if this is a config-issue then the resolution could be made clearer to the user. - Reply to this email directly, view it on GitHub<#752 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/APYHGATA26UL23ZJN34NU7LZX2EQVAVCNFSM6AAAAABNHHSFQ6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGNRWGMZDQMJTGE>. You are receiving this because you were mentioned.Message ID: ***@***.******@***.***>>

Plankske added the pending the label given to a new verification/icon request label Aug 28, 2024

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 Aug 28, 2024

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 Aug 28, 2024

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 Aug 28, 2024

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 Aug 28, 2024

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

bwp91 added verified use when a plugin meets the criteria - adds the verified badge text and removed currently-reviewing use for starting a review - adds a comment with the verification list with empty checkboxes labels Sep 22, 2024

bwp91 added a commit that referenced this issue Sep 22, 2024

verify: @vandubois/homebridge-virtual-switch

b95eddb

#752

bwp91 closed this as completed Sep 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Verification Request: @vandubois/homebridge-virtual-switch #752

Verification Request: @vandubois/homebridge-virtual-switch #752

Plankske commented Aug 28, 2024

github-actions bot commented Aug 28, 2024

Plankske commented Aug 28, 2024

github-actions bot commented Aug 28, 2024

Plankske commented Aug 28, 2024

github-actions bot commented Aug 28, 2024

bwp91 commented Sep 22, 2024

github-actions bot commented Sep 22, 2024

github-actions bot commented Sep 22, 2024 •

edited by bwp91

Loading

bwp91 commented Sep 22, 2024

github-actions bot commented Sep 22, 2024

Plankske commented Sep 26, 2024 via email

Verification Request: @vandubois/homebridge-virtual-switch #752

Verification Request: @vandubois/homebridge-virtual-switch #752

Comments

Plankske commented Aug 28, 2024

Plugin Name

Link To GitHub Repo

Plugin Icon (Optional)

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

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

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

The plugin does 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 stores them inside the Homebridge storage directory.

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

More Information

github-actions bot commented Aug 28, 2024

Plankske commented Aug 28, 2024

github-actions bot commented Aug 28, 2024

Plankske commented Aug 28, 2024

github-actions bot commented Aug 28, 2024

bwp91 commented Sep 22, 2024

github-actions bot commented Sep 22, 2024

github-actions bot commented Sep 22, 2024 • edited by bwp91 Loading

bwp91 commented Sep 22, 2024

github-actions bot commented Sep 22, 2024

Plankske commented Sep 26, 2024 via email

github-actions bot commented Sep 22, 2024 •

edited by bwp91

Loading