DataProviderInfo und DataStreamValue

DataProviderInfo und DataStreamValue

Im LM1.0.0 Schema gibt es zwei Nachrichten im JSON Format:

 JSON Format
Beschreibung
DataProviderInfo
Enthält Basis-Informationen über einen Sensor wie Hersteller/Name sowie dessen Eingänge bzw. Messwerte.
Diese Nachricht wird nur beim ersten Mal nach Aktivierung des Sensors gesendet, in weiterer Folge werden nur die einzelnen Messwerte per "DataSteamValue" Nachricht übermittelt.
DataStreamValue
Enthält Daten über einen aktuellen Sensorwert, wobei ein Werte in einer Nachricht versendet wird, d.h. ein Sensor erzeugt eine Nachricht pro Eingang pro Zeitintervall.

DataProviderInfo

Enthält Basis-Infos (Stammdaten) des Sensors. Dazu gehören unter anderem die Beschreibungen der Eingänge inkl. interne IDs. Diese werden bei den laufenden Nachrichten (DataStreamInfo Messages) verwendet.

Beispiel (Luftqualitätssensor)

  2. {
  3.     "messageId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  4.     "header": {
  5.       "message": "DataProviderInfo",
  6.       "bodySchema": "DataProviderInfo-1.0.0",
  7.       "trigger": {
  8.         "type": "EVENT",
  9.         "name": "DATA_PROVIDER_CREATED"
  10.       },
  11.       "createdAt": 1234567899000
  12.     },
  13.     "body": {
  14.       "id": "01234567890abcdef01234567890abcd",
  15.       "customKey": "",
  16.       "title": "Luftqualitätssensor",
  17.       "dataProviderStatus": {
  18.         "status": "",
  19.         "reason": "",
  20.         "since": 0
  21.       },
  22.       "onlineStatus": {
  23.         "status": "",
  24.         "since": 0,
  25.         "lastMessageAt": 0
  26.       },
  27.       "type": "LORA_NODE",
  28.       "typeObject": {
  29.         "lmId": "12345",
  30.         "devEui": "01234567890abcde",
  31.         "article": {
  32.           "articleNumber": "",
  33.           "name": "",
  34.           "imageUrl": ""
  35.         },
  36.         "vendor": {
  37.           "name": "",
  38.           "articleNumber": ""
  39.         },
  40.         "location": ""
  41.       },
  42.       "supportedCommands": [],
  43.       "supportedQueries": [],
  44.       "supportedSystemStreams": [],
  45.       "dataStreams": [
  46.         {
  47.           "id": "01234567890abcdef01234567890abc1",
  48.           "title": "Signal Strength",
  49.           "measurement": {
  50.             "type": "",
  51.             "unit": ""
  52.           },
  53.           "range": {
  54.             "min": 0,
  55.             "max": 0
  56.           },
  57.           "type": ""
  58.         },
  59.         {
  60.           "id": "01234567890abcdef01234567890abc2",
  61.           "title": "Battery Level",
  62.           "measurement": {
  63.             "type": "",
  64.             "unit": ""
  65.           },
  66.           "range": {
  67.             "min": 0,
  68.             "max": 0
  69.           },
  70.           "type": "ANALOG"
  71.         },
  72.         {
  73.           "id": "01234567890abcdef01234567890abc3",
  74.           "title": "Temperatur",
  75.           "measurement": {
  76.             "type": "temperature",
  77.             "unit": "centigrade"
  78.           },
  79.           "range": {
  80.             "min": 0,
  81.             "max": 0
  82.           },
  83.           "type": "ANALOG"
  84.         },
  85.         {
  86.           "id": "01234567890abcdef01234567890abc4",
  87.           "title": "Online Status",
  88.           "measurement": {
  89.             "type": "",
  90.             "unit": ""
  91.           },
  92.           "range": {
  93.             "min": 0,
  94.             "max": 0
  95.           },
  96.           "type": "DIGITAL"
  97.         },
  98.         {
  99.           "id": "01234567890abcdef01234567890abc5",
  100.           "title": "CO2",
  101.           "measurement": {
  102.             "type": "air_quality",
  103.             "unit": "ppm"
  104.           },
  105.           "range": {
  106.             "min": 0,
  107.             "max": 0
  108.           },
  109.           "type": "ANALOG"
  110.         },
  111.         {
  112.           "id": "01234567890abcdef01234567890abc6",
  113.           "title": "Luftfeuchte",
  114.           "measurement": {
  115.             "type": "humidity",
  116.             "unit": "percent"
  117.           },
  118.           "range": {
  119.             "min": 0,
  120.             "max": 0
  121.           },
  122.           "type": "ANALOG"
  123.         }
  124.       ]
  125.     }
  126.   }
  127.   

