Add Kaiterra integration (#10374)

* add Kaiterra integration

* fix: jekyll build

* ✏️ Tweaks

* ✏️ Tweaks

* adjust configuration example and release

* update logo

* fix: ha_release version
This commit is contained in:
Michał Mrozek 2019-09-23 10:31:14 +02:00 committed by Franck Nijhof
parent acf4db1d21
commit 52d64598c2
2 changed files with 121 additions and 0 deletions

View File

@ -0,0 +1,64 @@
---
title: "Kaiterra"
description: "Instructions on how to integrate your Kaiterra device into Home Assistant."
logo: kaiterra.svg
ha_iot_class: Cloud Polling
ha_category:
- Health
ha_release: "0.100"
---
The `kaiterra` integration allows you to view the readings from your Laser Egg or Sensedge device using the [Kaiterra REST API](https://www.kaiterra.com/dev/).
To use the integration, you need to get the API key by signing up at [Kaiterra dashboard](https://dashboard.kaiterra.cn/), registring the device and create the key under `Settings -> Profile -> Developer`.
## Configuration
To enable `kaiterra` in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
kaiterra:
api_key: YOUR_API_KEY
devices:
- device_id: YOUR_DEVICE_ID
type: YOUR_DEVICE_TYPE
```
{% configuration %}
api_key:
description: Your personal API key from Kaiterra Dashboard.
required: true
type: string
aqi_standard:
description: The standard of Air Quality Index. Available values `us`, `in`, `cn`.
required: false
type: string
default: us
scan_interval:
description: The interval to scan for sensor state changes in seconds.
required: false
type: integer
default: 30
preferred_units:
description: The list of preferred units. Available values in the list `x`, `%`, `C`, `F`, `mg/m³`, `µg/m³`, `ppm`, `ppb`.
required: false
type: list
devices:
description: The devices you want to get reading from.
required: true
type: list
keys:
device_id:
description: The UUID of the device you want to monitor. You can take it from Kaiterra Dashboard.
required: true
type: string
type:
description: The device type. Available values `laseregg` and `sensedge`.
required: true
type: string
name:
description: The custom name of your device.
required: false
type: string
{% endconfiguration %}

View File

@ -0,0 +1,57 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 22.1.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
viewBox="0 0 1117 342" style="enable-background:new 0 0 1117 342;" xml:space="preserve">
<style type="text/css">
.st0{fill:#002C43;}
</style>
<symbol id="kaiterra_logo" viewBox="-211 -63.6 422.1 127.3">
<g id="_编组__3_">
<g id="_编组_2_3_">
<path id="_复合路径__3_" class="st0" d="M-166.7-21.6v44l-38.1-22L-166.7-21.6 M-164.4-27.2c-0.5,0-0.9,0.2-1.3,0.4
l-44.1,25.5c-1.6,0.9-1.6,2.5,0,3.4l44.1,25.5c0.4,0.2,0.8,0.4,1.3,0.4c1,0,1.6-0.8,1.6-2.1v-50.9
C-162.8-26.4-163.4-27.2-164.4-27.2L-164.4-27.2z"/>
</g>
<g id="_编组_3_3_">
<path id="_复合路径_2_3_" class="st0" d="M-103.6-58v44l-38.1-22L-103.6-58 M-101.3-63.6c-0.5,0-0.9,0.2-1.3,0.4l-44.1,25.5
c-1.6,0.9-1.6,2.5,0,3.4l44.1,25.5c0.4,0.2,0.8,0.4,1.3,0.4c1,0,1.6-0.8,1.6-2.1v-50.9C-99.7-62.9-100.3-63.6-101.3-63.6z"/>
</g>
<g id="_编组_4_3_">
<path id="_复合路径_3_3_" class="st0" d="M-103.7,14.1v44l-38.1-22L-103.7,14.1 M-101.4,8.5c-0.5,0-0.9,0.2-1.3,0.4
l-44.1,25.5c-1.6,0.9-1.6,2.5,0,3.4l44.1,25.5c0.4,0.2,0.8,0.4,1.3,0.4c1,0,1.6-0.8,1.6-2.1V10.6C-99.7,9.3-100.4,8.5-101.4,8.5
L-101.4,8.5z"/>
</g>
<g id="_编组_5_3_">
<path id="_复合路径_4_3_" class="st0" d="M-149.8-21.9l38.1,22l-38.1,22L-149.8-21.9 M-152.2-27.5c-1,0-1.6,0.8-1.6,2.1v50.9
c0,1.3,0.7,2.1,1.6,2.1c0.5,0,0.9-0.2,1.3-0.4l44.1-25.5c1.6-0.9,1.6-2.5,0-3.4l-44.1-25.5C-151.3-27.3-151.7-27.4-152.2-27.5z"
/>
</g>
</g>
<g id="_编组_6_3_">
<path id="_路径__3_" class="st0" d="M-41.5,12.3C-50.6,4.9-53.2,2.8-54,2.2l23.4-23.3h-5.9L-58.5,1V-40H-63v63h4.6V3.9L-35.2,23
l0.1,0.1h6.9l-0.5-0.4C-28.8,22.6-35.1,17.5-41.5,12.3z"/>
<path id="_复合路径_5_3_" class="st0" d="M-6.2-22.2c-7.5,0-12.9,2.9-17.1,9.2l-0.1,0.2l3.4,2.3l0.1-0.2
c3.3-5.2,7.5-7.5,13.7-7.5c8.1,0,12,4.3,12,13.2v1.4H-8.8c-8,0-17.4,3.5-17.4,13.6c0,8.6,6.8,14.1,17.3,14.1
c6.2,0,11.5-2.3,14.8-6.4V23h4.6V-5.2C10.4-16.2,4.5-22.2-6.2-22.2z M5.8,0.5v7.8C5.8,16.3-1.3,20-8.4,20
c-4.9,0-13.2-1.3-13.2-9.9c0-3.6,1.7-9.5,13.4-9.5H5.8z"/>
<rect id="_路径_2_3_" x="21.8" y="-21.1" class="st0" width="4.6" height="44.1"/>
<path id="_路径_3_3_" class="st0" d="M56.2,17.8c-1.6,1.3-3.5,2-5.5,2.2c-3.5,0-5.3-2.2-5.3-6.7v-30.4h11.4v-4H45.4V-40h-4.6
v18.8h-6.2v4h6.2v31c0,6.3,3.8,10.2,9.8,10.2c2.9,0,5.7-1,7.8-2.9l0.1-0.1l-2.3-3.4L56.2,17.8z"/>
<path id="_复合路径_6_3_" class="st0" d="M106.5,1.8c-0.3-14.3-9-24-21.8-24c-5.9,0-11.6,2.4-15.7,6.7c-8.7,9.3-8.7,23.7,0,33
c4.4,4.4,10.4,6.8,16.7,6.7c8.1,0,14.3-2.8,18.6-8.2l0.1-0.2l-3.1-2.8l-0.1,0.2c-3.9,4.9-8.5,6.9-15.5,6.9
c-10.6,0-18-7.3-18.5-18.1h39.3L106.5,1.8z M67.3-2c1.2-9.7,8.2-16.2,17.3-16.2c9.6,0,15.8,5.9,17.1,16.2H67.3z"/>
<path id="_路径_4_3_" class="st0" d="M133.3-22.2c-5.3,0-9.9,3-12.8,8.1v-7H116V23h4.6V-2.5c0-8.5,5.6-15.4,12.6-15.4
c2.6,0,4.1,0.3,5.4,1.1l0.2,0.1l1.7-3.8l-0.2-0.1C138-21.9,136.5-22.2,133.3-22.2z"/>
<path id="_路径_5_3_" class="st0" d="M165.7-22.2c-5.3,0-9.9,3-12.8,8.1v-7h-4.6V23h4.6V-2.5c0-8.5,5.6-15.4,12.6-15.4
c2.6,0,4.1,0.3,5.4,1.1l0.2,0.1l1.7-3.8l-0.2-0.1C170.4-21.9,169-22.2,165.7-22.2z"/>
<path id="_复合路径_7_3_" class="st0" d="M194.5-22.2c-7.5,0-12.9,2.9-17.1,9.2l-0.1,0.2l3.4,2.3l0.1-0.2
c3.3-5.2,7.5-7.5,13.7-7.5c8.1,0,12,4.3,12,13.2v1.4h-14.6c-8,0-17.4,3.5-17.4,13.6c0,8.6,6.8,14.1,17.3,14.1
c6.2,0,11.5-2.3,14.8-6.4V23h4.6V-5.2C211-16.2,205.2-22.2,194.5-22.2z M206.5,0.5v7.8c0,8.1-7.1,11.7-14.2,11.7
c-5,0-13.2-1.3-13.2-9.9c0-3.6,1.7-9.5,13.4-9.5H206.5z"/>
<path id="_路径_6_3_" class="st0" d="M24.1-36.6c-2,0-3.7,1.6-3.7,3.7c0,2,1.6,3.7,3.7,3.7c2,0,3.7-1.6,3.7-3.7
C27.8-34.9,26.1-36.6,24.1-36.6z"/>
</g>
</symbol>
<title>kaiterra-logo-2019-white</title>
<use xlink:href="#kaiterra_logo" width="422.1" height="127.3" id="kaiterra_logo-3" x="-211" y="-63.6" transform="matrix(2.6116 0 0 2.6116 558.1591 171.8117)" style="overflow:visible;"/>
</svg>

After

Width:  |  Height:  |  Size: 4.0 KiB