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 603fba68de
commit 824e2c2ce5
3 changed files with 67 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

25
source/_components/sensor.amcrest.markdown
View file

@ -13,34 +13,13 @@ ha_release: 0.37
ha_iot_class: "Local Polling"
---
The `amcrest` sensor 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 the `amcrest` sensors on your camera, 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
sensor:
- platform: amcrest
host: IP_ADDRESS
username: USERNAME
password: PASSWORD
monitored_conditions:
- motion_detector
- sdcard
- ptz_preset
```
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.
- **scan_interval** (*Optional*): Defines the update interval of the sensor in seconds. The default is 10 seconds.
- **monitored_conditions** array (*Required*): Conditions to display in the frontend. The following conditions can be monitored.
- **motion_detector**: Return True/False when a motion is detected
- **sdcard**: Return the SD card usage by reporting the total and used space
- **ptz_preset**: Return the number of PTZ preset positions configured for the given camera
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.