You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-2Lines changed: 17 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,10 +18,23 @@ The MQTT data source has the following requirements:
18
18
- The plugin currently does not support all of the MQTT CONNECT packet options.
19
19
- The plugin currently does not support TLS.
20
20
- 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.
23
32
## Install the plugin
24
33
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
+
25
38
1. Clone the plugin to your Grafana plugins directory.
26
39
2. Build the plugin by running `yarn install` and then `yarn build`.
27
40
3. Run `mage reloadPlugin` or restart Grafana for the plugin to load.
@@ -30,6 +43,8 @@ The MQTT data source has the following requirements:
30
43
31
44
This plugin currently supports MQTT v3.1.x.
32
45
46
+
__Note: Since this plugin uses the Grafana Live Streaming API, make sure to use Grafana v8.0+__
47
+
33
48
### Verify that the plugin is installed
34
49
35
50
1. In Grafana from the left-hand menu, navigate to **Configuration** > **Data sources**.
0 commit comments