Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for Point oauth2 #32971

Merged
merged 5 commits into from
Sep 23, 2024
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 26 additions & 28 deletions source/_integrations/point.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -19,48 +19,46 @@ 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:
fredrike marked this conversation as resolved.
Show resolved Hide resolved

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)
fredrike marked this conversation as resolved.
Show resolved Hide resolved

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.
c0ffeeca7 marked this conversation as resolved.
Show resolved Hide resolved
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`.

{% 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 %}
</div>

{% include integrations/config_flow.md %}

# Device types
fredrike marked this conversation as resolved.
Show resolved Hide resolved

The integration supports the following device types within Home Assistant:

- [Device types](#device-types)
fredrike marked this conversation as resolved.
Show resolved Hide resolved
- [Alarm](#alarm)
- [Binary sensor](#binary-sensor)
- [Automation example](#automation-example)
- [Webhook events](#webhook-events)
fredrike marked this conversation as resolved.
Show resolved Hide resolved
- [Sensor](#sensor)

<div class='note'>
Expand Down