Update generic_ip_camera docs for config_flow (#14841)

Co-authored-by: J. Nick Koston <nick@koston.org>
This commit is contained in:
Dave T 2022-03-30 08:40:51 +01:00 committed by GitHub
parent 0a798246d6
commit 43d7af76a7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -15,68 +15,32 @@ The `generic` camera platform allows you to integrate any IP camera or other URL
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]`.
## Configuration
{% include integrations/config_flow.md %}
To enable this camera in your installation, add the following to your `configuration.yaml` file:
You must enter a URL in at least one of the fields **Still Image URL** or **Stream Source URL**, the others are optional.
```yaml
# Example configuration.yaml entry
camera:
- platform: generic
still_image_url: http://194.218.96.92/jpg/image.jpg
```
[Templates](/topics/templating/) are allowed in the URL fields, which can be used to select different images or parameterize the URL depending on the status of sensors. Template validity and network access are checked during the configuration steps.
{% configuration %}
{% configuration_basic %}
still_image_url:
description: "The URL your camera serves the image on, e.g., `http://192.168.1.21:2112/`. Can be a [template](/topics/templating/). At least one of still_image_url or stream_source must be provided."
required: false
type: string
stream_source:
description: "The URL your camera serves the live stream on, e.g., `rtsp://user:pass@192.168.1.21:554/`. Can be a [template](/topics/templating/). Usernames and passwords must be embedded in the URL. At least one of still_image_url or stream_source must be provided. Note that a stream_source without a still_image_url can only be used if the [stream integration](/integrations/stream/) is configured."
required: false
type: string
name:
description: This parameter allows you to override the name of your camera.
required: false
type: string
username:
description: The username for accessing your camera. Note that this username applies only to still_image_url and not to stream_source.
required: false
type: string
password:
description: The password for accessing your camera. Note that this password applies only to still_image_url and not to stream_source.
required: false
type: string
authentication:
description: "Type for authenticating the requests `basic` or `digest`."
required: false
default: basic
type: string
limit_refetch_to_url_change:
description: Limits re-fetching of the remote image to when the URL changes. Only relevant if using a template to fetch the remote image.
required: false
default: false
type: boolean
content_type:
description: Set the content type for the IP camera if it is not a jpg file. Use `image/svg+xml` to add a dynamic SVG file.
required: false
default: image/jpeg
type: string
framerate:
description: The number of frames-per-second (FPS) of the stream. Can cause heavy traffic on the network and/or heavy load on the camera.
required: false
default: 2
type: integer
verify_ssl:
description: Enable or disable SSL certificate verification. Set to false to use an http-only camera, or you have a self-signed SSL certificate and haven't installed the CA certificate to enable verification.
required: false
default: true
type: boolean
rtsp_transport:
description: "Set the RTSP transport protocol to `tcp`, `udp`, `udp_multicast` or `http`."
required: false
type: string
{% endconfiguration %}
{% endconfiguration_basic %}
<p class='img'>
<a href='/examples/google_maps_card/'>
@ -91,85 +55,46 @@ In this section, you find some real-life examples of how to use this camera plat
### Weather graph from yr.no
```yaml
camera:
- platform: generic
name: Weather
still_image_url: https://www.yr.no/en/content/1-72837/meteogram.svg
content_type: "image/svg+xml"
```
Instructions on how to locate the SVG for your location is available at [developer.yr.no](https://developer.yr.no/doc/guides/deprecating-old-widgets/)
- Still Image URL: `https://www.yr.no/en/content/1-72837/meteogram.svg`
Instructions on how to locate the SVG for your location are available at [developer.yr.no](https://developer.yr.no/doc/guides/deprecating-old-widgets/)
### Local image
You can show a static image with this platform. Just place the image here: `/config/www/your_image.png`
```yaml
camera:
- platform: generic
name: Some Image
still_image_url: https://127.0.0.1:8123/local/your_image.png
verify_ssl: false
```
- Still Image URL: `https://127.0.0.1:8123/local/your_image.png`
### Sharing a camera feed from one Home Assistant instance to another
If you are running more than one Home Assistant instance (let's call them the 'host' and 'receiver' instances) you may wish to display the camera feed from the host instance on the receiver instance. You can use the [REST API](https://developers.home-assistant.io/docs/api/rest/#get-apicamera_proxycameraentity_id) to access the camera feed on the host (IP address 127.0.0.5) and display it on the receiver instance by configuring the receiver with the following:
```yaml
camera:
- platform: generic
name: Host instance camera feed
still_image_url: https://127.0.0.5:8123/api/camera_proxy/camera.live_view
```
- Still Image URL: `https://127.0.0.5:8123/api/camera_proxy/camera.live_view`
### Image from HTTP only camera
To access a camera which is only available via HTTP, you must turn off SSL verification.
```yaml
camera:
- platform: generic
name: Some Image
still_image_url: http://example.org/your_image.png
verify_ssl: false
```
- Still Image URL: `http://example.org/your_image.png`
### Live stream
To access a camera that has both a snapshot and live stream URL, utilizing the [stream](/integrations/stream/) component.
```yaml
camera:
- platform: generic
name: Streaming Enabled
still_image_url: http://194.218.96.92/jpg/image.jpg
username: user
password: pass
stream_source: rtsp://user:pass@194.218.96.92:554
```
- Still Image URL: `http://194.218.96.92/jpg/image.jpg`
- Stream Source: `rtsp://user:pass@194.218.96.92:554`
If a camera only has a live stream URL and no snapshot URL, the [stream](/integrations/stream/) component can also generate still images from the live stream URL.
```yaml
camera:
- platform: generic
name: Streaming
stream_source: rtsp://user:pass@194.218.96.92:554
```
- Stream Source: `rtsp://user:pass@194.218.96.92:554`
### Secured access to the camera
To access a camera that requires secured access for still image or live stream (an HIK in my case).
```yaml
camera:
- platform: generic
still_image_url: "http://192.168.1.100/ISAPI/Streaming/Channels/101/picture"
stream_source: "rtsp://USERNAME:PASSWORD@192.168.1.100:554/Streaming/Channels/102"
name: "My Camera"
verify_ssl: false
username: "USERNAME"
password: "PASSWORD"
authentication: digest
```
- Still Image URL: `http://192.168.1.100/ISAPI/Streaming/Channels/101/picture`
- Stream Source: `rtsp://USERNAME:PASSWORD@192.168.1.100:554/Streaming/Channels/102`
- Verify SSL: `false`
- Username: `user`
- Password: `pass`
- Authentication: `digest`