This is a Homebridge Plugin derived from '''neramirez/homebrige-yale-connect'''
I found the plugin couldn't authenticate, and also lacked any instruction or helpful readme.
npm install
Open the package.json
and change the following attributes:
name
- this should be prefixed withhomebridge-
or@username/homebridge-
and contain no spaces or special characters apart from a dashesdisplayName
- this is the "nice" name displayed in the Homebridge UIrepository.url
- Link to your GitHub repobugs.url
- Link to your GitHub repo issues page
When you are ready to publish the plugin you should set private
to false, or remove the attribute entirely.
Open the src/settings.ts
file and change the default values:
PLATFORM_NAME
- Set this to be the name of your platform. This is the name of the platform that users will use to register the plugin in the Homebridgeconfig.json
.PLUGIN_NAME
- Set this to be the same name you set in thepackage.json
file.
Open the config.schema.json
file and change the following attribute:
pluginAlias
- set this to match thePLATFORM_NAME
you defined in the previous step.
TypeScript needs to be compiled into JavaScript before it can run. The following command will compile the contents of your src
directory and put the resulting code into the dist
folder.
npm run build
Run this command so your global install of Homebridge can discover the plugin in your development environment:
npm link
You can now start Homebridge, use the -D
flag so you can see debug log messages in your plugin:
homebridge -D
If you want to have your code compile automatically as you make changes, and restart Homebridge automatically between changes, you first need to add your plugin as a platform in ~/.homebridge/config.json
:
{
...
"platforms": [
{
"name": "Config",
"port": 8581,
"platform": "config"
},
{
"name": "<PLUGIN_NAME>",
//... any other options, as listed in config.schema.json ...
"platform": "<PLATFORM_NAME>"
}
]
}
and then you can run:
npm run watch
This will launch an instance of Homebridge in debug mode which will restart every time you make a change to the source code. It will load the config stored in the default location under ~/.homebridge
. You may need to stop other running instances of Homebridge while using this command to prevent conflicts. You can adjust the Homebridge startup command in the nodemon.json
file.
You can now start customising the plugin template to suit your requirements.
src/platform.ts
- this is where your device setup and discovery should go.src/lockAccessory.ts
- this is where your accessory control logic should go, you can rename or create multiple instances of this file for each accessory type you need to implement as part of your platform plugin. You can refer to the developer documentation to see what characteristics you need to implement for each service type.config.schema.json
- update the config schema to match the config you expect from the user. See the Plugin Config Schema Documentation.
Given a version number MAJOR
.MINOR
.PATCH
, such as 1.4.3
, increment the:
- MAJOR version when you make breaking changes to your plugin,
- MINOR version when you add functionality in a backwards compatible manner, and
- PATCH version when you make backwards compatible bug fixes.
You can use the npm version
command to help you with this:
# major update / breaking changes
npm version major
# minor update / new features
npm version update
# patch / bugfixes
npm version patch
When you are ready to publish your plugin to npm, make sure you have removed the private
attribute from the package.json
file then run:
npm publish
If you are publishing a scoped plugin, i.e. @username/homebridge-xxx
you will need to add --access=public
to command the first time you publish.
You can publish beta versions of your plugin for other users to test before you release it to everyone.
# create a new pre-release version (eg. 2.1.0-beta.1)
npm version prepatch --preid beta
# publish to @beta
npm publish --tag=beta
Users can then install the beta version by appending @beta
to the install command, for example:
sudo npm install -g homebridge-example-plugin@beta