homebridge-rademacher-homepilot

[bombadiltom]

Link To GitHub Repo

https://github.com/bombadiltom/homebridge-rademacher-homepilot

Link To NPM Package

https://www.npmjs.com/package/homebridge-rademacher-homepilot

[github-actions[bot]]

The following pre-checks failed:

:x: Failed to install.

Comment /check to run checks again.

[bombadiltom]

/check

[github-actions[bot]]

The following pre-checks failed:

:x: Failed to install.

Comment /check to run checks again.

[bombadiltom]

/check

[github-actions[bot]]

The following pre-checks failed:

:x: Failed to install.

Comment /check to run checks again.

[bombadiltom]

/check

[github-actions[bot]]

:white_check_mark: Pre-checks completed successfully.

[bwp91]

Hi @bombadiltom i have a couple of questions about the plugin name and brand. For starters, I see the plugin name is homebridge-rademacher-homepilot.

Can I assume that rademacher is the brand? - any reason why you aren't publishing under an npm name like homebridge-rademacher instead?

[bombadiltom]

Hi @bwp91, that's historical: I forked https://github.com/jortgies/homebridge-rademacher-blinds back in 2017 which only supported blinds from the brand Rademacher in order to support the Homepilot Hub (https://www.rademacher.de/smart-home/produkte/fernbedienung-automatisierung#homepilot) which is now called SmartHome Box completely. Rademacher then started to sell its products under the brand HOMEPILOT (https://de.homepilot-smarthome.com/impressum) so that the name now is perfekt, because my plugin supports both ;-)

[bwp91]

Thanks for this info - next thing!

It is quite concerning to see a plugin with a file deploy.sh that performs this command:

rm -f /etc/homebridge/accessories/cachedAccessories

any reason for this?

[bombadiltom]

upps, that's a leftover from the very early development stage, made it optional later in deploy_osx.sh. Removed it in both scripts now

[bwp91]

Are the two scripts still necessary in the repo?

I only ask because for fellow users who want to install the plugin but want to have a quick check of the code, they might seem alarmed the fact there are .sh files in the repo.

If they are for development purposes, perhaps they could be added to either:

• the .gitignore file, so they remain on your local machine but do not exist in the github repo, or
• an .npmignore file, so the files won't exist when a user installs a plugin on their machine, but will appear in the github repo

This is an example of my .npmignore file, the files are still present in the github repo but just aren't published as part of the package that is uploaded to npm: https://github.com/bwp91/homebridge-govee/blob/latest/.npmignore

I'm simply suggesting this because having .sh files is not typical in homebridge plugin repos, and im certainly not accusing you of any wrong-doing, but I personally don't like the idea of a verified plugin with these files present.

---

Another couple of things to hopefully save some back and forth!

---

(1) OPTIONAL:

Consider adding a name property here: https://github.com/bombadiltom/homebridge-rademacher-homepilot/blob/ac9a88389fd5b63e7b30b558dfc52eb0d291e4d0/config.schema.json#L9

Just so that users can rename how the plugin looks in the homebridge log.

Like I do here: https://github.com/bwp91/homebridge-govee/blob/c5157be2c468292bd907d89f767303a72afa456f/config.schema.json#L11

---

(2) OPTIONAL:

Don't forget to add some keywords here: https://github.com/bombadiltom/homebridge-rademacher-homepilot/blob/ac9a88389fd5b63e7b30b558dfc52eb0d291e4d0/package.json#L6

So your plugin appears in the homebridge UI if for example a user searches "rademacher" instead of having to search "homebridge-rademacher-homepilot"

---

(3) OPTIONAL

Your config.json file is invalid json, you need to escape the quotes on this line: https://github.com/bombadiltom/homebridge-rademacher-homepilot/blob/ac9a88389fd5b63e7b30b558dfc52eb0d291e4d0/config.json#L9 or even just replace them with single quotes '.

---

[bwp91]

Also please create a github release each time you publish a new version to npm.

https://github.com/bombadiltom/homebridge-rademacher-homepilot/releases

This is one of the criteria for a verified plugin:

A GitHub release should be created for every new version of your plugin, with patch notes.

[bombadiltom]

all done, thanks for the review!

[github-actions[bot]]

• [x] - The plugin must successfully install.
• [x] - The plugin must implement the Homebridge Plugin Settings GUI.
• [x] - The plugin must not start unless it is configured.
• [x] - The plugin must be of type dynamic platform.
• [x] - The plugin must not offer the same nor less functionality than that of any existing verified plugin.
• [x] - The plugin must not execute post-install scripts that modify the user's system in any way.
• [x] - The plugin must not contain any analytics or calls that enable you to track the user.
• [x] - The plugin must not throw unhandled exceptions, the plugin must catch and log its own errors.
• [x] - The plugin must be published to npm and the source code available on GitHub.
• [x] - A GitHub release should be created for every new version of your plugin, with patch notes.
• [x] - The plugin must run on all Active LTS versions of Node.js, at the time of writing this is Node.js v18.
• [x] - The plugin must not require the user to run Homebridge in a TTY or with non-standard startup parameters, even for initial configuration.
• [x] - 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[bot]]

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 :heart: 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!

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