AQW - Publish data to Goliath & visualise in a Grafana Dashboard

zpm1066

Hi Jared,
I’m trying to setup a Grafana Dashboard on Grafana Cloud for AQW using the ethernet_hub_ble example.

So far, I’ve successfully done the following:

Created a project in Goliath, provisioned my AQW device.
Published AQW data to Golioth. I’m able to view sensor data updates in Golioth LightDB State.
Setup Grafana Cloud instance.
Created an API Key.
Setup a data source with JSON API using the X-API Key and the value to the API key. Save & test was successful.
Created a dashboard using your Air Quality Wing-1633657750477.json.
I’m able to view the dashboard but no data appears in the dashboard for any of the AQW sensors. I do observe data updates in Golioth LightDB State.

For some reason, Grafana Cloud isn’t picking up the data from Golioth.

Any suggestions as to what may be going on? Thanks.

jaredwolff

zpm1066 that .json configuration may be out of date. I believe they built a Websocket based plugin that talks directly to their API:

https://blog.golioth.io/using-websockets-with-grafana-golioth-demo/

zpm1066

jaredwolff

Thanks. I’ll review the link.

btw - Should I use LightDB stream?

jaredwolff

Yes, that’s the only way to send real time data and retrieve it.

zpm1066

jaredwolff

From the link you shared above and ethernet_hub_ble code unchanged, I should be able use Golioth's WebSocket API to graph the LightDB State data.

Steps:

Install the Golioth’s WebSocket API in the Grafana Cloud instance
Create a WebSocket API data source
Fill in the WebSocket API info:
Host: wss://api.golioth.io/v1/projects/{Project ID}, add Custom Headers
Header: X-API-Key and the value, then Save & test
Grafana displays that the “Data source is working”.
Create a dashboard with the following.
Set Data source to WebSocket API
Add Path and Fields for LightDB State and transform the JSON result into something that the dashboard can display, for example
Path: /devices/{Device Id}
Field $..env.hum
Field $..env.temp

LightDB State
{1 item
     "env":{4 items
       "hum":30
       "pm25":2
       "temp":26
       "voc":52
      }
}

I tried creating a dashboard but got error Some queries returned an error: Query A - undefined.

I don’t see anything wrong with Data source configuration but there may be some other configuration issue.

I’ll open a ticket with Grafana Support.

zpm1066

jaredwolff

I’ve confirmed that the data source is returning data correctly using websocat from a macOS terminal session.

Below, I’ve replaced actual “Device Id” and “APIkey” by “mydeviceid” and “myapikey”

$ websocat wss://api.golioth.io/v1/ws/projects/aqw1066/devices/mydeviceid/data?x-api-key=myapikey
{"result":{"data":{"env":{"hum":33,"pm25":0,"temp":29,"voc":157}}}}
{"result":{"data":{"env":{"hum":32,"pm25":0,"temp":29,"voc":153}}}}
{"result":{"data":{"env":{"hum":32,"pm25":0,"temp":29,"voc":153}}}}

Next step, check why Grafana isn’t getting the data.

zpm1066

I’ve also ran curl against the device’s JSON endpoint to confirm that JSON data source returns the expected sensor data. Below, I’ve replaced the actual API key by myapikey.

$ curl -X 'GET' \

'https://api.golioth.io/v1/projects/aqw1066/devices/643c620df272169b4557ee61/data/env' \
-H 'accept: application/json' \
-H 'x-api-key: myapikey' \
-H 'Authorization: myapikey'
{"data":{"hum":20,"pm25":0,"temp":41,"voc":265}