https://github.com/custom-cards/surveillance-card
A custom component for displaying camera feeds in the style of a surveillance system.
https://github.com/custom-cards/surveillance-card
camera home-assistant motion security
Last synced: over 1 year ago
JSON representation
A custom component for displaying camera feeds in the style of a surveillance system.
- Host: GitHub
- URL: https://github.com/custom-cards/surveillance-card
- Owner: custom-cards
- License: apache-2.0
- Created: 2018-09-07T03:21:51.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-05-15T22:13:17.000Z (about 3 years ago)
- Last Synced: 2025-03-31T12:07:55.994Z (over 1 year ago)
- Topics: camera, home-assistant, motion, security
- Language: JavaScript
- Homepage:
- Size: 246 KB
- Stars: 256
- Watchers: 10
- Forks: 38
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Surveillance Card
Surveillance Card is a custom component for lovelace to be used as a panel for viewing security cameras. It shows all of the cameras on the left, and shows a big one with motion on the right.
---
## Configuration Parameters
| Name | Type | Description | Default
| ---- | ---- | ----------- | -------
| type | string | `custom:surveillance-card` | **Required**
| cameras | list | _See camera section below_ | **Required**
| thumb_interval | number | Update interval for thumbnails in seconds (_min_ 0.5) | 10
| update_interval | number | Update interval for main image in seconds (_min_ 0.5) | 1
| show_capture_buttons | boolean | Show screenshot and record buttons | true
| recording_duration | number | Number of seconds to record after clicking record button (_min_ 0.5) | 10
| focus_motion | boolean | Switch to camera when motion detected | true
| camera_view | string | “live” will show the live view if the `stream` integration is enabled. | ""
| thumb_position | string | Position of the thumbnails (left, right, top, bottom, none) | left
### Camera Parameters
Each entry in the camera list takes the following options
| Name | Type | Description | Default
| ---- | ---- | ----------- | -------
| entity | string or array | Camera entity_id | **Required**
| motion_entity | string | entity_id of a binary sensor to use for motion detection (_uses state=='on' as motion detected_) | none
---
## Install Using HACS
### Simple Install (Requires Core 2022.8 or newer)
[](https://my.home-assistant.io/redirect/hacs_repository/?owner=custom-cards&repository=custom-cards%2Fsurveillance-card)
### Manually Install through HACS
1. Make sure you have the latest version of HACS installed. [HACS install guide](https://hacs.xyz/docs/setup/prerequisites)
2. Log in as an Admin and go to HACS > Frontend > Explore and Download Repositories > Search for "surveillance-card" and select it from the list
3. Click download on the bottom right
4. Reload your browser when prompted
### Add Card To Dashboard
> **Note** For the page you create, make sure to set the View Type to "Panel (1 card)"
1. Create a new dashboard or select the dashboard you wish to use (must be a UI configured dashboard, use 3b for YAML)
2. Click the menu button (top right 3 dots) and select edit
3. Add a "Manual Card" to your screen
4. Fill out options like the example below
```yaml
type: custom:surveillance-card
thumb_interval: 15
update_interval: 2
recording_duration: 10
show_capture_buttons: true
camera_view: ""
cameras:
- entity: camera.front_porch
motion_entity: binary_sensor.front_porch_motion
- entity: camera.back_yard
motion_entity: binary_sensor.back_yard_motion
```
---
## Saving Snapshots from Cameras
Clicking on the _camera button_ will save a single snapshot from that camera.
Clicking the _record button_ will grab as many images as it can (based on the update intervals) for the set `recording_duration`
Note: This functionality is not available in native app versions (iOS & Android) and depends on the browser/device's ability to download image files.
## Motion entities
Cameras can automatically be set to foccussed when motion is detected from the associated motion entities.
`motion_entity` can either be a single entity ID or a list of multiple entity IDs.
Note: The entities don't necessarily need to be motion sensors, they just need to be a binary sensor that is triggered when in the "on" state. E.g. a door sensor could also be used.
```yaml
views:
- title: Surveillance
icon: mdi:cctv
cards:
- type: custom:surveillance-card
cameras:
- entity: camera.front_porch
motion_entity: binary_sensor.front_porch_motion
- entity: camera.back_yard
motion_entity:
- binary_sensor.back_yard_motion
- binary_sensor.back_yard_gate
```
## Thanks
Thanks to all the people who have contributed!
[](https://github.com/custom-cards/surveillance-card/graphs/contributors)