Updated Amcrest documentation to use hub component (home-assistant#2881)

tchellomello · balloob · commit 824e2c2ce5f8 · 2017-07-15T20:54:19.000-07:00
* Updated Amcrest documentation to use hub component

* Set default streaming source to snapshot

* updated version to 0.49
diff --git a/source/_components/amcrest.markdown b/source/_components/amcrest.markdown
@@ -0,0 +1,63 @@
+---
+layout: page
+title: "Amcrest IP Camera"
+description: "Instructions how to integrate Amcrest IP cameras within Home Assistant."
+date: 2017-06-24 10:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: amcrest.png
+ha_category: Hub
+ha_iot_class: "Local Polling"
+ha_release: 0.49
+---
+
+The `amcrest` platform allows you to integrate your [Amcrest](https://amcrest.com/) IP camera in Home Assistant.
+
+To enable your camera in your installation, add the following to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+amcrest:
+  - host: IP_ADDRESS
+    username: USERNAME
+    password: PASSWORD
+    sensors:
+      - motion_detector
+      - sdcard
+
+ - host: IP_ADDRESS
+   username: USERNAME
+   password: PASSWORD
+   resolution: low
+   stream_source: snapshot
+   sensors:
+     - 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.
+- **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 *snapshot*.
+- **ffmpeg_arguments**: (*Optional*): Extra options to pass to ffmpeg, e.g. image quality or video filter options.
+- **authentication**: (*Optional*): Defines which authentication method to use only when **stream_source** is **mjpeg**. Currently *aiohttp* only support *basic*. It defaults to *basic*.
+- **scan_interval** (*Optional*): Defines the update interval of the sensor in seconds. The default is 10 seconds.
+- **sensors** array (*Optional*): Conditions to display in the frontend. By default, *none* of the conditions are enabled. 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
+
+**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. If you defined the *stream_source* to **mjpeg**, make sure your camera supports *Basic* HTTP authentication. Newer Amcrest firwmares may not work, then **rtsp** is recommended instead.
+
+**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`.
+
+Finish its configuration by visiting the [Amcrest sensor page](/components/sensor.amcrest/) or [Amcrest camera page](/components/camera.amcrest/).
+
+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.
diff --git a/source/_components/camera.amcrest.markdown b/source/_components/camera.amcrest.markdown
@@ -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.
diff --git a/source/_components/sensor.amcrest.markdown b/source/_components/sensor.amcrest.markdown
@@ -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.
