Skip to content

Commit

Permalink
Merge pull request #14 from grafana/update-docs
Browse files Browse the repository at this point in the history
update docs
  • Loading branch information
atifali authored Aug 6, 2021
2 parents 46b6178 + e3ea0f5 commit ef82930
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,23 @@ The MQTT data source has the following requirements:
- The plugin currently does not support all of the MQTT CONNECT packet options.
- The plugin currently does not support TLS.
- Including multiple topics in a panel is not yet well supported.
- This plugin automatically supports topics publishing json formatted messages.

- This plugin automatically supports topics publishing very simple JSON formatted messages. Note that only the following structure is supported as of now:
```
{
'value1': 1.0,
'value2': 2,
'value3': 3.33,
...
}
```
We do plan to support more complex JSON data structures in the upcoming releases. Contributions are highly encouraged!
- This plugin currently attaches timestamps to the messages when they are received, so there is no way to have custom timestamp for messages.
## Install the plugin

### Installation Pre-requisites
Refer to: [Building a Streaming Datasource Backend Plugin](https://grafana.com/tutorials/build-a-streaming-data-source-plugin/)
### Installation Steps

1. Clone the plugin to your Grafana plugins directory.
2. Build the plugin by running `yarn install` and then `yarn build`.
3. Run `mage reloadPlugin` or restart Grafana for the plugin to load.
Expand All @@ -30,6 +43,8 @@ The MQTT data source has the following requirements:

This plugin currently supports MQTT v3.1.x.

__Note: Since this plugin uses the Grafana Live Streaming API, make sure to use Grafana v8.0+__

### Verify that the plugin is installed

1. In Grafana from the left-hand menu, navigate to **Configuration** > **Data sources**.
Expand Down

0 comments on commit ef82930

Please sign in to comment.