influxdb component config var formatting (#6641)

* influxdb component config var formatting

Updating the configuration variable section.

I wasn't sure that the customize variables should be included, since they apply to all components from my understanding.

- **component_config**, **component_config_domain**, **component_config_glob** (*Optional*): These attributes contains component-specific override values. See [Customizing devices and services](/getting-started/customizing-devices/) for format.
  - **override_measurement** (*Optional*): Measurement name to use for this component, takes precedence over the global 'override_measurement' and component-specific 'unit_of_measurement' attribute.

Related to #6385.

* Fixed default values

based on the component influxdb.py

* Update influxdb.markdown

Fix both 'int' -> 'integer'

Fix default database to correct value of 'home_assistant'

* Update influxdb.markdown

Added in component customization values to config variables. Left with default description from original component page. I'm checking to see if there is a better way to describe these.

* Update influxdb.markdown

Fixed wrong type for override_measurement.

Happy with description of custom values.

* Required Changes

Fixed grammar for the three customize variables.
This commit is contained in:
Nicholas Westerhausen 2018-10-11 15:30:54 -04:00 committed by Franck Nijhof
parent 7d07598533
commit 89c2db6639

View File

@ -25,28 +25,117 @@ influxdb:
You will still need 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](https://docs.influxdata.com/influxdb/latest/introduction/getting_started/#creating-a-database) relevant to the version you have installed.
Configuration variables:
- **host** (*Optional*): IP address of your database host, e.g., 192.168.1.10. Defaults to `localhost`.
- **port** (*Optional*): Port to use. Defaults to 8086.
- **username** (*Optional*): The username of the database user. The user needs read/write privileges on the database.
- **password** (*Optional*): The password for the database user account.
- **database** (*Optional*): Name of the database to use. Defaults to `home_assistant`. The database must already exist.
- **ssl** (*Optional*): Use https instead of http to connect. Defaults to false.
- **verify_ssl** (*Optional*): Verify SSL certificate for https request. Defaults to false.
- **max_retries** (*Optional*): Allow the component to retry if there was a network error when transmitting data
- **default_measurement** (*Optional*): Measurement name to use when an entity doesn't have a unit. Defaults to entity id.
- **override_measurement** (*Optional*): Measurement name to use instead of unit or default measurement. This will store all data points in a single measurement.
- **component_config**, **component_config_domain**, **component_config_glob** (*Optional*): These attributes contains component-specific override values. See [Customizing devices and services](/getting-started/customizing-devices/) for format.
- **override_measurement** (*Optional*): Measurement name to use for this component, takes precedence over the global 'override_measurement' and component-specific 'unit_of_measurement' attribute.
- **exclude** (*Optional*): Configure which components should be excluded from recording to InfluxDB.
- **entities** (*Optional*): The list of entity ids to be excluded from recording to InfluxDB.
- **domains** (*Optional*): The list of domains to be excluded from recording to InfluxDB.
- **include** (*Optional*): Configure which components should be included in recordings to InfluxDB. If set, all other entities will not be recorded to InfluxDB. Values set by the **blacklist** option will prevail.
- **entities** (*Optional*): The list of entity ids to be included from recordings to InfluxDB.
- **domains** (*Optional*): The list of domains to be included from recordings to InfluxDB.
- **tags** (*Optional*): Tags to mark the data.
- **tags_attributes** (*Optional*): The list of attribute names which should be reported as tags and not fields to InfluxDB. For example, if set to `friendly_name`, it will be possible to group by entities' friendly names as well, in addition to their ids.
{% configuration %}
host:
type: string
description: IP address of your database host, e.g., 192.168.1.10
required: false
default: localhost
port:
type: integer
description: Port to use
required: false
default: 8086
username:
type: string
description: The username of the database user. The user needs read/write privileges on the database
required: false
password:
type: string
description: The password for the database user account.
required: false
database:
type: string
description: Name of the database to use. The database must already exist.
required: false
default: home_assistant
ssl:
type: boolean
description: Use https instead of http to connect.
required: false
default: false
verify_ssl:
type: boolean
description: Verify SSL certificate for https request.
required: false
default: true
max_retries:
type: integer
description: Set this to allow the component to retry if there was a network error when transmitting data.
required: false
default: 0
default_measurement:
type: string
description: Measurement name to use when an entity doesn't have a unit.
required: false
default: uses the entity id of the entity
override_measurement:
type: string
description: Measurement name to use instead of unit or default measurement. This will store all data points in a single measurement.
required: false
exclude:
type: list
description: Configure which components should be excluded from recording to InfluxDB.
required: false
keys:
entities:
type: list
description: The list of entity ids to be excluded from recording to InfluxDB.
required: false
domains:
type: list
description: The list of domains to be excluded from recording to InfluxDB.
required: false
include:
type: list
description: Configure which components should be included in recordings to InfluxDB. If set, all other entities will not be recorded to InfluxDB. Values set by the **exclude** lists will take precedence.
required: false
keys:
entities:
type: string, list
description: The list of entity ids to be included in recording to InfluxDB.
required: false
domains:
type: string, list
description: The list of domains to be included in recording to InfluxDB.
required: false
tags:
type: string, list
description: Tags to mark the data.
default: 0
tags_attributes:
type: string, list
description: The list of attribute names which should be reported as tags and not fields to InfluxDB. For example, if set to `friendly_name`, it will be possible to group by entities' friendly names as well, in addition to their ids.
required: false
default: 0
component_config:
type: string
required: false
description: This attribute contains component-specific override values. See [Customizing devices and services](/getting-started/customizing-devices/) for format.
keys:
override_measurement:
type: string
description: Measurement name to use instead of unit or default measurement. This will store all data points in a single measurement.
required: false
component_config_domain:
type: string
required: false
description: This attribute contains domain-specific component override values. See [Customizing devices and services](/getting-started/customizing-devices/) for format.
keys:
override_measurement:
type: string
description: Measurement name to use instead of unit or default measurement. This will store all data points in a single measurement.
required: false
component_config_glob:
type: string
required: false
description: This attribute contains component-specific override values. See [Customizing devices and services](/getting-started/customizing-devices/) for format.
keys:
override_measurement:
type: string
description: Measurement name to use instead of unit or default measurement. This will store all data points in a single measurement.
required: false
{% endconfiguration %}
## {% linkable_title Helper scripts %}