add video doorbell functionality (#488)

* add video doorbell functionality

* bump version, add changelog

* fix typo

* it's a feature 😎

* Update package.json

* Update config.schema.json

* Update config.schema.json

* Update config.schema.json

* remove unneeded functions

* adapt indentation to rest of code

* revert local test config

* add subtype to motion/doorbell switches

* Update config.schema.json

* Update CHANGELOG.md

* add credit

* Create nodejs.yml

* Create package-lock.json

Co-authored-by: Donavan Becker <9875439+donavanbecker@users.noreply.github.com>

Author: normen

.github/workflows/nodejs.yml

@@ -0,0 +1,51 @@
+name: NodeJS
+
+on:
+  push:
+    branches: master
+  pull_request:
+  release: # Run when release is created
+    types: [created]
+
+jobs:
+  build:
+
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 13.x]
+        os: [ubuntu-latest]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v1
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: npm install, build and test
+        run: |
+          npm ci
+          npm run build --if-present
+          npm test
+        env:
+          CI: true
+
+  publish-npm:
+    # publish only if we are on our own repo, event was 'release' (a tag was created) and the tag starts with "v" (aka version tag)
+    if: github.repository == 'donavanbecker/homebridge-honeywell-home' && github.event_name == 'release' && startsWith(github.ref, 'refs/tags/v')
+
+    needs: build # only run if build succeeds
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 10 # use the minimum required version
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.npm_token }}

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to this project will be documented in this file. This project uses [Semantic Versioning](https://semver.org/).
 
+## v1.1.0 (2020-05-13)
+
+### Features
+* Adds an option to have a camera behave like a video doorbell, including a switch to trigger doorbell events (automate the switch to get notifications)
+* Add Manufacturer, Model, Serial, and Firmware Revision into config.schema.json.
 
 ## v1.0.0 (2020-05-11)
 

README.md

@@ -50,6 +50,7 @@
 
 * `uploader` enable uploading of snapshots to Google Drive, defaults to `false`. See wiki for more detailed instructions.
 * `motion` enable a dummy switch and motion sensor to trigger picture notifications in iOS 13, defaults to `false`.  See wiki for more detailed instructions.
+* `doorbell` enable doorbell function for this camera (image notifications). When enabled there will be an additional switch that triggers the doorbell event, automate it to use it with other HomeKit switches, HTTP events etc.
 * `manufacturer` set manufacturer name for display in the Home app
 * `model` set model for display in the Home app
 * `serialNumber` set serial number for display in the Home app
@@ -172,3 +173,7 @@ A somewhat complicated example:
 We have started collecting tested configurations in the wiki, so please before raising an issue with your configuration, please check the [wiki](https://github.com/KhaosT/homebridge-camera-ffmpeg/wiki).  Also if you have a working configuration that you would like to share, please add it to the [wiki](https://github.com/KhaosT/homebridge-camera-ffmpeg/wiki).
 
 https://github.com/KhaosT/homebridge-camera-ffmpeg/wiki
+
+## Credit
+
+Homebridge Camera FFmpeg was originally created by [Khaos Tian](https://twitter.com/khaost).

config.schema.json

@@ -3,7 +3,7 @@
   "pluginType": "platform",
   "singular": true,
   "headerDisplay": "Cameras are exposed to HomeKit as separate accessories and each needs to be manually paired.\n\n1. Open the Home <img src='https://user-images.githubusercontent.com/3979615/78010622-4ea1d380-738e-11ea-8a17-e6a465eeec35.png' height='16.42px'> app on your device.\n2. Tap the Home tab, then tap <img src='https://user-images.githubusercontent.com/3979615/78010869-9aed1380-738e-11ea-9644-9f46b3633026.png' height='16.42px'>.\n3. Tap *Add Accessory*, and select *I Don't Have a Code or Cannot Scan*.\n4. Enter the Homebridge PIN, this can be found under the QR code in Homebridge UI or your Homebridge logs, alternatively you can select *Use Camera* and scan the QR code again.\n\nFor help and examples of common configurations please read the [wiki](https://github.com/KhaosT/homebridge-camera-ffmpeg/wiki).",
-  "footerDisplay": "The **ffmpeg** binary must be installed on your system for this plugin to work.",
+  "footerDisplay": "The **ffmpeg** binary must be installed on your system for this plugin to work. If you are using a custom compiled FFmpeg, to use Audio must compile with libfdk-aac enabled.",
   "schema": {
     "name": {
       "title": "Name",
@@ -33,19 +33,28 @@
             "type": "boolean"
           },
           "manufacturer": {
+            "name": "Manufacturer",
             "type": "string"
           },
           "model": {
+            "name": "Model",
             "type": "string"
           },
           "serialNumber": {
+            "name": "Camera Serial",
             "type": "string"
           },
           "firmwareRevision": {
+            "name": "Firmware Version",
             "type": "string"
           },
           "motion": {
-            "title": "Enable IOS 13 Motion Notifications",
+            "title": "Enable iOS 13 Motion Notifications",
+            "type": "boolean"
+          },
+          "doorbell": {
+            "title": "Enable Doorbell",
+            "description": "Set this up as a doorbell with a switch as trigger (automate the switch to get notifications).",
             "type": "boolean"
           },
           "videoConfig": {
@@ -127,7 +136,7 @@
                 "title": "Packet Size",
                 "type": "number",
                 "placeholder": 1316,
-                "multipleOf": 188.0
+                "multipleOf": 188
               },
               "videoFilter": {
                 "title": "Allows a custom video filter to be passed to FFmpeg via -vf",
@@ -152,7 +161,7 @@
                 "description": " Select the stream used for audio"
               },
               "audio": {
-                "title": "Enable Audio (requires ffmpeg with libfdk-aac)",
+                "title": "Enable Audio",
                 "type": "boolean"
               },
               "vflip": {
@@ -185,7 +194,22 @@
         "cameras[].videoConfig.stillImageSource",
         "cameras[].videoConfig.vcodec",
         "cameras[].videoConfig.audio",
+        "cameras[].motion",
+        "cameras[].doorbell",
         "cameras[].videoConfig.debug",
+        {
+          "key": "cameras[]",
+          "type": "section",
+          "title": "Customization Settings",
+          "expandable": true,
+          "expanded": false,
+          "items": [
+            "cameras[].manufacturer",
+            "cameras[].model",
+            "cameras[].serialNumber",
+            "cameras[].firmwareRevision"
+          ]
+        },
         {
           "key": "cameras[].videoConfig",
           "type": "section",
@@ -205,11 +229,10 @@
             "cameras[].videoConfig.mapvideo",
             "cameras[].videoConfig.mapaudio",
             "cameras[].videoConfig.vflip",
-            "cameras[].videoConfig.hflip",
-            "cameras[].motion"
+            "cameras[].videoConfig.hflip"
           ]
         }
       ]
     }
   ]
-}
+}

