Scheme LM1.0.0

Scheme LM1.0.0

2 different types of messages are sent:
  1. DataProviderInfo
    Contains basic information about a sensor such as manufacturer/name as well as its inputs or measured values.
    This message is only sent the first time after activating the sensor, subsequently only the individual measured values are transmitted via "DataSteamValue" message.
  2. DataStreamValue
    Contains data about a current sensor value, whereby a value is sent in a message, i.e. a sensor generates one message per input per time interval.

DataProviderInfo

Contains basic information (master data) of the sensor. This includes the descriptions of the inputs including internal IDs. These are used for the current messages (DataStreamInfo Messages).

Example (air quality sensor)

  2. {
  3. "messageId": "aaaaaaaaaa-bbb-cccc-ddd-eeeeeeeeeeeeeeeeee",
  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": "air quality sensor",
  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": "ANALOGUE"
  71. },
  72. {
  73. "id": "01234567890abcdef01234567890abc3",
  74. "title": "temperature",
  75. "measurement": {
  76. "type": "temperature",
  77. "unit": "centigrade"
  78. },
  79. "range": {
  80. "min": 0,
  81. "max": 0
  82. },
  83. "type": "ANALOGUE"
  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": "ANALOGUE"
  110. },
  111. {
  112. "id": "01234567890abcdef01234567890abc6",
  113. "title": "humidification",
  114. "measurement": {
  115. "type": "humidity",
  116. "unit": "percent"
  117. },
  118. "range": {
  119. "min": 0,
  120. "max": 0
  121. },
  122. "type": "ANALOGUE"
  123. }
  124. ]
  125. }
  126. }

Scheme

The description of the scheme in the form of aJSONSchemacan also be found in the attached files underDataStreamValue-1.0.0.schema.json

messageId
string
Unique message ID (UUID)
header
{ }
message
string
Scheme Name

Possible values:
DataProviderInfo
bodySchema
string
Schema Name/Version

Possible values:
DataProviderInfo-1.0.0
trigger
{ }
type
string
Trigger Type (dzt. only 'EVENT')

Possible values:
Events
name
string
Trigger Type (dzt. only 'DATA_PROVIDER_CREATED' (sensor created)

Possible values:
Data_provider_created
createdAt
number
Timestamp of the sensor system (Unix Timestamp in ms)
body
{ }
id
string
Unique ID of the message
customKey
string
Sensor self-assigned ID
title
string
Sensor name
dataProviderStatus
{ }
status
string
Not yet implemented
reason
string
Not yet implemented
since
number
Not yet implemented
online status
{ }
status
string
Not yet implemented
since
number
Not yet implemented
lastMessageAt
number
Not yet implemented
type
string
Type of sensor

Possible values:
Lora_node
typeObject
{ }
lmId
string
linemetrics sensor ID
devEui
string
Unique sensor ID awarded by the manufacturer
article
{ }
articleNumber
Not yet implemented
name
Not yet implemented
imageUrl
Not yet implemented
vendor
{ }
name
Not yet implemented
articleNumber
Not yet implemented
location
string
Not yet implemented
supportedCommands
Not yet implemented
supportedQueries
Not yet implemented
supportedSystemStreams
Not yet implemented
dataStreams
[ { } ]
id
string
Unique ID of sensor value
title
string
Unique name of sensor value
measurement
{ }
type
string
Type of sensor value (e.g. temperature)
unit
string
Unit of sensor value (e.g. centigrade)
range
{ }
min
number
Not yet implemented
max
number
Not yet implemented
type
string
Type of sensor value

Possible values:
Analogue, digital
DataStreamValue
Example (air quality sensor)
  1. {
  2. "messageId": "aaaaaaaaaa-bbb-cccc-ddd-eeeeeeeeeeeeeeeeee",
  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. }
Scheme
The description of the scheme in the form of aJSONSchemacan also be found in the attached files underDataStreamValue-1.0.0.schema.json
messageId
string
Unique message ID (UUID v4)
header
{ }
message
string
Scheme Name

Possible values:
DataStreamValue
bodySchema
string
Schema Name/Version

Possible values:
DataStreamValue-1.0.0
trigger
{ }
type
string
Trigger Type (dzt. only 'EVENT')

Possible values:
Events
name
string
Trigger Type (dzt. only 'SENSOR_DATA_SENT' (sensor data sent)

Possible values:
Sensor_data_sent
createdAt
number
Message creation timestamp (Unix timestamp in milliseconds)
body
{ }
id
string
Stream ID
dataProviderId
string
Dataprovider (sensor) ID
timestamp
number
Time stamp of recording the value (Unix timestamp in milliseconds)
value
{ }
valves
number
Sensor value
rssi
number
optional		Signal Strength/RSSI (Only for 'Signal Strength' Streams)
snr
number
optional		Signal/Noise Ratio (SNR)
type
string
Type of value (currently only 'RAW')

Possible values:
Raw





    

    • Related Articles
      • 

    • Scheme ExtendedDataStreamValueV001
      In this format, both metadata and data are sent in a shared message - the distinction between "DataproviderInfo" and "DataStreamValue" as in LM100 format is not available. Example (temperature sensor) { "dataProvider": { "devEui": "01234567890abcde", ...
      • 

    • Webhook
      Payload Example {"data": {"dataProvider": {"devEui": "12345abcdef","lmId": "12345"},"dataStream": {"measurement": "temperature"},"dataPoint": {"timestamp": 1704897825000,"value": {"value": 123,"min": 123,"max": 123}}}} Scheme data protection { } ...
      • 

    • Mqtt
      The MQTT integration allows sensor data to be received via the Linemetrics MQTT broker (access data is passed when integration is created). Formats The following formats are available when using the MQTT integration: Json ...
      •