Skip to content

Commit

Permalink
Add documentation for Point oauth2 (#32971)
Browse files Browse the repository at this point in the history
Co-authored-by: c0ffeeca7 <[email protected]>
  • Loading branch information
fredrike and c0ffeeca7 authored Sep 23, 2024
1 parent 95a860c commit 12f1e4d
Showing 1 changed file with 17 additions and 29 deletions.
46 changes: 17 additions & 29 deletions source/_integrations/point.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -19,44 +19,32 @@ 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/).

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

There is currently support for the following device types within Home Assistant:
## Prerequisites

- [Alarm](#alarm)
- [Binary sensor](#binary-sensor)
- [Sensor](#sensor)
Before adding the integration to Home Assistant, you need to get Minut Point application credentials.

### Configuration
1. Navigate to the [API-client | Minut](https://web.minut.com/settings/api-clients) dashboard and **Create client**:

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

```yaml
# Example configuration.yaml entry
point:
client_id: CLIENT_ID
client_secret: CLIENT_SECRET
```
<div class='note'>

If you are a Kickstarter backer, you need to send an email to [email protected] to retrieve the **ClientID** and **ClientSecret**. Don't forget to mention that the **Redirect URI** should be `https://my.home-assistant.io/redirect/oauth`.

</div>

{% include integrations/config_flow.md %}

{% 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 %}
# Device types
## Device types

The integration supports the following device types within Home Assistant:
- [Alarm](#alarm)
Expand Down

0 comments on commit 12f1e4d

Please sign in to comment.