From 683b3538e289518cb7748f1c9f0b7eb24ccd8604 Mon Sep 17 00:00:00 2001 From: Fredrik Erlandsson Date: Tue, 20 Nov 2018 01:16:46 +0100 Subject: [PATCH] documentation for the Minut Point (#7269) * documentation for the Minut Point * Update source/_components/sensor.point.markdown Co-Authored-By: fredrike * Update source/_components/binary_sensor.point.markdown Co-Authored-By: fredrike * Update source/_components/binary_sensor.point.markdown Co-Authored-By: fredrike * Update source/_components/binary_sensor.point.markdown Co-Authored-By: fredrike * Update source/_components/point.markdown Co-Authored-By: fredrike * Update source/_components/point.markdown Co-Authored-By: fredrike * Update source/_components/sensor.point.markdown Co-Authored-By: fredrike * Added button_press and tamper * Update point.markdown, new configuration flow. * added ha_release * Update source/_components/point.markdown Co-Authored-By: fredrike * added configuration section * quote ha_release --- .../_components/binary_sensor.point.markdown | 35 +++++++++++++++ source/_components/point.markdown | 45 +++++++++++++++++++ source/_components/sensor.point.markdown | 29 ++++++++++++ source/images/supported_brands/minut.svg | 1 + 4 files changed, 110 insertions(+) create mode 100644 source/_components/binary_sensor.point.markdown create mode 100644 source/_components/point.markdown create mode 100644 source/_components/sensor.point.markdown create mode 100644 source/images/supported_brands/minut.svg diff --git a/source/_components/binary_sensor.point.markdown b/source/_components/binary_sensor.point.markdown new file mode 100644 index 00000000000..dadf24d5aa8 --- /dev/null +++ b/source/_components/binary_sensor.point.markdown @@ -0,0 +1,35 @@ +--- +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/). + +

+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](https://www.home-assistant.io/components/ifttt/) component on how to write automations for webhooks. +

diff --git a/source/_components/point.markdown b/source/_components/point.markdown new file mode 100644 index 00000000000..8186890c902 --- /dev/null +++ b/source/_components/point.markdown @@ -0,0 +1,45 @@ +--- +layout: page +title: "Minut Point" +description: "Instructions on how to integrate Minut Point into Home Assistant." +date: 2018-11-19 +sidebar: true +comments: false +sharing: true +footer: true +logo: minut.svg +ha_category: Hub +featured: true +ha_release: "0.83" +ha_iot_class: "Cloud Polling" +ha_qa_scale: silver +--- + +The Point component is the main component to integrate the [Minut Point](https://minut.se/). 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` 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**. + +### {% linkable_title Configuration %} + +```yaml +# Example configuration.yaml entry +point: + client_id: CLIENT_ID + client_secret: CLIENT_SECRET +``` + +{% 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 %} + +

+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](https://www.home-assistant.io/components/ifttt/) component on how to write automations for webhooks. +

diff --git a/source/_components/sensor.point.markdown b/source/_components/sensor.point.markdown new file mode 100644 index 00000000000..ad491d427c6 --- /dev/null +++ b/source/_components/sensor.point.markdown @@ -0,0 +1,29 @@ +--- +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/). + +

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

diff --git a/source/images/supported_brands/minut.svg b/source/images/supported_brands/minut.svg new file mode 100644 index 00000000000..6d73080ba2a --- /dev/null +++ b/source/images/supported_brands/minut.svg @@ -0,0 +1 @@ + \ No newline at end of file