This project is a homebridge plugin for the smart intercom nello.io. All your nello.io locks are dynamically added to HomeKit as lock accessories. If you want to learn more about the smart intercom nello one, please visit https://www.nello.io.
Nello went bankrupt and was bought by Sclak. The public API was down for a long time after the announcement in October 2019 (though the app worked intermittently), but is back online as of August 2020. This plugin may stop working at any time due to this uncertainty. (See: #48)
Look here: Release v1.0.0
It's recommended to create a new dedicated nello.io account in order to prevent duplicated notifications if you open the door over the Home app. It's also possible to use your own account with this plugin.
Install the plugin via npm:
npm install homebridge-nello -g
Generate clientId & clientSecret
IMPORTANT: Please visit https://auth.nello.io/admin/ and sign in with your username and password that you also use in the nello.io app. If you are using a dedicated user account for this plugin, make sure that you use the credentials of this account to generate a client ID.
Fill in all required fields in the "Create API client" form (mark all "Allowed response type"s and "Allowed grant type"s)
Add the basic configuration
{
"platforms": [
{
"platform" : "NelloPlatform",
"name" : "nello.io",
"auth": {
"clientSecret": "<paste-client-secret-here>",
"clientId": "<paste-client-id-here>"
}
}
]
}
This exposes ONLY the door lock. Look at the docs for more options to configure motion sensors, the video doorbell, a custom webhook server, automation helper switches, and configure reachability.
You can install the default package or compile it yourself if you have a special case to fit.
sudo apt-get install ffmpeg
General information about ffmpeg can be found here https://github.com/KhaosT/homebridge-camera-ffmpeg/wiki)
Due to HomeKit limitations it's required to add the camera separately. Just tap on the plus button in the top right corner, choose "Add Accessory" and click on "Don't Have a Code or Can't Scan?". In the next view you should see the camera accessory. Tap it in order to add it to the Home app. The PIN is the same as of your HomeBridge instance.
You need to install ffmpeg if you want to see a picture in the Home app. Just take a look at last paragraph of the Installation part.
This plugin uses the HTTP API of nello.io for the following features:
Others
config.json
on the PC/Mac/Raspberry running homebridge. Please make sure that nobody can access this device within your local network without permission.npm run lint
/ npm run format
bump-version
workflow and trigger a new event by clicking Run workflow
. You can enter major
minor
patch
or an actual version like v0.0.1
. This bumps the package.json
version, creates a tag, updates the docs, pushes it back to master, and publishes to npm. (Source: bump-version.yml).(Requires GitHub Action NPM_TOKEN
secret to be set in the repo with publish rights).