homebridge-sharkiq

[Bubba8291]

Link To GitHub Repo

https://github.com/Bubba8291/homebridge-sharkiq

Link To NPM Package

https://www.npmjs.com/package/homebridge-sharkiq

[github-actions]

✅ Pre-checks completed successfully.

[bwp91]

Hi @Bubba8291
Always grateful for new plugins and the time that devs spend to develop them!

And whilst I appreciate your honesty - I just have some concerns about verifying a plugin that claims in the readme things like

A very, very, very messy plugin for SharkIQ Vacuums.

This plugin is really, REALLY, buggy. Sometimes the vacuum won't turn on or off from Homebridge the first time, and you have to toggle it a second time.

One of the most important checks for verified homebridge plugins is that it catches any errors properly and does not end up crashing homebridge or any child bridge that the plugin is installed in.

So I just wanted to check when you talk about the bugs in your readme, are there any situations where it crashes homebridge?

Would you need any help with making your plugin not very, very, very messy 😂

[Bubba8291]

@bwp91

As I've been developing it, I made sure to catch all the errors. So there shouldn't be any unexpected crashing.

As I've been using it more, I've learned that it's not as messy as I thought it would be. The main issue is that sometimes the vacuum doesn't refresh on set a control right away.

So I feel like it is stable enough where people are able to use it functionally.

[bwp91]

Ah thanks for the clarification and updating the readme.

My mind is wandering now... these aren't really to do with verification but I noticed:

1. you don't need xmlhttprequest-ts in devDependencies if it is already above in the dependencies
2. is this expected in the config plugin screen? cc @donavanbecker

A.Screen.Recording.2023-09-01.at.23.50.34.mov

[bwp91]

Also, the json config example in your readme is in fact invalid json, there should not be a comma at the end of this line:
https://github.com/Bubba8291/homebridge-sharkiq/blob/1d49f840fdfe48f277977f8edc9b4cc6f6c310ca/README.md?plain=1#L35

Consider on this line:
https://github.com/Bubba8291/homebridge-sharkiq/blob/1d49f840fdfe48f277977f8edc9b4cc6f6c310ca/README.md?plain=1#L22
adding json after the three backticks, this will format the code nicely and also highlight any issues in the normal view. in fact this whole section could look like this:

```json
{
    "platforms": [
        {
            "name": "SharkIQ",
            "platform": "SharkIQ",
            "email": "[Shark Clean Account Email]",
            "password": "[Shark Clean Account Password]",
            "vacuums": [
                "[Shark Vacuum Serial Number]",
                "..."
            ],
            "invertDockedStatus": false
        }
    ]
}
`` <- add another backtick

which will end up looking like this:

{
    "platforms": [
        {
            "name": "SharkIQ",
            "platform": "SharkIQ",
            "email": "[Shark Clean Account Email]",
            "password": "[Shark Clean Account Password]",
            "vacuums": [
                "[Shark Vacuum Serial Number]",
                "..."
            ],
            "invertDockedStatus": false
        }
    ]
}

[Bubba8291]

@bwp91

I updated the devDependencies and readme. I'm not super familiar with the Homebridge config ui, but I updated a line in the config.schema.json that should hopefully have fixed it.

[github-actions]

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

---

Everything Looks Good!

[github-actions]

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

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