From 19312f1ea86d1d125f5ea1cdfd10c86cd541d950 Mon Sep 17 00:00:00 2001 From: Fredrik Erlandsson Date: Tue, 28 May 2024 08:13:45 +0200 Subject: [PATCH 1/5] add documentation for Point oauth2 --- source/_integrations/point.markdown | 52 +++++++++++++---------------- 1 file changed, 24 insertions(+), 28 deletions(-) diff --git a/source/_integrations/point.markdown b/source/_integrations/point.markdown index 0561832e5d53..50a0b1e3bf98 100644 --- a/source/_integrations/point.markdown +++ b/source/_integrations/point.markdown @@ -9,7 +9,7 @@ ha_category: ha_release: 0.83 ha_config_flow: true ha_iot_class: Cloud Polling -ha_quality_scale: gold +ha_quality_scale: silver ha_codeowners: - '@fredrike' ha_domain: point @@ -19,48 +19,44 @@ ha_platforms: - sensor ha_integration_type: integration related: - - docs: /docs/configuration/ - title: Configuration file + - docs: /integrations/application_credentials/ + title: Application credentials --- -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 and have a Pro subscription](https://minut.com/community/developers/) and get a `client_id` and `client_secret` with the `callback url` configured as your Home Assistant URL + `/api/minut`, e.g., `http://homeassistant.local: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/). There is currently support for the following device types within Home Assistant: -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**. +- [Device types](#device-types) + - [Alarm](#alarm) + - [Binary sensor](#binary-sensor) + - [Automation example](#automation-example) + - [Webhook events](#webhook-events) + - [Sensor](#sensor) -There is currently support for the following device types within Home Assistant: +## Get Minut Point application credentials -- [Alarm](#alarm) -- [Binary sensor](#binary-sensor) -- [Sensor](#sensor) +Navigate to the [API-client | Minut](https://web.minut.com/settings/api-clients) dashboard and **Create client**: -### Configuration +- Enter a **Name** for your client (this is just an identifier). +- Enter `https://my.home-assistant.io/redirect/oauth` in the **Redirect URI** field. +- Get the **ClientID** and **ClientSecret** for the new client, you need them to complete the integration setup in Home Assistant. -To use the Minut Point {% term integration %} in your installation, add it to your {% term "`configuration.yaml`" %} file. -{% include integrations/restart_ha_after_config_inclusion.md %} +
-```yaml -# Example configuration.yaml entry -point: - client_id: CLIENT_ID - client_secret: CLIENT_SECRET -``` +If you are a kickstarter backer you need to send an email to hello@minut.com to retrive **ClientID** and **ClientSecret**, don't forget to mention that the **Redirect URI** should be `https://my.home-assistant.io/redirect/oauth`. + +
-{% configuration %} -client_id: - description: Your Minut Point developer client ID. - required: true - type: string -client_secret: - description: Your Minut Point developer client secret. - required: true - type: string -{% endconfiguration %} +{% include integrations/config_flow.md %} # Device types The integration supports the following device types within Home Assistant: + +- [Device types](#device-types) - [Alarm](#alarm) - [Binary sensor](#binary-sensor) + - [Automation example](#automation-example) + - [Webhook events](#webhook-events) - [Sensor](#sensor)
From c9f77c3fc7e2af08a100c848b2816560d91dc782 Mon Sep 17 00:00:00 2001 From: Fredrik Erlandsson Date: Tue, 28 May 2024 20:58:50 +0200 Subject: [PATCH 2/5] Apply suggestions from code review Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> --- source/_integrations/point.markdown | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/source/_integrations/point.markdown b/source/_integrations/point.markdown index 50a0b1e3bf98..0afd273e3e7a 100644 --- a/source/_integrations/point.markdown +++ b/source/_integrations/point.markdown @@ -32,17 +32,19 @@ The Point hub enables integration with the [Minut Point](https://minut.com/). Th - [Webhook events](#webhook-events) - [Sensor](#sensor) -## Get Minut Point application credentials +## Prerequisites -Navigate to the [API-client | Minut](https://web.minut.com/settings/api-clients) dashboard and **Create client**: +Before adding the integration to Home Assistant, you need to get Minut Point application credentials. -- Enter a **Name** for your client (this is just an identifier). -- Enter `https://my.home-assistant.io/redirect/oauth` in the **Redirect URI** field. -- Get the **ClientID** and **ClientSecret** for the new client, you need them to complete the integration setup in Home Assistant. +1. Navigate to the [API-client | Minut](https://web.minut.com/settings/api-clients) dashboard and **Create client**: + + - Enter a **Name** for your client (this is just an identifier). + - Enter `https://my.home-assistant.io/redirect/oauth` in the **Redirect URI** field. +2. Get the **ClientID** and **ClientSecret** for the new client and store them in a safe place. You need them to complete the integration setup in Home Assistant.
-If you are a kickstarter backer you need to send an email to hello@minut.com to retrive **ClientID** and **ClientSecret**, don't forget to mention that the **Redirect URI** should be `https://my.home-assistant.io/redirect/oauth`. +If you are a Kickstarter backer, you need to send an email to hello@minut.com to retrieve the **ClientID** and **ClientSecret**. Don't forget to mention that the **Redirect URI** should be `https://my.home-assistant.io/redirect/oauth`.
From 80a2cd1ca38dbe4e60ef2a9a56f0cb6b88f33cc9 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Wed, 29 May 2024 06:53:39 +0200 Subject: [PATCH 3/5] fix indent --- source/_integrations/point.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_integrations/point.markdown b/source/_integrations/point.markdown index 0afd273e3e7a..b40472739750 100644 --- a/source/_integrations/point.markdown +++ b/source/_integrations/point.markdown @@ -38,8 +38,8 @@ Before adding the integration to Home Assistant, you need to get Minut Point app 1. Navigate to the [API-client | Minut](https://web.minut.com/settings/api-clients) dashboard and **Create client**: - - Enter a **Name** for your client (this is just an identifier). - - Enter `https://my.home-assistant.io/redirect/oauth` in the **Redirect URI** field. + - Enter a **Name** for your client (this is just an identifier). + - Enter `https://my.home-assistant.io/redirect/oauth` in the **Redirect URI** field. 2. Get the **ClientID** and **ClientSecret** for the new client and store them in a safe place. You need them to complete the integration setup in Home Assistant.
From 3329c289d3c8dd5d0ef25f3f19e9633a6706756a Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Wed, 29 May 2024 06:58:09 +0200 Subject: [PATCH 4/5] Update source/_integrations/point.markdown --- source/_integrations/point.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_integrations/point.markdown b/source/_integrations/point.markdown index b40472739750..dc3db1fb07a4 100644 --- a/source/_integrations/point.markdown +++ b/source/_integrations/point.markdown @@ -38,8 +38,8 @@ Before adding the integration to Home Assistant, you need to get Minut Point app 1. Navigate to the [API-client | Minut](https://web.minut.com/settings/api-clients) dashboard and **Create client**: - - Enter a **Name** for your client (this is just an identifier). - - Enter `https://my.home-assistant.io/redirect/oauth` in the **Redirect URI** field. + - Enter a **Name** for your client (this is just an identifier). + - Enter `https://my.home-assistant.io/redirect/oauth` in the **Redirect URI** field. 2. Get the **ClientID** and **ClientSecret** for the new client and store them in a safe place. You need them to complete the integration setup in Home Assistant.
From 2bb89c23da7a7a822ef7d3fc953e11ff6ac42c4b Mon Sep 17 00:00:00 2001 From: Fredrik Erlandsson Date: Wed, 29 May 2024 07:48:18 +0200 Subject: [PATCH 5/5] Apply suggestions from code review Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> --- source/_integrations/point.markdown | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/source/_integrations/point.markdown b/source/_integrations/point.markdown index dc3db1fb07a4..e093489821b5 100644 --- a/source/_integrations/point.markdown +++ b/source/_integrations/point.markdown @@ -23,14 +23,8 @@ related: title: Application credentials --- -The Point hub enables integration with the [Minut Point](https://minut.com/). There is currently support for the following device types within Home Assistant: +The Point hub enables integration with the [Minut Point](https://minut.com/). -- [Device types](#device-types) - - [Alarm](#alarm) - - [Binary sensor](#binary-sensor) - - [Automation example](#automation-example) - - [Webhook events](#webhook-events) - - [Sensor](#sensor) ## Prerequisites @@ -50,15 +44,11 @@ If you are a Kickstarter backer, you need to send an email to hello@minut.com to {% include integrations/config_flow.md %} -# Device types +## Device types The integration supports the following device types within Home Assistant: - -- [Device types](#device-types) - [Alarm](#alarm) - [Binary sensor](#binary-sensor) - - [Automation example](#automation-example) - - [Webhook events](#webhook-events) - [Sensor](#sensor)