From 52d64598c2be2abb175994448b3e9ddaf03166f7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Mrozek?= Date: Mon, 23 Sep 2019 10:31:14 +0200 Subject: [PATCH] Add Kaiterra integration (#10374) * add Kaiterra integration * fix: jekyll build * :pencil2: Tweaks * :pencil2: Tweaks * adjust configuration example and release * update logo * fix: ha_release version --- source/_components/kaiterra.markdown | 64 +++++++++++++++++++++ source/images/supported_brands/kaiterra.svg | 57 ++++++++++++++++++ 2 files changed, 121 insertions(+) create mode 100644 source/_components/kaiterra.markdown create mode 100644 source/images/supported_brands/kaiterra.svg diff --git a/source/_components/kaiterra.markdown b/source/_components/kaiterra.markdown new file mode 100644 index 00000000000..0ff306b1538 --- /dev/null +++ b/source/_components/kaiterra.markdown @@ -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 %} diff --git a/source/images/supported_brands/kaiterra.svg b/source/images/supported_brands/kaiterra.svg new file mode 100644 index 00000000000..fe12292c09f --- /dev/null +++ b/source/images/supported_brands/kaiterra.svg @@ -0,0 +1,57 @@ + + + + + +kaiterra-logo-2019-white + +