mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-24 01:37:23 +00:00
Add documentation for Point alarm_control_panel (#8477)
* add documentation for Point alarm_control_panel * ha_config_flow: true * Point reaches gold standard * Apply suggestions from code review Co-Authored-By: fredrike <fredrik.e@gmail.com> * merged documentation * updated merged documentation * updated automation examples
This commit is contained in:
Fredrik Erlandsson
Franck Nijhof
parent
0d39edaac5
commit
8e561c6530
@ -1,35 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Minut Point Binary Sensor"
|
||||
description: "Access your Minut Point Events as binary sensors."
|
||||
date: 2018-11-19
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: minut.svg
|
||||
ha_category: Binary Sensor
|
||||
ha_release: "0.83"
|
||||
ha_iot_class: "Cloud Push"
|
||||
ha_qa_scale: silver
|
||||
---
|
||||
|
||||
Each Point exposes the following binary sensors:
|
||||
|
||||
- **battery**: `On` means low, `Off` means normal
|
||||
- **button_press**: `On` means the button was pressed, `Off` means normal
|
||||
- **cold**: `On` means cold, `Off` means normal
|
||||
- **connectivity**: `On` means connected, `Off` means disconnected
|
||||
- **dry**: `On` means too dry, `Off` means normal
|
||||
- **heat**: `On` means hot, `Off` means normal
|
||||
- **light**: `On` means light detected, `Off` means no light
|
||||
- **moisture**: `On` means moisture detected (wet), `Off` means no moisture (dry)
|
||||
- **motion**: `On` means motion detected, `Off` means no motion (clear)
|
||||
- **sound**: `On` means sound detected, `Off` means no sound (clear)
|
||||
- **tamper**: `On` means the point was removed or attached
|
||||
|
||||
For installation instructions, see [the Point component](/components/point/).
|
||||
|
||||
<p class='note'>
|
||||
The events sent from the Point is also sent as a webhook back to Home Assistant with `event_type` as `point_webhook_received`, please consider the documentation for the [IFTT](/components/ifttt/) component on how to write automations for webhooks.
|
||||
</p>
|
||||
@ -8,16 +8,24 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: minut.svg
|
||||
ha_category: Hub
|
||||
ha_category:
|
||||
- Hub
|
||||
- Alarm
|
||||
- Binary Sensor
|
||||
- Sensor
|
||||
featured: false
|
||||
ha_release: "0.83"
|
||||
ha_config_flow: true
|
||||
ha_iot_class: "Cloud Polling"
|
||||
ha_qa_scale: silver
|
||||
ha_qa_scale: gold
|
||||
redirect_from:
|
||||
- /components/binary_sensor.point/
|
||||
- /components/sensor.point/
|
||||
---
|
||||
|
||||
The Point component is the main component to integrate the [Minut Point](https://minut.com/). To connect Point, you will have to [sign up for a developer account](https://minut.com/community/developers/) and get a `client_id` and `client_secret` using the `callback url` as `base_url` + `/api/minut`, e.g., `http://localhost:8123/api/minut`. The `client_id` and `client_secret` should be used as below.
|
||||
The Point hub enables integration with the [Minut Point](https://minut.com/). To connect with Point, you will have to [sign up for a developer account](https://minut.com/community/developers/) and get a `client_id` and `client_secret` with the `callback url` configured as your Home Assistant `base_url` + `/api/minut`, e.g. `http://localhost:8123/api/minut`. The `client_id` and `client_secret` should be used as below.
|
||||
|
||||
Once Home Assistant is started, a configurator will pop up asking you to Authenticate your Point account via a link when you follow the link and have clicked on **Accept** you will be redirected to the `callback url` and the Point integration will be automatically configured and you can go back to the original dialog and press **Submit**.
|
||||
Once Home Assistant is started, a configurator will pop up asking you to Authenticate your Point account via a link. When you follow the link and click on **Accept** you will be redirected to the `callback url` and the Point integration will be automatically configured and you can go back to the original dialog and press **Submit**.
|
||||
|
||||
### {% linkable_title Configuration %}
|
||||
|
||||
@ -39,7 +47,95 @@ client_secret:
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
# {% linkable_title Device types %}
|
||||
|
||||
The integration supports the following device types within Home Assistant:
|
||||
- [Alarm](#alarm)
|
||||
- [Binary Sensor](#binary-sensor)
|
||||
- [Sensor](#sensor)
|
||||
|
||||
<p class='note'>
|
||||
The Point is just active occasionally so the sensors are only updated every hour or so.
|
||||
The events sent from the Point is sent as a webhook back to Home Assistant with `event_type` as `point_webhook_received`, please consider the documentation for the [IFTT](/components/ifttt/) component on how to write automations for webhooks.
|
||||
The Point is just active occasionally so the [Sensors](#sensor) are only updated every hour or so. The [Binary Sensors](#binary-sensor) are however updated via [Cloud Push](https://www.home-assistant.io/blog/2016/02/12/classifying-the-internet-of-things/#cloud-pushing-new-state), making the changes close to instant.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Alarm %}
|
||||
|
||||
Each home configured in the Point mobile application will show up as a separate alarm control panel. The panels allow **arming** and **disarming** of the Point home alarm system.
|
||||
|
||||
<p class="note">
|
||||
The Point only supports a Arm/Disarm action, so there is no difference between `Arm Home` and `Arm Away`.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Binary Sensor %}
|
||||
|
||||
Each Point exposes the following binary sensors:
|
||||
|
||||
- **battery**: `On` means low, `Off` means normal
|
||||
- **button_press**: `On` means the button was pressed, `Off` means normal
|
||||
- **cold**: `On` means cold, `Off` means normal
|
||||
- **connectivity**: `On` means connected, `Off` means disconnected
|
||||
- **dry**: `On` means too dry, `Off` means normal
|
||||
- **heat**: `On` means hot, `Off` means normal
|
||||
- **light**: `On` means light detected, `Off` means no light
|
||||
- **moisture**: `On` means moisture detected (wet), `Off` means no moisture (dry)
|
||||
- **motion**: `On` means motion detected, `Off` means no motion (clear)
|
||||
- **sound**: `On` means sound detected, `Off` means no sound (clear)
|
||||
- **tamper**: `On` means the point was removed or attached, `Off` means normal
|
||||
|
||||
<p class="note">
|
||||
The binary sensors **battery**, **button_press** and **tamper** are switched `On` for a breif moment and are then switched back to `Off`.
|
||||
</p>
|
||||
|
||||
### {% linkable_title Automation example %}
|
||||
|
||||
The following example show how to implement an automation for the **button_press** binary sensor.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
# Example configuration.yaml Automation entry
|
||||
automation:
|
||||
alias: Point button press
|
||||
trigger:
|
||||
- platform: state
|
||||
entity_id: binary_sensor.point_button_press # Change this accordingly
|
||||
to: 'on'
|
||||
action:
|
||||
- service: persistent_notification.create
|
||||
data:
|
||||
title: Point button press
|
||||
message: Point button was pressed.
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
### {% linkable_title Webhook events %}
|
||||
|
||||
The events shown as [binary sensors](#binary-sensor) are sent to Home Assistant as webhooks with the `event_type` set to `point_webhook_received`. Below is an example of how to use such a webhook do note the `trigger.event.data.event.device_id` which translates to the id of the Point device that sent the event.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
# Example configuration.yaml Automation entry
|
||||
automation:
|
||||
alias: Point button press (webhook)
|
||||
trigger:
|
||||
- platform: event
|
||||
event_type: point_webhook_received
|
||||
event_data: {}
|
||||
condition:
|
||||
condition: template
|
||||
value_template: "{{ trigger.event.data.event.type == 'short_button_press' }}"
|
||||
action:
|
||||
- service: persistent_notification.create
|
||||
data_template:
|
||||
title: Point button press (webhook)
|
||||
message: "Button press on Point {{ trigger.event.data.event.device_id }}"
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
## {% linkable_title Sensor %}
|
||||
|
||||
Each Point exposes the following sensors:
|
||||
|
||||
- **temperature**: Temperature in °C.
|
||||
- **humidity**: Percentage of humidity in the air.
|
||||
- **pressure**: Pressure in hPa.
|
||||
- **sound_level**: Sound level in dBA
|
||||
|
||||
@ -1,29 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Minut Point Sensor"
|
||||
description: "Access your Minut Point Sensors."
|
||||
date: 2018-11-19
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: minut.svg
|
||||
ha_category: Sensor
|
||||
ha_release: "0.83"
|
||||
ha_iot_class: "Cloud Polling"
|
||||
ha_qa_scale: silver
|
||||
---
|
||||
|
||||
Each Point exposes the following sensors:
|
||||
|
||||
- **temperature**: Temperature in °C.
|
||||
- **humidity**: Percentage of humidity in the air.
|
||||
- **pressure**: Pressure in hPa.
|
||||
- **sound_level**: Sound level in dBa.
|
||||
|
||||
|
||||
For installation instructions, see [the Point component](/components/point/).
|
||||
|
||||
<p class='note'>
|
||||
The Point is just active occasionally so the sensors are only updated every hour or so.
|
||||
</p>
|
||||
Loading…
x
Reference in New Issue
Block a user