{
"UUID": "ABC-123-XYZ",
"timestamp": 1447771044557,
"latitude": 54.0,
"longitude": -7.5,
"name": "davranetworks.telematics.rpm",
"value": 1500,
"msg_type": "datum",
"tags": {
"fleet": "Denver"
}
}

Mandatory Fields:

UUID, timestamp, name, msg_type

Fields:

UUID replaces the "serialNumber" field - it's a more appropriate field name
timestamp - a representation of time as a count of milliseconds since the epoch
msg_type: set this to datum for timeseries data and event for anything else.
tags - tags are a way to attach dimensions to sensor data or events. Tags are useful for distinguishing one sensor reading/event from another. For example all sensor values read from a vehicle during a journey can be tagged with the id of the driver so when reviewing the telemetry of the vehicle later one can break-out the vehicles performance by driver.
latitude/longitude - the geo location for the event/sensor reading. When present the location of the corresponding IoT gateway will be updated on the RuBAN main map as well as the location being recorded for the gps replay feature.
j - this field can be added for backwards compatibility with the journey mechanism in RuBAN. As the example suggests above we "could" just mark data uploads with a GUID generated when the vehicle comes up and use it to mark all sensor readings/events with the same tag value denoting a journey
value - for datum messages this is the value stored in the timeseries store. It must be a number.

Restrictions:

While you can put any JSON structure into RuBAN's event store, it is still JSON and you must provide proper JSON. The underlying storage mechanisms in RuBAN further restrict what you can put into a message:

name must be one word and is limited to alphanumerics with “-_.”
tags cannot have spaces nor "."

Request

PUT /api/v1/iotdata

e.g.

curl -X PUT --data-binary "@data.json" -H "content-type:application/json" http://<ruban host>:<ruban port>/api/v1/iotdata

Meta-Data

Metric:

{
"name":"com.davranetworks.fleet.speed",
"label":"Vehicle Speed",
"group":"huntsville",
"semantics":"metric",
"units":"mph"
}

Tag:

{
"name":"us_state",
"label":"State",
"group":"fleet",
"semantics":"tag"
}

Request

To upload one metric definition just put the JSON into a text file and upload.

PUT /api/v1/iotdata/meta-data/com.davranetworks.fleet.speed

e.g.

curl X PUT --data-binary "@meta-data.json" -H "content-type:application/json" http://<ruban host>:<ruban port>/api/v1/iotdata/meta-data/com.davranetworks.fleet.speed

Bulk Meta-data upload

POST /api/v1/iotdata/meta-data

Payload:

[
{
"name":"com.davranetworks.fleet.speed",
"label":"Vehicle Speed",
"group":"huntsville",
"semantics":"metric",
"units":"mph"
},
{
"name":"us_state",
"label":"State",
"group":"fleet",
"semantics":"tag"
}
]

Querying Data/Events

Querying Data

see timeseriesData api here

Querying Events

This is a very early version of this feature... so be warned!

POST /api/v1/events/query

As it stands there is only the ability to list events in a timerange for an event name filtered by tags.
you'll notice that the events part of the query is an array which means you can request multiple event types in a single request (all for the same time range) but can be separately filtered
there is no aggregation yet - coming

{
	"start_absolute": 0,
	"end_absolute": 1447773710789,
	"events": [
		{
			"name": "davranetworks.telematics.rpm",
			"tags": {
				"driverId": "skjdls"
			}
		}
	]
}

Response

{ queries: 
   [ { name: 'davranetworks.telematics.rpm',
       events: 
        [ { _id: 564b23b325ef026425a6f299,
            UUID: 'FTX175280CX',
            timestamp: 1446735256301,
            latitude: 54,
            longitude: -7.5,
            name: 'davranetworks.telematics.rpm',
            value: 900,
            message: 'sample message 1',
            msg_type: 'event',
            tags: { davranetworks_journey: 1, driverId: '2983492-skjfk-2839' } },
          { _id: 564b23df1689a3a06827f07d,
            UUID: 'FTX175280CX',
            timestamp: 1446735316301,
            latitude: 54,
            longitude: -7.5,
            name: 'davranetworks.telematics.rpm',
            value: 901,
            message: 'sample message 2',
            msg_type: 'event',
            tags: { davranetworks_journey: 1, driverId: '2983492-skjfk-2839' } 
         }
         :
         :
       ] 
    } 
  ] 
}

Browser not supported