Merge pull request #6 from grafana/update-readme

Update SDK and readme

Author: ryantxu

README.md

@@ -4,6 +4,8 @@
 
 The MQTT data source plugin allows you to visualize streaming MQTT data from within Grafana.
 
+This datasource is under active development, all feedback and help is encouraged!
+
 ## Requirements
 
 The MQTT data source has the following requirements:
@@ -15,9 +17,15 @@ 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.
 
 ## Install the plugin
 
+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.
+
 1. Navigate to [The plugin on Github](https://github.com/MasslessParticle/ciac-datasource).
 1. Clone the plugin to your grafana plugins directory
 1. Restart Grafana
@@ -58,11 +66,3 @@ The query editor allows you to specify which MQTT topics the panel will subscrib
 for more information about valid topic names and filters.
 
 ![mqtt dashboard](./test_broker.gif)
-
-
-## Learn more
-
-- Add [Annotations](https://grafana.com/docs/grafana/latest/dashboards/annotations/).
-- Add [Transformations](https://grafana.com/docs/grafana/latest/panels/transformations/).
-- Set up alerting; refer to [Alerts overview](https://grafana.com/docs/grafana/latest/alerting/).
-- [MQTT v3.1.1 specification](http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/mqtt-v3.1.1.html)

go.mod

@@ -4,6 +4,6 @@ go 1.16
 
 require (
 	github.com/eclipse/paho.mqtt.golang v1.3.4
-	github.com/grafana/grafana-plugin-sdk-go v0.97.0
+	github.com/grafana/grafana-plugin-sdk-go v0.102.0
 	github.com/stretchr/testify v1.7.0
 )

go.sum

@@ -124,8 +124,8 @@ github.com/gorilla/mux v1.7.3/go.mod h1:1lud6UwP+6orDFRuTfBEV8e9/aOM/c4fVVCaMa2z
 github.com/gorilla/websocket v0.0.0-20170926233335-4201258b820c/go.mod h1:E7qHFY5m1UJ88s3WnNqhKjPHQ0heANvMoAMk2YaljkQ=
 github.com/gorilla/websocket v1.4.2 h1:+/TMaTYc4QFitKJxsQ7Yye35DkWvkdLcvGKqM+x0Ufc=
 github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
-github.com/grafana/grafana-plugin-sdk-go v0.97.0 h1:V9307Grs2QLvzcldC4hwe3Q1jh6vEMIwONq+l0iy+mk=
-github.com/grafana/grafana-plugin-sdk-go v0.97.0/go.mod h1:kgJSx8txPM+3lxLdSp+E9mdnB0xbXkM7VWr7FSHJY0k=
+github.com/grafana/grafana-plugin-sdk-go v0.102.0 h1:Pknh7mlOaJvdhPgKHxcimDOSd9h29eSpA34W0/sOF6c=
+github.com/grafana/grafana-plugin-sdk-go v0.102.0/go.mod h1:D7x3ah+1d4phNXpbnOaxa/osSaZlwh9/ZUnGGzegRbk=
 github.com/grpc-ecosystem/go-grpc-middleware v1.0.1-0.20190118093823-f849b5445de4/go.mod h1:FiyG127CGDf3tlThmgyCl78X/SZQqEOJBCDaAfeWzPs=
 github.com/grpc-ecosystem/go-grpc-middleware v1.3.0 h1:+9834+KizmvFV7pXQGSXQTsaWhq2GjuNUt0aUU0YBYw=
 github.com/grpc-ecosystem/go-grpc-middleware v1.3.0/go.mod h1:z0ButlSOZa5vEBq9m2m2hlwIgKw+rp3sdCBRoJY+30Y=
@@ -467,8 +467,8 @@ google.golang.org/grpc v1.27.0/go.mod h1:qbnxyOmOxrQa7FizSgH+ReBfzJrCY1pSN7KXBS8
 google.golang.org/grpc v1.27.1/go.mod h1:qbnxyOmOxrQa7FizSgH+ReBfzJrCY1pSN7KXBS8abTk=
 google.golang.org/grpc v1.29.1/go.mod h1:itym6AZVZYACWQqET3MqgPpjcuV5QH3BxFS3IjizoKk=
 google.golang.org/grpc v1.32.0/go.mod h1:N36X2cJ7JwdamYAgDz+s+rVMFjt3numwzf/HckM8pak=
-google.golang.org/grpc v1.37.0 h1:uSZWeQJX5j11bIQ4AJoj+McDBo29cY1MCoC1wO3ts+c=
-google.golang.org/grpc v1.37.0/go.mod h1:NREThFqKR1f3iQ6oBuvc5LadQuXVGo9rkm5ZGrQdJfM=
+google.golang.org/grpc v1.37.1 h1:ARnQJNWxGyYJpdf/JXscNlQr/uv607ZPU9Z7ogHi+iI=
+google.golang.org/grpc v1.37.1/go.mod h1:NREThFqKR1f3iQ6oBuvc5LadQuXVGo9rkm5ZGrQdJfM=
 google.golang.org/grpc/cmd/protoc-gen-go-grpc v0.0.0-20200910201057-6591123024b3/go.mod h1:6Kw0yEErY5E/yWrBtf03jp27GLLJujG4z/JK95pnjjw=
 google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8=
 google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0=

pkg/plugin/datasource.go

@@ -112,7 +112,7 @@ func (ds *MQTTDatasource) SubscribeStream(ctx context.Context, req *backend.Subs
 	}, nil
 }
 
-func (ds *MQTTDatasource) RunStream(ctx context.Context, req *backend.RunStreamRequest, sender backend.StreamPacketSender) error {
+func (ds *MQTTDatasource) RunStream(ctx context.Context, req *backend.RunStreamRequest, sender *backend.StreamSender) error {
 	defer ds.Client.Unsubscribe(req.Path)
 
 	for {
@@ -175,7 +175,7 @@ func (m *MQTTDatasource) Query(query backend.DataQuery) backend.DataResponse {
 	return response
 }
 
-func (m *MQTTDatasource) SendMessage(msg mqtt.StreamMessage, req *backend.RunStreamRequest, sender backend.StreamPacketSender) error {
+func (m *MQTTDatasource) SendMessage(msg mqtt.StreamMessage, req *backend.RunStreamRequest, sender *backend.StreamSender) error {
 	if !m.Client.IsSubscribed(req.Path) {
 		return nil
 	}
@@ -186,15 +186,7 @@ func (m *MQTTDatasource) SendMessage(msg mqtt.StreamMessage, req *backend.RunStr
 	}
 
 	frame := ToFrame(msg.Topic, []mqtt.Message{message})
-	bytes, err := data.FrameToJSON(frame, true, true) // send schema every frame - for now!
-	if err != nil {
-		return err
-	}
-
-	packet := &backend.StreamPacket{
-		Data: bytes,
-	}
 
 	log.DefaultLogger.Debug(fmt.Sprintf("Sending message to client for topic %s", msg.Topic))
-	return sender.Send(packet)
+	return sender.SendFrame(frame, data.IncludeAll)
 }