mirror of
https://github.com/koush/scrypted.git
synced 2026-05-26 14:40:29 +01:00
746ab230fd3145ce3a0a5ec6e4efae01fc9a103b
Scrypted Home Automation
Scrypted is a home automation platform primarily focusing on making camera experiences seamless.
- Streams load instantly, everywhere: Demo
- HomeKit Secure Video Support
- Google Home support: "Ok Google, Stream Backyard"
Discord
Supported Platforms
- Google Home
- Apple HomeKit
- Amazon Alexa
Supported accessories:
Installation
Run on Docker
Docker Installation Instructions
Run Locally
Local Installation Instructions
Plugin Development Documentation
https://developer.scrypted.app
Debug the Scrypted Server in VSCode
# check out the code
git clone https://github.com/koush/scrypted
cd scrypted
# get the dependencies for the server and various plugins
./npm-install.sh
# switch to the server directory
cd server
# open this directory in VS Code
code .
You can now launch Scrypted in VSCode.
Debug Scrypted Plugins in VSCode
# this is an example for homekit
# follow the steps above to set up the checkout
cd plugins/homekit
# open this directory in VS Code
code .
You can now launch the HomeKit Plugin in VSCode.
HomeKit Secure Video Setup
- Install Scrypted.
- Open https://localhost:10443/ (substitute localhost appropriately for a remote server).
- Install the Unifi, HikVision, ONVIF, or Amcrest camera plugin.
- HKSV requires cameras with motion alerts, and these plugins provide motion alerts.
- If there's no plugin for your camera, but it supports motion alerts using mail, use the generic RTSP, SMTP plugin, and Dummy Switch plugin. This will create a mail activated motion sensor.
- If there's no plugin or mail support for your camera, you can install the generic RTSP Plugin, Video Analysis Plugin, and OpenCV motion detection Plugin. This will use the processing power on your server to detect camera motion.
- Install the HomeKit Plugin.
- 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.
- Pair with the Scrypted Server accessory using your HomeKit app on iOS or Mac.
- Enable recording on the cameras in HomeKit.
Description
Languages
TypeScript
79.9%
Python
16.3%
JavaScript
2.2%
Shell
1.5%
PowerShell
0.1%