homebridge-ezviz
Version:
EZVIZ plugin for homebridge: https://homebridge.io/
70 lines (52 loc) • 6.37 kB
Markdown
<p align="center">
<a href="https://github.com/homebridge/verified/blob/master/verified-plugins.json"><img alt="Homebridge Verified" src="https://raw.githubusercontent.com/Brandawg93/homebridge-ezviz/master/branding/Homebridge_x_EZVIZ.svg?sanitize=true" width="500px"></a>
</p>
View your EZVIZ cameras in HomeKit using [Homebridge](https://github.com/homebridge/homebridge) with this plugin.
[](https://nodei.co/npm/homebridge-ezviz/)
[](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=CEYYGVB7ZZ764&item_name=homebridge-ezviz¤cy_code=USD&source=url)
[](https://www.buymeacoffee.com/L1FgZTD)
[](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
[](https://discord.gg/pc2pqmh)
[](https://nodei.co/npm/homebridge-ezviz/)
[](https://www.npmjs.com/package/homebridge-ezviz/v/latest)
[](https://www.npmjs.com/package/homebridge-ezviz/v/test)
[](https://github.com/Brandawg93/homebridge-ezviz/releases/latest)
## Installation
1. Install this plugin using: `npm install -g --unsafe-perm homebridge-ezviz`
2. Add your account credentials to `config.json`
3. Run [Homebridge](https://github.com/homebridge/homebridge)
**Note:** 2 Factor Authentication is not supported at this time.
### Setting up the Config.json
#### region
The `"region"` is based on your location. In order to set the `"region"`, either use the Settings UI or view the list of available region in the `config.schema.json`.
#### cameras
Each camera feed is protected by a verification code. The camera's serial number and verification code can be found on the bottom of the device. Add each camera to the `"cameras"` array to be able view their feeds.
```
{
"region": 314,
"email": "YOUR_EMAIL",
"password": "YOUR_PASSWORD",
"cameras": [
{
"serial": "SERIAL",
"username": "admin",
"code": "VERIFICATION_CODE"
}
],
"platform": "EZVIZ"
},
```
Extra options can be enabled/disabled depending on which switches and sensors you would like to see in the Home app. Here is the current list of available options:
| Name | Description | Type |
|-------------------|---------------------------------------------------------------------|------------------|
| sleepSwitch | Enable/disable the ability to turn the camera on or off | boolean |
| audioSwitch | Enable/disable the ability to turn the camera audio on or off | boolean |
| pathToFfmpeg | Specify the path to a custom FFmpeg binary | string |
Unfortunately, there is no way for me to test every subscription, camera type, and feature. If you would like to help me test new features and enhancements, or if you have general questions or need support, join the official [Homebridge Discord Server](https://discord.gg/pc2pqmh).
This plugin was made with you in mind. If you would like to show your appreciation for its continued development, please consider making [a small donation](https://www.buymeacoffee.com/L1FgZTD).
<sub><sup>**Disclaimer:** This plugin and its contributers are not affiliated with Hangzhou Ezviz Network Co., Ltd. in any way.</sub></sup>