🚜 Merges/Redirect Arlo component pages (#8547)

This commit is contained in:
Klaas Schoute 2019-02-13 16:01:10 +01:00 committed by Franck Nijhof
parent 6bbc329389
commit 3a86b7a639
4 changed files with 167 additions and 195 deletions

View File

@ -1,83 +0,0 @@
---
layout: page
title: "Arlo Control Panel"
description: "Instructions on how to setup the Netgear Arlo Base Stations as a control panel within Home Assistant."
date: 2017-10-05 17:45
sidebar: true
comments: false
sharing: true
footer: true
logo: arlo.png
ha_category: Alarm
ha_release: 0.56
ha_iot_class: "Cloud Polling"
---
The `arlo` alarm control panel allows you to control your [Arlo](https://arlo.netgear.com/) base stations. You can use it to switch modes and trigger alarms from Home Assistant.
## {% linkable_title Configuration %}
To get your [Arlo](https://arlo.netgear.com/) base stations working within Home Assistant, please follow the instructions for the general [Arlo component](/components/arlo).
Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
alarm_control_panel:
- platform: arlo
```
{% configuration %}
home_mode_name:
description: "Arlo base station does not have a built-in home mode. You can map one of your custom modes to Home Assistant's home mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match exactly as you set it up in the Arlo app."
required: false
type: string
away_mode_name:
description: "Arlo base station does not have a built-in away mode. You can map one of your custom modes to Home Assistant's away mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match eactly as you set it up in the Arlo app."
required: false
type: string
default: "`Armed` mode in Arlo"
night_mode_name:
description: "Arlo base station does not have a built-in night mode. You can map one of your custom modes to Home Assistant's night mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match eactly as you set it up in the Arlo app."
required: false
type: string
default: "`Armed` mode in Arlo"
{% endconfiguration %}
## {% linkable_title Examples %}
These examples are based on an Arlo base station named `my_arlo_base_station`. Replace this with the name of your base station's `entity_id`.
Arming the Arlo Base Station when leaving.
```yaml
- id: arm_arlo_when_leaving
alias: Arm Arlo cameras when leaving
trigger:
platform: state
entity_id: group.family
from: home
to: not_home
action:
service: alarm_control_panel.alarm_arm_away
entity_id: alarm_control_panel.my_arlo_base_station
```
Setting Arlo to a custom mode (mapped to `home_mode_name` in `configuration.yaml`) when arriving.
```yaml
- id: disarm_arlo_when_arriving
alias: Set Arlo cameras to Home mode when arriving
trigger:
platform: state
entity_id: group.family
from: not_home
to: home
action:
service: alarm_control_panel.alarm_arm_home
entity_id: alarm_control_panel.my_arlo_base_station
```
You can also completely disarm the Arlo base station by calling the `alarm_control_panel.alarm_disarm` service, and trigger the alarm by calling the `alarm_control_panel.alarm_trigger` service.
More examples and configuration options can be found on the [Manual Alarm Control page](/components/alarm_control_panel.manual/#examples).

View File

@ -8,13 +8,27 @@ comments: false
sharing: true
footer: true
logo: arlo.png
ha_category: Hub
ha_category:
- Hub
- Alarm
- Camera
- Sensor
ha_release: 0.46
ha_iot_class: "Cloud Polling"
redirect_from:
- /components/alarm_control_panel.arlo/
- /components/camera.arlo/
- /components/sensor.arlo/
---
The `arlo` implementation allows you to integrate your [Arlo](https://arlo.netgear.com/) devices in Home Assistant.
There is currently support for the following device types within Home Assistant:
- [Alarm](#alarm)
- [Camera](#camera)
- [Sensor](#sensor)
## {% linkable_title Configuration %}
To enable device linked in your [Arlo](https://arlo.netgear.com/) account, add the following to your `configuration.yaml` file:
@ -58,3 +72,155 @@ The Arlo component also provides a camera service to enable/disable the motion d
service: camera.enable_motion_detection
entity_id: camera.arlo_frontdoor
```
## {% linkable_title Alarm %}
### {% linkable_title Configuration %}
Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
alarm_control_panel:
- platform: arlo
```
{% configuration %}
home_mode_name:
description: "Arlo base station does not have a built-in home mode. You can map one of your custom modes to Home Assistant's home mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match exactly as you set it up in the Arlo app."
required: false
type: string
away_mode_name:
description: "Arlo base station does not have a built-in away mode. You can map one of your custom modes to Home Assistant's away mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match eactly as you set it up in the Arlo app."
required: false
type: string
default: "`Armed` mode in Arlo"
night_mode_name:
description: "Arlo base station does not have a built-in night mode. You can map one of your custom modes to Home Assistant's night mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match eactly as you set it up in the Arlo app."
required: false
type: string
default: "`Armed` mode in Arlo"
{% endconfiguration %}
### {% linkable_title Examples %}
These examples are based on an Arlo base station named `my_arlo_base_station`. Replace this with the name of your base station's `entity_id`.
Arming the Arlo Base Station when leaving.
```yaml
- id: arm_arlo_when_leaving
alias: Arm Arlo cameras when leaving
trigger:
platform: state
entity_id: group.family
from: home
to: not_home
action:
service: alarm_control_panel.alarm_arm_away
entity_id: alarm_control_panel.my_arlo_base_station
```
Setting Arlo to a custom mode (mapped to `home_mode_name` in `configuration.yaml`) when arriving.
```yaml
- id: disarm_arlo_when_arriving
alias: Set Arlo cameras to Home mode when arriving
trigger:
platform: state
entity_id: group.family
from: not_home
to: home
action:
service: alarm_control_panel.alarm_arm_home
entity_id: alarm_control_panel.my_arlo_base_station
```
You can also completely disarm the Arlo base station by calling the `alarm_control_panel.alarm_disarm` service, and trigger the alarm by calling the `alarm_control_panel.alarm_trigger` service.
More examples and configuration options can be found on the [Manual Alarm Control page](/components/alarm_control_panel.manual/#examples).
## {% linkable_title Camera %}
This component is not yet able to live stream from your Arlo camera, but it will be able to playback the last video capture.
### {% linkable_title Configuration %}
Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
camera:
- platform: arlo
ffmpeg_arguments: '-pred 1 -q:v 2'
```
{% configuration %}
ffmpeg_arguments:
description: Extra options to pass to ffmpeg, e.g., image quality or video filter options.
required: false
type: string
{% endconfiguration %}
**Note:** To be able to playback the last capture, it is required to install the `ffmpeg` component. Make sure to follow the steps mentioned at [FFMPEG](/components/ffmpeg/) documentation.
## {% linkable_title Sensor %}
To get your [Arlo](https://arlo.netgear.com/) sensors working within Home Assistant, please follow the instructions for the general [Arlo component](/components/arlo).
This platform does not support Arlo Q.
### {% linkable_title Configuration %}
Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: arlo
monitored_conditions:
- captured_today
- last_capture
- total_cameras
- battery_level
- signal_strength
```
Additionally, for Arlo Baby cameras that have additional sensors, you can add them to the `monitored_conditions` collection:
```yaml
# Additional sensors available for Arlo Baby cameras
sensor:
- platform: arlo
monitored_conditions:
# ...
- temperature
- humidity
- air_quality
```
{% configuration %}
monitored_conditions:
description: Conditions to display in the frontend. The following conditions can be monitored.
required: false
type: list
keys:
captured_today:
description: Return the number of videos captured on the current day.
last_capture:
description: Return the timestamp from the last video captured by your Arlo camera.
total_cameras:
description: Return the number of recognized and active cameras linked on your Arlo account.
battery_level:
description: Return the battery level of your Arlo camera.
signal_strength:
description: Return the wireless signal strength of your Arlo camera.
temperature:
description: Return the ambient temperature detected by your Arlo Baby camera.
humidity:
description: Return the ambient relative humidity detected by your Arlo Baby camera.
air_quality:
description: Return the ambient air quality (a reading of volatile organic compounds (VOCs) in parts per million) detected by your Arlo Baby camera.
{% endconfiguration %}
If no **monitored_conditions** are specified, all of above will be enabled by default.

View File

@ -1,38 +0,0 @@
---
layout: page
title: "Arlo Camera"
description: "Instructions on how to integrate your Netgear Arlo cameras within Home Assistant."
date: 2016-05-30 10:00
sidebar: true
comments: false
sharing: true
footer: true
logo: arlo.png
ha_category: Camera
ha_release: 0.46
ha_iot_class: "Cloud Polling"
---
To get your [Arlo](https://arlo.netgear.com/) cameras working within Home Assistant, please follow the instructions for the general [Arlo component](/components/arlo).
This component is not yet able to live stream from your Arlo camera, but it will be able to playback the last video capture.
## {% linkable_title Configuration %}
Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
camera:
- platform: arlo
ffmpeg_arguments: '-pred 1 -q:v 2'
```
{% configuration %}
ffmpeg_arguments:
description: Extra options to pass to ffmpeg, e.g., image quality or video filter options.
required: false
type: string
{% endconfiguration %}
**Note:** To be able to playback the last capture, it is required to install the `ffmpeg` component. Make sure to follow the steps mentioned at [FFMPEG](/components/ffmpeg/) documentation.

View File

@ -1,73 +0,0 @@
---
layout: page
title: "Arlo Sensor"
description: "Instructions on how to integrate your Netgear Arlo cameras within Home Assistant."
date: 2017-05-30 10:00
sidebar: true
comments: false
sharing: true
footer: true
logo: arlo.png
ha_category: Sensor
ha_release: "0.46"
ha_iot_class: "Cloud Polling"
---
To get your [Arlo](https://arlo.netgear.com/) sensors working within Home Assistant, please follow the instructions for the general [Arlo component](/components/arlo).
This platform does not support Arlo Q.
## {% linkable_title Configuration %}
Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: arlo
monitored_conditions:
- captured_today
- last_capture
- total_cameras
- battery_level
- signal_strength
```
Additionally, for Arlo Baby cameras that have additional sensors, you can add them to the `monitored_conditions` collection:
```yaml
# Additional sensors available for Arlo Baby cameras
sensor:
- platform: arlo
monitored_conditions:
# ...
- temperature
- humidity
- air_quality
```
{% configuration %}
monitored_conditions:
description: Conditions to display in the frontend. The following conditions can be monitored.
required: false
type: list
keys:
captured_today:
description: Return the number of videos captured on the current day.
last_capture:
description: Return the timestamp from the last video captured by your Arlo camera.
total_cameras:
description: Return the number of recognized and active cameras linked on your Arlo account.
battery_level:
description: Return the battery level of your Arlo camera.
signal_strength:
description: Return the wireless signal strength of your Arlo camera.
temperature:
description: Return the ambient temperature detected by your Arlo Baby camera.
humidity:
description: Return the ambient relative humidity detected by your Arlo Baby camera.
air_quality:
description: Return the ambient air quality (a reading of volatile organic compounds (VOCs) in parts per million) detected by your Arlo Baby camera.
{% endconfiguration %}
If no **monitored_conditions** are specified, all of above will be enabled by default.