Scrypted Home Automation

Discord

Join Scrypted Discord

Supported Platforms

• Google Home
• Apple HomeKit
• Amazon Alexa

Supported accessories:

• https://github.com/koush/scrypted/tree/main/plugins

Installation

Run on Docker

Instructions

Run Locally

Prerequisites

• Node v16 (older versions seem to have issues with the cluster module)
• Windows is not supported, but may work.

Linux Prerequisites

sudo apt install libavahi-compat-libdnssd-dev

Run in Terminal

# Mac M1 (Apple Silicon) should uncomment the nextline to switch to x64 mode
# arch -x86_64 zsh

# checkout source
git clone https://github.com/koush/scrypted.git

# npm install and run
cd scrypted/server
npm install
npm run serve
# visit https://localhost:9443/ in a browser

Debug in VSCode

Follow the steps for running locally above.

# in directory with the scrypted git checkout
cd scrypted/server
# open this directory in VSCode
code .

You can now launch Scrypted in VSCode.

Plugin Development Documentation

https://developer.scrypted.app

HomeKit Secure Video Setup

1. Install Scrypted
2. Open https://localhost:9443/
3. Install the HomeKit Plugin from the available plugins tab
4. Install the Unifi, HikVision, ONVIF, or Amcrest camera plugin
   • HKSV requires a plugin with hardware motion detect support. If there's no plugin for your camera, you can install the generic RTSP and the OpenCV motion detector plugin. This will use the processing power on your server to detect camera motion.
5. Install the Rebroadcast plugin.
   • This is optional but highly recommended. It keeps a short video loop of the stream in memory leading up to the motion.
6. Pair with the Scrypted Server accessory using your HomeKit app on iOS or Mac.
7. Enable recording on the cameras in HomeKit.
   • Troubleshooting: Reload the HomeKit Plugin and/or restart Scrypted if streaming works, but recording events do not.