README
¶
CloudBurst
CloudBurst is an HTTP/CoAP frontend for storing/retrieving SenML in/from InfluxDB using a simple API.
The API (documented below) works over HTTP(s) and CoAP(s) with CBOR (application/senml+cbor),
JSON (application/senml+json), and XML (application/senml+xml).
SenSML or SenML FETCH/PATCH are currently not supported.
Installation
Download and build the application using:
go get "gitlab.com/silkeh/cloudburst/cmd/cloudburst"
The server can be started using cloudburst -c <config file>.
Example configuration can be found in config.dist.yaml.
API
The API exposes endpoints based on InfluxDB measurements. This allows one to store data from different sources separately. See the OpenAPI specification for details.
Docker
A Docker image is provided to make it easy to run cloudburst in Docker.
The docker directory contains an example configuration for
running Cloudburst with HTTP and CoAP (udp and tcp) listeners against an InfluxDB2 backend.
Simply run docker-compose up from the directory to try it out.
Data can then be submitted over both HTTP and CoAP. For example:
curl -D- \
-X POST \
-H 'Content-Type: application/json' \
-d '[{"bn":"urn:dev:ow:10e2073a0108006:","bu":"A","bver":5,"n":"voltage","u":"V","v":120.1},{"n":"current","t":-5,"v":1.2},{"n":"current","t":-4,"v":1.3},{"n":"current","t":-3,"v":1.4},{"n":"current","t":-2,"v":1.5},{"n":"current","t":-1,"v":1.6},{"n":"current","v":1.7}]' \
http://localhost:8080/api/v1
And to retrieve the data:
curl -H "Accept: application/json" http://localhost:8080/api/v1
Directories
¶
| Path | Synopsis |
|---|---|
|
backends
|
|
|
influxdb
Package influxdb contains a client for an InfluxDB Cloudburst backend.
|
Package influxdb contains a client for an InfluxDB Cloudburst backend. |
|
influxdb2
Package influxdb2 contains a client for an InfluxDB2 Cloudburst backend.
|
Package influxdb2 contains a client for an InfluxDB2 Cloudburst backend. |
|
postgres
Package postgres contains a client for a PostgreSQL Cloudburst backend.
|
Package postgres contains a client for a PostgreSQL Cloudburst backend. |
|
timescale
Package timescale contains a client for a TimescaleDB Cloudburst backend.
|
Package timescale contains a client for a TimescaleDB Cloudburst backend. |
|
cmd
|
|
|
cloudburst
command
Package main contains the cloudburst application.
|
Package main contains the cloudburst application. |
|
Package server contains the implementation of the Cloudburst server.
|
Package server contains the implementation of the Cloudburst server. |