Clarify the setup instructions for Android IP Webcam (#12549)

Moved the alternate configuration methods to a separate section. Added more verbiage to the configuration descriptions.
This commit is contained in:
kentloving 2020-03-30 04:10:14 -07:00 committed by GitHub
parent 7ae012e235
commit 7065f30b35
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -25,7 +25,7 @@ There is currently support for the following device types within Home Assistant:
## Setup ## Setup
Download [the IP Webcam app](https://play.google.com/store/apps/details?id=com.pas.webcam) and launch the app. When you press 'Start Server', it will start streaming video from your phone and the IP address of the device will be shown on screen. Download [the Android IP Webcam app](https://play.google.com/store/apps/details?id=com.pas.webcam) and launch the app. When you press 'Start Server', it will start streaming video from your phone and the IP address of the device will be shown on screen.
## Configuration ## Configuration
@ -53,11 +53,11 @@ name:
default: IP Webcam default: IP Webcam
type: string type: string
username: username:
description: The username to access the phone. description: The username to access the phone. If username is specified then password must be also.
required: inclusive required: inclusive
type: string type: string
password: password:
description: The password to access the phone. description: The password to access the phone. If password is specified then username must be also.
required: inclusive required: inclusive
type: string type: string
scan_interval: scan_interval:
@ -66,7 +66,7 @@ scan_interval:
default: 10 default: 10
type: integer type: integer
sensors: sensors:
description: Conditions to display sensor in the frontend. See the list of supported sensors. description: List of sensor entities to be created by this component.
required: false required: false
type: list type: list
keys: keys:
@ -81,17 +81,17 @@ sensors:
light: light:
description: The light level description: The light level
motion: motion:
description: Motion detection description: Analog (not binary) amount of motion detected
pressure: pressure:
description: The current pressure description: The current pressure
proximity: proximity:
description: The proximity description: The proximity
sound: sound:
description: The sound detection description: The sound level
video_connections: video_connections:
description: The video connections description: The video connections
switches: switches:
description: Conditions to display settings in the frontend. See the list of supported switches. description: List of switch entities to be created by this component.
required: false required: false
type: list type: list
keys: keys:
@ -103,6 +103,8 @@ switches:
description: Control the focus. description: Control the focus.
gps_active: gps_active:
description: Control the GPS. description: Control the GPS.
motion_detection:
description: Control the motion detector.
night_vision: night_vision:
description: Control the night vision. description: Control the night vision.
overlay: overlay:
@ -114,7 +116,7 @@ switches:
video_recording: video_recording:
description: Control the video recording. description: Control the video recording.
motion_sensor: motion_sensor:
description: Activate motion sensor if `auto_discovery` is disabled. description: Create a binary_sensor.<name>_motion_active entity. Note that `auto_discovery` may also create this sensor.
required: false required: false
type: boolean type: boolean
default: false default: false
@ -162,13 +164,13 @@ android_ip_webcam:
- torch - torch
``` ```
## Binary Sensor ## Alternate Configuration Method
The `android_ip_webcam` binary sensor platform lets you observe the motion state of [Android IP Webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant. Devices will be configured automatically. The configuration described above will cause the `android_ip_webcam` binary sensor platform to automatically create and configure the devices automatically. Alternatively you can omit the `android_ip_webcam` component from your `configuration.yaml` file and add individual devices instead.
## Examples ### Binary Sensor
You can also setup the binary motion sensor with the following script: You can setup the binary motion sensor with the following in your `configuration.yaml` file:
{% raw %} {% raw %}
@ -177,17 +179,13 @@ binary_sensor:
- platform: rest - platform: rest
name: Kitchen Motion name: Kitchen Motion
sensor_class: motion sensor_class: motion
resource: http://IP:8080/sensors.json?sense=motion_active resource: http://IP_ADDRESS:PORT/sensors.json?sense=motion_active
value_template: '{{ value_json.motion_active.data[0][1][0] | round(0) }}' value_template: '{{ value_json.motion_active.data[0][1][0] | round(0) }}'
``` ```
{% endraw %} {% endraw %}
## Camera ### Camera
The `android_ip_webcam` integration adds a camera by default if you choose not to use the integration but still want to see the video feed then the [`mjpeg` camera](/integrations/mjpeg) platform can be used.
## Configuration
To enable only the camera in your installation, add the following to your `configuration.yaml` file: To enable only the camera in your installation, add the following to your `configuration.yaml` file:
@ -195,11 +193,9 @@ To enable only the camera in your installation, add the following to your `confi
# Example configuration.yaml entry # Example configuration.yaml entry
camera: camera:
- platform: mjpeg - platform: mjpeg
mjpeg_url: http://IP_ADDRESS:8080/video mjpeg_url: http://IP_ADDRESS:PORT/video
``` ```
## Sensor ### Other Sensors
The `android_ip_webcam` sensor platform lets you observe states of [Android IP Webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant. Devices will be configured automatically.
You can setup your own sensors by examining the JSON file from the webcam server: `http://IP:8080/sensors.json` You can setup your own sensors by examining the JSON file from the webcam server: `http://IP:8080/sensors.json`