mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 09:17:06 +00:00
Merge branch 'current' into next
This commit is contained in:
Fabian Affolter
commit
d380fc50d4
@ -1,76 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "AlarmDecoder Alarm Control Panel"
|
||||
description: "Instructions on how to setup the AlarmDecoder Alarm control panel within Home Assistant."
|
||||
date: 2017-04-02 13:28
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: alarmdecoder.png
|
||||
ha_category: Alarm
|
||||
ha_release: 0.43
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
The `alarmdecoder` alarm control panel platform allows you to control your [AlarmDecoder](https://www.alarmdecoder.com) alarms.
|
||||
|
||||
The requirement is that you have setup your [AlarmDecoder hub](/components/alarmdecoder/).
|
||||
|
||||
### {% linkable_title Services %}
|
||||
|
||||
The Alarm Decoder component gives you access to several services for you to control your alarm with.
|
||||
|
||||
- `alarm_arm_away`: Arms the alarm in away mode; all faults will trigger the alarm.
|
||||
- `alarm_arm_home`: Arms the alarm in stay mode; faults to the doors or windows will trigger the alarm.
|
||||
- `alarm_arm_night`: Arms the alarm in instant mode; all faults will trigger the alarm. Additionally, the entry delay is turned off on the doors.
|
||||
- `alarm_disarm`: Disarms the alarm from any state. Also clears a `check_zone` flag after an alarm was triggered.
|
||||
- `alarmdecoder_alarm_toggle_chime`: Toggles the alarm's chime state.
|
||||
|
||||
<p class='note'>
|
||||
`alarm_arm_custom_bypass` and `alarm_trigger`, while available in the services list in Home Assistant, are not currently implemented in the Alarm Decoder platform.
|
||||
</p>
|
||||
|
||||
### {% linkable_title Attributes %}
|
||||
|
||||
There are several attributes available on the alarm panel to give you more information about your alarm.
|
||||
|
||||
- `ac_power`: Set to `true` if your system has AC power supplying it.
|
||||
- `backlight_on`: Set to `true` if your keypad's backlight is on.
|
||||
- `battery_low`: Set to `true` if your system's back-up battery is low.
|
||||
- `check_zone`: Set to `true` if your system was recently triggered. When `check_zone` is `true`, it must be cleared by entering your code + 1 before attempting to rearm your alarm.
|
||||
- `chime`: Set to `true` if your system's chime is activated. When activated, your system will beep anytime a door or window is faulted while the alarm is disarmed.
|
||||
- `entry_delay_off`: Set to `true` if your system is in "Instant" mode, meaning the alarm will sound on any faults.
|
||||
- `programming_mode`: Set to `true` if your system is in programming mode.
|
||||
- `ready`: Set to `true` if your system is ready to be armed. Any faults, including motions sensors, will make this value `false`.
|
||||
- `zone_bypassed`: Set to `true` if your system is currently bypassing a zone.
|
||||
|
||||
### {% linkable_title Examples %}
|
||||
|
||||
Using a combination of the available services and attributes, you can create switch templates.
|
||||
|
||||
#### {% linkable_title Chime Status and Control %}
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
- platform: template
|
||||
switches:
|
||||
alarm_chime:
|
||||
friendly_name: Chime
|
||||
value_template: "{{ is_state_attr('alarm_control_panel.alarm_panel', 'chime', true) }}"
|
||||
turn_on:
|
||||
service: alarm_control_panel.alarmdecoder_alarm_toggle_chime
|
||||
data:
|
||||
code: !secret alarm_code
|
||||
turn_off:
|
||||
service: alarm_control_panel.alarmdecoder_alarm_toggle_chime
|
||||
data:
|
||||
code: !secret alarm_code
|
||||
icon_template: >-
|
||||
{% if is_state_attr('alarm_control_panel.alarm_panel', 'chime', true) %}
|
||||
mdi:bell-ring
|
||||
{% else %}
|
||||
mdi:bell-off
|
||||
{% endif %}
|
||||
```
|
||||
{% endraw %}
|
||||
@ -8,9 +8,16 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: alarmdecoder.png
|
||||
ha_category: Hub
|
||||
ha_category:
|
||||
- Alarm
|
||||
- Binary Sensor
|
||||
- Sensor
|
||||
ha_release: 0.43
|
||||
ha_iot_class: "Local Push"
|
||||
redirect_from:
|
||||
- /components/alarm_control_panel.alarmdecoder/
|
||||
- /components/binary_sensor.alarmdecoder/
|
||||
- /components/sensor.alarmdecoder/
|
||||
---
|
||||
|
||||
The `alarmdecoder` component will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Nu Tech Software Solutions, known as the AlarmDecoder. The AlarmDecoder devices provide a serial, TCP/IP socket or USB interface to the alarm panel, where it emulates an alarm keypad.
|
||||
@ -19,12 +26,14 @@ Please visit the [AlarmDecoder website](https://www.alarmdecoder.com/) for furth
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Binary Sensor](/components/binary_sensor.alarmdecoder/): Reports on zone status
|
||||
- [Sensor](/components/sensor.alarmdecoder/): Emulates a keypad display
|
||||
- [Alarm Control Panel](/components/alarm_control_panel.alarmdecoder/): Reports on alarm status, and can be used to arm/disarm the system
|
||||
- Binary Sensor: Reports on zone status
|
||||
- Sensor: Emulates a keypad display
|
||||
- [Alarm Control Panel](#alarm-control-panel): Reports on alarm status, and can be used to arm/disarm the system
|
||||
|
||||
This is a fully event-based component. Any event sent by the AlarmDecoder device will be immediately reflected within Home Assistant.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
An `alarmdecoder` section must be present in the `configuration.yaml` file and contain the following options as required:
|
||||
|
||||
```yaml
|
||||
@ -112,3 +121,61 @@ zones:
|
||||
required: inclusive
|
||||
type: integer
|
||||
{% endconfiguration %}
|
||||
|
||||
## {% linkable_title Alarm Control Panel %}
|
||||
|
||||
There are several attributes available on the alarm panel to give you more information about your alarm.
|
||||
|
||||
- `ac_power`: Set to `true` if your system has AC power supplying it.
|
||||
- `backlight_on`: Set to `true` if your keypad's backlight is on.
|
||||
- `battery_low`: Set to `true` if your system's back-up battery is low.
|
||||
- `check_zone`: Set to `true` if your system was recently triggered. When `check_zone` is `true`, it must be cleared by entering your code + 1 before attempting to rearm your alarm.
|
||||
- `chime`: Set to `true` if your system's chime is activated. When activated, your system will beep anytime a door or window is faulted while the alarm is disarmed.
|
||||
- `entry_delay_off`: Set to `true` if your system is in "Instant" mode, meaning the alarm will sound on any faults.
|
||||
- `programming_mode`: Set to `true` if your system is in programming mode.
|
||||
- `ready`: Set to `true` if your system is ready to be armed. Any faults, including motions sensors, will make this value `false`.
|
||||
- `zone_bypassed`: Set to `true` if your system is currently bypassing a zone.
|
||||
|
||||
## {% linkable_title Services %}
|
||||
|
||||
The Alarm Decoder component gives you access to several services for you to control your alarm with.
|
||||
|
||||
- `alarm_arm_away`: Arms the alarm in away mode; all faults will trigger the alarm.
|
||||
- `alarm_arm_home`: Arms the alarm in stay mode; faults to the doors or windows will trigger the alarm.
|
||||
- `alarm_arm_night`: Arms the alarm in instant mode; all faults will trigger the alarm. Additionally, the entry delay is turned off on the doors.
|
||||
- `alarm_disarm`: Disarms the alarm from any state. Also clears a `check_zone` flag after an alarm was triggered.
|
||||
- `alarmdecoder_alarm_toggle_chime`: Toggles the alarm's chime state.
|
||||
|
||||
<p class='note'>
|
||||
`alarm_arm_custom_bypass` and `alarm_trigger`, while available in the services list in Home Assistant, are not currently implemented in the Alarm Decoder platform.
|
||||
</p>
|
||||
|
||||
### {% linkable_title Examples %}
|
||||
|
||||
Using a combination of the available services and attributes, you can create switch templates.
|
||||
|
||||
### {% linkable_title Chime Status and Control %}
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
- platform: template
|
||||
switches:
|
||||
alarm_chime:
|
||||
friendly_name: Chime
|
||||
value_template: "{{ is_state_attr('alarm_control_panel.alarm_panel', 'chime', true) }}"
|
||||
turn_on:
|
||||
service: alarm_control_panel.alarmdecoder_alarm_toggle_chime
|
||||
data:
|
||||
code: !secret alarm_code
|
||||
turn_off:
|
||||
service: alarm_control_panel.alarmdecoder_alarm_toggle_chime
|
||||
data:
|
||||
code: !secret alarm_code
|
||||
icon_template: >-
|
||||
{% if is_state_attr('alarm_control_panel.alarm_panel', 'chime', true) %}
|
||||
mdi:bell-ring
|
||||
{% else %}
|
||||
mdi:bell-off
|
||||
{% endif %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
@ -1,20 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "AlarmDecoder Binary Sensor"
|
||||
description: "Instructions on how to integrate AlarmDecoder binary sensors into Home Assistant."
|
||||
date: 2017-04-02 13:28
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: alarmdecoder.png
|
||||
ha_release: 0.43
|
||||
ha_category: Binary Sensor
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
The `alarmdecoder` alarm control panel platform allows you to control your [AlarmDecoder](https://www.alarmdecoder.com) alarms.
|
||||
|
||||
Check the [type/class](/components/binary_sensor/) list for a possible visualization of your zone.
|
||||
|
||||
The requirement is that you have setup your [AlarmDecoder hub](/components/alarmdecoder/).
|
||||
@ -1,60 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Nest Binary Sensor"
|
||||
description: "Instructions on how to integrate Nest binary sensors within Home Assistant."
|
||||
date: 2016-01-26 08:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: nest.png
|
||||
ha_category: Binary Sensor
|
||||
ha_release: pre 0.7
|
||||
ha_iot_class: "Cloud Push"
|
||||
---
|
||||
|
||||
The `nest` binary sensor platform lets you monitor various states of your [Nest](https://nest.com) devices.
|
||||
|
||||
<p class='note'>
|
||||
You must have the [Nest component](/components/nest/) configured to use these sensors. The binary sensors will be setup if the `nest` component is configured and the required configuration for the `nest binary sensor` is set.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable binary sensors and customize which sensors are setup, you can extend the [Nest component](/components/nest/) configuration in your `configuration.yaml` file with the following settings:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
nest:
|
||||
binary_sensors:
|
||||
monitored_conditions:
|
||||
- 'fan'
|
||||
- 'target'
|
||||
```
|
||||
|
||||
By default all binary sensors for your available Nest devices will be monitored. Leave `monitored_conditions` blank to disable all binary sensors for the [Nest component](/components/nest/).
|
||||
|
||||
{% configuration %}
|
||||
monitored_conditions:
|
||||
description: States to monitor.
|
||||
required: false
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
The following conditions are available by device:
|
||||
|
||||
- Nest Home:
|
||||
- away
|
||||
- Nest Thermostat:
|
||||
- online
|
||||
- fan
|
||||
- is\_using\_emergency\_heat
|
||||
- is\_locked
|
||||
- has\_leaf
|
||||
- Nest Protect:
|
||||
- online
|
||||
- Nest Camera:
|
||||
- online
|
||||
- motion\_detected
|
||||
- person\_detected
|
||||
- sound\_detected
|
||||
@ -1,22 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Nest Camera"
|
||||
description: "Instructions on how to integrate Nest cameras into Home Assistant."
|
||||
date: 2016-12-03 08:10
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: nest.png
|
||||
ha_category: Camera
|
||||
ha_release: 0.34
|
||||
ha_iot_class: "Cloud Poll"
|
||||
---
|
||||
|
||||
The `nest` platform allows you to watch still frames from a video stream (not live stream) of your [Nest](https://nest.com/camera/meet-nest-cam/) camera in Home Assistant.
|
||||
|
||||
<p class='note'>
|
||||
You must have the [Nest component](/components/nest/) configured to use this camera. The `nest` camera will automatically be setup when you do.
|
||||
</p>
|
||||
|
||||
Nest Camera supports the `camera.turn_on` and `camera.turn_off` services since the 0.75 release.
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Nest Thermostat"
|
||||
description: "Instructions on how to integrate Nest thermostats within Home Assistant."
|
||||
date: 2015-03-23 19:59
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: nest.png
|
||||
ha_category: Climate
|
||||
ha_iot_class: "Cloud Push"
|
||||
---
|
||||
|
||||
The `nest` climate platform lets you control a thermostat from [Nest](https://nest.com).
|
||||
|
||||
<p class='note'>
|
||||
You must have the [Nest component](/components/nest/) configured to use these sensors. The `nest` climate component will automatically be setup when you do. Please note due to limitations with the European Nest Thermostat E, integration with Home Assistant for that thermostat is not possible.
|
||||
</p>
|
||||
|
||||
<p class='img'>
|
||||
<img src='{{site_root}}/images/screenshots/nest-thermostat-card.png' />
|
||||
</p>
|
||||
@ -1,35 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Freebox Device Tracker"
|
||||
description: "Instructions on how to track devices connected to a Freebox router in Home Assistant."
|
||||
date: 2018-05-16 23:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: freebox.svg
|
||||
ha_category: Presence Detection
|
||||
ha_release: "0.70"
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
This platform offers presence detection by keeping track of the
|
||||
devices connected to a [Freebox](http://www.free.fr/) router.
|
||||
|
||||
This requires you to have set up the [Freebox component](/components/freebox/)
|
||||
|
||||
### {% linkable_title Notes %}
|
||||
|
||||
Note that the Freebox waits for some time before marking a device as
|
||||
inactive, meaning that there will be a small delay (1 or 2 minutes)
|
||||
between the time you disconnect a device and the time it will appear
|
||||
as "away" in Home Assistant. You should take this into account when specifying
|
||||
the `consider_home` parameter.
|
||||
On the contrary, the Freebox immediately reports devices newly connected, so
|
||||
they should appear as "home" almost instantly, as soon as Home Assistant
|
||||
refreshes the devices states.
|
||||
|
||||
See the [device tracker component page](/components/device_tracker/) for
|
||||
instructions how to configure the devices to be tracked.
|
||||
|
||||
@ -8,20 +8,25 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: freebox.svg
|
||||
ha_category: Network
|
||||
ha_category:
|
||||
- Network
|
||||
- Presence Detection
|
||||
- Sensor
|
||||
ha_release: "0.85"
|
||||
ha_iot_class: "Local Polling"
|
||||
redirect_from:
|
||||
- /components/device_tracker.freebox/
|
||||
- /components/sensor.freebox/
|
||||
---
|
||||
|
||||
|
||||
The `freebox` component allows you to observe and control [Freebox router](http://www.free.fr/).
|
||||
|
||||
The integration provides:
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
* a sensor with traffic metrics
|
||||
* a device tracker for connected devices
|
||||
* [Sensor](#sensor) with traffic metrics
|
||||
* [Device tracker](#presence-detection) for connected devices
|
||||
|
||||
### {% linkable_title Configuration %}
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
If you have enabled the [discovery component](/components/discovery/),
|
||||
your Freebox should be detected automatically. Otherwise, you can set it
|
||||
@ -61,6 +66,28 @@ prompted to do so.
|
||||
### {% linkable_title Supported routers %}
|
||||
|
||||
Only the routers with Freebox OS are supported:
|
||||
|
||||
* Freebox V7 also known as Freebox Delta
|
||||
* Freebox V6 also known as Freebox Revolution
|
||||
* Freebox mini 4k
|
||||
|
||||
## {% linkable_title Presence Detection %}
|
||||
|
||||
This platform offers presence detection by keeping track of the
|
||||
devices connected to a [Freebox](http://www.free.fr/) router.
|
||||
|
||||
### {% linkable_title Notes %}
|
||||
|
||||
Note that the Freebox waits for some time before marking a device as
|
||||
inactive, meaning that there will be a small delay (1 or 2 minutes)
|
||||
between the time you disconnect a device and the time it will appear
|
||||
as "away" in Home Assistant. You should take this into account when specifying
|
||||
the `consider_home` parameter.
|
||||
On the contrary, the Freebox immediately reports devices newly connected, so
|
||||
they should appear as "home" almost instantly, as soon as Home Assistant
|
||||
refreshes the devices states.
|
||||
|
||||
## {% linkable_title Sensor %}
|
||||
|
||||
This platform offers you sensors to monitor a Freebox router. The monitored conditions are
|
||||
instant upload and download rates in KB/s.
|
||||
@ -8,28 +8,45 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: nest.png
|
||||
ha_category: Hub
|
||||
ha_category:
|
||||
- Hub
|
||||
- Binary Sensor
|
||||
- Camera
|
||||
- Climate
|
||||
- Sensor
|
||||
featured: true
|
||||
ha_iot_class: "Cloud Push"
|
||||
redirect_from:
|
||||
- /components/binary_sensor.nest/
|
||||
- /components/camera.nest/
|
||||
- /components/climate.nest/
|
||||
- /components/sensor.nest/
|
||||
---
|
||||
|
||||
The Nest component is the main component to integrate all [Nest](https://nest.com/) related platforms. To connect Nest, you will have to [sign up for a developer account](https://developers.nest.com/products) and get a `client_id` and `client_secret`.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Binary Sensor](#binary-sensor)
|
||||
- [Camera](#camera)
|
||||
- [Climate](#climate)
|
||||
- [Sensor](#sensor)
|
||||
|
||||
### {% linkable_title Setting up developer account %}
|
||||
|
||||
1. Visit [Nest Developers](https://developers.nest.com/), and sign in. Create an account if you don't have one already.
|
||||
2. Fill in account details:
|
||||
- The "Company Information" can be anything. We recommend using your name.
|
||||
* The "Company Information" can be anything. We recommend using your name.
|
||||
3. Submit changes
|
||||
4. Click "[Products](https://developers.nest.com/products)" at top of page.
|
||||
5. Click "[Create New Product](https://developers.nest.com/products/new)"
|
||||
6. Fill in details:
|
||||
- Product name must be unique. We recommend [email] - Home Assistant.
|
||||
- The description, users, URLs can all be anything you want.
|
||||
- Leave the "Redirect URI" Field blank
|
||||
* Product name must be unique. We recommend [email] - Home Assistant.
|
||||
* The description, users, URLs can all be anything you want.
|
||||
* Leave the "Redirect URI" Field blank
|
||||
7. For permissions check every box and if it's an option select the read/write option. Note: there are important permissions under the "Other Permissions" category. If you are only adding a thermostat, do not just select the permissions under "Thermostat". You still need to check the boxes under "Other Permissions" in order to give you access to features like away mode, ETA, structure read/write, and postal code.
|
||||
- The description requires a specific format to be accepted.
|
||||
- Use "[Home Assistant] [Edit] [For Home Automation]" as the description as it is not super important.
|
||||
* The description requires a specific format to be accepted.
|
||||
* Use "[Home Assistant] [Edit] [For Home Automation]" as the description as it is not super important.
|
||||
8. Click "Create Product"
|
||||
9. Once the new product page opens the "Product ID" and "Product Secret" are located on the right side. These will be used as `client_id` and `client_secret` below.
|
||||
10. Add the Nest component to your `configuration.yaml` and restart Home Assistant. Then, go to `Configuration > Integrations` and select `CONFIGURE` next to `Nest`. Click the link in the configurator pop up to log into your Nest account and complete the OAuth. Copy the resulting PIN code into the pop up.
|
||||
@ -177,3 +194,149 @@ script:
|
||||
### {% linkable_title Troubleshooting %}
|
||||
|
||||
- If you're getting [rickrolled](https://www.youtube.com/watch?v=dQw4w9WgXcQ) instead of being able to see your Nest cameras, you may not have set up your developer account's permissions correctly. Go back through and make sure you've selected read/write under every category that it's an option.
|
||||
|
||||
## {% linkable_title Platforms %}
|
||||
|
||||
<p class='note'>
|
||||
You must have the [Nest component](/components/nest/) configured to use the platforms below.
|
||||
<p>
|
||||
|
||||
## {% linkable_title Binary Sensor %}
|
||||
|
||||
The `nest` binary sensor platform lets you monitor various states of your [Nest](https://nest.com) devices.
|
||||
|
||||
<p class='note'>
|
||||
You must have the [Nest component](/components/nest/) configured to use these sensors. The binary sensors will be setup if the `nest` component is configured and the required configuration for the `nest binary sensor` is set.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable binary sensors and customize which sensors are setup, you can extend the [Nest component](/components/nest/) configuration in your `configuration.yaml` file with the following settings:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
nest:
|
||||
binary_sensors:
|
||||
monitored_conditions:
|
||||
- 'fan'
|
||||
- 'target'
|
||||
```
|
||||
|
||||
By default all binary sensors for your available Nest devices will be monitored. Leave `monitored_conditions` blank to disable all binary sensors for the [Nest component](/components/nest/).
|
||||
|
||||
{% configuration %}
|
||||
monitored_conditions:
|
||||
description: States to monitor.
|
||||
required: false
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
The following conditions are available by device:
|
||||
|
||||
- Nest Home:
|
||||
- away
|
||||
- Nest Thermostat:
|
||||
- online
|
||||
- fan
|
||||
- is\_using\_emergency\_heat
|
||||
- is\_locked
|
||||
- has\_leaf
|
||||
- Nest Protect:
|
||||
- online
|
||||
- Nest Camera:
|
||||
- online
|
||||
- motion\_detected
|
||||
- person\_detected
|
||||
- sound\_detected
|
||||
|
||||
## {% linkable_title Camera %}
|
||||
|
||||
The `nest` platform allows you to watch still frames from a video stream (not live stream) of your [Nest](https://nest.com/camera/meet-nest-cam/) camera in Home Assistant.
|
||||
|
||||
<p class='note'>
|
||||
The `nest` camera will automatically be setup when you do.
|
||||
</p>
|
||||
|
||||
Nest Camera supports the `camera.turn_on` and `camera.turn_off` services since the 0.75 release.
|
||||
|
||||
## {% linkable_title Climate %}
|
||||
|
||||
The `nest` climate platform lets you control a thermostat from [Nest](https://nest.com).
|
||||
|
||||
<p class='note'>
|
||||
Please note due to limitations with the European Nest Thermostat E, integration with Home Assistant for that thermostat is not possible.
|
||||
</p>
|
||||
|
||||
<p class='img'>
|
||||
<img src='{{site_root}}/images/screenshots/nest-thermostat-card.png' />
|
||||
</p>
|
||||
|
||||
## {% linkable_title Sensor %}
|
||||
|
||||
The `nest` sensor platform lets you monitor sensors connected to your [Nest](https://nest.com) devices.
|
||||
|
||||
<p class='note'>
|
||||
The sensors will be setup if the `nest` component is configured and the required configuration for the `nest sensor` is set.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable sensors and customize which sensors are setup, you can extend the [Nest component](/components/nest/) configuration in your `configuration.yaml` file with the following settings:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
nest:
|
||||
sensors:
|
||||
monitored_conditions:
|
||||
- 'temperature'
|
||||
- 'target'
|
||||
```
|
||||
|
||||
By default all sensors for your available Nest devices will be monitored. Leave `monitored_conditions` blank to disable all sensors for the [Nest component](/components/nest/).
|
||||
|
||||
{% configuration %}
|
||||
monitored_conditions:
|
||||
description: States to monitor.
|
||||
required: false
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
The following conditions are available by device:
|
||||
|
||||
- Nest Home:
|
||||
- eta: Estimated time of arrival.
|
||||
- security\_state: `ok` or `deter`. [Security State](#security-state). Only available when Nest Camera exists.
|
||||
- Nest Thermostat:
|
||||
- humidity
|
||||
- operation\_mode
|
||||
- temperature
|
||||
- target
|
||||
- hvac\_state: The currently active state of the HVAC system, `heat`, `cool` or `off` (previously `heating`, `cooling` or `off`).
|
||||
- Nest Protect:
|
||||
- co\_status: `Ok`, `Warning` or `Emergency`
|
||||
- smoke\_status: `Ok`, `Warning` or `Emergency`
|
||||
- battery\_health: `Ok` or `Replace`
|
||||
- color\_status: `gray`, `green`, `yellow` or `red`. Indicates device status by color in the Nest app UI. It is an aggregate condition for battery+smoke+CO states, and reflects the actual color indicators displayed in the Nest app.
|
||||
- Nest Camera: none
|
||||
|
||||
## {% linkable_title Security State %}
|
||||
|
||||
<p class='note warning'>
|
||||
This feature is not designed to transfer your Home Assistant to a security system, neither Home Assistant nor Nest be liable to You for damages,
|
||||
or consequential damages of any character arising as a result of use this feature.
|
||||
|
||||
This feature does not depend on the [Nest Secure alarm system](https://nest.com/alarm-system/overview/) and is not a reflection of the status of that system,
|
||||
nor does it react to state changes in that system.
|
||||
</p>
|
||||
|
||||
<p class='note'>
|
||||
This feature uses a new [Nest Security API](https://developers.nest.com/documentation/cloud/security-guide).
|
||||
You may need to change your ["Product"](https://developers.nest.com/products) permission setting to include `Security State Read`.
|
||||
After this permission change, you may need to re-authorize your client.
|
||||
</p>
|
||||
|
||||
If a Nest Cam detects the presence of a person (see `person_detected` in [binary_sensor.nest](#binary-sensor) while the structure is in `away` mode (see `away` in [binary_sensor.nest](#binary-sensor), the structure enters `deter` mode.
|
||||
|
||||
A `deter` state is re-evaluated after several minutes and relaxed to `ok` if no further `person_detected` events have occurred.
|
||||
|
||||
The `security_state` automatically switches to `ok` when the structure state is `home`.
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "AlarmDecoder Sensor"
|
||||
description: "Instructions on how to integrate AlarmDecoder sensors into Home Assistant."
|
||||
date: 2017-04-02 13:28
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: alarmdecoder.png
|
||||
ha_release: 0.43
|
||||
ha_category: Sensor
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
The `alarmdecoder` alarm control panel platform allows you to control your [AlarmDecoder](https://www.alarmdecoder.com) alarms.
|
||||
|
||||
The requirement is that you have setup your [AlarmDecoder hub](/components/alarmdecoder/).
|
||||
@ -1,20 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Freebox Sensor"
|
||||
description: "Instructions on how to integrate sensors from a Freebox router into Home Assistant."
|
||||
date: 2018-05-16 23:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: freebox.svg
|
||||
ha_category: Network
|
||||
ha_release: "0.85"
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
This platform offers you sensors to monitor a Freebox router. The monitored conditions are
|
||||
instant upload and download rates in KB/s.
|
||||
|
||||
This requires you to have set up the [Freebox component](/components/freebox/)
|
||||
@ -1,82 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Nest Sensor"
|
||||
description: "Instructions on how to integrate Nest sensors within Home Assistant."
|
||||
date: 2016-01-13 19:59
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: nest.png
|
||||
ha_category: Sensor
|
||||
ha_release: pre 0.7
|
||||
ha_iot_class: "Cloud Push"
|
||||
---
|
||||
|
||||
The `nest` sensor platform lets you monitor sensors connected to your [Nest](https://nest.com) devices.
|
||||
|
||||
<p class='note'>
|
||||
You must have the [Nest component](/components/nest/) configured to use these sensors. The sensors will be setup if the `nest` component is configured and the required configuration for the `nest sensor` is set.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable sensors and customize which sensors are setup, you can extend the [Nest component](/components/nest/) configuration in your `configuration.yaml` file with the following settings:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
nest:
|
||||
sensors:
|
||||
monitored_conditions:
|
||||
- 'temperature'
|
||||
- 'target'
|
||||
```
|
||||
|
||||
By default all sensors for your available Nest devices will be monitored. Leave `monitored_conditions` blank to disable all sensors for the [Nest component](/components/nest/).
|
||||
|
||||
{% configuration %}
|
||||
monitored_conditions:
|
||||
description: States to monitor.
|
||||
required: false
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
The following conditions are available by device:
|
||||
|
||||
- Nest Home:
|
||||
- eta: Estimated time of arrival.
|
||||
- security\_state: `ok` or `deter`. [Security State](#security-state). Only available when Nest Camera exists.
|
||||
- Nest Thermostat:
|
||||
- humidity
|
||||
- operation\_mode
|
||||
- temperature
|
||||
- target
|
||||
- hvac\_state: The currently active state of the HVAC system, `heat`, `cool` or `off` (previously `heating`, `cooling` or `off`).
|
||||
- Nest Protect:
|
||||
- co\_status: `Ok`, `Warning` or `Emergency`
|
||||
- smoke\_status: `Ok`, `Warning` or `Emergency`
|
||||
- battery\_health: `Ok` or `Replace`
|
||||
- color\_status: `gray`, `green`, `yellow` or `red`. Indicates device status by color in the Nest app UI. It is an aggregate condition for battery+smoke+CO states, and reflects the actual color indicators displayed in the Nest app.
|
||||
- Nest Camera: none
|
||||
|
||||
## {% linkable_title Security State %}
|
||||
|
||||
<p class='note warning'>
|
||||
This feature is not designed to transfer your Home Assistant to a security system, neither Home Assistant nor Nest be liable to You for damages,
|
||||
or consequential damages of any character arising as a result of use this feature.
|
||||
|
||||
This feature does not depend on the [Nest Secure alarm system](https://nest.com/alarm-system/overview/) and is not a reflection of the status of that system,
|
||||
nor does it react to state changes in that system.
|
||||
</p>
|
||||
|
||||
<p class='note'>
|
||||
This feature uses a new [Nest Security API](https://developers.nest.com/documentation/cloud/security-guide).
|
||||
You may need to change your ["Product"](https://developers.nest.com/products) permission setting to include `Security State Read`.
|
||||
After this permission change, you may need to re-authorize your client.
|
||||
</p>
|
||||
|
||||
If a Nest Cam detects the presence of a person (see `person_detected` in [binary_sensor.nest](/components/binary_sensor.nest/)) while the structure is in `away` mode (see `away` in [binary_sensor.nest](/components/binary_sensor.nest/)), the structure enters `deter` mode.
|
||||
|
||||
A `deter` state is re-evaluated after several minutes and relaxed to `ok` if no further `person_detected` events have occurred.
|
||||
|
||||
The `security_state` automatically switches to `ok` when the structure state is `home`.
|
||||
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: fuelcheck.png
|
||||
ha_category: Car
|
||||
ha_release: 0.72
|
||||
ha_iot_class: "Cloud Polling"
|
||||
@ -21,7 +22,7 @@ To get the station ID for any NSW fuel station you will need to:
|
||||
- Visit the [Fuel Check App](https://www.fuelcheck.nsw.gov.au/app).
|
||||
- Open the developer console of your browser (for Chrome, click View -> Developer -> Developer Tools). Click the "Network" tab in the developer console.
|
||||
- In the Fuel Check App, search for your postcode or click "Fuel Near Me".
|
||||
- In the developer console, you should see a request to `/FuelCheckApp/v1/fuel/prices/bylocation`. Open this request and preview the response. Find the station you wish to add, and copy down the `ServiceStationID` field.
|
||||
- In the developer console, you should see a request to `/FuelCheckApp/v1/fuel/prices/bylocation`. Open this request and preview the response. Find the station you wish to add, and copy down the `ServiceStationID` field.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ redirect_from: /getting-started/installation/
|
||||
Beginners should check our [Getting started guide](/getting-started/) first.
|
||||
</p>
|
||||
|
||||
Home Assistant provides multiple ways to be installed. The first start may take up to 20 minutes because the required packages will be downloaded and installed. The web interface will be served on `http://ip.add.re.ss:8123/` - replace `ip.add.re.ss` with the IP of the computer you installed it on.
|
||||
Home Assistant provides multiple ways to be installed. The first start may take up to 20 minutes because the required packages will be downloaded and installed. The web interface will be served on `http://ip.add.re.ss:8123/`. Replace `ip.add.re.ss` with the IP of the computer you installed it on.
|
||||
|
||||
<p class='note warning'>
|
||||
Please remember to [secure your installation](/docs/configuration/securing/) once you've finished with the installation process.
|
||||
@ -26,9 +26,9 @@ These install options are fully supported by Home Assistant's documentation. For
|
||||
|
||||
**Method**|**You have**|**Recommended for**
|
||||
:-----|:-----|:-----
|
||||
[Hass.io](https://www.home-assistant.io/hassio/installation/)|Raspberry Pi<br>VM|Anybody
|
||||
[Docker](https://www.home-assistant.io/docs/installation/docker/)|Docker|Anybody already running Docker
|
||||
[Hassbian](https://www.home-assistant.io/docs/hassbian/installation/)|Raspberry Pi|Those who want a more traditional Linux experience and either have experience with Linux, or intend to learn
|
||||
[Hass.io](/hassio/installation/)|Raspberry Pi<br>VM|Anybody
|
||||
[Docker](/docs/installation/docker/)|Docker|Anybody already running Docker
|
||||
[Hassbian](/docs/hassbian/installation/)|Raspberry Pi|Those who want a more traditional Linux experience and either have experience with Linux, or intend to learn
|
||||
|
||||
## {% linkable_title Alternative installs %}
|
||||
|
||||
@ -36,14 +36,12 @@ If you use these install methods, we assume that you know how to manage and admi
|
||||
|
||||
**Method**|**You have**|**Recommended for**
|
||||
:-----|:-----|:-----
|
||||
[Virtualenv<BR>(as another user)](https://www.home-assistant.io/docs/installation/raspberry-pi/)|Any Linux, Python 3.5.3 or later|Those familiar with their operating system
|
||||
[Virtualenv<BR>(as your user)](https://www.home-assistant.io/docs/installation/virtualenv/)|Any Python 3.5.3 or later|Developers
|
||||
|
||||
<HR>
|
||||
[Virtualenv<BR>(as another user)](/docs/installation/raspberry-pi/)|Any Linux, Python 3.5.3 or later|Those familiar with their operating system
|
||||
[Virtualenv<BR>(as your user)](/docs/installation/virtualenv/)|Any Python 3.5.3 or later|Developers
|
||||
|
||||
## {% linkable_title Community provided guides %}
|
||||
|
||||
These guides are provided as-is. Some of these install methods are more limited than the methods above - some components may not work due to limitations of the platform or because required Python packages aren't available for that platform.
|
||||
These guides are provided as-is. Some of these install methods are more limited than the methods above. Some components may not work due to limitations of the platform or because required Python packages aren't available for that platform.
|
||||
|
||||
<div class="text-center hass-option-cards" markdown="0">
|
||||
<a class='option-card' href='/docs/installation/armbian/'>
|
||||
@ -100,4 +98,10 @@ These guides are provided as-is. Some of these install methods are more limited
|
||||
</div>
|
||||
<div class='title'>FreeNAS</div>
|
||||
</a>
|
||||
<a class='option-card' href='/hassio/installation/#alternative-install-on-generic-linux-server'>
|
||||
<div class='img-container'>
|
||||
<img src='/images/supported_brands/home-assistant.png' />
|
||||
</div>
|
||||
<div class='title'>Hass.io <br> on generic Linux server</div>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
@ -13,7 +13,7 @@ footer: true
|
||||
|
||||
Python 3.5.3 or later is required.
|
||||
|
||||
Setup Python and `pip`
|
||||
Setup Python and `pip`:
|
||||
|
||||
```bash
|
||||
$ sudo apt-get update
|
||||
@ -23,10 +23,12 @@ $ sudo apt-get install python3-dev python3-pip
|
||||
Now that you installed python, there are two ways to install Home Assistant:
|
||||
1. It is recommended to install Home Assistant in a virtual environment to avoid using `root`, using the [VirtualEnv instructions](/docs/installation/virtualenv/)
|
||||
2. Alternatively, you can install Home Assistant for the user you created when first booting Armbian:
|
||||
|
||||
```bash
|
||||
$ sudo pip3 install homeassistant
|
||||
$ hass --open-ui
|
||||
```
|
||||
|
||||
Running these commands will:
|
||||
|
||||
- Install Home Assistant
|
||||
|
||||
@ -20,6 +20,7 @@ First of all install the software collection repository as root. For example, on
|
||||
```bash
|
||||
$ yum install centos-release-scl
|
||||
```
|
||||
|
||||
Install some dependencies you'll need later.
|
||||
|
||||
```bash
|
||||
|
||||
@ -23,14 +23,14 @@ and Home Assistant itself.
|
||||
$ pip3 install homeassistant
|
||||
```
|
||||
|
||||
To isolate the Home Assistant installation a [venv](https://docs.python.org/3/library/venv.html) is handy. First create a new directory to store the installation and adjust the permissions.
|
||||
To isolate the Home Assistant installation a [`venv`](https://docs.python.org/3/library/venv.html) is handy. First create a new directory to store the installation and adjust the permissions.
|
||||
|
||||
```bash
|
||||
$ sudo mkdir -p /opt/homeassistant
|
||||
$ sudo useradd -rm homeassistant -G dialout
|
||||
$ sudo chown -R homeassistant:homeassistant /opt/homeassistant
|
||||
```
|
||||
Now switch to the new directory, setup the venv, and activate it.
|
||||
Now switch to the new directory, setup the `venv`, and activate it.
|
||||
|
||||
```bash
|
||||
$ sudo -u homeassistant -H -s
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
{%- assign components = site.components | sort_natural: 'title' -%}
|
||||
{%- assign github_main_repo = 'https://github.com/home-assistant/home-assistant/blob/master/homeassistant' -%}
|
||||
{%- assign github_main_repo = 'https://github.com/home-assistant/home-assistant/blob/dev/homeassistant' -%}
|
||||
<section class="aside-module grid__item one-whole lap-one-half">
|
||||
{%- include edit_github.html -%}
|
||||
|
||||
@ -14,15 +14,15 @@
|
||||
{%- if file_parts.size == 2 -%}
|
||||
{%- assign is_platform = true -%}
|
||||
{%- assign imp_name = file_parts[1] -%}
|
||||
{%- assign imp_url = imp_name | prepend: '/components/' | append: '/' -%}
|
||||
{%- assign parent_name = file_parts[0] -%}
|
||||
{%- assign parent_url = parent_name | prepend: '/components/' | append: '/' -%}
|
||||
{%- assign embedded_url = imp_name | prepend: '/components/' | append: '/' -%}
|
||||
{%- assign embedded_component = components | where: 'url', embedded_url | first -%}
|
||||
{%- assign parent_component = components | where: 'url', parent_url | first -%}
|
||||
{%- assign parent_component = components | where: 'url', imp_url | first -%}
|
||||
{%- else -%}
|
||||
{%- assign is_platform = false -%}
|
||||
{%- assign imp_name = file_parts | first -%}
|
||||
{%- endif -%}
|
||||
{%- assign imp_url = imp_name | prepend: '/components/' | append: '/' -%}
|
||||
{%- endif -%}
|
||||
|
||||
{%- if page.ha_iot_class -%}
|
||||
<div class='section'>
|
||||
@ -58,12 +58,13 @@
|
||||
</div>
|
||||
{%- endif -%}
|
||||
|
||||
{%- if is_platform -%}
|
||||
<div class='section'>
|
||||
Source:
|
||||
<a href='{{github_main_repo}}{{embedded_url}}{{parent_name}}.py'>{{imp_name}}/{{parent_name}}.py</a>
|
||||
</div>
|
||||
{%- endif -%}
|
||||
<div class='section'>
|
||||
{%- if is_platform -%}
|
||||
Source: <a href='{{github_main_repo}}{{imp_url}}{{parent_name}}.py'>{{imp_name}}/{{parent_name}}.py</a>
|
||||
{%- else -%}
|
||||
Source: <a href='{{github_main_repo}}{{imp_url}}'>{{imp_url}}</a>
|
||||
{%- endif -%}
|
||||
</div>
|
||||
|
||||
{%- if is_platform and parent_name != 'sensor' -%}
|
||||
<div class='section'>
|
||||
|
||||
BIN
source/images/supported_brands/fuelcheck.png
Normal file
BIN
source/images/supported_brands/fuelcheck.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 53 KiB |
Loading…
x
Reference in New Issue
Block a user