index.js

@@ -51,7 +51,11 @@ ffmpegPlatform.prototype.didFinishLaunching = function() {
       }
 
       var uuid = UUIDGen.generate(cameraName);
-      var cameraAccessory = new Accessory(cameraName, uuid, hap.Accessory.Categories.CAMERA);
+      var accessoryType = hap.Accessory.Categories.CAMERA;
+      if(cameraConfig.doorbell){
+        accessoryType = hap.Accessory.Categories.VIDEO_DOORBELL;
+      }
+      var cameraAccessory = new Accessory(cameraName, uuid, accessoryType);
       var cameraAccessoryInfo = cameraAccessory.getService(Service.AccessoryInformation);
       if (cameraConfig.manufacturer) {
         cameraAccessoryInfo.setCharacteristic(Characteristic.Manufacturer, cameraConfig.manufacturer);
@@ -66,9 +70,25 @@ ffmpegPlatform.prototype.didFinishLaunching = function() {
         cameraAccessoryInfo.setCharacteristic(Characteristic.FirmwareRevision, cameraConfig.firmwareRevision);
       }
 
+      if(cameraConfig.doorbell) {
+        var doorbellService = new Service.Doorbell(cameraName+" Doorbell");
+        cameraAccessory.addService(doorbellService);
+        var switchService = new Service.Switch(cameraName + " Doorbell Trigger", "DoorbellTrigger");
+        switchService.getCharacteristic(Characteristic.On)
+        .on('set', function(state, callback){
+          if(state){
+            cameraAccessory.getService(Service.Doorbell).getCharacteristic(Characteristic.ProgrammableSwitchEvent).setValue(0);
+            setTimeout(function(){
+              switchService.getCharacteristic(Characteristic.On).updateValue(false);
+            }, 1000);
+          }
+          callback(null, state);
+        });
+        cameraAccessory.addService(switchService);
+      }
       cameraAccessory.context.log = self.log;
       if (cameraConfig.motion) {
-        var button = new Service.Switch(cameraName);
+        var button = new Service.Switch(cameraName, "MotionTrigger");
         cameraAccessory.addService(button);
 
         var motion = new Service.MotionSensor(cameraName);