Minimizing of the configuration sample (#1010)

This commit is contained in:
Fabian Affolter 2016-09-30 20:49:33 +02:00 committed by GitHub
parent a664249de9
commit 39f7c6289d
9 changed files with 24 additions and 44 deletions

View File

@ -22,8 +22,6 @@ To enable your FFmpeg feed in your installation, add the following to your `conf
camera: camera:
- platform: ffmpeg - platform: ffmpeg
input: FFMPEG_SUPPORTED_INPUT input: FFMPEG_SUPPORTED_INPUT
name: FFmpeg
extra_arguments: -q:v 2
``` ```
Configuration variables: Configuration variables:

View File

@ -21,8 +21,6 @@ To enable your Foscam IP camera in your installation, add the following to your
camera: camera:
platform: foscam platform: foscam
ip: IP_ADDRESS ip: IP_ADDRESS
name: Door Camera
port: 88
username: USERNAME username: USERNAME
password: PASSWORD password: PASSWORD
``` ```
@ -31,9 +29,9 @@ Configuration variables:
- **ip** (*Required*): The IP address your camera. - **ip** (*Required*): The IP address your camera.
- **port** (*Optional*): The port that the camera is running on. The default is 88. - **port** (*Optional*): The port that the camera is running on. The default is 88.
- **name** (*Optional*): This parameter allows you to override the name of your camera.
- **username** (*Required*): The username for accessing your camera. - **username** (*Required*): The username for accessing your camera.
- **password** (*Required*): The password for accessing your camera. - **password** (*Required*): The password for accessing your camera.
- **name** (*Optional*): This parameter allows you to override the name of your camera.
<p class='note'> <p class='note'>
There seems to be some issues within Foscam with lengthy passwords and passwords containing certain symbols. Be sure to check your camera's documentation. There seems to be some issues within Foscam with lengthy passwords and passwords containing certain symbols. Be sure to check your camera's documentation.

View File

@ -23,18 +23,13 @@ To enable this camera in your installation, add the following to your `configura
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
camera: camera:
platform: generic - platform: generic
still_image_url: http://194.218.96.92/jpg/image.jpg still_image_url: http://194.218.96.92/jpg/image.jpg
name: my sample camera
username: USERNAME
password: PASSWORD
authentication: basic
limit_refetch_to_url_change: true
``` ```
Configuration variables: Configuration variables:
- **still_image_url** (*Required*): The URL your camera serves the image on, eg. http://192.168.1.21:2112/. Can be a [template]. - **still_image_url** (*Required*): The URL your camera serves the image on, eg. http://192.168.1.21:2112/. Can be a [template](/topics/templating/).
- **name** (*Optional*): This parameter allows you to override the name of your camera. - **name** (*Optional*): This parameter allows you to override the name of your camera.
- **username** (*Optional*): The username for accessing your camera. - **username** (*Optional*): The username for accessing your camera.
- **password** (*Optional*): The password for accessing your camera. - **password** (*Optional*): The password for accessing your camera.
@ -48,4 +43,3 @@ Configuration variables:
</a> </a>
</p> </p>
[template]: /topics/templating/

View File

@ -22,15 +22,14 @@ To enable this camera in your installation, add the following to your `configura
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
camera: camera:
platform: local_file - platform: local_file
name: Local File
file_path: /tmp/image.jpg file_path: /tmp/image.jpg
``` ```
Configuration variables: Configuration variables:
- **name** (*Optional*): Name of the camera
- **file_path** (*Required*): File to serve as the camera. - **file_path** (*Required*): File to serve as the camera.
- **name** (*Optional*): Name of the camera
<p class='note'> <p class='note'>
The given `file_path` must be an existing file because the camera platform setup make a readable check on it. The given `file_path` must be an existing file because the camera platform setup make a readable check on it.

View File

@ -10,5 +10,5 @@ footer: true
--- ---
The camera component allows you to use IP cameras with Home Assistant. 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.

View File

@ -22,12 +22,8 @@ To enable this camera in your installation, add the following to your `configura
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
camera: camera:
platform: mjpeg - platform: mjpeg
mjpeg_url: http://192.168.1.92/mjpeg mjpeg_url: http://192.168.1.92/mjpeg
name: my sample camera
username: USERNAME
password: PASSWORD
authentication: basic
``` ```
Configuration variables: Configuration variables:

View File

@ -21,10 +21,6 @@ To enable the Netatmo camera, you first have to set up [netatmo](/components/net
# Example configuration.yaml entry # Example configuration.yaml entry
camera: camera:
platform: netatmo platform: netatmo
home: home_name
cameras:
- camera_name1
- camera_name2
``` ```
Configuration variables: Configuration variables:
@ -33,5 +29,14 @@ Configuration variables:
- **cameras** array (*Optional*): Cameras to use. Multiple enties allowed. - **cameras** array (*Optional*): Cameras to use. Multiple enties allowed.
- **camera_name**: Name of the camera to display. - **camera_name**: Name of the camera to display.
If **home** and **cameras** is not provided, all cameras will be displayed. If **home** and **cameras** are not provided, all cameras will be displayed. For more control over your cameras check the configuration sample below.
```yaml
# Example configuration.yaml entry
camera:
platform: netatmo
home: home_name
cameras:
- camera_name1
- camera_name2
```

View File

@ -21,16 +21,7 @@ To enable this camera in your installation, add the following to your `configura
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
camera: camera:
platform: rpi_camera - platform: rpi_camera
name: Raspberry Pi Camera
image_width: 640
image_height: 480
image_quality: 7
image_rotation: 0
timelapse: 1000
horizontal_flip: 0
vertical_flip: 0
file_path: /tmp/image.jpg
``` ```
Configuration variables: Configuration variables:

View File

@ -20,10 +20,9 @@ To enable a UVC camera in your installation, add the following to your `configur
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
camera: camera:
platform: uvc - platform: uvc
nvr: IP_ADDRESS nvr: IP_ADDRESS
port: PORT key: API_KEY
key: APIKEY
``` ```
Configuration variables: Configuration variables: