From 08a0432c8aae6d436dc4fbbb1a04a1abd300a19c Mon Sep 17 00:00:00 2001 From: Fredrik Erlandsson Date: Mon, 11 Feb 2019 10:46:06 +0100 Subject: [PATCH 1/7] add documentation for Point alarm_control_panel --- .../alarm_control_panel.point.markdown | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 source/_components/alarm_control_panel.point.markdown diff --git a/source/_components/alarm_control_panel.point.markdown b/source/_components/alarm_control_panel.point.markdown new file mode 100644 index 000000000000..1ef9edcb82f1 --- /dev/null +++ b/source/_components/alarm_control_panel.point.markdown @@ -0,0 +1,27 @@ +--- +layout: page +title: "Minut Point Alarm Control Panel" +description: "Control Alarm state for Minut Point." +date: 2019-02-11 +sidebar: true +comments: false +sharing: true +footer: true +logo: minut.png +ha_category: Alarm +ha_release: 0.88 +ha_iot_class: "Cloud Polling" +ha_qa_scale: silver +--- + +The `point` alarm control panel platform gives users the ability to +control a Point home alarm system. + +You must have the [`Point` component](/components/point/) configured +to use this platform. After configuring that component, the homes defined +in Point will automatiacally appear as alarm control panels. + +

+The Point only supports Arm/Disarm so there is no difference between `Arm Home` +and `Arm Away`. +

From 98ce144f08af1f9b765334ba03255127b5c49bc2 Mon Sep 17 00:00:00 2001 From: Fredrik Erlandsson Date: Mon, 11 Feb 2019 14:11:06 +0100 Subject: [PATCH 2/7] ha_config_flow: true --- source/_components/point.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_components/point.markdown b/source/_components/point.markdown index 36d790aca803..8ba51d045f0c 100644 --- a/source/_components/point.markdown +++ b/source/_components/point.markdown @@ -11,6 +11,7 @@ logo: minut.svg ha_category: Hub featured: false ha_release: "0.83" +ha_config_flow: true ha_iot_class: "Cloud Polling" ha_qa_scale: silver --- From c507e0565e186fc4d088040f3c578b30b492133e Mon Sep 17 00:00:00 2001 From: Fredrik Erlandsson Date: Mon, 11 Feb 2019 14:18:30 +0100 Subject: [PATCH 3/7] Point reaches gold standard --- source/_components/alarm_control_panel.point.markdown | 2 +- source/_components/binary_sensor.point.markdown | 2 +- source/_components/point.markdown | 2 +- source/_components/sensor.point.markdown | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/source/_components/alarm_control_panel.point.markdown b/source/_components/alarm_control_panel.point.markdown index 1ef9edcb82f1..5170d208933e 100644 --- a/source/_components/alarm_control_panel.point.markdown +++ b/source/_components/alarm_control_panel.point.markdown @@ -11,7 +11,7 @@ logo: minut.png ha_category: Alarm ha_release: 0.88 ha_iot_class: "Cloud Polling" -ha_qa_scale: silver +ha_qa_scale: gold --- The `point` alarm control panel platform gives users the ability to diff --git a/source/_components/binary_sensor.point.markdown b/source/_components/binary_sensor.point.markdown index f12d92751724..270b08fa62ba 100644 --- a/source/_components/binary_sensor.point.markdown +++ b/source/_components/binary_sensor.point.markdown @@ -11,7 +11,7 @@ logo: minut.svg ha_category: Binary Sensor ha_release: "0.83" ha_iot_class: "Cloud Push" -ha_qa_scale: silver +ha_qa_scale: gold --- Each Point exposes the following binary sensors: diff --git a/source/_components/point.markdown b/source/_components/point.markdown index 8ba51d045f0c..2bc1b83a970d 100644 --- a/source/_components/point.markdown +++ b/source/_components/point.markdown @@ -13,7 +13,7 @@ featured: false ha_release: "0.83" ha_config_flow: true ha_iot_class: "Cloud Polling" -ha_qa_scale: silver +ha_qa_scale: gold --- 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. diff --git a/source/_components/sensor.point.markdown b/source/_components/sensor.point.markdown index ad491d427c6a..f023e436ed9e 100644 --- a/source/_components/sensor.point.markdown +++ b/source/_components/sensor.point.markdown @@ -11,7 +11,7 @@ logo: minut.svg ha_category: Sensor ha_release: "0.83" ha_iot_class: "Cloud Polling" -ha_qa_scale: silver +ha_qa_scale: gold --- Each Point exposes the following sensors: From 89e026841062c61eaab7a71270ac663686f9e247 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Tue, 12 Feb 2019 07:59:38 +0100 Subject: [PATCH 4/7] Apply suggestions from code review Co-Authored-By: fredrike --- source/_components/point.markdown | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/source/_components/point.markdown b/source/_components/point.markdown index 2bc1b83a970d..764c32698ea7 100644 --- a/source/_components/point.markdown +++ b/source/_components/point.markdown @@ -8,13 +8,20 @@ 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: gold ---- +There is currently support for the following device types within Home Assistant: + - Alarm + - Binary Sensor + - Sensor 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. From 597527bdc1256b068f8dd16bd49da17562e785dd Mon Sep 17 00:00:00 2001 From: Fredrik Erlandsson Date: Tue, 12 Feb 2019 08:09:25 +0100 Subject: [PATCH 5/7] merged documentation --- .../alarm_control_panel.point.markdown | 27 ------------ .../_components/binary_sensor.point.markdown | 35 ---------------- source/_components/point.markdown | 41 +++++++++++++++++-- source/_components/sensor.point.markdown | 29 ------------- 4 files changed, 38 insertions(+), 94 deletions(-) delete mode 100644 source/_components/alarm_control_panel.point.markdown delete mode 100644 source/_components/binary_sensor.point.markdown delete mode 100644 source/_components/sensor.point.markdown diff --git a/source/_components/alarm_control_panel.point.markdown b/source/_components/alarm_control_panel.point.markdown deleted file mode 100644 index 5170d208933e..000000000000 --- a/source/_components/alarm_control_panel.point.markdown +++ /dev/null @@ -1,27 +0,0 @@ ---- -layout: page -title: "Minut Point Alarm Control Panel" -description: "Control Alarm state for Minut Point." -date: 2019-02-11 -sidebar: true -comments: false -sharing: true -footer: true -logo: minut.png -ha_category: Alarm -ha_release: 0.88 -ha_iot_class: "Cloud Polling" -ha_qa_scale: gold ---- - -The `point` alarm control panel platform gives users the ability to -control a Point home alarm system. - -You must have the [`Point` component](/components/point/) configured -to use this platform. After configuring that component, the homes defined -in Point will automatiacally appear as alarm control panels. - -

-The Point only supports Arm/Disarm so there is no difference between `Arm Home` -and `Arm Away`. -

diff --git a/source/_components/binary_sensor.point.markdown b/source/_components/binary_sensor.point.markdown deleted file mode 100644 index 270b08fa62ba..000000000000 --- a/source/_components/binary_sensor.point.markdown +++ /dev/null @@ -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: gold ---- - -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/). - -

-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. -

diff --git a/source/_components/point.markdown b/source/_components/point.markdown index 764c32698ea7..d3db14129d7f 100644 --- a/source/_components/point.markdown +++ b/source/_components/point.markdown @@ -2,7 +2,7 @@ layout: page title: "Minut Point" description: "Instructions on how to integrate Minut Point into Home Assistant." -date: 2018-11-19 +date: 2019-02-12 sidebar: true comments: false sharing: true @@ -14,10 +14,15 @@ ha_category: - Binary Sensor - Sensor featured: false -ha_release: "0.83" +ha_release: "0.87" ha_config_flow: true ha_iot_class: "Cloud Polling" ha_qa_scale: gold +redirect_from: + - /components/binary_sensor.point/ + - /components/sensor.point/ +--- + There is currently support for the following device types within Home Assistant: - Alarm - Binary Sensor @@ -47,7 +52,37 @@ client_secret: type: string {% endconfiguration %} +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. +

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. +

+ +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 + +

+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. +

+ +Each home configured in the Point application will show up as a separate alarm control panel platform that enables ability to control the Point home alarm system. + +

+The Point only supports Arm/Disarm so there is no difference between `Arm Home` and `Arm Away`.

diff --git a/source/_components/sensor.point.markdown b/source/_components/sensor.point.markdown deleted file mode 100644 index f023e436ed9e..000000000000 --- a/source/_components/sensor.point.markdown +++ /dev/null @@ -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: gold ---- - -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/). - -

-The Point is just active occasionally so the sensors are only updated every hour or so. -

From a3ebc1b33ab4c593b2d5580ea7970f007b64a1fb Mon Sep 17 00:00:00 2001 From: Fredrik Erlandsson Date: Tue, 12 Feb 2019 08:38:30 +0100 Subject: [PATCH 6/7] updated merged documentation --- source/_components/point.markdown | 36 +++++++++++++++++++------------ 1 file changed, 22 insertions(+), 14 deletions(-) diff --git a/source/_components/point.markdown b/source/_components/point.markdown index d3db14129d7f..74dfbdedcd27 100644 --- a/source/_components/point.markdown +++ b/source/_components/point.markdown @@ -24,11 +24,11 @@ redirect_from: --- There is currently support for the following device types within Home Assistant: - - Alarm - - Binary Sensor - - Sensor + - [Alarm](#alarm) + - [Binary Sensor](#binary-sensor) + - [Sensor](#sensor) -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` eg. `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**. @@ -52,17 +52,18 @@ client_secret: type: string {% endconfiguration %} -Each Point exposes the following sensors: +# Device types -- **temperature**: Temperature in °C. -- **humidity**: Percentage of humidity in the air. -- **pressure**: Pressure in hPa. -- **sound_level**: Sound level in dBa. +## {% linkable_title Alarm %} -

-The Point is just active occasionally so the sensors are only updated every hour or so. +Each home configured in the Point application will show up as a separate alarm control panel which enables controlling the Point home alarm system. + +

+The Point only supports Arm/Disarm so there is no difference between `Arm Home` and `Arm Away`.

+## {% linkable_title Binary Sensor %} + Each Point exposes the following binary sensors: - **battery**: `On` means low, `Off` means normal @@ -81,8 +82,15 @@ Each Point exposes the following binary sensors: 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.

-Each home configured in the Point application will show up as a separate alarm control panel platform that enables ability to control the Point home alarm system. +## {% linkable_title Sensor %} -

-The Point only supports Arm/Disarm so there is no difference between `Arm Home` and `Arm Away`. +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. + +

+The Point is just active occasionally so the sensors are only updated every hour or so.

From 08218241d89c146ac33f194f46a425375f9a18db Mon Sep 17 00:00:00 2001 From: Fredrik Erlandsson Date: Thu, 14 Feb 2019 10:55:28 +0100 Subject: [PATCH 7/7] updated automation examples --- source/_components/point.markdown | 87 +++++++++++++++++++++++-------- 1 file changed, 66 insertions(+), 21 deletions(-) diff --git a/source/_components/point.markdown b/source/_components/point.markdown index 74dfbdedcd27..705e94f23766 100644 --- a/source/_components/point.markdown +++ b/source/_components/point.markdown @@ -2,19 +2,19 @@ layout: page title: "Minut Point" description: "Instructions on how to integrate Minut Point into Home Assistant." -date: 2019-02-12 +date: 2018-11-19 sidebar: true comments: false sharing: true footer: true logo: minut.svg -ha_category: +ha_category: - Hub - Alarm - Binary Sensor - Sensor featured: false -ha_release: "0.87" +ha_release: "0.83" ha_config_flow: true ha_iot_class: "Cloud Polling" ha_qa_scale: gold @@ -23,14 +23,9 @@ redirect_from: - /components/sensor.point/ --- -There is currently support for the following device types within Home Assistant: - - [Alarm](#alarm) - - [Binary Sensor](#binary-sensor) - - [Sensor](#sensor) - -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` eg. `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 %} @@ -52,14 +47,23 @@ client_secret: type: string {% endconfiguration %} -# Device types +# {% linkable_title Device types %} + +The integration supports the following device types within Home Assistant: + - [Alarm](#alarm) + - [Binary Sensor](#binary-sensor) + - [Sensor](#sensor) + +

+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. +

## {% linkable_title Alarm %} -Each home configured in the Point application will show up as a separate alarm control panel which enables controlling the Point home alarm system. +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.

-The Point only supports Arm/Disarm so there is no difference between `Arm Home` and `Arm Away`. +The Point only supports a Arm/Disarm action, so there is no difference between `Arm Home` and `Arm Away`.

## {% linkable_title Binary Sensor %} @@ -76,12 +80,57 @@ Each Point exposes the following binary sensors: - **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 +- **tamper**: `On` means the point was removed or attached, `Off` means normal -

-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. +

+The binary sensors **battery**, **button_press** and **tamper** are switched `On` for a breif moment and are then switched back to `Off`.

+### {% 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: @@ -89,8 +138,4 @@ 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. - -

-The Point is just active occasionally so the sensors are only updated every hour or so. -

+- **sound_level**: Sound level in dBA