Skip to content

Commit 157633b

Browse files
authored
Prepare for 1.0.0-beta.1 release (#57)
1 parent c11488f commit 157633b

File tree

3 files changed

+28
-31
lines changed

3 files changed

+28
-31
lines changed

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Changelog
22

3-
## 1.0.0 (Unreleased)
3+
## [1.0.0-beta.1] - 2022-12-01
44

5-
Initial release.
5+
- Initial release

README.md

Lines changed: 25 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,38 @@
44

55
The MQTT data source plugin allows you to visualize streaming MQTT data from within Grafana.
66

7-
This datasource is under active development, all feedback and help is encouraged!
8-
97
## Requirements
108

119
The MQTT data source has the following requirements:
1210

1311
- Grafana user with a server or organization administration role; refer to [Permissions](https://grafana.com/docs/grafana/latest/permissions/).
1412
- Access to a MQTT broker.
1513

14+
## Configure the data source
15+
16+
[Add a data source](https://grafana.com/docs/grafana/latest/datasources/add-a-data-source/) by filling in the following fields:
17+
18+
#### Basic fields
19+
20+
| Field | Description |
21+
| ----- | -------------------------------------------------- |
22+
| Name | A name for this particular MQTT data source |
23+
| URI | The scehme, host, and port of the MQTT Broker. Supported schemes: TCP (tcp://), TLS (tls://), and WebSocket (ws://) |
24+
25+
#### Authentication fields
26+
27+
| Field | Description |
28+
| -------- | ----------------------------------------------------------------- |
29+
| Username | (Optional) The username to use when connecting to the MQTT broker |
30+
| Password | (Optional) The password to use when connecting to the MQTT broker |
31+
32+
## Query the data source
33+
34+
The query editor allows you to specify which MQTT topics the panel will subscribe to. Refer to the [MQTT v3.1.1 specification](http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718106)
35+
for more information about valid topic names and filters.
36+
37+
![mqtt dashboard](./test_broker.gif)
38+
1639
## Known limitations
1740

1841
- The plugin currently does not support all of the MQTT CONNECT packet options.
@@ -44,29 +67,3 @@ NOTE: The `yarn build` command above might fail on a non-unix-like system, like
4467
2. From the top-right corner, click the **Add data source** button.
4568
3. Search for `MQTT` in the search field, and hover over the MQTT search result.
4669
4. Click the **Select** button for MQTT.
47-
48-
## Configure the data source
49-
50-
[Add a data source](https://grafana.com/docs/grafana/latest/datasources/add-a-data-source/) by filling in the following fields:
51-
52-
#### Basic fields
53-
54-
| Field | Description |
55-
| ----- | -------------------------------------------------- |
56-
| Name | A name for this particular AppDynamics data source |
57-
| Host | The hostname or IP of the MQTT Broker |
58-
| Port | The port used by the MQTT Broker (default 1883) |
59-
60-
#### Authentication fields
61-
62-
| Field | Description |
63-
| -------- | ----------------------------------------------------------------- |
64-
| Username | (Optional) The username to use when connecting to the MQTT broker |
65-
| Password | (Optional) The password to use when connecting to the MQTT broker |
66-
67-
## Query the data source
68-
69-
The query editor allows you to specify which MQTT topics the panel will subscribe to. Refer to the [MQTT v3.1.1 specification](http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718106)
70-
for more information about valid topic names and filters.
71-
72-
![mqtt dashboard](./test_broker.gif)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "grafana-mqtt-datasource",
3-
"version": "0.0.1-dev",
3+
"version": "1.0.0-beta.1",
44
"description": "MQTT Datasource Plugin",
55
"scripts": {
66
"build": "rm -rf dist && grafana-toolkit plugin:build && mage build:backend",

0 commit comments

Comments
 (0)