Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
64 changes: 64 additions & 0 deletions source/_components/kaiterra.markdown
Original file line number Diff line number Diff line change
@@ -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 %}
57 changes: 57 additions & 0 deletions source/images/supported_brands/kaiterra.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.