jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Updated Amcrest documentation to use hub component (#2881)

Browse source 
* Updated Amcrest documentation to use hub component

* Set default streaming source to snapshot

* updated version to 0.49
This commit is contained in:
Marcelo Moreira de Mello 2017-07-15 23:54:19 -04:00 • committed by Paulus Schoutsen
parent 1e2a89d59a
commit ac7567d0c7
3 changed files with 67 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

23
source/_components/camera.amcrest.markdown
View file

@ -13,33 +13,14 @@ ha_iot_class: "Local Polling"
ha_release: 0.34
---
The `amcrest` platform allows you to integrate your [Amcrest](https://amcrest.com/) IP camera in Home Assistant.
To get your [Amcrest](https://amcrest.com/) cameras working within Home Assistant, please follow the instructions for the general [Amcrest component](/components/amcrest).
To enable your camera in your installation, add the following to your `configuration.yaml` file:
Once you have enabled the [Amcrest component](/components/amcrest), add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
camera:
- platform: amcrest
host: IP_ADDRESS
username: USERNAME
password: PASSWORD
```
Configuration variables:
- **host** (*Required*): The IP address or hostname of your camera. If using hostname, make sure the DNS works as expected.
- **username** (*Required*): The username 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. The default is "Amcrest Camera".
- **port** (*Optional*): The port that the camera is running on. The default is 80.
- **resolution** (*Optional*): This parameter allows you to specify the camera resolution. For a high resolution (1080/720p), specify the option `high`. For VGA resolution (640x480p), specify the option `low`. If omitted, it defaults to *high*.
- **stream_source** (*Optional*): The data source for the live stream. `mjpeg` will use the camera's native MJPEG stream, whereas `snapshot` will use the camera's snapshot API to create a stream from still images. You can also set the `rtsp` option to generate the streaming via RTSP protocol. If omitted, it defaults to *mjpeg*.
- **ffmpeg_arguments**: (*Optional*): Extra options to pass to ffmpeg, e.g. image quality or video filter options.
**Note:** Amcrest cameras with newer firmwares no longer have the ability to stream `high` definition video with MJPEG encoding. You may need to use `low` resolution stream or the `snapshot` stream source instead. If the quality seems too poor, lower the `Frame Rate (FPS)` and max out the `Bit Rate` settings in your camera's configuration manager.
**Note:** If you set the `stream_source` option to `rtsp`, make sure to follow the steps mentioned at
[FFMPEG](https://home-assistant.io/components/ffmpeg/) documentation to install the `ffmpeg`.
To check if your Amcrest camera is supported/tested, visit the [supportability matrix](https://github.com/tchellomello/python-amcrest#supportability-matrix) link from the `python-amcrest` project.