The Scrypted Custom Component for Home Assistant adds support for managing Scrypted from your Home Assistant Dashboard, and creation of Scrypted NVR cards.
The Custom Component must be installed even if using the Scrypted Home Assistant Addon.
- Remove the
Scryptedsidebar item via the Addon configuration.
- The Addon installation has a default
homeassistantuser for automatic login. A separate dedicated Scrypted
adminmust be created in
Usersin the sidebar menu.
Install Custom Component
The Scrypted Custom Component repository can be found on github.
- Install the custom component using the Home Assistant Community Store (HACS) by adding the
- Go to
Settings > Devices & Services > Add Integrationand select
- Enter the host, username, and password for your Scrypted server, as well as a name and icon for the side panel link in the Home Assistant menu.
If Scrypted was installed as a Home Assistant Addon, there is no default login. A dedicated admin account will need to be created for the custom component. The
Host will be
Scrypted can now be accessed in the Home Assistant side panel.
Scrypted NVR provides Home Assistant cards that feature low latency playback and two way audio. The NVR app is also deeply integrated into the Home Assistant UI.
There are several types of cards available:
- Single Camera Card
- Camera Grid Card
- Event Reel Card
Configuring multiple cameras within a single card dramatically improves performance and load times.
Follow the instructions below, and then substitute the card URL appopriately.
- Open Scrypted NVR inside Home Assistant using a desktop browser.
- Navigate to the camera.
- Open the the
- Copy the
Scrypted NVR Card Webpage URL. (Substitute this with Camera Grid or Event Reel URL if desired.)
- Add the following
Webpage Cardin Home Assistant and replace/paste the previously copied
Scrypted NVR Card Webpage URLbelow:
type: iframe url: >- /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id> aspect_ratio: '16:9' allow_open_top_navigation: true
Camera Card Options
The Scrypted NVR card behavior can be configured using query string parameters on the
Play the card video on load.
url: >- /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>?live=true
Open Scrypted NVR Timeline in Home Assistant when the still image is clicked.
url: >- /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>?imageClick=ha
Open Scrypted NVR Timeline in Home Assistant when the playing video is clicked.
url: >- /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>?videoClick=ha
By default the Card live stream will use the
low-resolution stream: it loads fast, uses minimal resources, is thus best suited for a small frame. The resolution can be changed with the
destination parameter. Supported destination values include
Using the high resolution stream (
local) for a Cards is not recommended, as it can cause the Home Assistant Dashboard to become sluggish with multiple cards.
url: >- /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>?destination=local
Multiple parameters may be combined using
url: >- /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>?imageClick=ha&videoClick=ha&live=true
Camera Grid Card
Multiple cameras can be configured within a single
Webpage Card. Configuration is similar to the single camera card, albeit a slightly different url format. The iframe url is:
|Card Type||URL Fragment|
type: iframe url: >- /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframegrid?ids=<id1>,<id2> allow_open_top_navigation: true
The Camera Grid card has additional parameters that can be used to used to customize the layout based on the device type and screen orientation:
|Name||Device Type||Screen Orientation||Default Value|
desktopMinWidth to set the minimum width of a camera within the grid and controls the cell wrap behavior. For example, with the default value of
480, if the screen is
960 pixels, the grid will be 2 columns. If the screen is
1920 pixels, the grid will be 4 columns.
cols to set a fixed number of columns for all screen sizes and orientations.
Event Reel Card
The Event Reel shows the recent highlighted events in a scrollable reel. Configuration is similar to the single camera card, albeit a slightly different url format. The iframe url is:
|Card Type||URL Fragment|
The Event Reel card has additional parameters that can be used to used to customize the cameras and events shown:
|ids||The camera ids shown in the reel. All are shown by default.|
|hiddenDetections||The detection types to hide in the reel. |
type: iframe url: >- /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframeevents?ids=<id1>,<id2> allow_open_top_navigation: true
Scrypted NVR Notifications can be delivered to the Home Assistant Companion app.
- Install the Home Assistant Plugin for Scrypted.
- Configure the Home Assistant Long Lived Access Token (this is not the same token used in the previous steps) and Address in the Plugin Settings.
- The Home Assistant
notifyentities should sync.
- Find the companion app
- Enable the
Scrypted NVR Usersextension.
- Assign the
notifyentity to a
Scrypted User. Provide the
Scrypted Tokenused by the Home Assistant Custom Component.
- Configure the detection options.