homebridge-camera-ffmpeg

ffmpeg plugin for Homebridge

Installation

1. Install ffmpeg on your computer
2. Install this plugin using: npm install -g homebridge-camera-ffmpeg
3. Edit config.json and add the camera.
4. Run Homebridge
5. Add extra camera accessories in Home app. The setup code is the same as homebridge.

Config.json Example

{
  "platform": "Camera-ffmpeg",
  "cameras": [
    {
      "name": "Camera Name",
      "videoConfig": {
      	"source": "-re -i rtsp://myfancy_rtsp_stream",
      	"stillImageSource": "-i http://faster_still_image_grab_url/this_is_optional.jpg",
      	"maxStreams": 2,
      	"maxWidth": 1280,
      	"maxHeight": 720,
      	"maxFPS": 30
      }
    }
  ]
}

Optional Parameters

• maxStreams is the maximum number of streams that will be generated for this camera, default 2
• maxWidth is the maximum width reported to HomeKit, default 1280
• maxHeight is the maximum height reported to HomeKit, default 720
• maxFPS is the maximum frame rate of the stream, default 10
• maxBitrate is the maximum bit rate of the stream in kbit/s, default 300
• vcodec If you're running on a RPi with the omx version of ffmpeg installed, you can change to the hardware accelerated video codec with this option, default "libx264"
• audio can be set to true to enable audio streaming from camera. To use audio ffmpeg must be compiled with --enable-libfdk-aac, see https://github.com/KhaosT/homebridge-camera-ffmpeg/wiki, default false
• packetSize If audio or video is choppy try a smaller value, set to a multiple of 188, default 1316
• debug Show the output of ffmpeg in the log, default false

{
  "platform": "Camera-ffmpeg",
  "cameras": [
    {
      "name": "Camera Name",
      "videoConfig": {
      	"source": "-re -i rtsp://myfancy_rtsp_stream",
        "stillImageSource": "-i http://faster_still_image_grab_url/this_is_optional.jpg",
      	"maxStreams": 2,
      	"maxWidth": 1280,
      	"maxHeight": 720,
      	"maxFPS": 30,
      	"maxBitrate": 200,
      	"vcodec": "h264_omx",
      	"audio": true,
      	"packetSize": 188,
      	"debug": true
      }
    }
  ]
}

Using another Video Processor

• videoProcessor is the video processor used to manage videos. eg: ffmpeg (by default) or avconv or /a/path/to/another/ffmpeg. Need to use the same parameters than ffmpeg.

{
  "platform": "Camera-ffmpeg",
  "videoProcessor": "avconv",
  "cameras": [
    ...
  ]
}

{
  "platform": "Camera-ffmpeg",
  "videoProcessor": "/my/own/compiled/ffmpeg",
  "cameras": [
    ...
  ]
}

Using Arlo cameras

In order to use this plugin with Arlo cameras, first install Jeffrey Walter's Arlo library.

Then, configure the following parameters under videoConfig:

• source This should be set to arlo
• stillImageSource This parameter should not be set.
• arloUserName Your arlo account email address.
• arloPassword Your arlo account password.
• arloCameraIndex Index of the Arlo camera to configure. First arlo camera on your account starts at index 0.
• audio Set to false. Audio is not currently supported with Arlo.
• vcodec Takes the usual parameters. Setting it to copy makes the video start faster and gives you better quality streaming.

Note : Arlo support is still experimental. I've only tested it with Arlo Pro 2 cameras. YMMV.

{
  "platform": "Camera-ffmpeg",
  "cameras": [
    {
      "name": "Camera Name",
      "videoConfig": {
      	"source": "arlo",
      	"maxStreams": 2,
      	"maxWidth": 1280,
      	"maxHeight": 720,
      	"maxFPS": 30,
      	"maxBitrate": 300,
      	"vcodec": "copy",
      	"audio": false,
      	"debug": true,
        "arloUserName": "email@provider.com",
        "arloPassword": "<your arlo password>",
        "arloCameraIndex": "0"
      }
    }
  ]
}

Uploading to Google Drive of Still Images ( Snapshots )

This is an optional feature that will automatically store every snapshot taken to your Google Drive account as a photo. This is very useful if you have motion sensor in the same room as the camera, as it will take a snapshot of whatever caused the motion sensor to trigger, and store the image on Google Drive and create a Picture Notification on your iOS device.

The snapshots are stored in a folder called "Camera Pictures", and are named with camera name, date and time of the image.

To enable this feature, please add a new config option "uploader", and follow the steps below.

• Add the option "uploader" to your config.json i.e.

{
  "platform": "Camera-ffmpeg",
  "cameras": [
    {
      "name": "Camera Name",
      "uploader": true,
      "videoConfig": {
      	"source": "-re -i rtsp://myfancy_rtsp_stream",
        "stillImageSource": "-i http://faster_still_image_grab_url/this_is_optional.jpg",
      	"maxStreams": 2,
      	"maxWidth": 1280,
      	"maxHeight": 720,
      	"maxFPS": 30,
      	"vcodec": "h264_omx"            
      }
    }
  ]
}

If the option is missing, it defaults to false, and does not enable the uploader.

• For the setup of Google Drive, please follow the Google Drive Quickstart for Node.js instructions from here except for these changes.

https://developers.google.com/drive/v3/web/quickstart/nodejs

• In Step 1-h the working directory should be the .homebridge directory
• Skip Step 2 and 3
• And in step 4, use the quickstart.js included in the plugin itself. And to do this you need to run the command from the plugin directory. Then just follow steps a to c

Tested configurations

We have started collecting tested configurations in the wiki, so please before raising an issue with your configuration, please check the 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