DOCSEARCHbyAlgolia
Submit Docs

Scrypted Documentation

repository·main·Indexed 27 days ago

https://github.com/koush/scrypted

A high-performance home video integration platform and NVR designed for low-latency streaming to HomeKit, Google Home, and Alexa. Includes documentation for the @scrypted/client and scrypted-sdk (Python) SDKs, as well as configuration guides for plugins including Amcrest, Alexa, and BTicino C300X.

Tokens
36.9K
Snippets
42
Records
279
Agent score
91%

What's inside Scrypted

  1. Overview of the Snapshot Plugin

    main
    The Snapshot Plugin is a core Scrypted plugin designed to handle video-to-image conversion and image manipulation. It enhances camera performance by providing custom snapshot URLs, cropping/scaling capabilities, and improved responsiveness through caching and error recovery.

  2. Overview of OpenVINO Object Detection Plugin

    main

    The OpenVINO plugin provides object detection capabilities for cameras within Scrypted.

    Important Usage Note: This plugin is specifically designed for Scrypted NVR users. It does not provide benefits for HomeKit integration, as HomeKit performs its own independent detection processing.

  4. Overview of the Scrypted Core Plugin

    main

    The Scrypted Core Plugin is the central component of the Scrypted ecosystem. It provides the essential management and operational features required to run the platform, including:

    • User Interface (UI): The primary interface for managing your Scrypted instance.
    • Automations: The engine for creating and executing automated workflows.
    • Device Groups: Functionality to organize and manage multiple devices as a single entity.
    • Core Functionality: Essential system-level services that power other plugins.

  5. Overview of Tuya for Scrypted

    main
    The Tuya plugin for Scrypted acts as a controller that integrates Tuya (or Smart Life) devices into the Scrypted ecosystem. It specifically focuses on discovering and integrating Tuya cameras, including support for motion events and doorbell ring notifications.

  7. Use TensorFlow Lite for Object Detection in Scrypted

    main

    The TensorFlow Lite plugin adds object detection capabilities to Scrypted cameras.

    Important Usage Note: This plugin is intended exclusively for Scrypted NVR users. It provides no benefits for HomeKit integration, as HomeKit performs its own independent detection processing.

    For optimal performance, a fast GPU and CPU are highly recommended. The plugin also supports Coral.ai Edge TPU hardware.

  8. Use the Video Analysis plugin for motion and object detection

    main

    The Video Analysis plugin provides two primary capabilities:

    1. Add detection capabilities: Enhances any camera with motion and object detection using engines like OpenCV, OpenVINO, or CoreML.
    2. Create smart sensors: Generates smart motion and occupancy sensors based on specific object types (e.g., people, animals, cars) detected by either the camera hardware or an Object Detection Plugin.

    Usage Guidelines:

    • Motion Detection: Only use this if your camera does not already provide motion events via a plugin, email, or webhooks.
    • Object Detection: If you are a Scrypted NVR user, use Object Detection Plugins. Note that Object Detection provides no benefit to HomeKit, as HomeKit performs its own detection processing.

  9. Use the Scrypted Remote Plugin to connect Scrypted instances

    main
    The Scrypted Remote Plugin enables a Scrypted instance to connect to a remote Scrypted server via the Scrypted Client API. Once connected, devices from the remote Scrypted server are automatically imported into the local Scrypted instance.

  10. Add FFmpeg Camera video streams to Scrypted

    main

    The FFmpeg Camera plugin allows you to integrate video streams that utilize FFmpeg. If your cameras provide still image snapshot URLs, you must also install the @scrypted/snapshot plugin to utilize them.

    To enable HomeKit Secure Video (HSV) functionality with FFmpeg Cameras, you are required to use a software motion detector. Recommended options include:

    • @scrypted/pam-diff
    • @scrypted/opencv

  11. Use ONNX Object Detection for Scrypted

    main

    The ONNX Plugin adds object detection capabilities to any camera in Scrypted.

    Important Usage Note: This plugin is intended exclusively for Scrypted NVR users. It provides no benefits to HomeKit, as HomeKit performs its own independent detection processing.