telegraf/plugins/inputs/fireboard

Fireboard Input Plugin

The fireboard plugin gathers the real time temperature data from fireboard thermometers. In order to use this input plugin, you'll need to sign up to use their REST API, you can find more information on their website here [https://docs.fireboard.io/reference/restapi.html]

Configuration

This section contains the default TOML to configure the plugin. You can generate it using telegraf --usage <plugin-name>.

[[inputs.fireboard]]
  ## Specify auth token for your account
  auth_token = "invalidAuthToken"
  ## You can override the fireboard server URL if necessary
  # url = https://fireboard.io/api/v1/devices.json
  ## You can set a different http_timeout if you need to
  # http_timeout = 4

auth_token

In lieu of requiring a username and password, this plugin requires the authToken that you can generate using the Fireboard REST API as described in their docs [https://docs.fireboard.io/reference/restapi.html#Authentication]

url

While there should be no reason to override the URL, the option is available in case Fireboard changes their site, etc.

http_timeout

If you need to increase the HTTP timeout, you can do so here. You can set this value in seconds. The default value is four (4) seconds.

Metrics

The Fireboard REST API docs have good examples of the data that is available, currently this input only returns the real time temperatures. Temperature values are included if they are less than a minute old.

• fireboard
  • tags:
    • channel
    • scale (Celcius; Farenheit)
    • title (name of the Fireboard)
    • uuid (UUID of the Fireboard)
  • fields:
    • temperature (float, unit)

Example Output

This section shows example output in Line Protocol format. You can often use telegraf --input-filter <plugin-name> --test or use the file output to get this information.

fireboard,channel=2,host=patas-mbp,scale=Farenheit,title=telegraf-FireBoard,uuid=b55e766c-b308-49b5-93a4-df89fe31efd0 temperature=78.2 1561690040000000000