InfluxDB

The influxdb integration集成将 Home Assistant 与您的设备、服务等连接和集成。 [Learn more] makes it possible to transfer all state changes to an external InfluxDB database. See the official installation documentation for how to set up an InfluxDB database.

Additionally, you can now make use of an InfluxDB 2.0 installation with this integration集成将 Home Assistant 与您的设备、服务等连接和集成。 [Learn more]. See the official installation instructions for how to set up an InfluxDB 2.0 database. Or you can sign up for their cloud service and connect Home Assistant to that. Note that the configuration is significantly different for a 2.xx installation, the documentation below will note when fields or defaults apply to only a 1.xx installation or a 2.xx installation.

There is currently support for the following device types within Home Assistant:

• Sensor

Configuration

The default InfluxDB configuration doesn’t enforce authentication. If you have installed InfluxDB on the same host where Home Assistant is running and haven’t made any configuration changes, add the following to your configuration.yamlconfiguration.yaml 文件是 Home Assistant 的主要配置文件。它列出了要加载的集成及其特定配置。在某些情况下，需要直接在 configuration.yaml 文件中手动编辑配置。大多数集成可以在 UI 中配置。 [Learn more] file. 在更改了configuration.yamlconfiguration.yaml 文件是 Home Assistant 的主要配置文件。它列出了要加载的集成及其特定配置。在某些情况下，需要直接在 configuration.yaml 文件中手动编辑配置。大多数集成可以在 UI 中配置。 [Learn more] 文件后，重启 Home Assistant 以应用更改。 该集成现在显示在集成页面的 设置 > 设备与服务 下。其实体在集成卡片上以及实体标签上列出。

# Example configuration.yaml entry
influxdb:

You will still need (not for version 2) to create a database named home_assistant via InfluxDB’s command-line interface. For instructions on how to create a database check the InfluxDB documentation relevant to the version you have installed.

Configure filter

By default, no entity will be excluded. To limit which entities are being exposed to InfluxDB, you can use the include and exclude parameters.

# Example filter to include specified domains and exclude specified entities
influxdb:
  include:
    domains:
      - alarm_control_panel
      - light
    entity_globs:
      - binary_sensor.*_occupancy
  exclude:
    entities:
      - light.kitchen_light

Filters are applied as follows:

1. 不使用过滤器
   • 包含所有实体
2. 仅包含
   • 实体列表中的实体包含：include
   • 否则，实体匹配域包含：include
   • 否则，实体匹配通配符包含：include
   • 否则：排除
3. 仅排除
   • 实体列表中的实体排除：exclude
   • 否则，实体匹配域排除：exclude
   • 否则，实体匹配通配符排除：exclude
   • 否则：包含
4. 域和/或通配符包含（还可能有排除）
   • 实体列表中的实体包含：include
   • 否则，实体列表中的排除：exclude
   • 否则，实体匹配通配符包含：include
   • 否则，实体匹配通配符排除：exclude
   • 否则，实体匹配域包含：include
   • 否则：排除
5. 域和/或通配符排除（没有域和/或通配符包含）
   • 实体列表中的实体包含：include
   • 否则，实体列表中的排除：exclude
   • 否则，实体匹配通配符排除：exclude
   • 否则，实体匹配域排除：exclude
   • 否则：包含
6. 没有域和/或通配符的包含或排除
   • 实体列表中的实体包含：include
   • 否则：排除

以下字符可用于实体通配符：

* - 星号表示零个、一个或多个字符
? - 问号表示零个或一个字符

Examples

Full configuration for 1.xx installations

influxdb:
  host: 192.168.1.190
  port: 20000
  database: DB_TO_STORE_EVENTS
  username: MY_USERNAME
  password: MY_PASSWORD
  ssl: true
  verify_ssl: true
  max_retries: 3
  default_measurement: state
  exclude:
    entities:
       - entity.id1
       - entity.id2
    domains:
       - automation
  include:
    entities:
       - entity.id3
       - entity.id4
  tags:
    instance: prod
    source: hass

Full configuration for 2.xx installations

influxdb:
  api_version: 2
  ssl: false
  host: localhost
  port: 9999
  token: GENERATED_AUTH_TOKEN
  organization: RANDOM_16_DIGIT_HEX_ID
  bucket: BUCKET_NAME
  tags:
    source: HA
  tags_attributes:
    - friendly_name
  default_measurement: units
  exclude:
    entities:
      - zone.home
    domains:
      - persistent_notification
      - person
  include:
    domains:
      - sensor
      - binary_sensor
      - sun
    entities:
      - weather.home

Sensor

The influxdb sensor allows you to use values from an InfluxDB database to populate a sensor state. This can be used to present statistics as Home Assistant sensors, if used with the influxdb history integration. It can also be used with an external data source.

influxdb:
  exclude:
    entity_globs: "*"

Configuration

To configure this sensor, you need to define the sensor connection variables and a list of queries to your configuration.yamlconfiguration.yaml 文件是 Home Assistant 的主要配置文件。它列出了要加载的集成及其特定配置。在某些情况下，需要直接在 configuration.yaml 文件中手动编辑配置。大多数集成可以在 UI 中配置。 [Learn more] file. A sensor will be created for each query:

# Example configuration.yaml entry
sensor:
  - platform: influxdb
    queries:
      - name: mean value of foo
        where: '"name" = ''foo'''
        measurement: '"°C"'

Note that 2.xx installations of InfluxDB only support queries in their Flux language. While this language was available in 1.xx installations, it was not the default and not used in the API so you may not be aware of it. You can learn more about it from their documentation or by using the query builder in the UI.

You will need to construct your queries in this language in sensors for 2.xx installations, it looks like this:

# Example configuration.yaml entry
sensor: 
  - platform: influxdb
    api_version: 2
    organization: RANDOM_16_DIGIT_HEX_ID
    token: GENERATED_AUTH_TOKEN
    queries_flux: 
      - group_function: mean
        imports: 
          - strings
        name: "Mean humidity reported from past day"
        query: >
          filter(fn: (r) => r._field == "value" and r.domain == "sensor" and strings.containsStr(v: r.entity_id, substr: "humidity"))
          |> keep(columns: ["_value"])
        range_start: "-1d"

Examples

Full configuration for 1.xx installations

The example configuration entry below create two request to your local InfluxDB instance, one to the database db1, the other to db2:

• select last(value) as value from "°C" where "name" = "foo"
• select min(tmp) as value from "%" where "entity_id" = ''salon'' and time > now() - 1h

sensor:
  - platform: influxdb
    host: localhost
    username: home-assistant
    password: password
    queries:
      - name: last value of foo
        unit_of_measurement: °C
        value_template: '{{ value | round(1) }}'
        group_function: last
        where: '"name" = ''foo'''
        measurement: '"°C"'
        field: value
        database: db1
      - name: Min for last hour
        unit_of_measurement: "%"
        value_template: '{{ value | round(1) }}'
        group_function: min
        where: '"entity_id" = ''salon'' and time > now() - 1h'
        measurement: '"%"'
        field: tmp
        database: db2

Full configuration for 2.xx installations

sensor:
  - platform: influxdb
    api_version: 2
    token: GENERATED_AUTH_TOKEN
    organization: RANDOM_16_DIGIT_HEX_ID
    bucket: BUCKET_NAME
    queries_flux:
      - range_start: "-1d"
        name: "How long have I been here"
        query: >
          filter(fn: (r) => r._domain == "person" and r._entity_id == "me" and r._value != "{{ states('person.me') }}")
          |> map(fn: (r) => ({ _value: r._time }))
        value_template: "{{ relative_time(strptime(value, '%Y-%m-%d %H:%M:%S %Z')) }}"
      - range_start: "-1d"
        name: "Cost of my house today across all power sensor"
        query: >
          filter(fn: (r) => r.domain == "sensor" and r._field == "value" and regexp.matchRegexpString(r: /_power$/, v: r.entity_id))
          |> keep(columns: ["_value", "_time"])
          |> sort(columns: ["_time"], desc: false)
          |> integral(unit: 5s, column: "_value")
        imports: regexp
        value_template: "{{ value|float / 24.0 / 1000.0 * states('sensor.current_cost_per_kwh')|float }}"
      - range_start: "-1d"
        bucket: Glances Bucket
        name: "Average CPU temp today"
        query: "filter(fn: (r) => r._field == \"value\" and r.entity_id == \"glances_cpu_temperature\")"
        group_function: mean

Note that when working with Flux queries, the resultset is broken into tables, you can see how this works in the Data Explorer of the UI. If you are operating on data created by the InfluxDB history integration, this means by default, you will have a table for each entity and each attribute of each entity (other then unit_of_measurement and any others you promoted to tags).

This is a lot more tables compared to 1.xx queries, where you essentially had one table per unit_of_measurement across all entities. You can still create aggregate metrics across multiple sensors though. As you can see in the example above, a good way to do this is with the keep or drop filters. When you remove key columns Influx merges tables, allowing you to make many tables that share a schema for _value into one.

Querying your data in Influx

Sensors

For sensors with a unit of measurement defined the unit of measurement is used as the measurement name and entries are tagged with the second part of the entity_id. Therefore you need to add a WHERE clause to the query to filter out values.

For example a query on a % battery for sensor.multi_sensor_battery_level:

SELECT * FROM "%" WHERE time > now() - 12h AND "entity_id" = 'multi_sensor_battery_level';

Or for temperatures represented in °C:

SELECT * FROM "°C" WHERE time > now() - 1h;

Everything else

Everything else can be queried using the entity_id as its measurement name.

SELECT * FROM "binary_sensor.front_doorbell" WHERE time > now() - 24h;

SELECT "temperature" FROM "climate.kitchen" WHERE time > now() - 24h;