Git Product home page Git Product logo

homebridge-nest-cam's Introduction

Homebridge Verified

homebridge-nest-cam

View your Nest cams in HomeKit using Homebridge with this plugin.

NPM

PayPal

verified-by-homebridge certified-hoobs-plugin

build Discord Downloads

npm (tag) npm (tag) GitHub commits since latest release (by date)

FAQ Troubleshooting Error Codes

Notes

  • This plugin does not work with the latest Nest cameras. If you do not see it in the Nest app, then it will not show in this plugin. More info can be found at #440.

Installation

  1. Install this plugin using: npm install -g --unsafe-perm homebridge-nest-cam
  2. Add google authentication to config.json
  3. Run Homebridge
  4. Login with homebridge-config-ui-x or use the manual authentication method.

FFmpeg

By default, libx264 is used as the h264 encoder. If you would like to use a hardware-accelerated encoder instead, refer to the h264 Hardware Encoders Wiki.

Setting up the Config.json

refreshToken

Google Accounts are configured using a "refreshToken" string in config.json. An example is shown below. The field will be generated automatically when using homebridge-config-ui-x, otherwise, it can be found in your Nest account using the manual authentication method.

{
    "platform": "Nest-cam",
    "options": {
      "ffmpegCodec": "libx264",
      "motionDetection": true,
      "streamingSwitch": true,
      "disableAudio": false
    },
    "refreshToken": "1//01T_..."
}

options

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
ffmpegCodec The video codec to use for FFmpeg string
streamQuality The quality of the stream from LOW to HIGH number (1-3)
alertCheckRate How often to check for alerts number (seconds)
alertCooldownRate How long between consecutive alert notifications number (seconds)
alertTypes What type of alerts to receive array
importantOnly Only send notifications on events considered important boolean
motionDetection Enable/disable the motion sensors boolean
doorbellAlerts Enable/disable doorbell ring notifications boolean
doorbellSwitch Enable/disable doorbell automation switch boolean
streamingSwitch Enable/disable the ability to turn the camera on or off boolean
chimeSwitch Enable/disable the ability to turn the doorbell chime 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
cameras Specify the camera UUID of which cameras to see array
structures Specify the structure ID of which structures' cameras to see array

Features

  • View cameras within homekit.
  • Receive notifications and set routines for motion or when the doorbell is rang.
  • Receive notifications for specific motion events.
  • Listen and talk back to people on equipped cameras.
  • Enable/disable the indoor chime on Hello doorbells.

Join the Discord

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.

Credits

This plugin was originally developed by KhaosT.

This plugin was converted to typescript using both homebridge-ring and homebridge-examples.

Donate to Support homebridge-nest-cam

This plugin was made with you in mind. If you would like to show your appreciation for its continued development, please consider sponsoring me on Github.

Disclaimer: This plugin and its contributers are not affiliated with Google LLC or Nest Labs in any way.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.