Skip to content

Commit ef82930

Browse files
authored
Merge pull request #14 from grafana/update-docs
update docs
2 parents 46b6178 + e3ea0f5 commit ef82930

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,23 @@ The MQTT data source has the following requirements:
1818
- The plugin currently does not support all of the MQTT CONNECT packet options.
1919
- The plugin currently does not support TLS.
2020
- Including multiple topics in a panel is not yet well supported.
21-
- This plugin automatically supports topics publishing json formatted messages.
22-
21+
- This plugin automatically supports topics publishing very simple JSON formatted messages. Note that only the following structure is supported as of now:
22+
```
23+
{
24+
'value1': 1.0,
25+
'value2': 2,
26+
'value3': 3.33,
27+
...
28+
}
29+
```
30+
We do plan to support more complex JSON data structures in the upcoming releases. Contributions are highly encouraged!
31+
- This plugin currently attaches timestamps to the messages when they are received, so there is no way to have custom timestamp for messages.
2332
## Install the plugin
2433

34+
### Installation Pre-requisites
35+
Refer to: [Building a Streaming Datasource Backend Plugin](https://grafana.com/tutorials/build-a-streaming-data-source-plugin/)
36+
### Installation Steps
37+
2538
1. Clone the plugin to your Grafana plugins directory.
2639
2. Build the plugin by running `yarn install` and then `yarn build`.
2740
3. Run `mage reloadPlugin` or restart Grafana for the plugin to load.
@@ -30,6 +43,8 @@ The MQTT data source has the following requirements:
3043

3144
This plugin currently supports MQTT v3.1.x.
3245

46+
__Note: Since this plugin uses the Grafana Live Streaming API, make sure to use Grafana v8.0+__
47+
3348
### Verify that the plugin is installed
3449

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

0 commit comments

Comments
 (0)