mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-24 09:46:59 +00:00
Jorim Tielemans
Franck Nijhof
parent
9bc13810a9
commit
db30e60a44
@ -177,7 +177,7 @@ Trigger as soon as an event starts:
|
||||
to: 'on'
|
||||
```
|
||||
|
||||
By using specific text in the event title, you can set conditions to initiate particular automation flows on designated events while other events will be ignored.
|
||||
By using specific text in the event title, you can set conditions to initiate particular automation flows on designated events while other events will be ignored.
|
||||
|
||||
For example, the actions following this condition will only be executed for events named 'vacation':
|
||||
|
||||
|
||||
@ -15,6 +15,8 @@ ha_release: 0.34
|
||||
|
||||
To get your [Amcrest](https://amcrest.com/) cameras working within Home Assistant, please follow the instructions for the general [Amcrest component](/components/amcrest).
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
Once you have enabled the [Amcrest component](/components/amcrest), add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
||||
@ -13,9 +13,10 @@ ha_release: "0.40"
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
The `android_ip_webcam` component adds a camera by default if you choose not to use the component but still want to see the video feed then the [`mjpeg` camera](/components/camera.mjpeg/) platform can be used.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable only the camera in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -24,4 +25,3 @@ camera:
|
||||
- platform: mjpeg
|
||||
mjpeg_url: http://IP_ADDRESS:8080/video
|
||||
```
|
||||
|
||||
|
||||
@ -17,6 +17,8 @@ To get your [Arlo](https://arlo.netgear.com/) cameras working within Home Assist
|
||||
|
||||
This component is not yet able to live stream from your Arlo camera, but it will be able to playback the last video capture.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
||||
@ -13,7 +13,6 @@ ha_release: 0.13
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
The `bloomsky` camera component allows you to view the current photo created by the camera in the [BloomSky](https://www.bloomsky.com) weather station. This can work in concert with [BloomSky sensors](/components/sensor.bloomsky).
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
@ -17,6 +17,8 @@ The `canary` camera platform allows you to watch the live stream of your [Canary
|
||||
|
||||
To add `canary` camera to your installation, follow instructions in [Canary component](/components/canary/). Once you have [Canary component](/components/canary/) setup, your [Canary](https://canary.is) camera(s) should show up automatically.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
You can add the following to your `configuration.yaml` file to configure `canary` camera with optional settings:
|
||||
|
||||
```yaml
|
||||
@ -25,8 +27,8 @@ camera:
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
ffmpeg_arguments:
|
||||
description: Extra options to pass to `ffmpeg`, e.g., image quality or video filter options. More details in [FFmpeg component](/components/ffmpeg).
|
||||
required: false
|
||||
type: string
|
||||
ffmpeg_arguments:
|
||||
description: Extra options to pass to `ffmpeg`, e.g., image quality or video filter options. More details in [FFmpeg component](/components/ffmpeg).
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
@ -19,6 +19,8 @@ This platform is meant for developers only.
|
||||
|
||||
The `dispatcher` camera platform allows developers to create virtual camera's.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
You would normally not add this camera to your configuration directly but have it be discovered by one of the components that uses it.
|
||||
|
||||
```yaml
|
||||
|
||||
@ -19,6 +19,8 @@ The `doorbird` implementation allows you to view the live video and previous ima
|
||||
You must have the [DoorBird component](/components/doorbird/) configured to use this camera.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable the camera, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
||||
@ -13,9 +13,10 @@ ha_release: 0.26
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
The `ffmpeg` platform allows you to use any video feed as a camera in Home Assistant via [FFmpeg](http://www.ffmpeg.org/). This video source must support multiple simultaneous reads, because for every concurrent Home Assistant user, a connection will be made to the source every 10 seconds. Normally this should not be a problem.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable your FFmpeg feed in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -44,5 +45,4 @@ extra_arguments:
|
||||
|
||||
You can control the image quality with [`extra_arguments`](https://www.ffmpeg.org/ffmpeg-codecs.html#jpeg2000) `-q:v 2-32` or with lossless option `-pred 1`.
|
||||
|
||||
|
||||
If you are running into trouble with this sensor, please refer to the [Troubleshooting section](/components/ffmpeg/#troubleshooting).
|
||||
|
||||
@ -12,7 +12,6 @@ ha_category: Camera
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
The `foscam` platform allows you to watch the live stream of your [Foscam](http://www.foscam.com/) IP camera in Home Assistant.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
@ -13,11 +13,12 @@ ha_release: pre 0.7
|
||||
ha_iot_class: "depends"
|
||||
---
|
||||
|
||||
|
||||
The `generic` camera platform allows you to integrate any IP camera or other URL into Home Assistant. Templates can be used to generate the URLs on the fly.
|
||||
|
||||
Home Assistant will serve the images via its server, making it possible to view your IP cameras while outside of your network. The endpoint is `/api/camera_proxy/camera.[name]`.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable this camera in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
||||
@ -17,6 +17,8 @@ The `local_file` camera platform allows you to integrate an image file from disk
|
||||
|
||||
The `local_file` camera can for example be used with various camera platforms that save a temporary images locally. It can also be used to display a graph that you render periodically and will then be displayed in Home Assistant.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable this camera in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
||||
@ -35,8 +35,8 @@ camera:
|
||||
scan_interval:
|
||||
description: How frequently to query for new camera stills, value are in seconds.
|
||||
required: false
|
||||
default: 60
|
||||
type: integer
|
||||
default: 60
|
||||
{% endconfiguration %}
|
||||
|
||||
### {% linkable_title Service `camera.logi_circle_livestream_record` %}
|
||||
|
||||
@ -9,10 +9,9 @@ sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
|
||||
The camera component allows you to use IP cameras with Home Assistant. With a little additional work you could use [USB cameras](/blog/2016/06/23/usb-webcams-and-home-assistant/) as well.
|
||||
|
||||
### {% linkable_title Service %}
|
||||
### {% linkable_title Services %}
|
||||
|
||||
Once loaded, the `camera` platform will expose services that can be called to perform various actions.
|
||||
|
||||
@ -82,4 +81,3 @@ A simple way to test if you have set up your `camera` platform correctly, is to
|
||||
"entity_id": "camera.living_room_camera"
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
@ -16,6 +16,8 @@ ha_iot_class: "depends"
|
||||
The `mjpeg` camera platform allows you to integrate IP cameras which are capable
|
||||
to stream their video with MJPEG into Home Assistant.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable this camera in your installation,
|
||||
add the following to your `configuration.yaml` file:
|
||||
|
||||
|
||||
@ -17,6 +17,8 @@ The `mqtt` camera platform allows you to integrate the content of an image file
|
||||
|
||||
This can be used with an application or a service capable of sending images through MQTT, for example [Zanzito](https://play.google.com/store/apps/details?id=it.barbaro.zanzito).
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable this camera in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -27,18 +29,18 @@ camera:
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
topic:
|
||||
description: MQTT topic to subscribe to.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: Name of the camera.
|
||||
required: false
|
||||
type: string
|
||||
unique_id:
|
||||
description: >
|
||||
An ID that uniquely identifies this camera. If two cameras have the same unique ID
|
||||
Home Assistant will raise an exception.
|
||||
required: false
|
||||
type: string
|
||||
topic:
|
||||
description: MQTT topic to subscribe to.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: Name of the camera.
|
||||
required: false
|
||||
type: string
|
||||
unique_id:
|
||||
description: >
|
||||
An ID that uniquely identifies this camera. If two cameras
|
||||
have the same unique ID Home Assistant will raise an exception.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
@ -13,7 +13,6 @@ ha_release: 0.42
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
|
||||
The `neato` camera platform allows you to view the latest cleaning map of your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/).
|
||||
|
||||
To add `neato` camera to your installation, follow instructions in [Neato component](/components/neato/).
|
||||
|
||||
@ -13,10 +13,10 @@ ha_release: 0.22
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
### {% linkable_title Basic Configuration %}
|
||||
|
||||
The `netatmo` camera platform is consuming the information provided by a [Netatmo](https://www.netatmo.com) camera. This component allows you to view the current photo created by the Camera.
|
||||
|
||||
### {% linkable_title Basic configuration %}
|
||||
|
||||
To enable the Netatmo camera, you have to set up [netatmo](/components/netatmo/), this will use discovery to add your camera.
|
||||
|
||||
### {% linkable_title Advanced configuration %}
|
||||
|
||||
@ -12,9 +12,10 @@ ha_category: Camera
|
||||
ha_release: 0.47
|
||||
---
|
||||
|
||||
|
||||
The `onvif` camera platform allows you to use an ONVIF camera in Home Assistant. This requires the [`ffmpeg` component](/components/ffmpeg/) to be already configured.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable your ONVIF camera in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -44,13 +45,13 @@ password:
|
||||
port:
|
||||
description: The port for the camera.
|
||||
required: false
|
||||
default: 5000
|
||||
type: integer
|
||||
default: 5000
|
||||
profile:
|
||||
description: Video profile that will be used to obtain the stream, more details below.
|
||||
required: false
|
||||
default: 0
|
||||
type: integer
|
||||
default: 0
|
||||
extra_arguments:
|
||||
description: "Extra options to pass to `ffmpeg`, e.g., image quality or video filter options. More details in [FFmpeg component](/components/ffmpeg)."
|
||||
required: false
|
||||
|
||||
@ -11,13 +11,14 @@ ha_category: Camera
|
||||
ha_release: 0.65
|
||||
---
|
||||
|
||||
|
||||
The `proxy` camera platform allows you to pass another camera's output through post-processing routines and generate a new camera with the post-processed output.
|
||||
|
||||
The current post-processing supports resizing the image/MJPEG as well as limiting the maximum refresh rate.
|
||||
|
||||
The current proxy capabilities are intended to reduce the camera bandwidth for slower internet connections.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable this camera in your installation, you must first have an existing working camera configured in Home Assistant. Next, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -30,47 +31,46 @@ camera:
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
entity_id:
|
||||
description: The ID of another Home Assistant camera to post-process.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: This parameter allows you to override the name of your camera.
|
||||
required: false
|
||||
type: string
|
||||
max_image_width:
|
||||
description: The maximum width of single images taken from the camera (aspect ratio will be maintained).
|
||||
required: false
|
||||
type: integer
|
||||
max_stream_width:
|
||||
description: The maximum width of the MJPEG stream from the camera (aspect ratio will be maintained).
|
||||
required: false
|
||||
type: integer
|
||||
image_quality:
|
||||
description: The quality level used for resulting JPEG for snapshots.
|
||||
required: false
|
||||
type: integer
|
||||
default: 75
|
||||
stream_quality:
|
||||
description: The quality level used for resulting MJPEG streams.
|
||||
required: false
|
||||
type: integer
|
||||
default: 75
|
||||
image_refresh_rate:
|
||||
description: The minimum time in seconds between generating successive image snapshots.
|
||||
required: false
|
||||
type: float
|
||||
force_resize:
|
||||
description: Resize the image even if the resulting image would take up more bandwidth than the original.
|
||||
required: false
|
||||
type: boolean
|
||||
cache_images:
|
||||
description: Preserve the last image and re-send in the case the camera is not responding.
|
||||
required: false
|
||||
type: boolean
|
||||
entity_id:
|
||||
description: The ID of another Home Assistant camera to post-process.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: This parameter allows you to override the name of your camera.
|
||||
required: false
|
||||
type: string
|
||||
max_image_width:
|
||||
description: The maximum width of single images taken from the camera (aspect ratio will be maintained).
|
||||
required: false
|
||||
type: integer
|
||||
max_stream_width:
|
||||
description: The maximum width of the MJPEG stream from the camera (aspect ratio will be maintained).
|
||||
required: false
|
||||
type: integer
|
||||
image_quality:
|
||||
description: The quality level used for resulting JPEG for snapshots.
|
||||
required: false
|
||||
type: integer
|
||||
default: 75
|
||||
stream_quality:
|
||||
description: The quality level used for resulting MJPEG streams.
|
||||
required: false
|
||||
type: integer
|
||||
default: 75
|
||||
image_refresh_rate:
|
||||
description: The minimum time in seconds between generating successive image snapshots.
|
||||
required: false
|
||||
type: float
|
||||
force_resize:
|
||||
description: Resize the image even if the resulting image would take up more bandwidth than the original.
|
||||
required: false
|
||||
type: boolean
|
||||
cache_images:
|
||||
description: Preserve the last image and re-send in the case the camera is not responding.
|
||||
required: false
|
||||
type: boolean
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
## {% linkable_title Examples %}
|
||||
|
||||
Example of using a Camera proxy along with a Foscam camera:
|
||||
|
||||
@ -19,7 +19,7 @@ Optionally the Push Camera can **buffer** a given number of images, creating an
|
||||
|
||||
Images are cleared on new events, and events are separated by a soft (configurable) **timeout**.
|
||||
|
||||
## Integration with motionEye
|
||||
## {% linkable_title Integration with motionEye %}
|
||||
|
||||
The `push` camera can as an example be used with [motionEye](https://github.com/ccrisan/motioneye/wiki) a web frontend for the motion daemon. motionEye is usually configured to save/record files ***only*** when motion is detected. It provides a hook to run a command whenever an image is saved, which can be used together with cURL to send the motion detected images to the `push` camera, as shown in this example:
|
||||
|
||||
@ -57,25 +57,25 @@ camera:
|
||||
name:
|
||||
description: The name you would like to give to the camera.
|
||||
required: false
|
||||
default: Push Camera
|
||||
type: string
|
||||
default: Push Camera
|
||||
buffer:
|
||||
description: Number of images to buffer per event. Be conservative, large buffers will starve your system memory.
|
||||
required: false
|
||||
default: 1
|
||||
type: string
|
||||
default: 1
|
||||
timeout:
|
||||
description: Amount of time after which the event is considered to have finished.
|
||||
required: false
|
||||
default: 5 seconds
|
||||
type: time
|
||||
default: 5 seconds
|
||||
token:
|
||||
description: User provided token acting as access control, should be a large string (more then 8 chars). Required if you can't use HA new auth system (0.77).
|
||||
required: false
|
||||
required: false
|
||||
type: string
|
||||
field:
|
||||
description: HTTP POST field containing the image file
|
||||
required: false
|
||||
default: image
|
||||
type: string
|
||||
default: image
|
||||
{% endconfiguration %}
|
||||
|
||||
@ -33,8 +33,8 @@ ffmpeg_arguments:
|
||||
scan_interval:
|
||||
description: How frequently to query for new video in seconds.
|
||||
required: false
|
||||
default: 90
|
||||
type: integer
|
||||
default: 90
|
||||
{% endconfiguration %}
|
||||
|
||||
**Note:** To be able to playback the last capture, it is required to install the `ffmpeg` component. Make sure to follow the steps mentioned at [FFMPEG](/components/ffmpeg/) documentation.
|
||||
|
||||
@ -13,7 +13,6 @@ ha_iot_class: "Local Polling"
|
||||
ha_release: 0.17
|
||||
---
|
||||
|
||||
|
||||
The `rpi_camera` platform allows you to integrate the Raspberry Pi camera into Home Assistant. This component uses the application [`raspistill`](https://www.raspberrypi.org/documentation/usage/camera/raspicam/raspistill.md) to store the image from camera.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
@ -30,49 +29,48 @@ camera:
|
||||
image_width:
|
||||
description: Set the image width.
|
||||
required: false
|
||||
default: 640
|
||||
type: integer
|
||||
default: 640
|
||||
name:
|
||||
description: Name of the camera.
|
||||
required: false
|
||||
default: Raspberry Pi Camera
|
||||
type: string
|
||||
default: Raspberry Pi Camera
|
||||
image_height:
|
||||
description: Set the image height.
|
||||
required: false
|
||||
default: 480
|
||||
type: integer
|
||||
default: 480
|
||||
image_quality:
|
||||
description: Set the image quality (from 0 to 100).
|
||||
required: false
|
||||
default: 7
|
||||
type: integer
|
||||
default: 7
|
||||
image_rotation:
|
||||
description: Set image rotation (0-359).
|
||||
required: false
|
||||
default: 0
|
||||
type: integer
|
||||
default: 0
|
||||
horizontal_flip:
|
||||
description: Set horizontal flip (0 to disable, 1 to enable).
|
||||
required: false
|
||||
default: 0
|
||||
type: integer
|
||||
default: 0
|
||||
vertical_flip:
|
||||
description: Set vertical flip (0 to disable, 1 to enable).
|
||||
required: false
|
||||
default: 0
|
||||
type: integer
|
||||
default: 0
|
||||
timelapse:
|
||||
description: Takes a picture every this many milliseconds (thousands of a second) - the default means one picture a second.
|
||||
required: false
|
||||
default: 1000
|
||||
type: integer
|
||||
default: 1000
|
||||
file_path:
|
||||
description: Save the picture in a custom file path.
|
||||
required: false
|
||||
default: A temporary file is used.
|
||||
type: string
|
||||
default: A temporary file is used.
|
||||
{% endconfiguration %}
|
||||
|
||||
The given **file_path** must be an existing file because the camera platform setup performs a writeable check on it. Also, keep in mind that the path should be [whitelisted](/docs/configuration/basic/).
|
||||
|
||||
The given **file_path** must be an existing file because the camera platform setup performs a writeable check on it. Also, keep in mind that the path should be [whitelisted](/docs/configuration/basic/).
|
||||
|
||||
@ -13,7 +13,6 @@ ha_release: 0.31
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
The `synology` camera platform allows you to watch the live streams of your [Synology](https://www.synology.com/) Surveillance Station based IP cameras in Home Assistant.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
@ -33,8 +32,8 @@ camera:
|
||||
name:
|
||||
description: A name for this Synology camera.
|
||||
required: false
|
||||
default: Synology Camera
|
||||
type: string
|
||||
default: Synology Camera
|
||||
url:
|
||||
description: The URL to your Synology, including port.
|
||||
required: true
|
||||
@ -50,8 +49,8 @@ password:
|
||||
timeout:
|
||||
description: The timeout in seconds used when connecting to the Surveillance Station.
|
||||
required: false
|
||||
default: 5
|
||||
type: integer
|
||||
default: 5
|
||||
whitelist:
|
||||
description: A list of which cameras you want to add, the names must be the same as in Surveillance Station. If omitted all cameras are added.
|
||||
required: false
|
||||
@ -59,8 +58,8 @@ whitelist:
|
||||
verify_ssl:
|
||||
description: Verify SSL/TLS certificate for HTTPS request.
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
default: true
|
||||
{% endconfiguration %}
|
||||
|
||||
## {% linkable_title Full example %}
|
||||
|
||||
@ -13,13 +13,14 @@ ha_release: 0.52
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
|
||||
The `usps` camera component allows you to view the mail piece images made available through USPS via the Informed Delivery service. You must "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see mail images. This works in concert with [USPS sensors](/components/sensor.usps).
|
||||
|
||||
<p class='note'>
|
||||
You must have the [USPS component](/components/usps/) configured to use this camera. The camera will be setup if the `usps` component is configured and the required configuration is set.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To customize the interval that mail images are rotated in the mail camera you can edit your `configuration.yaml` file with the following settings:
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -56,4 +56,3 @@ password:
|
||||
type: string
|
||||
default: ubnt
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
@ -13,8 +13,6 @@ ha_release: 0.31
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
The `verisure` camera platform allows you to control your [Verisure](https://www.verisure.com/) cameras.
|
||||
|
||||
The requirement is that you have setup your [Verisure hub](/components/verisure/).
|
||||
|
||||
|
||||
@ -15,6 +15,8 @@ ha_release: 0.62
|
||||
|
||||
The `Xeoma` camera platform allows you to view the video feeds from a [Xeoma](http://felenasoft.com/xeoma) video surveillance server.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable Xeoma camera feeds, add the following lines to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
@ -40,8 +42,8 @@ password:
|
||||
new_version:
|
||||
description: Set to false if the Xeoma server version is 17.5 or earlier.
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
default: true
|
||||
cameras:
|
||||
description: List of customizations for individual Xeoma cameras.
|
||||
required: false
|
||||
@ -54,16 +56,16 @@ cameras:
|
||||
name:
|
||||
description: The name to display in the frontend for this camera.
|
||||
required: false
|
||||
default: The `image_name` for this camera.
|
||||
type: string
|
||||
default: The `image_name` for this camera.
|
||||
hide:
|
||||
description: Don't show this camera in Home Assistant.
|
||||
required: false
|
||||
default: false
|
||||
type: boolean
|
||||
default: false
|
||||
{% endconfiguration %}
|
||||
|
||||
## {% linkable_title Full examples %}
|
||||
## {% linkable_title Full example %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -76,16 +76,15 @@ password:
|
||||
path:
|
||||
description: The path to the raw MP4 files.
|
||||
required: false
|
||||
default: /media/mmcblk0p1/record
|
||||
type: string
|
||||
default: /media/mmcblk0p1/record
|
||||
username:
|
||||
description: The user that can access the FTP server.
|
||||
required: false
|
||||
default: root
|
||||
type: string
|
||||
default: root
|
||||
ffmpeg_arguments:
|
||||
description: >
|
||||
Extra options to pass to `ffmpeg`
|
||||
description: Extra options to pass to `ffmpeg`.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
@ -81,13 +81,13 @@ password:
|
||||
path:
|
||||
description: The path to the raw MP4 files.
|
||||
required: false
|
||||
default: /media/mmcblk0p1/record
|
||||
type: string
|
||||
default: /media/mmcblk0p1/record
|
||||
username:
|
||||
description: The user that can access the FTP server.
|
||||
required: false
|
||||
default: root
|
||||
type: string
|
||||
default: root
|
||||
ffmpeg_arguments:
|
||||
description: Extra options to pass to `ffmpeg` (e.g., image quality or video filter options).
|
||||
required: false
|
||||
|
||||
@ -13,13 +13,14 @@ ha_release: 0.39
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
The `zoneminder` camera platform lets you monitor the current stream of your [ZoneMinder](https://www.zoneminder.com) cameras.
|
||||
|
||||
<p class='note'>
|
||||
You must have the [ZoneMinder component](/components/zoneminder/) configured to view the camera stream.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To set it up, add the following information to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
||||
@ -29,19 +29,19 @@ canary:
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
username:
|
||||
description: The username for accessing your Canary account.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password for accessing your Canary account.
|
||||
required: true
|
||||
type: string
|
||||
timeout:
|
||||
description: Timeout to wait for connections.
|
||||
required: false
|
||||
type: integer
|
||||
default: 10
|
||||
username:
|
||||
description: The username for accessing your Canary account.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password for accessing your Canary account.
|
||||
required: true
|
||||
type: string
|
||||
timeout:
|
||||
description: Timeout to wait for connections.
|
||||
required: false
|
||||
type: integer
|
||||
default: 10
|
||||
{% endconfiguration %}
|
||||
|
||||
Once loaded, your front end will have the following components:
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user