Schema

Die Beschreibung des Schemas in Form eines JSONSchema findet sich auch in den angehängten Dateien unter DataStreamValue-1.0.0.schema.json

messageId
string
Eindeutige ID der Message (UUID)
header
{ }
message
string
Schema Name

Mögliche Werte:
DataProviderInfo
bodySchema
string
Schema Name/Version

Mögliche Werte:
DataProviderInfo-1.0.0
trigger
{ }
type
string
Trigger Type (dzt. nur 'EVENT')

Mögliche Werte:
EVENT
name
string
Trigger Type (dzt. nur 'DATA_PROVIDER_CREATED' (Sensor erstellt)

Mögliche Werte:
DATA_PROVIDER_CREATED
createdAt
number
Zeitstempel der Anlage des Sensors (Unix Timestamp in ms)
body
{ }
id
string
Eindeutige ID der Message
customKey
string
Selbstvergebene ID des Sensors
title
string
Name des Sensors
dataProviderStatus
{ }
status
string
Noch nicht implementiert
reason
string
Noch nicht implementiert
since
number
Noch nicht implementiert
onlineStatus
{ }
status
string
Noch nicht implementiert
since
number
Noch nicht implementiert
lastMessageAt
number
Noch nicht implementiert
type
string
Art des Sensors

Mögliche Werte:
LORA_NODE
typeObject
{ }
lmId
string
linemetrics ID des Sensors
devEui
string
Eindeutige, vom Hersteller vergebene ID des Sensors
article
{ }
articleNumber
Noch nicht implementiert
name
Noch nicht implementiert
imageUrl
Noch nicht implementiert
vendor
{ }
name
Noch nicht implementiert
articleNumber
Noch nicht implementiert
location
string
Noch nicht implementiert
supportedCommands
Noch nicht implementiert
supportedQueries
Noch nicht implementiert
supportedSystemStreams
Noch nicht implementiert
dataStreams
[ { } ]
id
string
Eindeutige ID des Sensorwerts
title
string
Eindeutiger Name des Sensorwerts
measurement
{ }
type
string
Type des Sensorwerts (zB temperature)
unit
string
Einheit des Sensorwerts (zB centigrade)
range
{ }
min
number
Noch nicht implementiert
max
number
Noch nicht implementiert
type
string
Art des Sensorwerts

Mögliche Werte:
ANALOG, DIGITAL
DataStreamValue 
Enthält Daten über einen aktuellen Sensorwert, wobei ein Werte in einer Nachricht versendet wird, d.h. ein Sensor erzeugt eine Nachricht pro Eingang pro Zeitintervall.
Beispiel (Luftqualitätssensor)
  1. {
  2.     "messageId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  3.     "header": {
  4.       "message": "DataStreamValue",
  5.       "bodySchema": "DataStreamValue-1.0.0",
  6.       "trigger": {
  7.         "type": "EVENT",
  8.         "name": "SENSOR_DATA_SENT"
  9.       },
  10.       "createdAt": 1234567899000
  11.     },
  12.     "body": {
  13.       "id": "01234567890abcdef01234567890abcd",
  14.       "dataProviderId": "01234567890abcdef01234567890abcd",
  15.       "timestamp": 1234567899000,
  16.       "value": {
  17.         "val": 123
  18.       },
  19.       "type": "RAW"
  20.     }
  21.   }
  
Schema
Die Beschreibung des Schemas in Form eines JSONSchema findet sich auch in den angehängten Dateien unter DataStreamValue-1.0.0.schema.json
​
messageId
string
Eindeutige ID der Message (UUID v4)
header
{ }
message
string
Schema Name

Mögliche Werte:
DataStreamValue
bodySchema
string
Schema Name/Version

Mögliche Werte:
DataStreamValue-1.0.0
trigger
{ }
type
string
Trigger Type (dzt. nur 'EVENT')

Mögliche Werte:
EVENT
name
string
Trigger Type (dzt. nur 'SENSOR_DATA_SENT' (Sensor Daten gesendet)

Mögliche Werte:
SENSOR_DATA_SENT
createdAt
number
Zeitstempel der Erstellung der Message (Unix Timestamp in Millisekunden)
body
{ }
id
string
Stream ID
dataProviderId
string
Dataprovider (Sensor) ID
timestamp
number
Zeitstempel der Erfassung des Werts (Unix Timestamp in Millisekunden)
value
{ }
val
number
Sensorwert
rssi
number
optional		Signalstärke/RSSI (Nur bei 'Signal Strength' Streams)
snr
number
optional		Signal/Noise Ratio (SNR) (Nur bei 'Signal Strength' Streams)
type
string
Type des Werts (aktuell nur 'RAW')

Mögliche Werte:
RAW