Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ptz0n/homebridge-verisure
Platform plugin for Homebridge allowing to manage and control Verisure devices.
https://github.com/ptz0n/homebridge-verisure
homebridge homebridge-plugin iot verisure
Last synced: 10 days ago
JSON representation
Platform plugin for Homebridge allowing to manage and control Verisure devices.
- Host: GitHub
- URL: https://github.com/ptz0n/homebridge-verisure
- Owner: ptz0n
- License: mit
- Created: 2017-01-21T15:41:49.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-12-05T09:00:34.000Z (11 months ago)
- Last Synced: 2024-10-17T13:35:14.901Z (20 days ago)
- Topics: homebridge, homebridge-plugin, iot, verisure
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/homebridge-verisure
- Size: 258 KB
- Stars: 66
- Watchers: 17
- Forks: 15
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# homebridge-verisure
[](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
[](https://snyk.io/)
[](https://github.com/ptz0n/homebridge-verisure/actions?query=workflow%3ATest)
This is a plugin for [Homebridge](https://github.com/nfarina/homebridge). It's
an implementation for your Verisure installation and exposes the following devices:
- Security alarm
- Climate sensor
- Magnetic contact
- Night Control
- Siren
- SmartLock
- SmartPlug
- Smoke detector
- Vibration detector
## Protect linked devices & accounts
If configured, this plugin will expose your security system and door lock.
Please protect you installation from unauthorised access:
1. Generate a unique `pin` for your config. Never, ever use the default one.
2. Lock all devices with access to your installation when not in use.
3. Remove access from users that no longer need it.
4. Keep your devices up to date.
## Installation
```bash
npm install -g homebridge-verisure
```
Now you can update your configuration file to enable the plugin, see sample
snippet below.
## Configuration
As part of your configuration, add an object with your Verisure credentials to
your array (list) of enabled platform plugins. Example config:
```json
"platforms": [
{
"platform" : "verisure",
"name" : "Verisure",
"email": "[email protected]",
"password": "yourT0p5ecre7Passw0rd",
"cookies": [
"vid=myTopSecretToken",
"vs-access=myAccessToken",
"vs-refresh=myRefreshToken"
],
"alarmCode": "0000",
"doorCode": "000000",
"installations": ["Alias"],
"pollInterval": 60
}
]
```
* __`email`__ Required string containing your Verisure account email address.
* __`password`__ Required string containing your Verisure account password. Not needed if you use `cookies`.
* __`cookies`__ Required array of strings for accounts with MFA enabled.
* `alarmCode` Optional string containing your security system alarm code.
* `doorCode` Optional string containing your door lock code.
* `installations` Optional array for filtering installations based on Verisure alias. Defaults to `[]`
* `pollInterval` Optional integer containing poll interval in seconds. Defaults to `60`.
* `showAutoLockSwitch` Optional boolean for exposing door lock auto lock switch. Defaults to `true`.
* `showAudioSwitch` Optional boolean for exposing door audio volume switch. Defaults to `true`.
* `audioOffValue` Optional string for door audio volume, `SILENCE` or `LOW`. Defaults to `SILENCE`.
* `audioOnValue` Optional string for door audio volume, `LOW` or `HIGH`. Defaults to `LOW`.
### Multi-factor authentication
> [Verisure] MFA is enabled for user. Please see README.
In 2021 Verisure started enrolling MFA which requires you to obtain cookies. These cookies are used instead of a `password` in your config and will need to be renewed yearly. After installing the plugin, run `npx homebridge-verisure` in your terminal and copy the output values into your config.
```bash
$ npx homebridge-verisure
✔ What is your login email? · [email protected]
✔ What is your password? · ********************
One-time code sent.
✔ What is your one-time code? · FAKE12
Your config is ready.
{
"platform": "verisure",
"name": "Verisure",
"email": "[email protected]",
"cookies": [
"vid=myTopSecretToken",
"vs-access=myAccessToken",
"vs-refresh=myRefreshToken"
]
}
```
### Environment variables
For convenience, the following environment variables can be used instead of placing secrets in your `config.json`.
* `VERISURE_ALARM_CODE`
* `VERISURE_COOKIES` - Join into a string, separated by `;`. Example: `vid=myTopSecretToken;vs-access=myAccessToken;vs-refresh=myRefreshToken`.
* `VERISURE_DOOR_CODE`
* `VERISURE_EMAIL`
* `VERISURE_PASSWORD`