From 92cabcd323f97739edfe3b1176935d3d30e76f64 Mon Sep 17 00:00:00 2001 From: Daniel Nelson Date: Mon, 22 Jul 2019 15:37:52 -0700 Subject: [PATCH] Add fireboard to top level README --- README.md | 1 + plugins/inputs/fireboard/README.md | 18 +++++++----------- 2 files changed, 8 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 86f34738a..ad3c3bc4e 100644 --- a/README.md +++ b/README.md @@ -176,6 +176,7 @@ For documentation on the latest development code see the [documentation index][d * [file](./plugins/inputs/file) * [filestat](./plugins/inputs/filestat) * [filecount](./plugins/inputs/filecount) +* [fireboard](/plugins/inputs/fireboard) * [fluentd](./plugins/inputs/fluentd) * [github](./plugins/inputs/github) * [graylog](./plugins/inputs/graylog) diff --git a/plugins/inputs/fireboard/README.md b/plugins/inputs/fireboard/README.md index b4b8376ce..7e1f351fa 100644 --- a/plugins/inputs/fireboard/README.md +++ b/plugins/inputs/fireboard/README.md @@ -1,15 +1,11 @@ # 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] +thermometers. In order to use this input plugin, you'll need to sign up to use +the [Fireboard REST API](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 `. - ```toml [[inputs.fireboard]] ## Specify auth token for your account @@ -22,9 +18,9 @@ generate it using `telegraf --usage `. #### 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] +In lieu of requiring a username and password, this plugin requires an +authentication token that you can generate using the [Fireboard REST +API](https://docs.fireboard.io/reference/restapi.html#Authentication). #### url @@ -39,7 +35,7 @@ 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 +currently this input only returns the real time temperatures. Temperature values are included if they are less than a minute old. - fireboard @@ -59,4 +55,4 @@ this information. ``` fireboard,channel=2,host=patas-mbp,scale=Farenheit,title=telegraf-FireBoard,uuid=b55e766c-b308-49b5-93a4-df89fe31efd0 temperature=78.2 1561690040000000000 -``` \ No newline at end of file +```