Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 1.88 KB

README.md

File metadata and controls

48 lines (35 loc) · 1.88 KB
Raw

InfluxDB custom component for ESPHome

This custom component allows you to send sensor updates from ESPHome to an InfluxDB database with UDP.

Installation

Clone this repository into custom_components/influxdb from the directory where your ESPHome configuration is stored.

git clone https://github.com/la7dja/esphome-influxdb custom_components/influxdb

Usage

Add influxdb section to your ESPHome configuration file.

Example configuration

influxdb:
  host: "influxdb-host"
  sensors:
    meter_id:
      ignore: True
    ams_temperature:
      measurement: 'temperature'
      tags: 
        room: kitchen

Configuration variables

  • host (Required, string): Hostname or IP for the InfluxDB server
  • port (Optional, int): Port number the InfluxDB server is listening on. Defaults to 8089.
  • max_packet_size (Optional, int): Max size of UDP packets. Defaults to 500.
  • send_timeout (Optional, time): Time to wait before sending UDP packets which have not been filled to max size. Defaults to 100ms.
  • publish_all (Optional, boolean): If true publish updates from all sensors unless explicit ignored in per sensor configuration. If false only publish updates from sensors explicit configured. Defaults to True.
  • tags (Optional, mapping): Mapping of tag keys and values. Defaults to 'node: <esphome.name>'.
  • sensors (Optional, mapping): Per sensor configuration. Keys are sensor IDs. All types of sensors are included in this mapping, there is no distinquin bettwi float, binary and text sensors.

Sensor configuration variables

  • ignore (Optional, boolean): Whether or not to include updates for this sensor. Defaults to True.
  • measurement (Optional, string): Name of measurements with update from this sensor. Defaults to the sanitized name of the sensor.
  • tags (Optional, mapping): Additional tags added for this sensor.