Skip to content

Adding documentation for influxdb sensor #1340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 27, 2016

Conversation

bestlibre
Copy link
Contributor

Description:

Adding documentation for influxdb sensor

The `InfluxDB` sensor allows you to use values from an InfluxDB database to populate a sensor state.

To configure this sensor, you need to define the sensor connection variables and a list of queries. A sensor will be created for each query.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a minimal sample to get users started quickly.

sensor:
  - platform: influxdb
    queries:
      - name: last value of foo
        unit_of_measurement: °C
        where: '"name" = ''foo'''
        measurement: '"°C"'
``


Configuration variables for the server:

- **host** (*Optional*): IP address of your database host, eg. http://192.168.1.10. Defaults to `localhost`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please do me a favor and check if that's right? We are talking about the IP address but show an URL. I guess that wrong in the InfluxDB component documentation as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have corrected both. The influxdb client api wait for a hostname/ip address

@fabaff fabaff merged commit c9276d5 into home-assistant:next Oct 27, 2016
@fabaff fabaff added Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! new-integration This PR adds documentation for a new Home Assistant integration labels Oct 27, 2016
@bestlibre bestlibre deleted the influxdb_sensor branch October 27, 2016 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! new-integration This PR adds documentation for a new Home Assistant integration
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants