Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
silviokennecke committed Mar 25, 2022
1 parent ef99b4b commit c675187
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 4 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@

This plugin listens the GPIO input of the Raspberry PI and passes it as a HomeKit doorbell.

Alternatively you can use this plugin to trigger a doorbell exposed by [homebridge-camera-ffmpeg](https://www.npmjs.com/package/homebridge-camera-ffmpeg) or [homebridge-camera-ui](https://www.npmjs.com/package/homebridge-camera-ui).

> :warning: This plugin is only designed for and tested on Raspberry PI.
> There's no guarantee, the plugin works also on other boards equipped with GPIO!
Expand Down Expand Up @@ -51,6 +53,12 @@ To connect your doorbell to your PI via GPIO, connect a GPIO pin with GND and th
Optionally you can add a separate output which is triggered when the doorbell rings.
This way you can keep your existing bell working or add a separate buzzer for instance.

### Add to camera

Since version 2.1 you can also use this plugin to trigger a webhook. This way you can use the exposed doorbell by [homebridge-camera-ffmpeg](https://www.npmjs.com/package/homebridge-camera-ffmpeg) or [homebridge-camera-ui](https://www.npmjs.com/package/homebridge-camera-ui). Enabling the webhook will cause the doorbell exposed by this plugin to not be triggered anymore.

For setup first open the `homebridge-camera-ffmpeg` plugin configuration and enable the HTTP Server under "Global Automation" by assigning a port (e.g. 8080) to it. Also, click the "Enable Doorbell" switch in "Automation" for the camera you want to use. Save the changes and open the `homebridge-gpio-doorbell` configuration. Enable the "Enable HTTP Webhook" option and enter the webhook url for triggering the ffmpeg doorbell (e.g. `http://127.0.0.1/doorbell?NameOfVideoCamera`). Save the configuration an restart homebridge. When ringing the doorbell now, your camera exposed by homebridge-camera-ffmpeg will ring and a video stream is shown in the push notification on your iPhone, Apple Watch, etc..

## Support & Contribution

This project is not commercially developed or maintained.
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 6 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "homebridge-gpio-doorbell",
"displayName": "Homebridge GPIO Doorbell",
"version": "2.1.0",
"version": "2.1.1",
"description": "Use GPIO input as HomeKit doorbell",
"license": "Apache-2.0",
"author": {
Expand Down Expand Up @@ -32,7 +32,11 @@
"prepublishOnly": "npm run lint && npm run build"
},
"keywords": [
"homebridge-plugin"
"homebridge-plugin",
"homebridge",
"gpio",
"doorbell",
"pi"
],
"dependencies": {
"axios": "^0.26.1",
Expand Down

0 comments on commit c675187

Please sign in to comment.