Live Objects - public decoders output

generated at 2023-11-13T14:03:01.558Z

ABEEWAY-MicroTracker

Product(s) version :
hw: x.y fw: 1.2.0

Orange decoder : abeeway_microtracker_v1.0
Developer : Orange

PayloadTracker_On
DescriptionMessage transmitted, when the device is on.
Example :
Input2101120000011006
Output
{"battery":{"charging":false,"unmeasurable":false,"energyLevel":1},"messageType":"TRACKER_ON","trackerMode":"MOTION_DETECTION","version":{"firmware":"1.2.0","ble":"1.0.6"},"lastResetReason":1}
Output json fields :
Fields
nametypedescription
battery.energyLevel Number Energy level (0 = in charge / 1..254 = battery level [ min = 1, max = 254 ] / 255 = unmeasurable level
messageType String Message type. Values can be :
  • TRACKER_ON
  • TRACKER_HEARTBEAT
  • TRACKER_POSITION
  • TRACKER_OFF
trackerMode String Tracker mode. Values can be :
  • SLEEPING
  • TRACKING
  • MOTION_DETECTION
  • CLASSIC
version.firmware String Firmware number, with the x.y.z format :
  • x (version: 0..7)
  • y (revision: 0..15)
  • z (iteration)
version.ble String Ble number, with the x.y.z format :
  • x (version: 0..7)
  • y (revision: 0..15)
  • z (iteration)
lastResetReason Number Last reset reason, taken from the main processor RMU_RSTCAUSE register
PayloadHeartbeat
DescriptionPeriodic minimal heartbeat message transmitted.
Example :
Input2286
Output
{"battery":{"charging":false,"unmeasurable":false,"energyLevel":134},"messageType":"TRACKER_HEARTBEAT","trackerMode":"MOTION_DETECTION"}
Output json fields :
Fields
nametypedescription
battery.energyLevel Number Energy level (0 = in charge / 1..254 = battery level [ min = 1, max = 254 ] / 255 = unmeasurable level
messageType String Message type. Values can be :
  • TRACKER_ON
  • TRACKER_HEARTBEAT
  • TRACKER_POSITION
  • TRACKER_OFF
trackerMode String Tracker mode. Values can be :
  • SLEEPING
  • TRACKING
  • MOTION_DETECTION
  • CLASSIC
PayloadTracker_Position (GPS mode)
DescriptionMessage transmitted, on user request, upon motion detection or at periodic intervals.
Example :
Input2360001d254e015bd532
Output
{"battery":{"charging":false,"unmeasurable":false,"energyLevel":96},"messageType":"TRACKER_POSITION","trackerMode":"MOTION_DETECTION","status":{"bleFailure":false,"gpsFailure":false,"wifiFailure":false},"triggerEvent":"TRACKER_MODE","location":{"lat":48.8984064,"lon":2.279552,"accuracy":50}}
Output json fields :
Fields
nametypedescription
battery.energyLevel Number Energy level (0 = in charge / 1..254 = battery level [ min = 1, max = 254 ] / 255 = unmeasurable level
messageType String Message type. Values can be :
  • TRACKER_ON
  • TRACKER_HEARTBEAT
  • TRACKER_POSITION
  • TRACKER_OFF
trackerMode String Tracker mode. Values can be :
  • SLEEPING
  • TRACKING
  • MOTION_DETECTION
  • CLASSIC
status.gpsFailure Boolean Flag indicating a failure to communicate with the GPS subsystem.
status.bleFailure Boolean Flag indicating a failure to communicate with the BLE subsystem.
status.wifiFailure Boolean Flag indicating a failure to communicate with the WIFI subsystem.
triggerEvent String Event that triggers the TRACKER_POSITION message. Values can be :
  • TRACKER_MODE
  • USER_ACTION
  • NETWORK_REQUEST
  • USER_ACTION
location.lat Number Latitude in decimal degrees.
location.lon Number Longitude in decimal degrees.
location.accuracy Number EHPE Estimated Horizontal Position Error (in meters), a measure of the error in a GPS position in the horizontal plane. Range from 0 to 255m.
PayloadTracker_Position (Wifi mode)
DescriptionMessage transmitted, on user request, upon motion detection or at periodic intervals.
Example :
Input238300
Output
{"battery":{"charging":false,"unmeasurable":false,"energyLevel":131},"messageType":"TRACKER_POSITION","trackerMode":"MOTION_DETECTION","status":{"bleFailure":false,"gpsFailure":false,"wifiFailure":false},"triggerEvent":"TRACKER_MODE"}
Output json fields :
Fields
nametypedescription
battery.energyLevel Number Energy level (0 = in charge / 1..254 = battery level [ min = 1, max = 254 ] / 255 = unmeasurable level
messageType String Message type. Values can be :
  • TRACKER_ON
  • TRACKER_HEARTBEAT
  • TRACKER_POSITION
  • TRACKER_OFF
trackerMode String Tracker mode. Values can be :
  • SLEEPING
  • TRACKING
  • MOTION_DETECTION
  • CLASSIC
status.gpsFailure Boolean Flag indicating a failure to communicate with the GPS subsystem.
status.bleFailure Boolean Flag indicating a failure to communicate with the BLE subsystem.
status.wifiFailure Boolean Flag indicating a failure to communicate with the WIFI subsystem.
triggerEvent String Event that triggers the TRACKER_POSITION message. Values can be :
  • TRACKER_MODE
  • USER_ACTION
  • NETWORK_REQUEST
  • USER_ACTION
location.lat Number Latitude in decimal degrees.
location.lon Number Longitude in decimal degrees.
location.accuracy Number EHPE Estimated Horizontal Position Error (in meters), a measure of the error in a GPS position in the horizontal plane. Range from 0 to 255m.
PayloadTracker_Off
DescriptionMessage transmitted, when the device is off.
Example :
Input240100
Output
{"battery":{"charging":false,"unmeasurable":false,"energyLevel":1},"messageType":"TRACKER_OFF","trackerMode":"MOTION_DETECTION","trackerOffReason":"LOW_BATTERY"}
Output json fields :
Fields
nametypedescription
battery.energyLevel Number Energy level (0 = in charge / 1..254 = battery level [ min = 1, max = 254 ] / 255 = unmeasurable level
messageType String Message type. Values can be :
  • TRACKER_ON
  • TRACKER_HEARTBEAT
  • TRACKER_POSITION
  • TRACKER_OFF
trackerMode String Tracker mode. Values can be :
  • SLEEPING
  • TRACKING
  • MOTION_DETECTION
  • CLASSIC
trackerOffReason String Tracker off reason. Values can be :
  • LOW_BATTERY
  • USER_REQUEST

ABEEWAY-AssetTracker

Product(s) version :
fw: <= 2.1.0

Orange decoder : abeeway_tracker_lora_v1.4
Developer : Orange

PayloadFramePending
DescriptionFrame Pending.
Example :
Input000a
Output
{"ack":10,"deviceModel":"MASTER","messageType":"FRAME-PENDING"}
Output json fields :
Fields
nametypedescription
ack Number Acknowledgement token is sent to trigger the sending of additional messages.
messageType String Message type. Values can be :
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
  • DATA_SCAN_COLLECTION
  • PROXIMITY_DETECTION
deviceModel String Device model. Values can be :
  • MASTER
  • MICRO
  • UNKNOWN
PayloadPosition
DescriptionBLE beacon scan.
Example :
Input032cf2719926140c76764fd9adf20d5602e447a6083e5d85e42ca6f20d5602e446a1
Output
{"battery":{"valueFirmwarePrev15":3.75,"value":4.13,"inCharge":false,"unit":"V"},"temperature":{"value":13.16,"unit":"°C"},"adt":"WIFI-BSSIDs-WITHOUT-CIPHERING","ack":9,"deviceModel":"MASTER","messageType":"POSITION","status":{"appMode":"motionTrack","appState":"tracking","moving":true,"periodic":false,"onDemand":false,"userAlert":false},"bssId0":"140c76764fd9","rssi0":{"unit":"dB","value":-83},"bssId1":"f20d5602e447","rssi1":{"unit":"dB","value":-90},"bssId2":"083e5d85e42c","rssi2":{"unit":"dB","value":-90},"bssId3":"f20d5602e446","rssi3":{"unit":"dB","value":-95},"scanAge":304}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
  • UNUSED
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
  • DATA_SCAN_COLLECTION
  • PROXIMITY_DETECTION
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
scanAge Number Scan age (in seconds).
rssi.unit String Received signal strength unit (dB).
rssi.value Number Receive Signal Strength Indication for the beacon.
rssi.unit String Received signal strength unit (dB).
rssi.value Number Receive Signal Strength Indication for the beacon.
rssi.unit String Received signal strength unit (dB).
rssi.value Number Receive Signal Strength Indication for the beacon.
rssi.unit String Received signal strength unit (dB).
rssi.value Number Receive Signal Strength Indication for the beacon.
macAdr0 String Mac address of the 0 beacon.
macAdr1 String Mac address of the 1 beacon.
macAdr2 String Mac address of the 2 beacon.
macAdr3 String Mac address of the 3 beacon.
PayloadPosition
DescriptionBLE failure.
Example :
Input036c99880805
Output
{"battery":{"valueFirmwarePrev15":3.4,"value":3.64,"inCharge":false,"unit":"V"},"temperature":{"value":24.8,"unit":"°C"},"adt":"BLE-BEACON-FAILURE","ack":0,"deviceModel":"MASTER","messageType":"POSITION","status":{"appMode":"motionStartEndTrack","appState":"tracking","moving":true,"periodic":false,"onDemand":false,"userAlert":false},"bleError":"NO-BEACON-DETECTED"}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
  • UNUSED
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
  • DATA_SCAN_COLLECTION
  • PROXIMITY_DETECTION
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
bleError String BLE error. Values can be :
  • BLE-NOT-RESPONDING
  • INTERNAL-ERROR
  • SHARED-ANTENNA-NOT-AVAILABLE
  • SCAN-ALREADY-GOING
  • BLE-BUSY
  • NO-BEACON-DETECTED
  • HARDWARE-INCOMPATIBLITY
PayloadGPS timeout
Descriptionthe tracker was not able to compute a GPS position on time.The unability to find a fix on time is always related to bad GPS signal (indoor/urban/cloudy environment),but the software timeout can be hit by various events.
Example :
Input032cc983010100000000
Output
{"battery":{"valueFirmwarePrev15":3.59,"value":3.91,"inCharge":false,"unit":"V"},"temperature":{"value":22.27,"unit":"°C"},"cn0":0,"cn1":0,"cn2":0,"cn3":0,"adt":"GPS-TIMEOUT","ack":0,"deviceModel":"MICRO","messageType":"POSITION","status":{"appMode":"motionTrack","appState":"tracking","moving":true,"periodic":false,"onDemand":false,"userAlert":false},"timeoutCause":"PREEMPT-CONDITION-0"}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
  • UNUSED
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
  • DATA_SCAN_COLLECTION
  • PROXIMITY_DETECTION
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
fixAge Number Age in seconds of the GPS location measure.
cn0 Number The carrier-to-noise density ratio (C/N) used to show the signal strength and quality for the best 4 satellites.
cn1 Number
cn2 Number
cn3 Number
timeoutCause String The GPS timeout cause. Values can be
  • USER-TIMEOUT : the GPS was not able to compute a fix before the position message period,
  • PREEMPT-CONDITION-0 : the geoloc engine was configured to preempt the GPS scan before the user timeout,
    in case the GPS signal is too weak.
  • PREEMPT-CONDITION-1 : idem
PayloadPosition
DescriptionPosition on demand.
Example :
Input032a957e790f7cb73388d2ace1d8d7759cee90d6f20d5602e444c0
Output
{"battery":{"valueFirmwarePrev15":3.38,"value":3.62,"inCharge":false,"unit":"V"},"temperature":{"value":19.74,"unit":"°C"},"adt":"WIFI-BSSIDs-WITHOUT-CIPHERING","ack":7,"deviceModel":"MASTER","messageType":"POSITION","status":{"appMode":"motionTrack","appState":"tracking","moving":false,"periodic":true,"onDemand":false,"userAlert":false},"bssId0":"7cb73388d2ac","rssi0":{"unit":"dB","value":-31},"bssId1":"d8d7759cee90","rssi1":{"unit":"dB","value":-42},"bssId2":"f20d5602e444","rssi2":{"unit":"dB","value":-64},"scanAge":120}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
  • UNUSED
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
  • DATA_SCAN_COLLECTION
  • PROXIMITY_DETECTION
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
location.lat Number Latitude in decimal degrees.
location.lon Number Longitude in decimal degrees.
location.accuracy Number EHPE Estimated Horizontal Position Error (in meters), a measure of the error in a GPS position in the horizontal plane.
fixAge Number Age in seconds of the GPS location measure.
PayloadPosition with Wi-Fi BSSID
DescriptionUp to 4 <BSSID-RSSI> couples can be used transmitted. Note: the BSSID and RSSI values may or not be encrypted.
Example :
Input0348c77d0277b7111557c0060469662fb1ed419bdf1ab79057d302a59af0816aceb3
Output
{"battery":{"valueFirmwarePrev15":3.58,"value":3.9,"inCharge":false,"unit":"V"},"temperature":{"value":19.24,"unit":"°C"},"adt":"WIFI-BSSIDs","ack":0,"deviceModel":"MICRO","messageType":"POSITION","status":{"appMode":"permanentTrack","appState":"tracking","moving":false,"periodic":false,"onDemand":false,"userAlert":false},"bssId0":"b7111557c006","rssi0":{"unit":"dB","value":4},"bssId1":"69662fb1ed41","rssi1":{"unit":"dB","value":-101},"bssId2":"df1ab79057d3","rssi2":{"unit":"dB","value":2},"bssId3":"a59af0816ace","rssi3":{"unit":"dB","value":-77},"scanAge":952}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
  • UNUSED
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
  • DATA_SCAN_COLLECTION
  • PROXIMITY_DETECTION
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
location.lat Number Latitude in decimal degrees.
location.lon Number Longitude in decimal degrees.
location.accuracy Number EHPE Estimated Horizontal Position Error (in meters), a measure of the error in a GPS position in the horizontal plane.
scanAge Number Scan age (in seconds).
rssi.unit String Wifi signal strength unit (dB).
rssi.value Number Wifi signal strength. Can be used, associated with the BssId of same index, to compute a position.
rssi.unit String Wifi signal strength unit (dB).
rssi.value Number Wifi signal strength. Can be used, associated with the BssId of same index, to compute a position.
rssi.unit String Wifi signal strength unit (dB).
rssi.value Number Wifi signal strength. Can be used, associated with the BssId of same index, to compute a position.
rssi.unit String Wifi signal strength unit (dB).
rssi.value Number Wifi signal strength. Can be used, associated with the BssId of same index, to compute a position.
bssId0 String Wifi identifier 0.
bssId1 String Wifi identifier 1.
bssId2 String Wifi identifier 2.
bssId3 String Wifi identifier 3.
PayloadWifi Position failure
DescriptionIf a Wi-Fi error occurs, a serie of measures of the battery voltage during the attempt to run the Wi-Fi scan is reported.
Example :
Input034cc57e04ca9c9b9a999703
Output
{"battery":{"valueFirmwarePrev15":3.57,"value":3.88,"inCharge":false,"unit":"V"},"temperature":{"value":19.74,"unit":"°C"},"adt":"WIFI-FAILURE","ack":0,"deviceModel":"MASTER","messageType":"POSITION","status":{"appMode":"permanentTrack","appState":"tracking","moving":true,"periodic":false,"onDemand":false,"userAlert":false},"vBatT0":{"value":3.91,"unit":"V"},"vBatT0_500":{"value":3.66,"unit":"V"},"vBatT0_1000":{"value":3.65,"unit":"V"},"vBatT0_1500":{"value":3.65,"unit":"V"},"vBatT0_2000":{"value":3.64,"unit":"V"},"vBatT0_2500":{"value":3.63,"unit":"V"},"wifiError":"WIFI-NOT-SUPPORTED"}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
  • UNUSED
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
  • DATA_SCAN_COLLECTION
  • PROXIMITY_DETECTION
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
location.lat Number Latitude in decimal degrees.
location.lon Number Longitude in decimal degrees.
location.accuracy Number EHPE Estimated Horizontal Position Error (in meters), a measure of the error in a GPS position in the horizontal plane.
vBatT0.value Number Battery voltage value at T0.
vBatT0.unit String Unit : Volt
vBatT0_500.value Number Battery voltage value at T0+500 ms.
vBatT0_500.unit String Unit : Volt
vBatT0_1000.value Number Battery voltage value at T0+1000 ms.
vBatT0_1000.unit String Unit : Volt
vBatT0_1500.value Number Battery voltage value at T0+1500 ms.
vBatT0_1500.unit String Unit : Volt
vBatT0_2000.value Number Battery voltage value at T0+2000 ms.
vBatT0_2000.unit String Unit : Volt
vBatT0_2500.value Number Battery voltage value at T0+2500 ms.
vBatT0_2500.unit String Unit : Volt
wifiError String Wifi error. Values can be :
  • ANTENNA-UNAVAILABLE
  • SCAN-FAILURE
  • WIFI-CONNECTION-FAILURE
  • WIFI-NOT-SUPPORTED
PayloadPosition with Wi-Fi timeout
DescriptionIf a Wi-Fi timeout occurs, a serie of measures of the battery voltage during the attempt to run the Wi-Fi scan is reported.
Example :
Input034cc57e03ca9c9b9a9997
Output
{"battery":{"valueFirmwarePrev15":3.57,"value":3.88,"inCharge":false,"unit":"V"},"temperature":{"value":19.74,"unit":"°C"},"adt":"WIFI-TIMEOUT","ack":0,"deviceModel":"MASTER","messageType":"POSITION","status":{"appMode":"permanentTrack","appState":"tracking","moving":true,"periodic":false,"onDemand":false,"userAlert":false},"vBatT0":{"value":3.91,"unit":"V"},"vBatT0_500":{"value":3.66,"unit":"V"},"vBatT0_1000":{"value":3.65,"unit":"V"},"vBatT0_1500":{"value":3.65,"unit":"V"},"vBatT0_2000":{"value":3.64,"unit":"V"},"vBatT0_2500":{"value":3.63,"unit":"V"}}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
  • UNUSED
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
  • DATA_SCAN_COLLECTION
  • PROXIMITY_DETECTION
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
location.lat Number Latitude in decimal degrees.
location.lon Number Longitude in decimal degrees.
location.accuracy Number EHPE Estimated Horizontal Position Error (in meters), a measure of the error in a GPS position in the horizontal plane.
vBatT0.value Number Battery voltage value at T0.
vBatT0.unit String Unit : Volt
vBatT0_500.value Number Battery voltage value at T0+500 ms.
vBatT0_500.unit String Unit : Volt
vBatT0_1000.value Number Battery voltage value at T0+1000 ms.
vBatT0_1000.unit String Unit : Volt
vBatT0_1500.value Number Battery voltage value at T0+1500 ms.
vBatT0_1500.unit String Unit : Volt
vBatT0_2000.value Number Battery voltage value at T0+2000 ms.
vBatT0_2000.unit String Unit : Volt
vBatT0_2500.value Number Battery voltage value at T0+2500 ms.
vBatT0_2500.unit String Unit : Volt
wifiError String Wifi error. Values can be :
  • ANTENNA-UNAVAILABLE
  • SCAN-FAILURE
  • WIFI-CONNECTION-FAILURE
  • WIFI-NOT-SUPPORTED
PayloadWifi Position Without Ciphering
DescriptionUp to 4 <BSSID-RSSI> couples can be used transmitted. Note: the BSSID and RSSI values are not encrypted.
Example :
Input032cef8c090e00131a90b420cf024e2685f48cc5b04e2685f48cc4124e2685f48cc1
Output
{"battery":{"valueFirmwarePrev15":3.74,"value":4.12,"inCharge":false,"unit":"V"},"temperature":{"value":26.82,"unit":"°C"},"adt":"WIFI-BSSIDs-WITHOUT-CIPHERING","ack":0,"deviceModel":"MASTER","messageType":"POSITION","status":{"appMode":"motionTrack","appState":"tracking","moving":true,"periodic":false,"onDemand":false,"userAlert":false},"bssId0":"00131a90b420","rssi0":{"unit":"dB","value":-49},"bssId1":"024e2685f48c","rssi1":{"unit":"dB","value":-59},"bssId2":"b04e2685f48c","rssi2":{"unit":"dB","value":-60},"bssId3":"124e2685f48c","rssi3":{"unit":"dB","value":-63},"scanAge":112}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
  • UNUSED
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
  • DATA_SCAN_COLLECTION
  • PROXIMITY_DETECTION
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
location.lat Number Latitude in decimal degrees.
location.lon Number Longitude in decimal degrees.
location.accuracy Number EHPE Estimated Horizontal Position Error (in meters), a measure of the error in a GPS position in the horizontal plane.
scanAge Number Scan age (in seconds).
rssi.unit String Wifi signal strength unit (dB).
rssi.value Number Wifi signal strength. Can be used, associated with the BssId of same index, to compute a position.
rssi.unit String Wifi signal strength unit (dB).
rssi.value Number Wifi signal strength. Can be used, associated with the BssId of same index, to compute a position.
rssi.unit String Wifi signal strength unit (dB).
rssi.value Number Wifi signal strength. Can be used, associated with the BssId of same index, to compute a position.
rssi.unit String Wifi signal strength unit (dB).
rssi.value Number Wifi signal strength. Can be used, associated with the BssId of same index, to compute a position.
bssId0 String Wifi identifier 0.
bssId1 String Wifi identifier 1.
bssId2 String Wifi identifier 2.
bssId3 String Wifi identifier 3.
PayloadEnergy status
DescriptionHelps estimating the battery level by indicating the total (since boot) power consumption of most power greedy peripherals.
Example :
Input0420f2749000007c5a00041d910000005a
Output
{"battery":{"valueFirmwarePrev15":3.75,"value":4.13,"inCharge":false,"unit":"V"},"temperature":{"value":14.68,"unit":"°C"},"adt":"UNUSED","ack":9,"deviceModel":"MICRO","messageType":"ENERGY-STATUS","status":{"appMode":"motionTrack","appState":"idle","moving":false,"periodic":false,"onDemand":false,"userAlert":false},"gpsOnRuntime":{"value":31834,"unit":"s"},"gpsStandbyRuntime":{"value":269713,"unit":"s"},"wifiScanCount":90,"energyExpenseByHour":{"gpsOn":{"value":353.71,"unit":"mA"},"gpsOff":{"value":7492.03,"unit":"µA"},"wifi":{"value":7.5,"unit":"mA"}}}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
  • UNUSED
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be :
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
  • DATA_SCAN_COLLECTION
  • PROXIMITY_DETECTION
deviceModel String Device model. Values can be :
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
gpsOnRuntime.value Number Total time spent by the GPS in state ON since boot.
gpsOnRuntime.unit String In seconds.
gpsStandbyRuntime.value Number Total time spent by the GPS in STANDBY state since boot.
gpsStandbyRuntime.unit String In seconds.
gpsOnSection.value Number Energy expense by hour, for the GPSOn mode.
gpsOnSection.unit String In mA.
gpsOffSection.value Number Energy expense by hour, for the GPSOff mode.
gpsOffSection.unit String In µA.
wifiSection.value Number Energy expense by hour, for the WifiScan mode.
wifiSection.unit String In mA.
PayloadHeartbeat
DescriptionPeriodic minimal heartbeat message transmitted (only in idle mode).
Example :
Input056096850001010500020700
Output
{"battery":{"valueFirmwarePrev15":3.39,"value":3.62,"inCharge":false,"unit":"V"},"temperature":{"value":23.28,"unit":"°C"},"adt":"UNUSED","ack":0,"deviceModel":"MASTER","messageType":"HEARTBEAT","status":{"appMode":"motionStartEndTrack","appState":"idle","moving":false,"periodic":false,"onDemand":false,"userAlert":false},"resetCause":"POWER-ON-RESET","firmwareVersion":"1.5.0","bleFirmwareVersion":"2.7.0"}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
  • UNUSED
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
  • DATA_SCAN_COLLECTION
  • PROXIMITY_DETECTION
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
resetCause String Reset cause.
firmwareVersion String Firmware version (format = ..)
PayloadHeartbeat
DescriptionHeartbeat message with all reset cause messages
Example :
Input0520cc840040
Output
{"battery":{"valueFirmwarePrev15":3.6,"value":3.92,"inCharge":false,"unit":"V"},"temperature":{"value":22.78,"unit":"°C"},"adt":"UNUSED","ack":0,"deviceModel":"MASTER","messageType":"HEARTBEAT","status":{"appMode":"motionTrack","appState":"idle","moving":false,"periodic":false,"onDemand":false,"userAlert":false},"resetCause":"SYSTEM-REQUEST-RESET"}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
  • UNUSED
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
  • DATA_SCAN_COLLECTION
  • PROXIMITY_DETECTION
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
resetCause String Reset cause.
firmwareVersion String Firmware version (format = ..)
PayloadOther tests
DescriptionActivity, Shock Detection, Event ....
Example :
Input0A80b4830002000100020003
Output
{"battery":{"valueFirmwarePrev15":3.51,"value":3.79,"inCharge":false,"unit":"V"},"temperature":{"value":22.27,"unit":"°C"},"axis_z":3,"adt":"UNUSED","ack":0,"deviceModel":"MASTER","messageType":"EVENT","status":{"appMode":"activityTrack","appState":"idle","moving":false,"periodic":false,"onDemand":false,"userAlert":false},"eventValue":"MOTION-END","trackerOrientationData":{"unit":"mG","axisX":1,"axisY":2,"axisZ":3}}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
  • UNUSED
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
  • DATA_SCAN_COLLECTION
  • PROXIMITY_DETECTION
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
typeValue String Type value. Possible items can be :
  • ACTIVITY-COUNTER
activityCounter Number Activity counter for the tracker.
configParam0 String Configuration parameter 0.
valueParam0 String Configuration value 0 (string value).
configParam1 String Configuration parameter 1.
valueParam1 String Configuration value 1 (string value).
configParam2 String Configuration parameter 2.
valueParam2 String Configuration value 2 (string value).
configParam3 String Configuration parameter 3.
valueParam3 String Configuration value 3 (string value).
configParam4 String Configuration parameter 4.
valueParam4 String Configuration value 4 (string value).
PayloadMisc
DescriptionMiscellaneous data message.
Example :
Input074cf882e00301fab6ff2b0161
Output
{"battery":{"valueFirmwarePrev15":3.78,"value":4.17,"inCharge":false,"unit":"V"},"temperature":{"value":21.76,"unit":"°C"},"adt":"UNUSED","ack":14,"deviceModel":"UNKNOWN","messageType":"MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)","status":{"appMode":"permanentTrack","appState":"tracking","moving":true,"periodic":false,"onDemand":false,"userAlert":false},"typeValue":"SHOCK-DETECTION","numberShocksBeyondThresholds":1,"accelerometerShockData":{"unit":"mG","axisX":-1354,"axisY":-213,"axisZ":353}}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
  • UNUSED
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
  • DATA_SCAN_COLLECTION
  • PROXIMITY_DETECTION
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
typeValue String Type value. Possible items can be :
  • ACTIVITY-COUNTER
activityCounter Number Activity counter for the tracker.
configParam0 String Configuration parameter 0.
valueParam0 String Configuration value 0 (string value).
configParam1 String Configuration parameter 1.
valueParam1 String Configuration value 1 (string value).
configParam2 String Configuration parameter 2.
valueParam2 String Configuration value 2 (string value).
configParam3 String Configuration parameter 3.
valueParam3 String Configuration value 3 (string value).
configParam4 String Configuration parameter 4.
valueParam4 String Configuration value 4 (string value).
PayloadShutdown
DescriptionShutdown message.
Example :
Input09a049820003
Output
{"battery":{"valueFirmwarePrev15":3.08,"value":3.2,"inCharge":false,"unit":"V"},"temperature":{"value":21.76,"unit":"°C"},"adt":"UNUSED","ack":0,"deviceModel":"MICRO","messageType":"SHUTDOWN","status":{"appMode":"off","appState":"idle","moving":false,"periodic":false,"onDemand":false,"userAlert":false},"shutdownCause":"BLE-REQUEST"}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
  • UNUSED
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
  • DATA_SCAN_COLLECTION
  • PROXIMITY_DETECTION
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
shutdownCause String Shutdown cause. Values can be
  • USER-ACTION
  • LOW-BATTERY
  • DOWNLINK-REQUEST
PayloadData Scan Collection
DescriptionFor devices with firmware version greater than 2.1
Example :
Input0b2a629001410335adb26cac19cb3dad906cac19cb3dab84a06e97cfb6ab020c42ab3a3d
Output
{"battery":{"value":98,"unit":"%","inCharge":false,"measureInError":false},"temperature":{"value":28.85,"unit":"°C"},"adt":"UNUSED","ack":0,"deviceModel":"MASTER","messageType":"DATA_SCAN_COLLECTION","status":{"appMode":"motionTrack","appState":"tracking","moving":false,"periodic":true,"onDemand":false,"userAlert":false},"scanCollection":{"type":"WIFI_BSSIDs","fragmentId":1,"format":"MAC_ADDRESS","moreData":false,"collectionId":3,"hash":53},"macAdr0":"b26cac19cb3d","rssi0":{"unit":"dB","value":-83},"macAdr1":"906cac19cb3d","rssi1":{"unit":"dB","value":-83},"macAdr2":"84a06e97cfb6","rssi2":{"unit":"dB","value":-85},"macAdr3":"020c42ab3a3d","rssi3":{"unit":"dB","value":-85}}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
  • UNUSED
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
  • DATA_SCAN_COLLECTION
  • PROXIMITY_DETECTION
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
scanCollection.type String Data Type. Value can be :
  • BLE-BEACON-SCAN
  • WIFI_BSSIDs
scanCollection.fragmentId Number Fragment identifier (0, for the first one)
scanCollection.format String Data format. Value can be :
  • BEACON_ID
  • MAC_ADDRESS
scanCollection.moreData boolean Boolean field, which specifies whether the data collection is complete or not. Value = true, if another associated uplink will follow.
scanCollection.collectionId Number Collection identifier. Unique number ranging from 0-255, indicating the collection number. It starts at 0 and is incremented for each new collection. All fragments have the same collection identifier.
scanCollection.hash Number This field is the hash of the associated position message. Hash is the xor sum on the whole position message (including the payload header). All fragments have the same hash.
rssi0 Rssi Receive Signal Strength Indication for the 0 beacon.
rssi.unit String Received signal strength unit (dB).
rssi.value Number Receive Signal Strength Indication for the beacon.
rssi1 Rssi Receive Signal Strength Indication for the 1 beacon.
rssi.unit String Received signal strength unit (dB).
rssi.value Number Receive Signal Strength Indication for the beacon.
rssi2 Rssi Receive Signal Strength Indication for the 2 beacon.
rssi.unit String Received signal strength unit (dB).
rssi.value Number Receive Signal Strength Indication for the beacon.
rssi3 Rssi Receive Signal Strength Indication for the 3 beacon.
rssi.unit String Received signal strength unit (dB).
rssi.value Number Receive Signal Strength Indication for the beacon.
macAdr0 String Mac address of the 0 beacon.
macAdr1 String Mac address of the 1 beacon.
macAdr2 String Mac address of the 2 beacon.
macAdr3 String Mac address of the 3 beacon.
beaconId0 String 0 beacon id. Big endian format (two last bytes of the ID)
beaconId1 String 1 beacon id. Big endian format (two last bytes of the ID)
beaconId2 String 2 beacon id. Big endian format (two last bytes of the ID)
beaconId3 String 3 beacon id. Big endian format (two last bytes of the ID)

ABEEWAY-AssetTracker

Product(s) version :
fw:1.7.0

Orange decoder : abeeway_tracker_v1.2
Developer : Orange

PayloadFramePending
DescriptionFrame Pending
Example :
Input000a
Output
{"ack":10,"deviceModel":"MASTER","messageType":"FRAME-PENDING"}
Output json fields :
Fields
nametypedescription
ack Number Acknowledgement token is sent to trigger the sending of additional messages.
messageType String Message type. Values can be :
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • OTHER
  • SHUTDOWN
  • DEBUG
deviceModel String Device model. Values can be :
  • MASTER
  • MICRO
  • UNKNOWN
PayloadPosition BLE beacon scan
DescriptionPosition BLE beacon scan
Example :
Input032cf2719926140c76764fd9adf20d5602e447a6083e5d85e42ca6f20d5602e446a1
Output
{"battery":{"valueFirmwarePrev15":3.75,"value":4.13,"inCharge":false,"unit":"V"},"temperature":{"value":13.16,"unit":"°C"},"adt":"WIFI-BSSIDs-WITHOUT-CIPHERING","ack":9,"deviceModel":"MASTER","messageType":"POSITION","status":{"appMode":"motionTrack","appState":"tracking","moving":true,"periodic":false,"onDemand":false,"userAlert":false},"bssId0":"140c76764fd9","rssi0":{"unit":"dB","value":-83},"bssId1":"f20d5602e447","rssi1":{"unit":"dB","value":-90},"bssId2":"083e5d85e42c","rssi2":{"unit":"dB","value":-90},"bssId3":"f20d5602e446","rssi3":{"unit":"dB","value":-95},"scanAge":304}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A-GPS-DATA
  • A-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be :
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • OTHER
  • SHUTDOWN
  • DEBUG
deviceModel String Device model. Values can be :
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
scanAge Number Scan age (in seconds).
rssi.unit String Received signal strength unit (dB).
rssi.value Number Receive Signal Strength Indication for the beacon.
rssi.unit String Received signal strength unit (dB).
rssi.value Number Receive Signal Strength Indication for the beacon.
rssi.unit String Received signal strength unit (dB).
rssi.value Number Receive Signal Strength Indication for the beacon.
rssi.unit String Received signal strength unit (dB).
rssi.value Number Receive Signal Strength Indication for the beacon.
macAdr0 String Mac address of the 0 beacon.
macAdr1 String Mac address of the 1 beacon.
macAdr2 String Mac address of the 2 beacon.
macAdr3 String Mac address of the 3 beacon.
PayloadPosition BLE failure
DescriptionPosition BLE failure
Example :
Input036c99880805
Output
{"battery":{"valueFirmwarePrev15":3.4,"value":3.64,"inCharge":false,"unit":"V"},"temperature":{"value":24.8,"unit":"°C"},"adt":"BLE-BEACON-FAILURE","ack":0,"deviceModel":"MASTER","messageType":"POSITION","status":{"appMode":"motionStartEndTrack","appState":"tracking","moving":true,"periodic":false,"onDemand":false,"userAlert":false}}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A-GPS-DATA
  • A-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be :
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • OTHER
  • SHUTDOWN
  • DEBUG
deviceModel String Device model. Values can be :
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
bleError String BLE error. Values can be :
  • BLE-NOT-RESPONDING
  • INTERNAL-ERROR
  • SHARED-ANTENNA-NOT-AVAILABLE
  • SCAN-ALREADY-GOING
  • BLE-BUSY
  • NO-BEACON-DETECTED
  • HARDWARE-INCOMPATIBLITY
PayloadPosition GPS timeout
DescriptionPosition GPS timeout. The tracker was not able to compute a GPS position on time.The unability to find a fix on time is always related to bad GPS signal (indoor/urban/cloudy environment),but the software timeout can be hit by various events.
Example :
Input032cc983010100000000
Output
{"battery":{"valueFirmwarePrev15":3.59,"value":3.91,"inCharge":false,"unit":"V"},"temperature":{"value":22.27,"unit":"°C"},"cn0":0,"cn1":0,"cn2":0,"cn3":0,"adt":"GPS-TIMEOUT","ack":0,"deviceModel":"MICRO","messageType":"POSITION","status":{"appMode":"motionTrack","appState":"tracking","moving":true,"periodic":false,"onDemand":false,"userAlert":false},"timeoutCause":"PREEMPT-CONDITION-0"}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A-GPS-DATA
  • A-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be :
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • OTHER
  • SHUTDOWN
  • DEBUG
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
fixAge Number Age in seconds of the GPS location measure.
cn0 Number The carrier-to-noise density ratio (C/N) used to show the signal strength and quality for the best 4 satellites.
cn1 Number
cn2 Number
cn3 Number
timeoutCause String The GPS timeout cause. Values can be
  • USER-TIMEOUT : the GPS was not able to compute a fix before the position message period,
  • PREEMPT-CONDITION-0 : the geoloc engine was configured to preempt the GPS scan before the user timeout,
    in case the GPS signal is too weak.
  • PREEMPT-CONDITION-1 : idem
PayloadPosition on demand
DescriptionPosition on demand
Example :
Input032a957e790f7cb73388d2ace1d8d7759cee90d6f20d5602e444c0
Output
{"battery":{"valueFirmwarePrev15":3.38,"value":3.62,"inCharge":false,"unit":"V"},"temperature":{"value":19.74,"unit":"°C"},"adt":"WIFI-BSSIDs-WITHOUT-CIPHERING","ack":7,"deviceModel":"MASTER","messageType":"POSITION","status":{"appMode":"motionTrack","appState":"tracking","moving":false,"periodic":true,"onDemand":false,"userAlert":false},"bssId0":"7cb73388d2ac","rssi0":{"unit":"dB","value":-31},"bssId1":"d8d7759cee90","rssi1":{"unit":"dB","value":-42},"bssId2":"f20d5602e444","rssi2":{"unit":"dB","value":-64},"scanAge":120}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A-GPS-DATA
  • A-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be :
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • OTHER
  • SHUTDOWN
  • DEBUG
deviceModel String Device model. Values can be :
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
location.lat Number Latitude in decimal degrees.
location.lon Number Longitude in decimal degrees.
location.accuracy Number EHPE Estimated Horizontal Position Error (in meters), a measure of the error in a GPS position in the horizontal plane.
fixAge Number Age in seconds of the GPS location measure.
PayloadPosition with Wi-Fi BSSID
DescriptionPosition with Wi-Fi BSSID. Up to 4 <BSSID-RSSI> couples can be used transmitted. Note: the BSSID and RSSI values may or not be encrypted.
Example :
Input0348c77d0277b7111557c0060469662fb1ed419bdf1ab79057d302a59af0816aceb3
Output
{"battery":{"valueFirmwarePrev15":3.58,"value":3.9,"inCharge":false,"unit":"V"},"temperature":{"value":19.24,"unit":"°C"},"adt":"WIFI-BSSIDs","ack":0,"deviceModel":"MICRO","messageType":"POSITION","status":{"appMode":"permanentTrack","appState":"tracking","moving":false,"periodic":false,"onDemand":false,"userAlert":false},"bssId0":"b7111557c006","rssi0":{"unit":"dB","value":4},"bssId1":"69662fb1ed41","rssi1":{"unit":"dB","value":-101},"bssId2":"df1ab79057d3","rssi2":{"unit":"dB","value":2},"bssId3":"a59af0816ace","rssi3":{"unit":"dB","value":-77},"scanAge":952}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A-GPS-DATA
  • A-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be :
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • OTHER
  • SHUTDOWN
  • DEBUG
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
location.lat Number Latitude in decimal degrees.
location.lon Number Longitude in decimal degrees.
location.accuracy Number EHPE Estimated Horizontal Position Error (in meters), a measure of the error in a GPS position in the horizontal plane.
scanAge Number Scan age (in seconds).
rssi.unit String Wifi signal strength unit (dB).
rssi.value Number Wifi signal strength. Can be used, associated with the BssId of same index, to compute a position.
rssi.unit String Wifi signal strength unit (dB).
rssi.value Number Wifi signal strength. Can be used, associated with the BssId of same index, to compute a position.
rssi.unit String Wifi signal strength unit (dB).
rssi.value Number Wifi signal strength. Can be used, associated with the BssId of same index, to compute a position.
rssi.unit String Wifi signal strength unit (dB).
rssi.value Number Wifi signal strength. Can be used, associated with the BssId of same index, to compute a position.
bssId0 String Wifi identifier 0.
bssId1 String Wifi identifier 1.
bssId2 String Wifi identifier 2.
bssId3 String Wifi identifier 3.
PayloadPosition with Wifi position failure
DescriptionPosition with Wifi position failure. If a Wi-Fi error occurs, a serie of measures of the battery voltage during the attempt to run the Wi-Fi scan is reported.
Example :
Input034cc57e04ca9c9b9a999703
Output
{"battery":{"valueFirmwarePrev15":3.57,"value":3.88,"inCharge":false,"unit":"V"},"temperature":{"value":19.74,"unit":"°C"},"adt":"WIFI-FAILURE","ack":0,"deviceModel":"MASTER","messageType":"POSITION","status":{"appMode":"permanentTrack","appState":"tracking","moving":true,"periodic":false,"onDemand":false,"userAlert":false},"vBatT0":{"value":3.91,"unit":"V"},"vBatT0_500":{"value":3.66,"unit":"V"},"vBatT0_1000":{"value":3.65,"unit":"V"},"vBatT0_1500":{"value":3.65,"unit":"V"},"vBatT0_2000":{"value":3.64,"unit":"V"},"vBatT0_2500":{"value":3.63,"unit":"V"},"wifiError":"WIFI-NOT-SUPPORTED"}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A-GPS-DATA
  • A-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be :
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • OTHER
  • SHUTDOWN
  • DEBUG
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
location.lat Number Latitude in decimal degrees.
location.lon Number Longitude in decimal degrees.
location.accuracy Number EHPE Estimated Horizontal Position Error (in meters), a measure of the error in a GPS position in the horizontal plane.
vBatT0.value Number Battery voltage value at T0.
vBatT0.unit String Unit : Volt
vBatT0_500.value Number Battery voltage value at T0+500 ms.
vBatT0_500.unit String Unit : Volt
vBatT0_1000.value Number Battery voltage value at T0+1000 ms.
vBatT0_1000.unit String Unit : Volt
vBatT0_1500.value Number Battery voltage value at T0+1500 ms.
vBatT0_1500.unit String Unit : Volt
vBatT0_2000.value Number Battery voltage value at T0+2000 ms.
vBatT0_2000.unit String Unit : Volt
vBatT0_2500.value Number Battery voltage value at T0+2500 ms.
vBatT0_2500.unit String Unit : Volt
wifiError String Wifi error. Values can be :
  • ANTENNA-UNAVAILABLE
  • SCAN-FAILURE
  • WIFI-CONNECTION-FAILURE
  • WIFI-NOT-SUPPORTED
PayloadPosition with Wi-Fi timeout
DescriptionPosition with Wi-Fi timeout. If a Wi-Fi timeout occurs, a serie of measures of the battery voltage during the attempt to run the Wi-Fi scan is reported.
Example :
Input034cc57e03ca9c9b9a9997
Output
{"battery":{"valueFirmwarePrev15":3.57,"value":3.88,"inCharge":false,"unit":"V"},"temperature":{"value":19.74,"unit":"°C"},"adt":"WIFI-TIMEOUT","ack":0,"deviceModel":"MASTER","messageType":"POSITION","status":{"appMode":"permanentTrack","appState":"tracking","moving":true,"periodic":false,"onDemand":false,"userAlert":false},"vBatT0":{"value":3.91,"unit":"V"},"vBatT0_500":{"value":3.66,"unit":"V"},"vBatT0_1000":{"value":3.65,"unit":"V"},"vBatT0_1500":{"value":3.65,"unit":"V"},"vBatT0_2000":{"value":3.64,"unit":"V"},"vBatT0_2500":{"value":3.63,"unit":"V"}}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A-GPS-DATA
  • A-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be :
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • OTHER
  • SHUTDOWN
  • DEBUG
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
location.lat Number Latitude in decimal degrees.
location.lon Number Longitude in decimal degrees.
location.accuracy Number EHPE Estimated Horizontal Position Error (in meters), a measure of the error in a GPS position in the horizontal plane.
vBatT0.value Number Battery voltage value at T0.
vBatT0.unit String Unit : Volt
vBatT0_500.value Number Battery voltage value at T0+500 ms.
vBatT0_500.unit String Unit : Volt
vBatT0_1000.value Number Battery voltage value at T0+1000 ms.
vBatT0_1000.unit String Unit : Volt
vBatT0_1500.value Number Battery voltage value at T0+1500 ms.
vBatT0_1500.unit String Unit : Volt
vBatT0_2000.value Number Battery voltage value at T0+2000 ms.
vBatT0_2000.unit String Unit : Volt
vBatT0_2500.value Number Battery voltage value at T0+2500 ms.
vBatT0_2500.unit String Unit : Volt
wifiError String Wifi error. Values can be :
  • ANTENNA-UNAVAILABLE
  • SCAN-FAILURE
  • WIFI-CONNECTION-FAILURE
  • WIFI-NOT-SUPPORTED
PayloadPosition with Wifi position without ciphering
DescriptionPosition with Wifi position without ciphering. Up to 4 <BSSID-RSSI> couples can be used transmitted. Note: the BSSID and RSSI values are not encrypted.
Example :
Input032cef8c090e00131a90b420cf024e2685f48cc5b04e2685f48cc4124e2685f48cc1
Output
{"battery":{"valueFirmwarePrev15":3.74,"value":4.12,"inCharge":false,"unit":"V"},"temperature":{"value":26.82,"unit":"°C"},"adt":"WIFI-BSSIDs-WITHOUT-CIPHERING","ack":0,"deviceModel":"MASTER","messageType":"POSITION","status":{"appMode":"motionTrack","appState":"tracking","moving":true,"periodic":false,"onDemand":false,"userAlert":false},"bssId0":"00131a90b420","rssi0":{"unit":"dB","value":-49},"bssId1":"024e2685f48c","rssi1":{"unit":"dB","value":-59},"bssId2":"b04e2685f48c","rssi2":{"unit":"dB","value":-60},"bssId3":"124e2685f48c","rssi3":{"unit":"dB","value":-63},"scanAge":112}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A-GPS-DATA
  • A-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be :
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • OTHER
  • SHUTDOWN
  • DEBUG
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
location.lat Number Latitude in decimal degrees.
location.lon Number Longitude in decimal degrees.
location.accuracy Number EHPE Estimated Horizontal Position Error (in meters), a measure of the error in a GPS position in the horizontal plane.
scanAge Number Scan age (in seconds).
rssi.unit String Wifi signal strength unit (dB).
rssi.value Number Wifi signal strength. Can be used, associated with the BssId of same index, to compute a position.
rssi.unit String Wifi signal strength unit (dB).
rssi.value Number Wifi signal strength. Can be used, associated with the BssId of same index, to compute a position.
rssi.unit String Wifi signal strength unit (dB).
rssi.value Number Wifi signal strength. Can be used, associated with the BssId of same index, to compute a position.
rssi.unit String Wifi signal strength unit (dB).
rssi.value Number Wifi signal strength. Can be used, associated with the BssId of same index, to compute a position.
bssId0 String Wifi identifier 0.
bssId1 String Wifi identifier 1.
bssId2 String Wifi identifier 2.
bssId3 String Wifi identifier 3.
PayloadEnergy status
DescriptionEnergy status. Helps estimating the battery level by indicating the total (since boot) power consumption of most power greedy peripherals.
Example :
Input0420f2749000007c5a00041d910000005a
Output
{"battery":{"valueFirmwarePrev15":3.75,"value":4.13,"inCharge":false,"unit":"V"},"temperature":{"value":14.68,"unit":"°C"},"adt":"UNUSED","ack":9,"deviceModel":"MICRO","messageType":"ENERGY-STATUS","status":{"appMode":"motionTrack","appState":"idle","moving":false,"periodic":false,"onDemand":false,"userAlert":false},"gpsOnRuntime":{"value":31834,"unit":"s"},"gpsStandbyRuntime":{"value":269713,"unit":"s"},"wifiScanCount":90,"energyExpenseByHour":{"gpsOn":{"value":353.71,"unit":"mA"},"gpsOff":{"value":7492.03,"unit":"µA"},"wifi":{"value":7.5,"unit":"mA"}}}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A-GPS-DATA
  • A-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • OTHER
  • SHUTDOWN
  • DEBUG
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
gpsOnRuntime.value Number Total time spent by the GPS in state ON since boot.
gpsOnRuntime.unit String In seconds.
gpsStandbyRuntime.value Number Total time spent by the GPS in STANDBY state since boot.
gpsStandbyRuntime.unit String In seconds.
gpsOnSection.value Number Energy expense by hour, for the GPSOn mode.
gpsOnSection.unit String In mA.
gpsOffSection.value Number Energy expense by hour, for the GPSOff mode.
gpsOffSection.unit String In µA.
wifiSection.value Number Energy expense by hour, for the WifiScan mode.
wifiSection.unit String In mA.
PayloadHeartbeat
DescriptionHeartbeat. Periodic minimal heartbeat message transmitted (only in idle mode).
Example :
Input056096850001010500020700
Output
{"battery":{"valueFirmwarePrev15":3.39,"value":3.62,"inCharge":false,"unit":"V"},"temperature":{"value":23.28,"unit":"°C"},"adt":"UNUSED","ack":0,"deviceModel":"MASTER","messageType":"HEARTBEAT","status":{"appMode":"motionStartEndTrack","appState":"idle","moving":false,"periodic":false,"onDemand":false,"userAlert":false},"resetCause":"POWER-ON-RESET","firmwareVersion":"1.5.0"}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A-GPS-DATA
  • A-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be :
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • OTHER
  • SHUTDOWN
  • DEBUG
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
resetCause String Reset cause.
firmwareVersion String Firmware version (format = ..)
PayloadMisc
DescriptionMiscellaneous data message.
Example :
Input074cf882e00301fab6ff2b0161
Output
{"battery":{"valueFirmwarePrev15":3.78,"value":4.17,"inCharge":false,"unit":"V"},"temperature":{"value":21.76,"unit":"°C"},"adt":"UNUSED","ack":14,"deviceModel":"UNKNOWN","messageType":"MISC","status":{"appMode":"permanentTrack","appState":"tracking","moving":true,"periodic":false,"onDemand":false,"userAlert":false},"typeValue":"UNKNOWN"}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A-GPS-DATA
  • A-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be :
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • OTHER
  • SHUTDOWN
  • DEBUG
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
typeValue String Type value. Possible items can be :
  • ACTIVITY-COUNTER
activityCounter Number Activity counter for the tracker.
configParam0 String Configuration parameter 0.
valueParam0 String Configuration value 0 (string value).
configParam1 String Configuration parameter 1.
valueParam1 String Configuration value 1 (string value).
configParam2 String Configuration parameter 2.
valueParam2 String Configuration value 2 (string value).
configParam3 String Configuration parameter 3.
valueParam3 String Configuration value 3 (string value).
configParam4 String Configuration parameter 4.
valueParam4 String Configuration value 4 (string value).
PayloadShutdown
DescriptionShutdown message
Example :
Input09a049820003
Output
{"battery":{"valueFirmwarePrev15":3.08,"value":3.2,"inCharge":false,"unit":"V"},"temperature":{"value":21.76,"unit":"°C"},"adt":"UNUSED","ack":0,"deviceModel":"MICRO","messageType":"SHUTDOWN","status":{"appMode":"off","appState":"idle","moving":false,"periodic":false,"onDemand":false,"userAlert":false},"shutdownCause":""}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-TIMEOUT
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be :
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • OTHER
  • SHUTDOWN
  • DEBUG
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
shutdownCause String Shutdown cause. Values can be
  • USER-ACTION
  • LOW-BATTERY
  • DOWNLINK-REQUEST

ABEEWAY-AssetTracker

Product(s) version :
fw:1.8.0

Orange decoder : abeeway_tracker_v1.3
Developer : Orange

PayloadFramePending
DescriptionFrame Pending.
Example :
Input000a
Output
{"ack":10,"deviceModel":"MASTER","messageType":"FRAME-PENDING"}
Output json fields :
Fields
nametypedescription
ack Number Acknowledgement token is sent to trigger the sending of additional messages.
messageType String Message type. Values can be :
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
deviceModel String Device model. Values can be :
  • MASTER
  • MICRO
  • UNKNOWN
PayloadPosition
DescriptionBLE beacon scan.
Example :
Input032cf2719926140c76764fd9adf20d5602e447a6083e5d85e42ca6f20d5602e446a1
Output
{"battery":{"valueFirmwarePrev15":3.75,"value":4.13,"inCharge":false,"unit":"V"},"temperature":{"value":13.16,"unit":"°C"},"adt":"WIFI-BSSIDs-WITHOUT-CIPHERING","ack":9,"deviceModel":"MASTER","messageType":"POSITION","status":{"appMode":"motionTrack","appState":"tracking","moving":true,"periodic":false,"onDemand":false,"userAlert":false},"bssId0":"140c76764fd9","rssi0":{"unit":"dB","value":-83},"bssId1":"f20d5602e447","rssi1":{"unit":"dB","value":-90},"bssId2":"083e5d85e42c","rssi2":{"unit":"dB","value":-90},"bssId3":"f20d5602e446","rssi3":{"unit":"dB","value":-95},"scanAge":304}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
scanAge Number Scan age (in seconds).
rssi.unit String Received signal strength unit (dB).
rssi.value Number Receive Signal Strength Indication for the beacon.
rssi.unit String Received signal strength unit (dB).
rssi.value Number Receive Signal Strength Indication for the beacon.
rssi.unit String Received signal strength unit (dB).
rssi.value Number Receive Signal Strength Indication for the beacon.
rssi.unit String Received signal strength unit (dB).
rssi.value Number Receive Signal Strength Indication for the beacon.
macAdr0 String Mac address of the 0 beacon.
macAdr1 String Mac address of the 1 beacon.
macAdr2 String Mac address of the 2 beacon.
macAdr3 String Mac address of the 3 beacon.
PayloadPosition
DescriptionBLE failure.
Example :
Input036c99880805
Output
{"battery":{"valueFirmwarePrev15":3.4,"value":3.64,"inCharge":false,"unit":"V"},"temperature":{"value":24.8,"unit":"°C"},"adt":"BLE-BEACON-FAILURE","ack":0,"deviceModel":"MASTER","messageType":"POSITION","status":{"appMode":"motionStartEndTrack","appState":"tracking","moving":true,"periodic":false,"onDemand":false,"userAlert":false},"bleError":"NO-BEACON-DETECTED"}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
bleError String BLE error. Values can be :
  • BLE-NOT-RESPONDING
  • INTERNAL-ERROR
  • SHARED-ANTENNA-NOT-AVAILABLE
  • SCAN-ALREADY-GOING
  • BLE-BUSY
  • NO-BEACON-DETECTED
  • HARDWARE-INCOMPATIBLITY
PayloadGPS timeout
Descriptionthe tracker was not able to compute a GPS position on time.The unability to find a fix on time is always related to bad GPS signal (indoor/urban/cloudy environment),but the software timeout can be hit by various events.
Example :
Input032cc983010100000000
Output
{"battery":{"valueFirmwarePrev15":3.59,"value":3.91,"inCharge":false,"unit":"V"},"temperature":{"value":22.27,"unit":"°C"},"cn0":0,"cn1":0,"cn2":0,"cn3":0,"adt":"GPS-TIMEOUT","ack":0,"deviceModel":"MICRO","messageType":"POSITION","status":{"appMode":"motionTrack","appState":"tracking","moving":true,"periodic":false,"onDemand":false,"userAlert":false},"timeoutCause":"PREEMPT-CONDITION-0"}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
fixAge Number Age in seconds of the GPS location measure.
cn0 Number The carrier-to-noise density ratio (C/N) used to show the signal strength and quality for the best 4 satellites.
cn1 Number
cn2 Number
cn3 Number
timeoutCause String The GPS timeout cause. Values can be
  • USER-TIMEOUT : the GPS was not able to compute a fix before the position message period,
  • PREEMPT-CONDITION-0 : the geoloc engine was configured to preempt the GPS scan before the user timeout,
    in case the GPS signal is too weak.
  • PREEMPT-CONDITION-1 : idem
PayloadPosition
DescriptionPosition on demand.
Example :
Input032a957e790f7cb73388d2ace1d8d7759cee90d6f20d5602e444c0
Output
{"battery":{"valueFirmwarePrev15":3.38,"value":3.62,"inCharge":false,"unit":"V"},"temperature":{"value":19.74,"unit":"°C"},"adt":"WIFI-BSSIDs-WITHOUT-CIPHERING","ack":7,"deviceModel":"MASTER","messageType":"POSITION","status":{"appMode":"motionTrack","appState":"tracking","moving":false,"periodic":true,"onDemand":false,"userAlert":false},"bssId0":"7cb73388d2ac","rssi0":{"unit":"dB","value":-31},"bssId1":"d8d7759cee90","rssi1":{"unit":"dB","value":-42},"bssId2":"f20d5602e444","rssi2":{"unit":"dB","value":-64},"scanAge":120}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
location.lat Number Latitude in decimal degrees.
location.lon Number Longitude in decimal degrees.
location.accuracy Number EHPE Estimated Horizontal Position Error (in meters), a measure of the error in a GPS position in the horizontal plane.
fixAge Number Age in seconds of the GPS location measure.
PayloadPosition with Wi-Fi BSSID
DescriptionUp to 4 <BSSID-RSSI> couples can be used transmitted. Note: the BSSID and RSSI values may or not be encrypted.
Example :
Input0348c77d0277b7111557c0060469662fb1ed419bdf1ab79057d302a59af0816aceb3
Output
{"battery":{"valueFirmwarePrev15":3.58,"value":3.9,"inCharge":false,"unit":"V"},"temperature":{"value":19.24,"unit":"°C"},"adt":"WIFI-BSSIDs","ack":0,"deviceModel":"MICRO","messageType":"POSITION","status":{"appMode":"permanentTrack","appState":"tracking","moving":false,"periodic":false,"onDemand":false,"userAlert":false},"bssId0":"b7111557c006","rssi0":{"unit":"dB","value":4},"bssId1":"69662fb1ed41","rssi1":{"unit":"dB","value":-101},"bssId2":"df1ab79057d3","rssi2":{"unit":"dB","value":2},"bssId3":"a59af0816ace","rssi3":{"unit":"dB","value":-77},"scanAge":952}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
location.lat Number Latitude in decimal degrees.
location.lon Number Longitude in decimal degrees.
location.accuracy Number EHPE Estimated Horizontal Position Error (in meters), a measure of the error in a GPS position in the horizontal plane.
scanAge Number Scan age (in seconds).
rssi.unit String Wifi signal strength unit (dB).
rssi.value Number Wifi signal strength. Can be used, associated with the BssId of same index, to compute a position.
rssi.unit String Wifi signal strength unit (dB).
rssi.value Number Wifi signal strength. Can be used, associated with the BssId of same index, to compute a position.
rssi.unit String Wifi signal strength unit (dB).
rssi.value Number Wifi signal strength. Can be used, associated with the BssId of same index, to compute a position.
rssi.unit String Wifi signal strength unit (dB).
rssi.value Number Wifi signal strength. Can be used, associated with the BssId of same index, to compute a position.
bssId0 String Wifi identifier 0.
bssId1 String Wifi identifier 1.
bssId2 String Wifi identifier 2.
bssId3 String Wifi identifier 3.
PayloadWifi Position failure
DescriptionIf a Wi-Fi error occurs, a serie of measures of the battery voltage during the attempt to run the Wi-Fi scan is reported.
Example :
Input034cc57e04ca9c9b9a999703
Output
{"battery":{"valueFirmwarePrev15":3.57,"value":3.88,"inCharge":false,"unit":"V"},"temperature":{"value":19.74,"unit":"°C"},"adt":"WIFI-FAILURE","ack":0,"deviceModel":"MASTER","messageType":"POSITION","status":{"appMode":"permanentTrack","appState":"tracking","moving":true,"periodic":false,"onDemand":false,"userAlert":false},"vBatT0":{"value":3.91,"unit":"V"},"vBatT0_500":{"value":3.66,"unit":"V"},"vBatT0_1000":{"value":3.65,"unit":"V"},"vBatT0_1500":{"value":3.65,"unit":"V"},"vBatT0_2000":{"value":3.64,"unit":"V"},"vBatT0_2500":{"value":3.63,"unit":"V"},"wifiError":"WIFI-NOT-SUPPORTED"}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
location.lat Number Latitude in decimal degrees.
location.lon Number Longitude in decimal degrees.
location.accuracy Number EHPE Estimated Horizontal Position Error (in meters), a measure of the error in a GPS position in the horizontal plane.
vBatT0.value Number Battery voltage value at T0.
vBatT0.unit String Unit : Volt
vBatT0_500.value Number Battery voltage value at T0+500 ms.
vBatT0_500.unit String Unit : Volt
vBatT0_1000.value Number Battery voltage value at T0+1000 ms.
vBatT0_1000.unit String Unit : Volt
vBatT0_1500.value Number Battery voltage value at T0+1500 ms.
vBatT0_1500.unit String Unit : Volt
vBatT0_2000.value Number Battery voltage value at T0+2000 ms.
vBatT0_2000.unit String Unit : Volt
vBatT0_2500.value Number Battery voltage value at T0+2500 ms.
vBatT0_2500.unit String Unit : Volt
wifiError String Wifi error. Values can be :
  • ANTENNA-UNAVAILABLE
  • SCAN-FAILURE
  • WIFI-CONNECTION-FAILURE
  • WIFI-NOT-SUPPORTED
PayloadPosition with Wi-Fi timeout
DescriptionIf a Wi-Fi timeout occurs, a serie of measures of the battery voltage during the attempt to run the Wi-Fi scan is reported.
Example :
Input034cc57e03ca9c9b9a9997
Output
{"battery":{"valueFirmwarePrev15":3.57,"value":3.88,"inCharge":false,"unit":"V"},"temperature":{"value":19.74,"unit":"°C"},"adt":"WIFI-TIMEOUT","ack":0,"deviceModel":"MASTER","messageType":"POSITION","status":{"appMode":"permanentTrack","appState":"tracking","moving":true,"periodic":false,"onDemand":false,"userAlert":false},"vBatT0":{"value":3.91,"unit":"V"},"vBatT0_500":{"value":3.66,"unit":"V"},"vBatT0_1000":{"value":3.65,"unit":"V"},"vBatT0_1500":{"value":3.65,"unit":"V"},"vBatT0_2000":{"value":3.64,"unit":"V"},"vBatT0_2500":{"value":3.63,"unit":"V"}}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
location.lat Number Latitude in decimal degrees.
location.lon Number Longitude in decimal degrees.
location.accuracy Number EHPE Estimated Horizontal Position Error (in meters), a measure of the error in a GPS position in the horizontal plane.
vBatT0.value Number Battery voltage value at T0.
vBatT0.unit String Unit : Volt
vBatT0_500.value Number Battery voltage value at T0+500 ms.
vBatT0_500.unit String Unit : Volt
vBatT0_1000.value Number Battery voltage value at T0+1000 ms.
vBatT0_1000.unit String Unit : Volt
vBatT0_1500.value Number Battery voltage value at T0+1500 ms.
vBatT0_1500.unit String Unit : Volt
vBatT0_2000.value Number Battery voltage value at T0+2000 ms.
vBatT0_2000.unit String Unit : Volt
vBatT0_2500.value Number Battery voltage value at T0+2500 ms.
vBatT0_2500.unit String Unit : Volt
wifiError String Wifi error. Values can be :
  • ANTENNA-UNAVAILABLE
  • SCAN-FAILURE
  • WIFI-CONNECTION-FAILURE
  • WIFI-NOT-SUPPORTED
PayloadWifi Position Without Ciphering
DescriptionUp to 4 <BSSID-RSSI> couples can be used transmitted. Note: the BSSID and RSSI values are not encrypted.
Example :
Input032cef8c090e00131a90b420cf024e2685f48cc5b04e2685f48cc4124e2685f48cc1
Output
{"battery":{"valueFirmwarePrev15":3.74,"value":4.12,"inCharge":false,"unit":"V"},"temperature":{"value":26.82,"unit":"°C"},"adt":"WIFI-BSSIDs-WITHOUT-CIPHERING","ack":0,"deviceModel":"MASTER","messageType":"POSITION","status":{"appMode":"motionTrack","appState":"tracking","moving":true,"periodic":false,"onDemand":false,"userAlert":false},"bssId0":"00131a90b420","rssi0":{"unit":"dB","value":-49},"bssId1":"024e2685f48c","rssi1":{"unit":"dB","value":-59},"bssId2":"b04e2685f48c","rssi2":{"unit":"dB","value":-60},"bssId3":"124e2685f48c","rssi3":{"unit":"dB","value":-63},"scanAge":112}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
location.lat Number Latitude in decimal degrees.
location.lon Number Longitude in decimal degrees.
location.accuracy Number EHPE Estimated Horizontal Position Error (in meters), a measure of the error in a GPS position in the horizontal plane.
scanAge Number Scan age (in seconds).
rssi.unit String Wifi signal strength unit (dB).
rssi.value Number Wifi signal strength. Can be used, associated with the BssId of same index, to compute a position.
rssi.unit String Wifi signal strength unit (dB).
rssi.value Number Wifi signal strength. Can be used, associated with the BssId of same index, to compute a position.
rssi.unit String Wifi signal strength unit (dB).
rssi.value Number Wifi signal strength. Can be used, associated with the BssId of same index, to compute a position.
rssi.unit String Wifi signal strength unit (dB).
rssi.value Number Wifi signal strength. Can be used, associated with the BssId of same index, to compute a position.
bssId0 String Wifi identifier 0.
bssId1 String Wifi identifier 1.
bssId2 String Wifi identifier 2.
bssId3 String Wifi identifier 3.
PayloadEnergy status
DescriptionHelps estimating the battery level by indicating the total (since boot) power consumption of most power greedy peripherals.
Example :
Input0420f2749000007c5a00041d910000005a
Output
{"battery":{"valueFirmwarePrev15":3.75,"value":4.13,"inCharge":false,"unit":"V"},"temperature":{"value":14.68,"unit":"°C"},"adt":"UNUSED","ack":9,"deviceModel":"MICRO","messageType":"ENERGY-STATUS","status":{"appMode":"motionTrack","appState":"idle","moving":false,"periodic":false,"onDemand":false,"userAlert":false},"gpsOnRuntime":{"value":31834,"unit":"s"},"gpsStandbyRuntime":{"value":269713,"unit":"s"},"wifiScanCount":90,"energyExpenseByHour":{"gpsOn":{"value":353.71,"unit":"mA"},"gpsOff":{"value":7492.03,"unit":"µA"},"wifi":{"value":7.5,"unit":"mA"}}}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be :
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
deviceModel String Device model. Values can be :
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
gpsOnRuntime.value Number Total time spent by the GPS in state ON since boot.
gpsOnRuntime.unit String In seconds.
gpsStandbyRuntime.value Number Total time spent by the GPS in STANDBY state since boot.
gpsStandbyRuntime.unit String In seconds.
gpsOnSection.value Number Energy expense by hour, for the GPSOn mode.
gpsOnSection.unit String In mA.
gpsOffSection.value Number Energy expense by hour, for the GPSOff mode.
gpsOffSection.unit String In µA.
wifiSection.value Number Energy expense by hour, for the WifiScan mode.
wifiSection.unit String In mA.
PayloadHeartbeat
DescriptionPeriodic minimal heartbeat message transmitted (only in idle mode).
Example :
Input056096850001010500020700
Output
{"battery":{"valueFirmwarePrev15":3.39,"value":3.62,"inCharge":false,"unit":"V"},"temperature":{"value":23.28,"unit":"°C"},"adt":"UNUSED","ack":0,"deviceModel":"MASTER","messageType":"HEARTBEAT","status":{"appMode":"motionStartEndTrack","appState":"idle","moving":false,"periodic":false,"onDemand":false,"userAlert":false},"resetCause":"POWER-ON-RESET","firmwareVersion":"1.5.0","bleFirmwareVersion":"2.7.0"}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
resetCause String Reset cause.
firmwareVersion String Firmware version (format = ..)
PayloadHeartbeat
DescriptionHeartbeat message with all reset cause messages
Example :
Input0520cc840040
Output
{"battery":{"valueFirmwarePrev15":3.6,"value":3.92,"inCharge":false,"unit":"V"},"temperature":{"value":22.78,"unit":"°C"},"adt":"UNUSED","ack":0,"deviceModel":"MASTER","messageType":"HEARTBEAT","status":{"appMode":"motionTrack","appState":"idle","moving":false,"periodic":false,"onDemand":false,"userAlert":false},"resetCause":"SYSTEM-REQUEST-RESET"}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
resetCause String Reset cause.
firmwareVersion String Firmware version (format = ..)
PayloadOther tests
DescriptionActivity, Shock Detection, Event ....
Example :
Input0A80b4830002000100020003
Output
{"battery":{"valueFirmwarePrev15":3.51,"value":3.79,"inCharge":false,"unit":"V"},"temperature":{"value":22.27,"unit":"°C"},"axis_z":3,"adt":"UNUSED","ack":0,"deviceModel":"MASTER","messageType":"EVENT","status":{"appMode":"activityTrack","appState":"idle","moving":false,"periodic":false,"onDemand":false,"userAlert":false},"eventValue":"MOTION-END","trackerOrientationData":{"unit":"mG","axisX":1,"axisY":2,"axisZ":3}}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
typeValue String Type value. Possible items can be :
  • ACTIVITY-COUNTER
activityCounter Number Activity counter for the tracker.
configParam0 String Configuration parameter 0.
valueParam0 String Configuration value 0 (string value).
configParam1 String Configuration parameter 1.
valueParam1 String Configuration value 1 (string value).
configParam2 String Configuration parameter 2.
valueParam2 String Configuration value 2 (string value).
configParam3 String Configuration parameter 3.
valueParam3 String Configuration value 3 (string value).
configParam4 String Configuration parameter 4.
valueParam4 String Configuration value 4 (string value).
PayloadMisc
DescriptionMiscellaneous data message.
Example :
Input074cf882e00301fab6ff2b0161
Output
{"battery":{"valueFirmwarePrev15":3.78,"value":4.17,"inCharge":false,"unit":"V"},"temperature":{"value":21.76,"unit":"°C"},"adt":"UNUSED","ack":14,"deviceModel":"UNKNOWN","messageType":"MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)","status":{"appMode":"permanentTrack","appState":"tracking","moving":true,"periodic":false,"onDemand":false,"userAlert":false},"typeValue":"SHOCK-DETECTION","numberShocksBeyondThresholds":1,"accelerometerShockData":{"unit":"mG","axisX":-1354,"axisY":-213,"axisZ":353}}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
typeValue String Type value. Possible items can be :
  • ACTIVITY-COUNTER
activityCounter Number Activity counter for the tracker.
configParam0 String Configuration parameter 0.
valueParam0 String Configuration value 0 (string value).
configParam1 String Configuration parameter 1.
valueParam1 String Configuration value 1 (string value).
configParam2 String Configuration parameter 2.
valueParam2 String Configuration value 2 (string value).
configParam3 String Configuration parameter 3.
valueParam3 String Configuration value 3 (string value).
configParam4 String Configuration parameter 4.
valueParam4 String Configuration value 4 (string value).
PayloadShutdown
DescriptionShutdown message.
Example :
Input09a049820003
Output
{"battery":{"valueFirmwarePrev15":3.08,"value":3.2,"inCharge":false,"unit":"V"},"temperature":{"value":21.76,"unit":"°C"},"adt":"UNUSED","ack":0,"deviceModel":"MICRO","messageType":"SHUTDOWN","status":{"appMode":"off","appState":"idle","moving":false,"periodic":false,"onDemand":false,"userAlert":false},"shutdownCause":"BLE-REQUEST"}
Output json fields :
Fields
nametypedescription
battery.value Number Battery voltage
battery.valueFirmwarePrev15 Number Battery voltage, for old firmwares (< 1.5)
battery.unit String Volt
battery.inCharge Boolean Battery in charge, if true. This can only occur with MicroTracker devices, not with MasterTracker ones.
temperature.value Number Board temperature
temperature.unit String °C
adt String Additional Data Type. Value can be :
  • GPS-FIX
  • GPS-TIMEOUT
  • WIFI-BSSIDs
  • WIFI-BSSIDs-WITHOUT-CIPHERING
  • WIFI-TIMEOUT
  • WIFI-FAILURE
  • A/LP-GPS-DATA
  • A/LP-GPS-DATA-WITH-TIME
  • BLE-BEACON-SCAN
  • BLE-BEACON-FAILURE
ack Number Acknowledgement token is used to inform the server of the reception of LoRa downlink messages.
messageType String Message type. Values can be
:
  • FRAME-PENDING
  • POSITION
  • ENERGY-STATUS
  • HEARTBEAT
  • MISC (ACTIVITY, CONFIGURATION, SHOCK DETECTION)
  • SHUTDOWN
  • EVENT
  • DEBUG
deviceModel String Device model. Values can be
:
  • MASTER
  • MICRO
  • UNKNOWN
status.appMode String Application mode :
  • off
  • motionTrack
  • permanentTrack
  • motionStartEndTrack
  • activityTrack
  • off
  • standBy
status.appState String Application state :
  • Idle
  • Tracking
status.moving Boolean Moving. True if the tracker is currently moving.
status.periodic Boolean Periodic. True if this is a periodic position message.
status.onDemand Boolean True if this is an on-demand message.
status.userAlert Boolean True if this is an user-alert message.
shutdownCause String Shutdown cause. Values can be
  • USER-ACTION
  • LOW-BATTERY
  • DOWNLINK-REQUEST

ADEUNIS-DryContacts - ARF8170BA

Product(s) version :
RTU : V01.03.00 APP : V01.01.02

Orange decoder : adeunis_arf8170ba_v1.0
Developer : Orange

Device documentation
PayloadProduct configuration data frames - 0x10 Product Configuration frame
DescriptionFollowing reception of a downlink frame with the code 0x10 or on switching to the operating mode (from the Park or Command Mode), the next frames (0x10 to 0x14) representing the application configuration of the product are transmitted
Example :
Input10AB90487300B43201
Output
{"s300":144,"s301":72,"s320":"73","s321":"00","s322":"b4","s323":"32","s306":1,"messageType":"PRODUCT_CONFIG","status":{"frameCounter":5,"configuration":"carried","lowBattery":true,"hardwareError":false,"commandOutput":"controlled"},"productMode":"Production","keepAlivePeriodicity":{"value":86400,"unit":"s"},"transmission":{"mode":"Periodic","period":{"value":43200,"unit":"s"}}}
Output json fields :
Fields
nametypedescription
messageType String Type of frame
status Status Alarm Status
status.frameCounter Number Frame counter. It counts from 0 to 7 before looping.
status.commandOutput String Reserved bytes.
status.hardwareError Boolean Check if a hardware error has occurred.
status.lowBattery Boolean Detect if the battery voltage is low (less than 2.5V).
status.configuration String Check if a configuration has been done during the last downlink frame.
productMode String Product mode : Park, Production, Test or Repli.
keepAlivePeriodicity Period Keep alive frame transmission period in seconds.
period.value Number The period value.
period.unit String The period unit.
transmission Transmission Data transmission config.
transmission.mode String Transmission mode: Periodic or Event.
transmission.period Period Data frame transmission period in seconds if the mode is periodic. No present if the event mode is used.
period.value Number The period value.
period.unit String The period unit.
s300 Number Raw periodicity of the Keep Alive frame
s301 Number Raw periodicity of transmission (periodic mode)
s320 String Configuration of input TOR1
s321 String Configuration of input TOR2
s322 String Configuration of input TOR3
s323 String Configuration of input TOR4
s306 Number Raw product mode (Park, Production [standard value], Test, Repli)
PayloadNetwork configuration data frames - 0x14 Network Configuration frame
DescriptionFollowing reception of a downlink frame with the code 0x02 or on switching to the operating mode (from the Park or Command Mode), the next frame (0x10) representing the network configuration of the product is transmitted
Example :
Input20C40101
Output
{"messageType":"NETWORK_CONFIG_0x20","status":{"frameCounter":6,"configuration":"nothing","lowBattery":false,"hardwareError":true,"commandOutput":"nothing"},"adaptiveDataRate":true,"connectionMode":"OTAA"}
Output json fields :
Fields
nametypedescription
messageType String Type of frame
status Status Alarm Status
status.frameCounter Number Frame counter. It counts from 0 to 7 before looping.
status.commandOutput String Reserved bytes.
status.hardwareError Boolean Check if a hardware error has occurred.
status.lowBattery Boolean Detect if the battery voltage is low (less than 2.5V).
status.configuration String Check if a configuration has been done during the last downlink frame.
adaptiveDataRate Boolean Activation of the Adaptive Data Rate
connectionMode String Connection mode
PayloadKeep Alive frame - 0x30 Keep Alive frame
DescriptionThis frame (0x30) is only issued when the different digital outputs are configured in the event mode or in output and at the frequency defined by register 300
Example :
Input30E7
Output
{"messageType":"ALIVE","status":{"frameCounter":7,"configuration":"carried","lowBattery":true,"hardwareError":true,"commandOutput":"nothing"}}
Output json fields :
Fields
nametypedescription
messageType String Type of frame
status Status Alarm Status
status.frameCounter Number Frame counter. It counts from 0 to 7 before looping.
status.commandOutput String Reserved bytes.
status.hardwareError Boolean Check if a hardware error has occurred.
status.lowBattery Boolean Detect if the battery voltage is low (less than 2.5V).
status.configuration String Check if a configuration has been done during the last downlink frame.
PayloadData Frame - 0x40 Data frame
DescriptionThis frame (0x40) contains the values measured on the different digital outputs.
Example :
Input400800F10002000100009C
Output
{"tor1":{"currentState":false,"previousState":false,"eventCounter":241},"tor2":{"currentState":true,"previousState":true,"eventCounter":2},"tor3":{"currentState":true,"previousState":false,"eventCounter":1},"tor4":{"currentState":false,"previousState":true,"eventCounter":0},"messageType":"DATA","status":{"frameCounter":0,"configuration":"nothing","lowBattery":false,"hardwareError":false,"commandOutput":"controlled"}}
Output json fields :
Fields
nametypedescription
messageType String Type of frame
status Status Alarm Status
status.frameCounter Number Frame counter. It counts from 0 to 7 before looping.
status.commandOutput String Reserved bytes.
status.hardwareError Boolean Check if a hardware error has occurred.
status.lowBattery Boolean Detect if the battery voltage is low (less than 2.5V).
status.configuration String Check if a configuration has been done during the last downlink frame.
tor1 Tor This jsonobject represents differents informations of tor1
tor.currentState Boolean Current state
tor.previousState Boolean State at the sending of the previous frame
tor.eventCounter Number Value of event counter
tor2 Tor This jsonobject represents differents informations of tor2
tor.currentState Boolean Current state
tor.previousState Boolean State at the sending of the previous frame
tor.eventCounter Number Value of event counter
tor3 Tor This jsonobject represents differents informations of tor3
tor.currentState Boolean Current state
tor.previousState Boolean State at the sending of the previous frame
tor.eventCounter Number Value of event counter
tor4 Tor This jsonobject represents differents informations of tor4
tor.currentState Boolean Current state
tor.previousState Boolean State at the sending of the previous frame
tor.eventCounter Number Value of event counter
PayloadWrong Frame
DescriptionTest bad frames
Example :
Input458484EC415A5151
Output
{"error":"decoding failed"}
Output json fields :
Fields
nametypedescription

ADEUNIS-Temp - ARF8180BA

Product(s) version :
RTU : V01.04.00 APP : V01.03.03

Orange decoder : adeunis_arf8180ba_v1.0
Developer : Orange

Device documentation
PayloadDevice configuration and event processing - 0x10 Production frame
DescriptionThe first frame after the reboot, all registers are in default values.
Example :
Input100090030003100301020a
Output
{"productMode":"Production","keepAlivePeriodicity":{"value":86400,"unit":"s"},"transmission":{"mode":"Periodic","period":{"value":1800,"unit":"s"}},"internal":{"sensor":{"id":"0x0","eventsConfiguration":"LOWandHIGH"}},"external":{"sensor":{"id":"0x1","eventsConfiguration":"LOWandHIGH","type":"FANB57863-400-1"}},"acquisitionPeriod":{"value":600,"unit":"s"},"messageType":"DeviceConfigAndEventProcessing","status":{"frameCounter":0,"reserved":0,"hardwareError":false,"lowBattery":false,"lastFrameConfig":false}}
Output json fields :
Fields
nametypedescription
messageType String Explicit type to identify the message.
status.frameCounter Number Frame counter. It counts from 0 to 7 before looping.
status.reserved Number Reserved bytes.
status.hardwareError Boolean Check if a hardware error has occurred.
status.lowBattery Boolean Detect if the battery voltage is low (less than 2.5V).
status.lastFrameConfig Boolean Check if a configuration has been done during the last downlink frame.
keepAlivePeriodicity Period Keep alive frame transmission period in seconds.
period.value Number The period value.
period.unit String The period unit.
transmission Transmission Data transmission config.
transmission.mode String Transmission mode: Periodic or Event.
transmission.period Period Data frame transmission period in seconds if the mode is periodic. No present if the event mode is used.
period.value Number The period value.
period.unit String The period unit.
internal Internal Internal sensor config.
internal.sensor Sensor Sensor config.
sensor.id String Identifier of the sensor.
sensor.eventsConfiguration String Detection of high and low thresholds of the sensor.
sensor.type String Type of external sensor.
external External External sensor config.
external.sensor Sensor Sensor config.
sensor.id String Identifier of the sensor.
sensor.eventsConfiguration String Detection of high and low thresholds of the sensor.
sensor.type String Type of external sensor.
productMode String Product mode : Park, Production, Test or Repli.
acquisitionPeriod Period Acquisition period in seconds.
period.value Number The period value.
period.unit String The period unit.
PayloadDevice configuration and event processing - 0x10 Test frame
DescriptionThe frame is configured in test mode.
Example :
Input10E75000D003800202010A
Output
{"productMode":"Test","keepAlivePeriodicity":{"value":1600,"unit":"s"},"transmission":{"mode":"Event"},"internal":{"sensor":{"id":"0xd","eventsConfiguration":"LOWandHIGH"}},"external":{"sensor":{"id":"0x8","eventsConfiguration":"HIGH","type":"UNKNOWN"}},"acquisitionPeriod":{"value":100,"unit":"s"},"messageType":"DeviceConfigAndEventProcessing","status":{"frameCounter":7,"reserved":0,"hardwareError":true,"lowBattery":true,"lastFrameConfig":true}}
Output json fields :
Fields
nametypedescription
messageType String Explicit type to identify the message.
status.frameCounter Number Frame counter. It counts from 0 to 7 before looping.
status.reserved Number Reserved bytes.
status.hardwareError Boolean Check if a hardware error has occurred.
status.lowBattery Boolean Detect if the battery voltage is low (less than 2.5V).
status.lastFrameConfig Boolean Check if a configuration has been done during the last downlink frame.
keepAlivePeriodicity Period Keep alive frame transmission period in seconds.
period.value Number The period value.
period.unit String The period unit.
transmission Transmission Data transmission config.
transmission.mode String Transmission mode: Periodic or Event.
transmission.period Period Data frame transmission period in seconds if the mode is periodic. No present if the event mode is used.
period.value Number The period value.
period.unit String The period unit.
internal Internal Internal sensor config.
internal.sensor Sensor Sensor config.
sensor.id String Identifier of the sensor.
sensor.eventsConfiguration String Detection of high and low thresholds of the sensor.
sensor.type String Type of external sensor.
external External External sensor config.
external.sensor Sensor Sensor config.
sensor.id String Identifier of the sensor.
sensor.eventsConfiguration String Detection of high and low thresholds of the sensor.
sensor.type String Type of external sensor.
productMode String Product mode : Park, Production, Test or Repli.
acquisitionPeriod Period Acquisition period in seconds.
period.value Number The period value.
period.unit String The period unit.
PayloadInternal sensor configuration - 0x11 frame
DescriptionAll registers are in default values. The frame counter is 1.
Example :
Input1120012c0a00320a02
Output
{"sensorHighThreshold":{"value":30,"unit":"°C"},"sensorHighHysteresisThreshold":{"value":1,"unit":"°C"},"sensorLowThreshold":{"value":5,"unit":"°C"},"sensorLowHysteresisThreshold":{"value":1,"unit":"°C"},"superSamplingFactor":{"value":2,"unit":""},"messageType":"DeviceInternalSensorConfig","status":{"frameCounter":1,"reserved":0,"hardwareError":false,"lowBattery":false,"lastFrameConfig":false}}
Output json fields :
Fields
nametypedescription
messageType String Explicit type to identify the message.
status.frameCounter Number Frame counter. It counts from 0 to 7 before looping.
status.reserved Number Reserved bytes.
status.hardwareError Boolean Check if an hardware error has occurred.
status.lowBattery Boolean Detect if the battery voltage is low (less than 2.5V).
status.lastFrameConfig Boolean Check if a configuration has been done during the last downlink frame.
sensorHighThreshold Threshold High threshold in celsius.
threshold.value Number The threshold value.
threshold.unit String The threshold unit.
sensorHighHysteresisThreshold Threshold Hysteresis of the high threshold in celsius.
threshold.value Number The threshold value.
threshold.unit String The threshold unit.
sensorLowThreshold Threshold Low threshold in celsius.
threshold.value Number The threshold value.
threshold.unit String The threshold unit.
sensorLowHysteresisThreshold Threshold Hysteresis of the low threshold in celsuis
threshold.value Number The threshold value.
threshold.unit String The threshold unit.
superSamplingFactor Threshold Super-sampling factor
threshold.value Number The threshold value.
threshold.unit String The threshold unit.
PayloadExternal sensor configuration - 0x12 frame
DescriptionAll registers are in default values. The frame counter is 2.
Example :
Input1240012c0a00320a
Output
{"sensorHighThreshold":{"value":30,"unit":"°C"},"sensorHighHysteresisThreshold":{"value":1,"unit":"°C"},"sensorLowThreshold":{"value":5,"unit":"°C"},"sensorLowHysteresisThreshold":{"value":1,"unit":"°C"},"messageType":"DeviceExternalSensorConfig","status":{"frameCounter":2,"reserved":0,"hardwareError":false,"lowBattery":false,"lastFrameConfig":false}}
Output json fields :
Fields
nametypedescription
messageType String Explicit type to identify the message.
status.frameCounter Number Frame counter. It counts from 0 to 7 before looping.
status.reserved Number Reserved bytes.
status.hardwareError Boolean Check if an hardware error has occurred.
status.lowBattery Boolean Detect if the battery voltage is low (less than 2.5V).
status.lastFrameConfig Boolean Check if a configuration has been done during the last downlink frame.
sensorHighThreshold Threshold High threshold in celsuis.
threshold.value Number The threshold value.
threshold.unit String The threshold unit.
sensorHighHysteresisThreshold Threshold Hysteresis of the high threshold in celsius.
threshold.value Number The threshold value.
threshold.unit String The threshold unit.
sensorLowThreshold Threshold Low threshold in celsuis.
threshold.value Number The threshold value.
threshold.unit String The threshold unit.
sensorLowHysteresisThreshold Threshold Hysteresis of the low threshold in celsuis
threshold.value Number The threshold value.
threshold.unit String The threshold unit.
superSamplingFactor Threshold Super-sampling factor
threshold.value Number The threshold value.
threshold.unit String The threshold unit.
PayloadNetwork sensor configuration - 0x20 frame
DescriptionThe device is configured with ABP and the adaptative data rate is disabled. The frame counter is 0.
Example :
Input20020000
Output
{"adaptativeDataRate":"OFF","connexionMode":"ABP","messageType":"NetworkConfig","status":{"frameCounter":0,"reserved":0,"hardwareError":false,"lowBattery":true,"lastFrameConfig":false}}
Output json fields :
Fields
nametypedescription
messageType String Explicit type to identify the message.
status.frameCounter Number Frame counter. It counts from 0 to 7 before looping.
status.reserved Number Reserved bytes.
status.hardwareError Boolean Check if an hardware error has occurred.
status.lowBattery Boolean Detect if the battery voltage is low (less than 2.5V).
status.lastFrameConfig Boolean Check if a configuration has been done during the last downlink frame.
adaptativeDataRate String Activation of the Adaptive Data Rate : ON or OFF.
connexionMode String Lora connexion mode : ABP or OTAA.
PayloadNetwork sensor configuration - 0x20 frame
DescriptionThe device is configured with OTAA and the adaptative data rate is enabled. The frame counter is 3.
Example :
Input20620101
Output
{"adaptativeDataRate":"ON","connexionMode":"OTAA","messageType":"NetworkConfig","status":{"frameCounter":3,"reserved":0,"hardwareError":false,"lowBattery":true,"lastFrameConfig":false}}
Output json fields :
Fields
nametypedescription
messageType String Explicit type to identify the message.
status.frameCounter Number Frame counter. It counts from 0 to 7 before looping.
status.reserved Number Reserved bytes.
status.hardwareError Boolean Check if an hardware error has occurred.
status.lowBattery Boolean Detect if the battery voltage is low (less than 2.5V).
status.lastFrameConfig Boolean Check if a configuration has been done during the last downlink frame.
adaptativeDataRate String Activation of the Adaptive Data Rate : ON or OFF.
connexionMode String Lora connexion mode : ABP or OTAA.
PayloadKeep alive - 0x30 frame
DescriptionThe frame counter is 5.
Example :
Input30a2018000128000
Output
{"internal":{"sensor":{"id":"0x0","isDetected":true,"type":"B57863S0321F040"},"data":{"temperature":{},"isValid":false}},"external":{"sensor":{"id":"0x1","isDetected":true,"type":"FANB57863-400-1"},"data":{"temperature":{},"isValid":false}},"messageType":"KeepAlive","status":{"frameCounter":5,"reserved":0,"hardwareError":false,"lowBattery":true,"lastFrameConfig":false}}
Output json fields :
Fields
nametypedescription
messageType String Explicit type to identify the message.
status.frameCounter Number Frame counter. It counts from 0 to 7 before looping.
status.reserved Number Reserved bytes.
status.hardwareError Boolean Check if an hardware error has occurred.
status.lowBattery Boolean Detect if the battery voltage is low (less than 2.5V).
status.lastFrameConfig Boolean Check if a configuration has been done during the last downlink frame.
internal Internal Internal sensor information.
internal.sensor Sensor Internal sensor config.
sensor.id String Identifier of the sensor.
sensor.type String Type of the sensor.
sensor.isDetected Boolean Detection of the sensor.
internal.data SensorData Internal sensor data.
sensorData.temperature Temperature Temperature in celsius. Not present if the data is invalid.
temperature.value Number The temperature value.
temperature.unit String The temperature unit.
sensorData.isValid Boolean Validity of the data.
external External External sensor information.
external.sensor Sensor External sensor config.
sensor.id String Identifier of the sensor.
sensor.type String Type of the sensor.
sensor.isDetected Boolean Detection of the sensor.
external.data SensorData External sensor data.
sensorData.temperature Temperature Temperature in celsius. Not present if the data is invalid.
temperature.value Number The temperature value.
temperature.unit String The temperature unit.
sensorData.isValid Boolean Validity of the data.
PayloadData - 0x31 frame
DescriptionAn error occured when trying to get registers
Example :
Input31c2
Output
{"registers":"UNKNOWN","messageType":"RegistersValues","status":{"frameCounter":6,"reserved":0,"hardwareError":false,"lowBattery":true,"lastFrameConfig":false}}
Output json fields :
Fields
nametypedescription
messageType String Explicit type to identify the message.
status.frameCounter Number Frame counter. It counts from 0 to 7 before looping.
status.reserved Number Reserved bytes.
status.hardwareError Boolean Check if an hardware error has occurred.
status.lowBattery Boolean Detect if the battery voltage is low (less than 2.5V).
status.lastFrameConfig Boolean Check if a configuration has been done during the last downlink frame.
registers String All the registers requested in the downlink command.
PayloadData - 0x31 frame
DescriptionThe requested registers are 0xFF and 0xFF. It is fake values to test.
Example :
Input31c2ffff
Output
{"registers":"ffff","messageType":"RegistersValues","status":{"frameCounter":6,"reserved":0,"hardwareError":false,"lowBattery":true,"lastFrameConfig":false}}
Output json fields :
Fields
nametypedescription
messageType String Explicit type to identify the message.
status.frameCounter Number Frame counter. It counts from 0 to 7 before looping.
status.reserved Number Reserved bytes.
status.hardwareError Boolean Check if an hardware error has occurred.
status.lowBattery Boolean Detect if the battery voltage is low (less than 2.5V).
status.lastFrameConfig Boolean Check if a configuration has been done during the last downlink frame.
registers String All the registers requested in the downlink command.
PayloadData - 0x43 frame
DescriptionThe frame counter is 4.
Example :
Input43820100ee1200e4
Output
{"internal":{"sensor":{"id":"0x0","isDetected":true,"type":"B57863S0321F040"},"data":{"temperature":{"value":23.8,"unit":"°C"},"isValid":true}},"external":{"sensor":{"id":"0x1","isDetected":true,"type":"FANB57863-400-1"},"data":{"temperature":{"value":22.8,"unit":"°C"},"isValid":true}},"messageType":"Data","status":{"frameCounter":4,"reserved":0,"hardwareError":false,"lowBattery":true,"lastFrameConfig":false}}
Output json fields :
Fields
nametypedescription
messageType String Explicit type to identify the message.
status.frameCounter Number Frame counter. It counts from 0 to 7 before looping.
status.reserved Number Reserved bytes.
status.hardwareError Boolean Check if an hardware error has occurred.
status.lowBattery Boolean Detect if the battery voltage is low (less than 2.5V).
status.lastFrameConfig Boolean Check if a configuration has been done during the last downlink frame.
internal Internal Internal sensor information.
internal.sensor Sensor Internal sensor config.
sensor.id String Identifier of the sensor.
sensor.type String Type of the sensor.
sensor.isDetected Boolean Detection of the sensor.
internal.data SensorData Internal sensor data.
sensorData.temperature Temperature Temperature in celsius. Not present if the data is invalid.
temperature.value Number The temperature value.
temperature.unit String The temperature unit.
sensorData.isValid Boolean Validity of the data.
external External External sensor information.
external.sensor Sensor External sensor config.
sensor.id String Identifier of the sensor.
sensor.type String Type of the sensor.
sensor.isDetected Boolean Detection of the sensor.
external.data SensorData External sensor data.
sensorData.temperature Temperature Temperature in celsius. Not present if the data is invalid.
temperature.value Number The temperature value.
temperature.unit String The temperature unit.
sensorData.isValid Boolean Validity of the data.
PayloadData - Example of unknown frames
DescriptionError message for unknown payloads.
Example :
Inputff
Output
{"error":"decoding failed for the current payload \u003d ff"}
Output json fields :
Fields
nametypedescription

ADEUNIS-Adeunis ARF8240xx

Product(s) version :


Orange decoder : adeunis_arf8240_lora_v1.2
Developer : Orange

Device documentation
PayloadPeriodic Frame
Description
Example :
Input44A038d1b7173c23d70a
Output
{"status":{"frameCounter":5,"modbusReadError":false,"configInconsistency":false,"hardwareError":false,"lowBattery":false,"lastFrameConfig":false},"messageType":"PERIODIC","scaledConcentration":"0.0001","temperature":"0.01"}
Output json fields :
Fields
nametypedescription
scaledConcentration Number Scaled Concentration measured by sensor
temperature Number Temperature of sensor
loRaWANOptions int LoRaWAN Options
activationMode int Mode of activation
requestStatus int Request Status
registerId int Register ID
PayloadResponse to Set register request
Description
Example :
Input33e0040258
Output
{"status":{"frameCounter":7,"modbusReadError":false,"configInconsistency":false,"hardwareError":false,"lowBattery":false,"lastFrameConfig":false},"messageType":"RESPONSE-TO-SET-REGISTER-REQUEST","requestStatus":4,"registerId":600}
Output json fields :
Fields
nametypedescription
scaledConcentration Number Scaled Concentration measured by sensor
temperature Number Temperature of sensor
loRaWANOptions int LoRaWAN Options
activationMode int Mode of activation
requestStatus int Request Status
registerId int Register ID
PayloadProduct configuration
Description
Example :
Input10ffffffffffffffffffff
Output
{"status":{"frameCounter":7,"modbusReadError":true,"configInconsistency":true,"hardwareError":true,"lowBattery":true,"lastFrameConfig":true},"messageType":"PRODUCT-CONFIGURATION","registers":{"keepAliveRateInHour":182.04,"periodicFrame1RateInMin":10922.5,"samplingPeriodRateInMin":10922.5,"supplyTimeBeforeReqRateInSec":6553.5},"modbusConf":{"busType":"RS232","stopBits":"2","parity":"Unknown parity","baudRate":"Unknown speed"}}
Output json fields :
Fields
nametypedescription
scaledConcentration Number Scaled Concentration measured by sensor
temperature Number Temperature of sensor
loRaWANOptions int LoRaWAN Options
activationMode int Mode of activation
requestStatus int Request Status
registerId int Register ID
Payloadbad payload
Description
Example :
Input00
Output
{"error":"decoding failed"}
Output json fields :
Fields
nametypedescription
PayloadNetwork configuration
Description
Example :
Input20FFFFFF
Output
{"status":{"frameCounter":7,"modbusReadError":true,"configInconsistency":true,"hardwareError":true,"lowBattery":true,"lastFrameConfig":true},"messageType":"NETWORK-CONFIGURATION","networkConfig":{"activationADR":true,"dutyCycle":true,"networkClass":"CLASS C","mode":"OTAA"}}
Output json fields :
Fields
nametypedescription
scaledConcentration Number Scaled Concentration measured by sensor
temperature Number Temperature of sensor
loRaWANOptions int LoRaWAN Options
activationMode int Mode of activation
requestStatus int Request Status
registerId int Register ID

ADEUNIS-Multidevices - Tag to associate to the device on LiveObjects

Product(s) version :
Declare tag according to the device type:


Orange decoder : adeunis_arf_v1.3.0
Developer : Adeunis / Orange

Device documentation
PayloadAnalog 0x10 Analog configuration frame
DescriptionAnalog 0x10 Analog configuration frame. Tag Analog associated to the device. Following reception of a downlink frame with the code 0x01 or on switching to the operating mode (from the Park or Command Mode), the next frame (0x10) representing the application configuration of the product is transmitted
Example :
Input104248000203A1DD01
Output
{"type":"0x10 Analog configuration","status":{"frameCounter":2,"hardwareError":false,"lowBattery":true,"configurationDone":false,"alarmChannelA":false,"alarmChannelB":false},"transmissionPeriodKeepAlive":{"unit":"m","value":720},"transmissionPeriodData":{"unit":"m","value":0},"channels":[{"name":"channel A","id":0,"type":"4-20mA","threshold":"both","externalTrigger":{"type":"none","debounceDuration":{"unit":"s","value":0}}},{"name":"channel B","id":10,"type":"0-10V","threshold":"low","externalTrigger":{"type":"both","debounceDuration":{"unit":"s","value":60}}}],"productMode":"PRODUCTION"}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Analog configuration
  • 0x11 Analog configuration
  • 0x12 Analog configuration
  • 0x13 Analog configuration
  • 0x14 Analog configuration
  • 0x20 network configuration
  • 0x30 Analog keep alive
  • 0x42 Analog data
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
transmissionPeriodKeepAlive Period Transmission period of the Keep Alive frame.
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
transmissionPeriodData Period periodicity of the transmission, expressed in tens of minutes
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
channels Array Channels list : configuration of the events on channels
channel Channel Channel
channel.name String channel name
channel.id int free Id from 0 to 15
channel.type String type : values can be: deactivated, 0-10V or 4-20mA
channel.threshold String threshold : values can be: none, low, high or both
channel.externalTrigger ExternalTrigger Trigger by digital input
externalTrigger.type String type : values can be: none, low, high or both
externalTrigger.debounceDuration Duration Duration of the waiting period
  • ms
  • s
  • min
duration.value int Period duration
duration.unit String Duration value: can be ms, s or min
productMode String Product mode. Values can be: PRODUCTION, PARK, TEST or DEAD
PayloadAnalog 0x11 Analog configuration frame
DescriptionAnalog 0x11 Analog configuration frame. Tag Analog associated to the device. Following the frame 0x10
Example :
Input1140000000000000
Output
{"type":"0x11 Analog configuration","status":{"frameCounter":2,"hardwareError":false,"lowBattery":false,"configurationDone":false,"alarmChannelA":false,"alarmChannelB":false},"threshold":{"name":"channel A","unit":"µV or 10 nA","high":{"value":0,"hysteresis":0}}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Analog configuration
  • 0x11 Analog configuration
  • 0x12 Analog configuration
  • 0x13 Analog configuration
  • 0x14 Analog configuration
  • 0x20 network configuration
  • 0x30 Analog keep alive
  • 0x42 Analog data
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
threshold Threshold threshold for frames 0x11, 0x12, 0x13 and 0x14
threshold.name String channel name
threshold.unit String unit, only one value :
  • µV or 10 nA
threshold.high ThresholdValue High threshold value channel
thresholdValue.value int threshold value channel, depending of channel type
  • 4-20mA : 400,000 - 2,000,000
  • 0-10V : 0 - 10,000,000
thresholdValue.hysteresis int threshold hysteresis of channel, depending of channel type
  • 4-20mA : 0 - 1,600,000
  • 0-10V : 0 - 10,000,000
threshold.low ThresholdValue Low threshold value channel
thresholdValue.value int threshold value channel, depending of channel type
  • 4-20mA : 400,000 - 2,000,000
  • 0-10V : 0 - 10,000,000
thresholdValue.hysteresis int threshold hysteresis of channel, depending of channel type
  • 4-20mA : 0 - 1,600,000
  • 0-10V : 0 - 10,000,000
PayloadAnalog 0x12 Analog configuration frame
DescriptionAnalog 0x12 Analog configuration frame. Tag Analog associated to the device. Following the frame 0x11
Example :
Input1240000000000000
Output
{"type":"0x12 Analog configuration","status":{"frameCounter":2,"hardwareError":false,"lowBattery":false,"configurationDone":false,"alarmChannelA":false,"alarmChannelB":false},"threshold":{"name":"channel A","unit":"µV or 10 nA","low":{"value":0,"hysteresis":0}}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Analog configuration
  • 0x11 Analog configuration
  • 0x12 Analog configuration
  • 0x13 Analog configuration
  • 0x14 Analog configuration
  • 0x20 network configuration
  • 0x30 Analog keep alive
  • 0x42 Analog data
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
threshold Threshold threshold for frames 0x11, 0x12, 0x13 and 0x14
threshold.name String channel name
threshold.unit String unit, only one value :
  • µV or 10 nA
threshold.high ThresholdValue High threshold value channel
thresholdValue.value int threshold value channel, depending of channel type
  • 4-20mA : 400,000 - 2,000,000
  • 0-10V : 0 - 10,000,000
thresholdValue.hysteresis int threshold hysteresis of channel, depending of channel type
  • 4-20mA : 0 - 1,600,000
  • 0-10V : 0 - 10,000,000
threshold.low ThresholdValue Low threshold value channel
thresholdValue.value int threshold value channel, depending of channel type
  • 4-20mA : 400,000 - 2,000,000
  • 0-10V : 0 - 10,000,000
thresholdValue.hysteresis int threshold hysteresis of channel, depending of channel type
  • 4-20mA : 0 - 1,600,000
  • 0-10V : 0 - 10,000,000
PayloadAnalog 0x13 Analog configuration frame
DescriptionAnalog 0x13 Analog configuration frame. Tag Analog associated to the device. Following the frame 0x12
Example :
Input1380061A80186A00
Output
{"type":"0x13 Analog configuration","status":{"frameCounter":4,"hardwareError":false,"lowBattery":false,"configurationDone":false,"alarmChannelA":false,"alarmChannelB":false},"threshold":{"name":"channel B","unit":"µV or 10 nA","high":{"value":400000,"hysteresis":1600000}}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Analog configuration
  • 0x11 Analog configuration
  • 0x12 Analog configuration
  • 0x13 Analog configuration
  • 0x14 Analog configuration
  • 0x20 network configuration
  • 0x30 Analog keep alive
  • 0x42 Analog data
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
threshold Threshold threshold for frames 0x11, 0x12, 0x13 and 0x14
threshold.name String channel name
threshold.unit String unit, only one value :
  • µV or 10 nA
threshold.high ThresholdValue High threshold value channel
thresholdValue.value int threshold value channel, depending of channel type
  • 4-20mA : 400,000 - 2,000,000
  • 0-10V : 0 - 10,000,000
thresholdValue.hysteresis int threshold hysteresis of channel, depending of channel type
  • 4-20mA : 0 - 1,600,000
  • 0-10V : 0 - 10,000,000
threshold.low ThresholdValue Low threshold value channel
thresholdValue.value int threshold value channel, depending of channel type
  • 4-20mA : 400,000 - 2,000,000
  • 0-10V : 0 - 10,000,000
thresholdValue.hysteresis int threshold hysteresis of channel, depending of channel type
  • 4-20mA : 0 - 1,600,000
  • 0-10V : 0 - 10,000,000
PayloadAnalog 0x14 Analog configuration frame
DescriptionAnalog 0x14 Analog configuration frame. Tag Analog associated to the device. Following the frame 0x13
Example :
Input14C01E8480989680
Output
{"type":"0x14 Analog configuration","status":{"frameCounter":6,"hardwareError":false,"lowBattery":false,"configurationDone":false,"alarmChannelA":false,"alarmChannelB":false},"threshold":{"name":"channel B","unit":"µV or 10 nA","low":{"value":2000000,"hysteresis":10000000}}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Analog configuration
  • 0x11 Analog configuration
  • 0x12 Analog configuration
  • 0x13 Analog configuration
  • 0x14 Analog configuration
  • 0x20 network configuration
  • 0x30 Analog keep alive
  • 0x42 Analog data
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
threshold Threshold threshold for frames 0x11, 0x12, 0x13 and 0x14
threshold.name String channel name
threshold.unit String unit, only one value :
  • µV or 10 nA
threshold.high ThresholdValue High threshold value channel
thresholdValue.value int threshold value channel, depending of channel type
  • 4-20mA : 400,000 - 2,000,000
  • 0-10V : 0 - 10,000,000
thresholdValue.hysteresis int threshold hysteresis of channel, depending of channel type
  • 4-20mA : 0 - 1,600,000
  • 0-10V : 0 - 10,000,000
threshold.low ThresholdValue Low threshold value channel
thresholdValue.value int threshold value channel, depending of channel type
  • 4-20mA : 400,000 - 2,000,000
  • 0-10V : 0 - 10,000,000
thresholdValue.hysteresis int threshold hysteresis of channel, depending of channel type
  • 4-20mA : 0 - 1,600,000
  • 0-10V : 0 - 10,000,000
PayloadAnalog 0x20 Network configuration information frame
DescriptionAnalog 0x20 Network configuration information frame. Tag Analog associated to the device. Following reception of a downlink frame with the code 0x02 or on switching to the operating mode (from the Park or Command Mode), the next frame (0x20) representing the network configuration of the product is transmitted
Example :
Input20420000
Output
{"type":"0x20 Configuration","status":{"frameCounter":2,"hardwareError":false,"lowBattery":true,"configurationDone":false,"alarmChannelA":false,"alarmChannelB":false},"loraAdr":false,"loraProvisioningMode":"ABP","loraClassMode":"CLASS A"}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Analog configuration
  • 0x11 Analog configuration
  • 0x12 Analog configuration
  • 0x13 Analog configuration
  • 0x14 Analog configuration
  • 0x20 network configuration
  • 0x30 Analog keep alive
  • 0x42 Analog data
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
loraAdr Boolean Activation of the ADR : true if ON, false if OFF
loraProvisioningMode String Mode of activation : value can be ABP or OTAA (default value
loraClassMode String ClassMode : values can be CLASS A or CLASS C.
PayloadAnalog 0x30 Keep Alive frame
DescriptionAnalog 0x30 Keep Alive frame. Tag Analog associated to the device. This frame (0x30) is transmitted only in the event mode at the frequency defined by register 300
Example :
Input3080020186A0010186A0
Output
{"type":"0x30 Analog keep alive","status":{"frameCounter":4,"hardwareError":false,"lowBattery":false,"configurationDone":false,"alarmChannelA":false,"alarmChannelB":false},"channels":[{"name":"channel A","unit":"mA","value":1},{"name":"channel B","unit":"V","value":0.1}]}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Analog configuration
  • 0x11 Analog configuration
  • 0x12 Analog configuration
  • 0x13 Analog configuration
  • 0x14 Analog configuration
  • 0x20 network configuration
  • 0x30 Analog keep alive
  • 0x42 Analog data
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
channels Array List of channels : configuration of the events on channels
channel Channel Channel
channel.name String channel name
channel.unit String unit
channel.value float value measured on channel
PayloadAnalog 0x42 Data Frame
DescriptionAnalog 0x42 Data Frame. Tag Analog associated to the device. This frame (0x42) contains the values measured on the different sensors
Example :
Input4280020186A0010186A0
Output
{"type":"0x42 Analog data","status":{"frameCounter":4,"hardwareError":false,"lowBattery":false,"configurationDone":false,"alarmChannelA":false,"alarmChannelB":false},"channels":[{"name":"channel A","unit":"mA","value":1},{"name":"channel B","unit":"V","value":0.1}]}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Analog configuration
  • 0x11 Analog configuration
  • 0x12 Analog configuration
  • 0x13 Analog configuration
  • 0x14 Analog configuration
  • 0x20 network configuration
  • 0x30 Analog keep alive
  • 0x42 Analog data
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
channels Array List of channels : configuration of the events on channels
channel Channel Channel
channel.name String channel name
channel.unit String unit
channel.value float value measured on channel
PayloadComfort 0x10 Comfort configuration frame
DescriptionComfort 0x10 Comfort configuration frame. Tag comfort associated to the device. When switching to operating mode (PARK or COMMAND mode output), this frame representing the application configuration of the device is transmitted
Example :
Input100021c000030002012c
Output
{"type":"0x10 Comfort configuration","status":{"frameCounter":0,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"transmissionPeriodKeepAlive":{"unit":"s","value":86400},"numberOfHistorizationBeforeSending":3,"numberOfSamplingBeforeHistorization":2,"samplingPeriod":{"unit":"s","value":600},"calculatedPeriodRecording":{"unit":"s","value":1200},"calculatedSendingPeriod":{"unit":"s","value":3600}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Comfort configuration
  • 0x10 Comfort 2 configuration
  • 0x10 Comfort CO2 configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Comfort CO2 Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x4c Comfort data
  • 0x4c Comfort 2 data
  • 0x4d Comfort alarm
  • 0x4d Comfort 2 alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x6a Comfort CO2 data
  • 0x6b Comfort CO2 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
transmissionPeriodKeepAlive Period Transmission period of the Keep Alive frame.
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
numberOfHistorizationBeforeSending int Transmission period of the periodic frame
numberOfSamplingBeforeHistorization int History period
samplingPeriod Period Sampling period
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
calculatedPeriodRecording Period Calculated period recording
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
calculatedSendingPeriod Period Calculated sending period
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
redundantSamples int Number of additional (redundant) samples per frame
dailyFrameActivated Boolean True if daily frame transmission is activated
PayloadComfort 0x1f Digital Input Configuration
DescriptionComfort 0x1f Digital Input Configuration. Tag comfort associated to the device. This frame is sent at the start-up of the device (except when it is a reboot after a downlink).
Example :
Input1f20410001410001
Output
{"type":"0x1f digital input configuration","status":{"frameCounter":1,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"digitalInput1":{"type":"highEdge","debouncingPeriod":{"unit":"ms","value":100},"threshold":1},"digitalInput2":{"type":"highEdge","debouncingPeriod":{"unit":"ms","value":100},"threshold":1}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Comfort configuration
  • 0x10 Comfort 2 configuration
  • 0x10 Comfort CO2 configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Comfort CO2 Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x4c Comfort data
  • 0x4c Comfort 2 data
  • 0x4d Comfort alarm
  • 0x4d Comfort 2 alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x6a Comfort CO2 data
  • 0x6b Comfort CO2 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
digitalInput1 DigitalInput Configuration of the button (Digital Input 1)
digitalInput.type String Digital Input type. Values can be deactivated when off, highEdge when event ON, lowEdge when event OFF, or bothEdges when event ON/OFF
digitalInput.debouncingPeriod DebouncingPeriod Debouncing period
debouncingPeriod.unit String milliseconds
debouncingPeriod.value int Debouncing period value
digitalInput.threshold int Button alarm threshold value : when the detection counter becomes greater than this threshold, an alarm is triggered
digitalInput2 DigitalInput Configuration of the button (Digital Input 2)
digitalInput.type String Digital Input type. Values can be deactivated when off, highEdge when event ON, lowEdge when event OFF, or bothEdges when event ON/OFF
digitalInput.debouncingPeriod DebouncingPeriod Debouncing period
debouncingPeriod.unit String milliseconds
debouncingPeriod.value int Debouncing period value
digitalInput.threshold int Button alarm threshold value : when the detection counter becomes greater than this threshold, an alarm is triggered
PayloadComfort 0x20 Configuration
DescriptionComfort 0x20 Configuration. Tag comfort associated to the device. Information frame on Network configuration
Example :
Input20a00501
Output
{"type":"0x20 Configuration","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"loraAdr":true,"loraProvisioningMode":"OTAA","loraDutycyle":"activated","loraClassMode":"CLASS A"}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Comfort configuration
  • 0x10 Comfort 2 configuration
  • 0x10 Comfort CO2 configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Comfort CO2 Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x4c Comfort data
  • 0x4c Comfort 2 data
  • 0x4d Comfort alarm
  • 0x4d Comfort 2 alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x6a Comfort CO2 data
  • 0x6b Comfort CO2 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
loraAdr Boolean Activation of the ADR : true if ON, false if OFF
loraProvisioningMode String Mode of activation : value can be ABP or OTAA (default value
loraClassMode String ClassMode : values can be CLASS A or CLASS C.
loraDutycyle String Dutycycle : values can be activated or deactivated
PayloadComfort 0x30 Keep alive
DescriptionComfort 0x30 Keep alive. Tag comfort associated to the device. Keep alive frame
Example :
Input30A0
Output
{"type":"0x30 Keep alive","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Comfort configuration
  • 0x10 Comfort 2 configuration
  • 0x10 Comfort CO2 configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Comfort CO2 Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x4c Comfort data
  • 0x4c Comfort 2 data
  • 0x4d Comfort alarm
  • 0x4d Comfort 2 alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x6a Comfort CO2 data
  • 0x6b Comfort CO2 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
icone int ICONE indicator (0-5)
qaiRedDuration Duration Duration above QAI red indicator. Min 0, max 24 hours)
duration.value int Duration
duration.unit String Time unit
temperatureMax Temperature Temperature max.
temperature.value Number Temperature value
temperature.unit String °C
temperatureMin Temperature Temperature min.
temperature.value Number Temperature value
temperature.unit String °C
temperatureAverage Temperature Temperature average.
temperature.value Number Temperature value
temperature.unit String °C
co2Max Co2 Co2 max.
co2.value int Co2 value
co2.unit String ppm
co2Min Co2 Co2 min.
co2.value int Co2 value
co2.unit String ppm
co2Average Co2 Co2 average.
co2.value int Co2 value
co2.unit String ppm
humidityMax Humidity Humidity max.
humidity.value int Humidity value
humidity.unit String %
humidityMin Humidity Humidity min.
humidity.value int Humidity value
humidity.unit String %
humidityAverage Humidity Humidity average.
humidity.value int Humidity value
humidity.unit String %
timestamp String Timestamp
PayloadComfort 0x33 Set Register Status
DescriptionComfort 0x33 Set Register Status. Tag comfort associated to the device. Response frame following an update of register(s) via downlink
Example :
Input3380040140
Output
{"type":"0x33 Set register status","status":{"frameCounter":4,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"requestStatus":"errorInvalidRegister","registerId":320}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Comfort configuration
  • 0x10 Comfort 2 configuration
  • 0x10 Comfort CO2 configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Comfort CO2 Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x4c Comfort data
  • 0x4c Comfort 2 data
  • 0x4d Comfort alarm
  • 0x4d Comfort 2 alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x6a Comfort CO2 data
  • 0x6b Comfort CO2 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
requestStatus String Request status. Values can be:
  • errorOtherReason
  • success
  • successNoUpdate
  • errorCoherency
  • errorInvalidRegister
  • errorInvalidValue
  • errorTruncatedValue
  • errorAccesNotAllowed
registerId int Indicates to the user the register that caused the error, only if requestStatus is different from success.
PayloadComfort 0x4c Comfort Data
DescriptionComfort 0x4c Comfort Data. Tag comfort associated to the device. Periodic data frame
Example :
Input4c2000c51f00c72000c82100ca2200cc2300cd24
Output
{"type":"0x4c Comfort data","status":{"frameCounter":1,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"decodingInfo":"values: [t\u003d0, t-1, t-2, ...]","temperature":{"unit":"°C","values":[19.7,19.9,20,20.2,20.4,20.5]},"humidity":{"unit":"%","values":[31,32,33,34,35,36]}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Comfort configuration
  • 0x10 Comfort 2 configuration
  • 0x10 Comfort CO2 configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Comfort CO2 Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x4c Comfort data
  • 0x4c Comfort 2 data
  • 0x4d Comfort alarm
  • 0x4d Comfort 2 alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x6a Comfort CO2 data
  • 0x6b Comfort CO2 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
decodingInfo String List of temperatures : t0, t-1, t-2, t-3,t-4, t-5, t-6
temperature Temperatures Sensor Temperatures
temperatures.unit String Degrees Celcius
temperatures.values Array Temperature values in array
humidities.unit String Pourcents
humidities.values Array Humidity values in array
timestamp String Timestamp
PayloadComfort 0x4d Comfort Alarm
DescriptionComfort 0x4d Comfort Alarm. Tag comfort associated to the device. Temperature and humidity alarm frame
Example :
Input4dc010010832
Output
{"type":"0x4d Comfort alarm","status":{"frameCounter":6,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"alarmTemperature":{"alarmStatus":"active","temperature":{"unit":"°C","value":26.4}},"alarmHumidity":{"alarmStatus":"inactive","humidity":{"unit":"%","value":50}}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Comfort configuration
  • 0x10 Comfort 2 configuration
  • 0x10 Comfort CO2 configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Comfort CO2 Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x4c Comfort data
  • 0x4c Comfort 2 data
  • 0x4d Comfort alarm
  • 0x4d Comfort 2 alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x6a Comfort CO2 data
  • 0x6b Comfort CO2 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
alarmTemperature AlarmTemperature Temperature alarm
alarmTemperature.alarmStatus String Alarm status. Values can be active when thresholds are exceeded, or inactive when thresholds are not reached
alarmTemperature.temperature Temperature Temperature
temperature.unit String Degrees Celcius
temperature.value Number Temperature value
temperature.name String Name
temperature.id Number Id
alarmHumidity AlarmHumidity Humidity alarm
alarmHumidity.alarmStatus String Alarm status. Values can be active when thresholds are exceeded, or inactive when thresholds are not reached
alarmHumidity.humidity Humidity Humidity
humidity.unit String Pourcents
humidity.value int Humidity value
timestamp String Timestamp
PayloadComfort 0x51 Comfort Digital Input 1 Alarm
DescriptionComfort 0x51 Comfort Digital Input 1 Alarm. Tag comfort associated to the device. Digital Input Digital Input 1 button alarm frame
Example :
Input51a0010000017E0001
Output
{"type":"0x51 digital input 1 alarm","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"state":{"previousFrame":false,"current":true},"counter":{"global":382,"instantaneous":1}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Comfort configuration
  • 0x10 Comfort 2 configuration
  • 0x10 Comfort CO2 configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Comfort CO2 Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x4c Comfort data
  • 0x4c Comfort 2 data
  • 0x4d Comfort alarm
  • 0x4d Comfort 2 alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x6a Comfort CO2 data
  • 0x6b Comfort CO2 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
state State State
state.previousFrame boolean State of the digital input when sending the previous frame : true if ON/CLOSED, false if OFF/OPENED
state.current boolean Current state of the digital input : true if ON/CLOSED, false if OFF/OPENED
counter Counter Counters
counter.global int Global counter of the digital input
counter.instantaneous int Instantaneous counter of the digital input
timestamp String Timestamp
PayloadComfort 0x52 Comfort Digital Input 2 Alarm
DescriptionComfort 0x52 Comfort Digital Input 2 Alarm. Tag comfort associated to the device. Digital Input 2 terminal block alarm frame
Example :
Input52a0010000017E0001
Output
{"type":"0x52 digital input 2 alarm","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"state":{"previousFrame":false,"current":true},"counter":{"global":382,"instantaneous":1}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Comfort configuration
  • 0x10 Comfort 2 configuration
  • 0x10 Comfort CO2 configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Comfort CO2 Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x4c Comfort data
  • 0x4c Comfort 2 data
  • 0x4d Comfort alarm
  • 0x4d Comfort 2 alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x6a Comfort CO2 data
  • 0x6b Comfort CO2 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
state State State
state.previousFrame boolean State of the digital input when sending the previous frame : true if ON/CLOSED, false if OFF/OPENED
state.current boolean Current state of the digital input : true if ON/CLOSED, false if OFF/OPENED
counter Counter Counters
counter.global int Global counter of the digital input
counter.instantaneous int Instantaneous counter of the digital input
timestamp String Timestamp
PayloadDelta P 0x10 Delta P configuration frame
DescriptionDelta P 0x10 Delta P configuration frame. Tag deltap associated to the device.The following frame representing the application configuration of the device are transmitted when switching to operating mode (PARK or COMMAND mode output).
Example :
Input10A321C000080012012C
Output
{"type":"0x10 Delta P configuration","status":{"frameCounter":5,"hardwareError":false,"lowBattery":true,"configurationDone":true,"configurationInconsistency":false},"transmissionPeriodKeepAlive":{"unit":"s","value":86400},"numberOfHistorizationBeforeSending":8,"numberOfSamplingBeforeHistorization":18,"samplingPeriod":{"unit":"s","value":600},"calculatedPeriodRecording":{"unit":"s","value":10800},"calculatedSendingPeriod":{"unit":"s","value":86400}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Delta P configuration
  • 0x11 Delta P 0-10V configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x2f Delta P Downlink ack
  • 0x30 Keep alive
  • 0x33 Set register status
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x53 Delta P periodic data
  • 0x54 Delta P alarm
  • 0x55 Delta P - periodic 0-10 V
  • 0x56 Delta P - alarm 0-10 V
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
transmissionPeriodKeepAlive Period Transmission period of the Keep Alive frame.
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
numberOfHistorizationBeforeSending int Transmission period of the periodic frame
numberOfSamplingBeforeHistorization int History period
samplingPeriod Period Sampling period
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
calculatedPeriodRecording Period Calculated period recording
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
calculatedSendingPeriod Period Calculated sending period
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
PayloadDelta P 0x11 Delta P 0-10V configuration frame
DescriptionDelta P 0x11 Delta P 0-10V configuration frame. Tag deltap associated to the device. The following frame representing the application configuration of the device are transmitted when switching to operating mode (PARK or COMMAND mode output).
Example :
Input11A30001012C0001
Output
{"type":"0x11 Delta P 0-10V configuration","status":{"frameCounter":5,"hardwareError":false,"lowBattery":true,"configurationDone":true,"configurationInconsistency":false},"numberOfHistorizationBeforeSending":1,"numberOfSamplingBeforeHistorization":1,"samplingPeriod":{"unit":"s","value":600},"calculatedPeriodRecording":{"unit":"s","value":600},"calculatedSendingPeriod":{"unit":"s","value":600}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Delta P configuration
  • 0x11 Delta P 0-10V configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x2f Delta P Downlink ack
  • 0x30 Keep alive
  • 0x33 Set register status
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x53 Delta P periodic data
  • 0x54 Delta P alarm
  • 0x55 Delta P - periodic 0-10 V
  • 0x56 Delta P - alarm 0-10 V
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
numberOfHistorizationBeforeSending int Transmission period of the periodic frame
numberOfSamplingBeforeHistorization int History period
samplingPeriod Period Sampling period
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
calculatedPeriodRecording Period Calculated period recording
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
calculatedSendingPeriod Period Calculated sending period
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
PayloadDelta P 0x1F Digital Input Configuration frame
DescriptionDelta P 0x1F TOR Configuration frame. Tag deltap associated to the device. The following frame, representing the configuration of the digital inputs/outputs, is transmitted when switching to operating mode (PARK or CONTROL output mode)
Example :
Input1FA0410001000001
Output
{"type":"0x1f digital input configuration","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"digitalInput1":{"type":"highEdge","debouncingPeriod":{"unit":"ms","value":100},"threshold":1},"digitalInput2":{"type":"deactivated","debouncingPeriod":{"unit":"ms","value":0},"threshold":1}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Delta P configuration
  • 0x11 Delta P 0-10V configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x2f Delta P Downlink ack
  • 0x30 Keep alive
  • 0x33 Set register status
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x53 Delta P periodic data
  • 0x54 Delta P alarm
  • 0x55 Delta P - periodic 0-10 V
  • 0x56 Delta P - alarm 0-10 V
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
digitalInput1 DigitalInput Configuration of the button (Digital Input 1)
digitalInput.type String Digital Input type. Values can be deactivated when off, highEdge when event ON, lowEdge when event OFF, or bothEdges when event ON/OFF
digitalInput.debouncingPeriod DebouncingPeriod Debouncing period
debouncingPeriod.unit String milliseconds
debouncingPeriod.value int Debouncing period value
digitalInput.threshold int Button alarm threshold value : when the detection counter becomes greater than this threshold, an alarm is triggered
digitalInput2 DigitalInput Configuration of the button (Digital Input 2)
digitalInput.type String Digital Input type. Values can be deactivated when off, highEdge when event ON, lowEdge when event OFF, or bothEdges when event ON/OFF
digitalInput.debouncingPeriod DebouncingPeriod Debouncing period
debouncingPeriod.unit String milliseconds
debouncingPeriod.value int Debouncing period value
digitalInput.threshold int Button alarm threshold value : when the detection counter becomes greater than this threshold, an alarm is triggered
PayloadDelta P 0x20 Configuration frame
DescriptionDelta P 0x20 Configuration frame. Tag deltap associated to the device. Frame of information on the network configuration
Example :
Input20A00101
Output
{"type":"0x20 Configuration","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"loraAdr":true,"loraProvisioningMode":"OTAA","loraClassMode":"CLASS A"}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Delta P configuration
  • 0x11 Delta P 0-10V configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x2f Delta P Downlink ack
  • 0x30 Keep alive
  • 0x33 Set register status
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x53 Delta P periodic data
  • 0x54 Delta P alarm
  • 0x55 Delta P - periodic 0-10 V
  • 0x56 Delta P - alarm 0-10 V
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
loraAdr Boolean Activation of the ADR : true if ON, false if OFF
loraProvisioningMode String Mode of activation : value can be ABP or OTAA (default value
loraClassMode String ClassMode : values can be CLASS A or CLASS C.
PayloadDelta P 0x2F Delta P Downlink ack frame
DescriptionDelta P 0x2F Delta P Downlink ack frame. Tag deltap associated to the device. The 0x2F frame allows the acknowledgment of a 0x60 or 0x61 frame
Example :
Input2FA0010203040506070809
Output
{"type":"0x2f Delta P Downlink ack","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"requestStatus":"success"}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Delta P configuration
  • 0x11 Delta P 0-10V configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x2f Delta P Downlink ack
  • 0x30 Keep alive
  • 0x33 Set register status
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x53 Delta P periodic data
  • 0x54 Delta P alarm
  • 0x55 Delta P - periodic 0-10 V
  • 0x56 Delta P - alarm 0-10 V
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
requestStatus String Request status. Values can be:
  • errorOtherReason
  • success
  • successNoUpdate
  • errorCoherency
  • errorInvalidRegister
  • errorInvalidValue
  • errorTruncatedValue
  • errorAccesNotAllowed
PayloadDelta P 0x30 Keep Alive frame
DescriptionDelta P 0x30 Keep Alive frame. Tag deltap associated to the device.
Example :
Input30A3
Output
{"type":"0x30 Keep alive","status":{"frameCounter":5,"hardwareError":false,"lowBattery":true,"configurationDone":true,"configurationInconsistency":false}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Delta P configuration
  • 0x11 Delta P 0-10V configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x2f Delta P Downlink ack
  • 0x30 Keep alive
  • 0x33 Set register status
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x53 Delta P periodic data
  • 0x54 Delta P alarm
  • 0x55 Delta P - periodic 0-10 V
  • 0x56 Delta P - alarm 0-10 V
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
PayloadDelta P 0x33 Register Value Response frame
DescriptionDelta P 0x33 Register Value Response frame. Tag deltap associated to the device. Response frame following a registry update via downlink.
Example :
Input3380040140
Output
{"type":"0x33 Set register status","status":{"frameCounter":4,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"requestStatus":"errorInvalidRegister","registerId":320}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Delta P configuration
  • 0x11 Delta P 0-10V configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x2f Delta P Downlink ack
  • 0x30 Keep alive
  • 0x33 Set register status
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x53 Delta P periodic data
  • 0x54 Delta P alarm
  • 0x55 Delta P - periodic 0-10 V
  • 0x56 Delta P - alarm 0-10 V
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
requestStatus String Request status. Values can be:
  • errorOtherReason
  • success
  • successNoUpdate
  • errorCoherency
  • errorInvalidRegister
  • errorInvalidValue
  • errorTruncatedValue
  • errorAccesNotAllowed
registerId int Indicates to the user the register that caused the error, only if requestStatus is different from success.
PayloadDelta P 0x51 Delta P Digital Input 1 Alarm
DescriptionDelta P 0x51 Delta P Digital Input 1 Alarm. Tag deltap associated to the device. Digital Input 1 button alarm frame
Example :
Input51a0010000017E0001
Output
{"type":"0x51 digital input 1 alarm","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"state":{"previousFrame":false,"current":true},"counter":{"global":382,"instantaneous":1}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Delta P configuration
  • 0x11 Delta P 0-10V configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x2f Delta P Downlink ack
  • 0x30 Keep alive
  • 0x33 Set register status
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x53 Delta P periodic data
  • 0x54 Delta P alarm
  • 0x55 Delta P - periodic 0-10 V
  • 0x56 Delta P - alarm 0-10 V
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
state State State
state.previousFrame boolean State of the digital input when sending the previous frame : true if ON/CLOSED, false if OFF/OPENED
state.current boolean Current state of the digital input : true if ON/CLOSED, false if OFF/OPENED
counter Counter Counters
counter.global int Global counter of the digital input
counter.instantaneous int Instantaneous counter of the digital input
PayloadDelta P 0x52 Delta P Digital Input 2 Alarm
DescriptionDelta P 0x52 Delta P Digital Input 2 Alarm. Tag deltap associated to the device. Digital Input 2 terminal block
Example :
Input52a0010000017E0001
Output
{"type":"0x52 digital input 2 alarm","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"state":{"previousFrame":false,"current":true},"counter":{"global":382,"instantaneous":1}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Delta P configuration
  • 0x11 Delta P 0-10V configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x2f Delta P Downlink ack
  • 0x30 Keep alive
  • 0x33 Set register status
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x53 Delta P periodic data
  • 0x54 Delta P alarm
  • 0x55 Delta P - periodic 0-10 V
  • 0x56 Delta P - alarm 0-10 V
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
state State State
state.previousFrame boolean State of the digital input when sending the previous frame : true if ON/CLOSED, false if OFF/OPENED
state.current boolean Current state of the digital input : true if ON/CLOSED, false if OFF/OPENED
counter Counter Counters
counter.global int Global counter of the digital input
counter.instantaneous int Instantaneous counter of the digital input
PayloadDelta P 0x53 Delta P Pressure Delta
DescriptionDelta P 0x53 Delta P Pressure Delta. Tag deltap associated to the device.This frame is sent according to the interval chosen by the user (period = S321xS320xS301) and contains the periodic data of the observed pressure delta.
Example :
Input53A3012C01400190012E
Output
{"type":"0x53 Delta P periodic data","status":{"frameCounter":5,"hardwareError":false,"lowBattery":true,"configurationDone":true,"configurationInconsistency":false},"decodingInfo":"values: [t\u003d0, t-1, t-2, ...]","deltaPressure":{"unit":"pa","values":[300,320,400,302]}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Delta P configuration
  • 0x11 Delta P 0-10V configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x2f Delta P Downlink ack
  • 0x30 Keep alive
  • 0x33 Set register status
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x53 Delta P periodic data
  • 0x54 Delta P alarm
  • 0x55 Delta P - periodic 0-10 V
  • 0x56 Delta P - alarm 0-10 V
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
decodingInfo String values: [t=0, t-1, t-2, ...]
deltaPressure DeltaPressure Sensor Pressure delta
deltaPressure.unit String Pascal
deltaPressure.values Array Pressure delta values in array
PayloadDelta P 0x54 Delta P Pressure Delta Alarm
DescriptionDelta P 0x54 Delta P Pressure Delta Alarm. Tag deltap associated to the device.This frame is sent when a threshold defined by the configuration of register 330 for the pressure delta alarm is exceeded.
Example :
Input54A3010190
Output
{"type":"0x54 Delta P alarm","status":{"frameCounter":5,"hardwareError":false,"lowBattery":true,"configurationDone":true,"configurationInconsistency":false},"alarmStatus":"active","deltaPressure":{"unit":"pa","value":400}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Delta P configuration
  • 0x11 Delta P 0-10V configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x2f Delta P Downlink ack
  • 0x30 Keep alive
  • 0x33 Set register status
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x53 Delta P periodic data
  • 0x54 Delta P alarm
  • 0x55 Delta P - periodic 0-10 V
  • 0x56 Delta P - alarm 0-10 V
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
alarmStatus String Alarm status. Values can be active when thresholds are exceeded, or inactive when thresholds are not reached
deltaPressure DeltaPressure Sensor Pressure delta
deltaPressure.unit String Pascal
deltaPressure.value Number Pressure delta value
PayloadDelta P 0x55 Delta P Analogic Entry Data
DescriptionDelta P 0x55 Delta P Analogic Entry Data. Tag deltap associated to the device.This frame is sent according to the period chosen by the user (period = S323xS322xS324) and contains the periodic data of the 0-10 V analog input.
Example :
Input55A32710251C25802710
Output
{"type":"0x55 Delta P - periodic 0-10 V","status":{"frameCounter":5,"hardwareError":false,"lowBattery":true,"configurationDone":true,"configurationInconsistency":false},"decodingInfo":"values: [t\u003d0, t-1, t-2, ...]","voltage":{"unit":"mV","values":[10000,9500,9600,10000]}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Delta P configuration
  • 0x11 Delta P 0-10V configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x2f Delta P Downlink ack
  • 0x30 Keep alive
  • 0x33 Set register status
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x53 Delta P periodic data
  • 0x54 Delta P alarm
  • 0x55 Delta P - periodic 0-10 V
  • 0x56 Delta P - alarm 0-10 V
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
decodingInfo String values: [t=0, t-1, t-2, ...]
voltage Voltage Measurement 0-10V
voltage.unit String MilliVolts
voltage.values Array Measurement 0-10V values in array
PayloadDelta P 0x56 Delta P Analogic Entry Alarm
DescriptionDelta P 0x56 Delta P Analogic Entry Alarm. Tag deltap associated to the device.Alarm frame for analog input alarm 0-10 V. This frame is sent when a threshold defined by the configuration of register 350 for the 0-10 V input alarm is exceeded.
Example :
Input56A30111C6
Output
{"type":"0x56 Delta P - alarm 0-10 V","status":{"frameCounter":5,"hardwareError":false,"lowBattery":true,"configurationDone":true,"configurationInconsistency":false},"alarmStatus":"active","voltage":{"unit":"mV","value":4550}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Delta P configuration
  • 0x11 Delta P 0-10V configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x2f Delta P Downlink ack
  • 0x30 Keep alive
  • 0x33 Set register status
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x53 Delta P periodic data
  • 0x54 Delta P alarm
  • 0x55 Delta P - periodic 0-10 V
  • 0x56 Delta P - alarm 0-10 V
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
alarmStatus String Alarm status. Values can be active when thresholds are exceeded, or inactive when thresholds are not reached
voltage Voltage Measurement 0-10V
voltage.unit String MilliVolts
voltage.value Number Measurement 0-10V value
PayloadDry Contacts 0x10 Product Configuration frame
DescriptionDry Contacts 0x10 Product Configuration frame. Tag dc associated to the device. Following reception of a downlink frame with the code 0x10 or on switching to the operating mode (from the Park or Command Mode), the next frames (0x10 to 0x14) representing the application configuration of the product are transmitted
Example :
Input10AB90487300B43201
Output
{"type":"0x10 Dry Contacts configuration","status":{"frameCounter":5,"hardwareError":false,"lowBattery":true,"configurationDone":true},"productMode":"PRODUCTION","keepAlivePeriod":{"unit":"m","value":1440},"transmitPeriod":{"unit":"m","value":720},"channelA":{"type":"inputPeriodic","edge":"both","debounceDuration":{"unit":"s","value":1}},"channelB":{"type":"disabled"},"channelC":{"type":"inputEvent","edge":"high","debounceDuration":{"unit":"s","value":20}},"channelD":{"type":"inputPeriodic","edge":"low","debounceDuration":{"unit":"ms","value":50}}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Dry Contacts configuration
  • 0x10 Dry Contacts 2 configuration
  • 0x20 Configuration
  • 0x2f Downlink ack
  • 0x30 Keep alive
  • 0x30 Dry Contacts 2 keep alive
  • 0x40 Dry Contacts data
  • 0x40 Dry Contacts 2 data
  • 0x41 Dry Contacts 2 duration alarm
  • 0x59 Dry Contacts 2 time counting data
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.timestamp boolean True if timestamp is activated
productMode String Product mode. Values can be:
  • PRODUCTION
  • PARK
  • TEST
  • DEAD
keepAlivePeriod DcPeriod Periodicity of the Keep Alive
dcPeriod.value int Period
dcPeriod.unit String Period unit
transmitPeriod DcPeriod Periodicity of transmission
dcPeriod.value int Period
dcPeriod.unit String Period unit
channelA Channel Configuration of the input Channel 1
channel.type String Mode type. Values can be: disabled, input, inputPeriodic, inputEvent, output
channel.edge String Edge. Values can be: high, low, both
channel.debounceDuration DcPeriod Debounce duration
dcPeriod.value int Period
dcPeriod.unit String Period unit
channel.value int If configured as an input (event or Periodic mode), contains the value of the event counter of Input Channel
channel.currentState Boolean Current state
channel.previousFrameState Boolean State at the sending of the previous frame
channelB Channel Configuration of the input Channel 2
channel.type String Mode type. Values can be: disabled, input, inputPeriodic, inputEvent, output
channel.edge String Edge. Values can be: high, low, both
channel.debounceDuration DcPeriod Debounce duration
dcPeriod.value int Period
dcPeriod.unit String Period unit
channel.value int If configured as an input (event or Periodic mode), contains the value of the event counter of Input Channel
channel.currentState Boolean Current state
channel.previousFrameState Boolean State at the sending of the previous frame
channelC Channel Configuration of the input Channel 3
channel.type String Mode type. Values can be: disabled, input, inputPeriodic, inputEvent, output
channel.edge String Edge. Values can be: high, low, both
channel.debounceDuration DcPeriod Debounce duration
dcPeriod.value int Period
dcPeriod.unit String Period unit
channel.value int If configured as an input (event or Periodic mode), contains the value of the event counter of Input Channel
channel.currentState Boolean Current state
channel.previousFrameState Boolean State at the sending of the previous frame
channelD Channel Configuration of the input Channel 4
channel.type String Mode type. Values can be: disabled, input, inputPeriodic, inputEvent, output
channel.edge String Edge. Values can be: high, low, both
channel.debounceDuration DcPeriod Debounce duration
dcPeriod.value int Period
dcPeriod.unit String Period unit
channel.value int If configured as an input (event or Periodic mode), contains the value of the event counter of Input Channel
channel.currentState Boolean Current state
channel.previousFrameState Boolean State at the sending of the previous frame
PayloadDry Contacts 0x20 Configuration frame
DescriptionDry Contacts 0x20 Configuration frame. Tag dc associated to the device. Frame of information on the network configuration
Example :
Input20C40101
Output
{"type":"0x20 Configuration","status":{"frameCounter":6,"hardwareError":true,"lowBattery":false,"configurationDone":false},"loraAdr":true,"loraProvisioningMode":"OTAA","loraClassMode":"CLASS A"}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Dry Contacts configuration
  • 0x10 Dry Contacts 2 configuration
  • 0x20 Configuration
  • 0x2f Downlink ack
  • 0x30 Keep alive
  • 0x30 Dry Contacts 2 keep alive
  • 0x40 Dry Contacts data
  • 0x40 Dry Contacts 2 data
  • 0x41 Dry Contacts 2 duration alarm
  • 0x59 Dry Contacts 2 time counting data
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.timestamp boolean True if timestamp is activated
loraAdr Boolean Activation of the ADR : true if ON, false if OFF
loraProvisioningMode String Mode of activation : value can be ABP or OTAA (default value
loraDutycyle String Dutycycle : values can be activated or deactivated
loraClassMode String ClassMode : values can be CLASS A or CLASS C.
PayloadDry Contacts 0x30 Keep Alive frame
DescriptionDry Contacts 0x30 Keep Alive frame. Tag dc associated to the device. This frame (0x30) is only issued when the different digital outputs are configured in the event mode or in output and at the frequency defined by register 300
Example :
Input30E7
Output
{"type":"0x30 Keep alive","status":{"frameCounter":7,"hardwareError":true,"lowBattery":true,"configurationDone":true}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Dry Contacts configuration
  • 0x10 Dry Contacts 2 configuration
  • 0x20 Configuration
  • 0x2f Downlink ack
  • 0x30 Keep alive
  • 0x30 Dry Contacts 2 keep alive
  • 0x40 Dry Contacts data
  • 0x40 Dry Contacts 2 data
  • 0x41 Dry Contacts 2 duration alarm
  • 0x59 Dry Contacts 2 time counting data
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.timestamp boolean True if timestamp is activated
channelA Channel Channel 1 info if configured in input mode
channel.state boolean Current state : true when ON/CLOSED, false when OFF/OPEN
channel.value int Gloabal event counter
channelB Channel Channel 2 info if configured in input mode
channel.state boolean Current state : true when ON/CLOSED, false when OFF/OPEN
channel.value int Gloabal event counter
channelC Channel Channel 3 info if configured in input mode
channel.state boolean Current state : true when ON/CLOSED, false when OFF/OPEN
channel.value int Gloabal event counter
channelD Channel Channel 4 info if configured in input mode
channel.state boolean Current state : true when ON/CLOSED, false when OFF/OPEN
channel.value int Gloabal event counter
timestamp String Timestamp
PayloadDry Contacts 0x40 Data frame
DescriptionDry Contacts 0x40 Data frame. Tag dc associated to the device. This frame (0x40) contains the values measured on the different digital outputs.
Example :
Input400800F10002000100009C
Output
{"type":"0x40 Dry Contacts data","status":{"frameCounter":0,"hardwareError":false,"lowBattery":false,"configurationDone":false},"decodingInfo":"true: ON/CLOSED, false: OFF/OPEN","channelA":{"value":241,"currentState":false,"previousFrameState":false},"channelB":{"value":2,"currentState":true,"previousFrameState":true},"channelC":{"value":1,"currentState":true,"previousFrameState":false},"channelD":{"value":0,"currentState":false,"previousFrameState":true}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Dry Contacts configuration
  • 0x10 Dry Contacts 2 configuration
  • 0x20 Configuration
  • 0x2f Downlink ack
  • 0x30 Keep alive
  • 0x30 Dry Contacts 2 keep alive
  • 0x40 Dry Contacts data
  • 0x40 Dry Contacts 2 data
  • 0x41 Dry Contacts 2 duration alarm
  • 0x59 Dry Contacts 2 time counting data
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.timestamp boolean True if timestamp is activated
decodingInfo String True: ON/CLOSED, false: OFF/OPEN
channelA Channel Configuration of the input Channel 1
channel.value int If configured as an input (event or Periodic mode), contains the value of the event counter of Input Channel
channel.currentState Boolean Current state
channel.previousFrameState Boolean State at the sending of the previous frame
channelB Channel Configuration of the input Channel 2
channel.value int If configured as an input (event or Periodic mode), contains the value of the event counter of Input Channel
channel.currentState Boolean Current state
channel.previousFrameState Boolean State at the sending of the previous frame
channelC Channel Configuration of the input Channel 3
channel.value int If configured as an input (event or Periodic mode), contains the value of the event counter of Input Channel
channel.currentState Boolean Current state
channel.previousFrameState Boolean State at the sending of the previous frame
channelD Channel Configuration of the input Channel 4
channel.value int If configured as an input (event or Periodic mode), contains the value of the event counter of Input Channel
channel.currentState Boolean Current state
channel.previousFrameState Boolean State at the sending of the previous frame
timestamp String Timestamp
PayloadMotion 0x10 Motion Configuration
DescriptionMotion 0x10 Motion Configuration. Tag motion associated to the device. Information frame on device configuration
Example :
Input10A321C000080012012c0001
Output
{"type":"0x10 Motion configuration","status":{"frameCounter":5,"hardwareError":false,"lowBattery":true,"configurationDone":true,"configurationInconsistency":false},"transmissionPeriodKeepAlive":{"unit":"s","value":86400},"numberOfHistorizationBeforeSending":8,"numberOfSamplingBeforeHistorization":18,"samplingPeriod":{"unit":"s","value":600},"presenceDetectorInhibition":{"unit":"s","value":10},"calculatedPeriodRecording":{"unit":"s","value":10800},"calculatedSendingPeriod":{"unit":"s","value":86400}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Motion configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x33 Set register status
  • 0x4e Motion data
  • 0x4f Motion presence alarm
  • 0x50 Motion luminosity alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x5c Motion data
  • 0x5d Motion presence alarm
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
transmissionPeriodKeepAlive Period Transmission period of the Keep Alive frame.
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
numberOfHistorizationBeforeSending int Transmission period of the periodic frame
numberOfSamplingBeforeHistorization int History period
samplingPeriod Period Sampling period
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
presenceDetectorInhibition Period Presence Detector Inhibition
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
calculatedPeriodRecording Period Calculated period recording
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
calculatedSendingPeriod Period Calculated sending period
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
PayloadMotion 0x1f Motion Digital Input Configuration
DescriptionMotion 0x1f Motion Digital Input Configuration. Tag motion associated to the device. Information frame on configuration of Digital Input(s)
Example :
Input1f20410001410001
Output
{"type":"0x1f digital input configuration","status":{"frameCounter":1,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"digitalInput1":{"type":"highEdge","debouncingPeriod":{"unit":"ms","value":100},"threshold":1},"digitalInput2":{"type":"highEdge","debouncingPeriod":{"unit":"ms","value":100},"threshold":1}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Motion configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x33 Set register status
  • 0x4e Motion data
  • 0x4f Motion presence alarm
  • 0x50 Motion luminosity alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x5c Motion data
  • 0x5d Motion presence alarm
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
digitalInput1 DigitalInput Configuration of the button (Digital Input 1)
digitalInput.type String Digital Input type. Values can be deactivated when off, highEdge when event ON, lowEdge when event OFF, or bothEdges when event ON/OFF
digitalInput.debouncingPeriod DebouncingPeriod Debouncing period
debouncingPeriod.unit String milliseconds
debouncingPeriod.value int Debouncing period value
digitalInput.threshold int Button alarm threshold value : when the detection counter becomes greater than this threshold, an alarm is triggered
digitalInput2 DigitalInput Configuration of the button (Digital Input 2)
digitalInput.type String Digital Input type. Values can be deactivated when off, highEdge when event ON, lowEdge when event OFF, or bothEdges when event ON/OFF
digitalInput.debouncingPeriod DebouncingPeriod Debouncing period
debouncingPeriod.unit String milliseconds
debouncingPeriod.value int Debouncing period value
digitalInput.threshold int Button alarm threshold value : when the detection counter becomes greater than this threshold, an alarm is triggered
PayloadMotion - 0x20 Configuration
DescriptionMotion - 0x20 Configuration. Tag motion associated to the device. Information frames on Network configuration
Example :
Input20A00101
Output
{"type":"0x20 Configuration","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"loraAdr":true,"loraProvisioningMode":"OTAA","loraClassMode":"CLASS A"}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Motion configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x33 Set register status
  • 0x4e Motion data
  • 0x4f Motion presence alarm
  • 0x50 Motion luminosity alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x5c Motion data
  • 0x5d Motion presence alarm
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
loraAdr Boolean Activation of the ADR : true if ON, false if OFF
loraProvisioningMode String Mode of activation : value can be ABP or OTAA (default value
loraDutycyle String Dutycycle : values can be activated or deactivated
loraClassMode String ClassMode : values can be CLASS A or CLASS C.
PayloadMotion 0x30 Keep alive
DescriptionMotion 0x30 Keep alive. Tag motion associated to the device. Keep alive frame
Example :
Input30A3
Output
{"type":"0x30 Keep alive","status":{"frameCounter":5,"hardwareError":false,"lowBattery":true,"configurationDone":true,"configurationInconsistency":false}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Motion configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x33 Set register status
  • 0x4e Motion data
  • 0x4f Motion presence alarm
  • 0x50 Motion luminosity alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x5c Motion data
  • 0x5d Motion presence alarm
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
PayloadMotion 0x4e Motion Data
DescriptionMotion 0x4e Motion Data. Tag motion associated to the device. Periodic data frame
Example :
Input4EA300D2003550
Output
{"type":"0x4e Motion data","status":{"frameCounter":5,"hardwareError":false,"lowBattery":true,"configurationDone":true,"configurationInconsistency":false},"globalCounterValue":210,"decodingInfo":"counterValues/values: [t\u003d0, t-1, t-2, ...]","counterValues":[53],"luminosity":{"unit":"%","values":[80]}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Motion configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x33 Set register status
  • 0x4e Motion data
  • 0x4f Motion presence alarm
  • 0x50 Motion luminosity alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x5c Motion data
  • 0x5d Motion presence alarm
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
globalCounterValue Number Presence global counter containing the number of presence detections since device start
decodingInfo String counterValues/values: [t=0, t-1, t-2, ...]
counterValues Array Presence Counter values
luminosity Luminosity Luminosity
luminosity.unit String %
luminosity.values Array Luminosity in array
PayloadMotion 0x4f Motion presence alarm
DescriptionMotion 0x4f Motion presence alarm. Tag motion associated to the device. Presence detection alarm frame
Example :
Input4fa301400023
Output
{"type":"0x4f Motion presence alarm","status":{"frameCounter":5,"hardwareError":false,"lowBattery":true,"configurationDone":true,"configurationInconsistency":false},"alarmPresence":{"globalCounterValue":320,"counterValue":35}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Motion configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x33 Set register status
  • 0x4e Motion data
  • 0x4f Motion presence alarm
  • 0x50 Motion luminosity alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x5c Motion data
  • 0x5d Motion presence alarm
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
alarmPresence AlarmPresence
alarmPresence.globalCounterValue int Presence global counter: global count of detections since start up
alarmPresence.counterValue int Presence counter: counter since the last frame sent
PayloadMotion 0x50 Motion luminosity alarm
DescriptionMotion 0x50 Motion luminosity alarm. Tag motion associated to the device. Brightness alarm frame
Example :
Input50a30118
Output
{"type":"0x50 Motion luminosity alarm","status":{"frameCounter":5,"hardwareError":false,"lowBattery":true,"configurationDone":true,"configurationInconsistency":false},"alarmLuminosity":{"alarmStatus":"active","luminosity":{"unit":"%","value":24}}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Motion configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x33 Set register status
  • 0x4e Motion data
  • 0x4f Motion presence alarm
  • 0x50 Motion luminosity alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x5c Motion data
  • 0x5d Motion presence alarm
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
alarmLuminosity AlarmLuminosity Luminosity alarm
alarmLuminosity.alarmStatus String Alarm status. Values can be active when thresholds are exceeded, or inactive when thresholds are not reached
alarmLuminosity.luminosity Luminosity Luminosity
luminosity.unit String %
luminosity.value int Luminosity
PayloadMotion 0x51 Motion Digital Input 1 Alarm
DescriptionMotion 0x51 Motion Digital Input 1 Alarm. Tag motion associated to the device. Digital Input 1 button alarm frame
Example :
Input51a0010000017E0001
Output
{"type":"0x51 digital input 1 alarm","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"state":{"previousFrame":false,"current":true},"counter":{"global":382,"instantaneous":1}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Motion configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x33 Set register status
  • 0x4e Motion data
  • 0x4f Motion presence alarm
  • 0x50 Motion luminosity alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x5c Motion data
  • 0x5d Motion presence alarm
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
state State State
state.previousFrame boolean State of the digital input when sending the previous frame : true if ON/CLOSED, false if OFF/OPENED
state.current boolean Current state of the digital input : true if ON/CLOSED, false if OFF/OPENED
counter Counter Counters
counter.global int Global counter of the digital input
counter.instantaneous int Instantaneous counter of the digital input
PayloadMotion 0x52 Motion Digital Input 2 Alarm
DescriptionMotion 0x52 Motion Digital Input 2 Alarm. Tag motion associated to the device. Digital Input 2 terminal block
Example :
Input52a0010000017E0001
Output
{"type":"0x52 digital input 2 alarm","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"state":{"previousFrame":false,"current":true},"counter":{"global":382,"instantaneous":1}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Motion configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x33 Set register status
  • 0x4e Motion data
  • 0x4f Motion presence alarm
  • 0x50 Motion luminosity alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x5c Motion data
  • 0x5d Motion presence alarm
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
state State State
state.previousFrame boolean State of the digital input when sending the previous frame : true if ON/CLOSED, false if OFF/OPENED
state.current boolean Current state of the digital input : true if ON/CLOSED, false if OFF/OPENED
counter Counter Counters
counter.global int Global counter of the digital input
counter.instantaneous int Instantaneous counter of the digital input
PayloadMotion 0x33 Set Register Status
DescriptionMotion 0x33 Set Register Status. Tag motion associated to the device. Response frame following an update of register(s) via downlink
Example :
Input3380040140
Output
{"type":"0x33 Set register status","status":{"frameCounter":4,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"requestStatus":"errorInvalidRegister","registerId":320}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Motion configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x33 Set register status
  • 0x4e Motion data
  • 0x4f Motion presence alarm
  • 0x50 Motion luminosity alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x5c Motion data
  • 0x5d Motion presence alarm
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
requestStatus String Request status. Values can be:
  • errorOtherReason
  • success
  • successNoUpdate
  • errorCoherency
  • errorInvalidRegister
  • errorInvalidValue
  • errorTruncatedValue
  • errorAccesNotAllowed
registerId int Indicates to the user the register that caused the error, only if requestStatus is different from success.
PayloadPulse3 0x10 Configuration frame
DescriptionPulse3 0x10 Configuration frame. Tag pulse3 associated to the device. Information frame on device configuration
Example :
Input10A301003C390257003C27107530000A000000030005
Output
{"type":"0x10 Pulse 3 configuration","status":{"frameCounter":5,"hardwareError":false,"lowBattery":true,"configurationDone":true,"configurationInconsistency":false},"productMode":"PRODUCTION","numberOfHistorizationBeforeSending":60,"samplingPeriod":{"unit":"s","value":1198},"calculatedSendingPeriod":{"unit":"s","value":71880},"flowCalculationPeriod":{"unit":"m","value":15399},"channels":[{"name":"channel A","state":"enabled","type":"otherPullUpOff","debouncingPeriod":{"unit":"ms","value":0}},{"name":"channel B","state":"enabled","type":"gasPullUpOn","debouncingPeriod":{"unit":"ms","value":0}}]}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Pulse 3 configuration
  • 0x10 Pulse 4 configuration
  • 0x11 Pulse 3 configuration
  • 0x11 Pulse 4 configuration
  • 0x12 Pulse 3 configuration
  • 0x12 Pulse 4 configuration
  • 0x20 Configuration
  • 0x30 Pulse 3 keep alive
  • 0x30 Pulse 4 keep alive
  • 0x46 Pulse 3 data
  • 0x46 Pulse 4 data
  • 0x47 Pulse 3 alarm
  • 0x47 Pulse 4 alarm
  • 0x5a Pulse 3 data - channel A
  • 0x5a Pulse 4 data - channel A
  • 0x5b Pulse 3 data - channel B
  • 0x5b Pulse 4 data - channel B
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
productMode String Product mode. Values can be:
  • PRODUCTION
  • PARK
numberOfHistorizationBeforeSending int Transmission period of the periodic frame
samplingPeriod Period Sampling period
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
calculatedSendingPeriod Period Calculated sending period
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
flowCalculationPeriod PulsePeriod Flow Calculation Period
pulsePeriod.value int Period
pulsePeriod.unit String Period unit
redundantSamples int Number of redundant samples per frame
channels Array Channels
channel Channel Channel
channel.name String Channel name. Values can be: channel A or channel B
channel.state String State. Values can be: enabled or disabled
channel.type String Type. Values can be: otherPullUpOff or gasPullUpOn
channel.debouncingPeriod PulsePeriod Debouncing period
pulsePeriod.value int Period
pulsePeriod.unit String Period unit
channel.leakageDetection LeakageDetection Leakage detection
leakageDetection.overflowAlarmTriggerThreshold int Flow threshold
leakageDetection.threshold int Leak threshold
leakageDetection.dailyPeriodsBelowWhichLeakageAlarmTriggered int Number of daily periods under leak threshold
channel.tamper Tamper Tamper
tamper.activated boolean True if activated tamper
tamper.samplePeriodForDetection PulsePeriod Sampling period
pulsePeriod.value int Period
pulsePeriod.unit String Period unit
tamper.threshold int Number of sampling necessary before tamper alarm
PayloadPulse3 0x11 Pulse 3 Configuration frame
DescriptionPulse3 0x11 Pulse 3 Configuration frame. Tag pulse3 associated to the device. Information frame on device configuration
Example :
Input11400001000200030004
Output
{"type":"0x11 Pulse 3 configuration","status":{"frameCounter":2,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"channels":[{"name":"channel A","leakageDetection":{"overflowAlarmTriggerThreshold":1,"threshold":3}},{"name":"channel B","leakageDetection":{"overflowAlarmTriggerThreshold":2,"threshold":4}}]}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Pulse 3 configuration
  • 0x10 Pulse 4 configuration
  • 0x11 Pulse 3 configuration
  • 0x11 Pulse 4 configuration
  • 0x12 Pulse 3 configuration
  • 0x12 Pulse 4 configuration
  • 0x20 Configuration
  • 0x30 Pulse 3 keep alive
  • 0x30 Pulse 4 keep alive
  • 0x46 Pulse 3 data
  • 0x46 Pulse 4 data
  • 0x47 Pulse 3 alarm
  • 0x47 Pulse 4 alarm
  • 0x5a Pulse 3 data - channel A
  • 0x5a Pulse 4 data - channel A
  • 0x5b Pulse 3 data - channel B
  • 0x5b Pulse 4 data - channel B
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
channels Array Channels
channel Channel Channel
channel.name String Channel name. Values can be: channel A or channel B
channel.leakageDetection LeakageDetection Leakage Dectection
leakageDetection.overflowAlarmTriggerThreshold int Overflow Alarm Trigger Threshold
leakageDetection.threshold int Threshold
PayloadPulse3 0x12 Pulse 3 Configuration frame
DescriptionPulse3 0x12 Pulse 3 Configuration frame. Tag pulse3 associated to the device. Information frame on device configuration
Example :
Input1280000500060203020301
Output
{"type":"0x12 Pulse 3 configuration","status":{"frameCounter":4,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"channels":[{"name":"channel A","leakageDetection":{"dailyPeriodsBelowWhichLeakageAlarmTriggered":5},"tamper":{"samplePeriodForDetection":{"unit":"s","value":20},"threshold":3}},{"name":"channel B","leakageDetection":{"dailyPeriodsBelowWhichLeakageAlarmTriggered":6},"tamper":{"samplePeriodForDetection":{"unit":"s","value":20},"threshold":3}}]}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Pulse 3 configuration
  • 0x10 Pulse 4 configuration
  • 0x11 Pulse 3 configuration
  • 0x11 Pulse 4 configuration
  • 0x12 Pulse 3 configuration
  • 0x12 Pulse 4 configuration
  • 0x20 Configuration
  • 0x30 Pulse 3 keep alive
  • 0x30 Pulse 4 keep alive
  • 0x46 Pulse 3 data
  • 0x46 Pulse 4 data
  • 0x47 Pulse 3 alarm
  • 0x47 Pulse 4 alarm
  • 0x5a Pulse 3 data - channel A
  • 0x5a Pulse 4 data - channel A
  • 0x5b Pulse 3 data - channel B
  • 0x5b Pulse 4 data - channel B
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
channels Array Channels
channel Channel Channel
channel.name String Channel name. Values can be: channel A or channel B
channel.leakageDetection LeakageDetection Leakage Dectection
leakageDetection.dailyPeriodsBelowWhichLeakageAlarmTriggered int Daily Periods Below Which Leakage Alarm Triggered
channel.tamper Tamper Tamper
tamper.samplePeriodForDetection PulsePeriod Period
pulsePeriod.value int Period
pulsePeriod.unit String Period unit
tamper.threshold int Threshold
PayloadPulse3 0x20 Configuration
DescriptionPulse3 0x20 Configuration. Tag pulse3 associated to the device. Frame of information on the network configuration
Example :
Input20A30501
Output
{"type":"0x20 Configuration","status":{"frameCounter":5,"hardwareError":false,"lowBattery":true,"configurationDone":true,"configurationInconsistency":false},"loraAdr":true,"loraProvisioningMode":"OTAA","loraDutycyle":"activated","loraClassMode":"CLASS A"}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Pulse 3 configuration
  • 0x10 Pulse 4 configuration
  • 0x11 Pulse 3 configuration
  • 0x11 Pulse 4 configuration
  • 0x12 Pulse 3 configuration
  • 0x12 Pulse 4 configuration
  • 0x20 Configuration
  • 0x30 Pulse 3 keep alive
  • 0x30 Pulse 4 keep alive
  • 0x46 Pulse 3 data
  • 0x46 Pulse 4 data
  • 0x47 Pulse 3 alarm
  • 0x47 Pulse 4 alarm
  • 0x5a Pulse 3 data - channel A
  • 0x5a Pulse 4 data - channel A
  • 0x5b Pulse 3 data - channel B
  • 0x5b Pulse 4 data - channel B
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
loraAdr Boolean Activation of the ADR : true if ON, false if OFF
loraProvisioningMode String Mode of activation : value can be ABP or OTAA (default value
loraDutycyle String Dutycycle : values can be activated or deactivated
loraClassMode String ClassMode : values can be CLASS A or CLASS C.
PayloadPulse3 0x30 Pulse 3 Keep Alive frame
DescriptionPulse3 0x30 Pulse 3 Keep Alive Frame. Tag pulse3 associated to the device. Daily Keep-Alive frame
Example :
Input3024E692C4310A80000010
Output
{"type":"0x30 Pulse 3 keep alive","status":{"frameCounter":1,"hardwareError":true,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"channels":[{"name":"channel A","flow":{"alarm":false,"last24hMin":32768,"last24hMax":37572},"tamperAlarm":true,"leakageAlarm":false},{"name":"channel B","flow":{"alarm":true,"last24hMin":16,"last24hMax":12554},"tamperAlarm":false,"leakageAlarm":true}]}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Pulse 3 configuration
  • 0x10 Pulse 4 configuration
  • 0x11 Pulse 3 configuration
  • 0x11 Pulse 4 configuration
  • 0x12 Pulse 3 configuration
  • 0x12 Pulse 4 configuration
  • 0x20 Configuration
  • 0x30 Pulse 3 keep alive
  • 0x30 Pulse 4 keep alive
  • 0x46 Pulse 3 data
  • 0x46 Pulse 4 data
  • 0x47 Pulse 3 alarm
  • 0x47 Pulse 4 alarm
  • 0x5a Pulse 3 data - channel A
  • 0x5a Pulse 4 data - channel A
  • 0x5b Pulse 3 data - channel B
  • 0x5b Pulse 4 data - channel B
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
channels Array Channels
channel Channel Channel
channel.name String Channel name. Values can be: channel A or channel B
channel.flow Flow Flow
flow.alarm Boolean True if alarm is activated
flow.last24hMin int Minimum measured flow on channel A within the last 24 hours
flow.last24hMax int Maximum measured flow on channel within the last 24 hours
channel.tamperAlarm Boolean Tamper decteted : true or false
channel.leakageAlarm Boolean Leak decteted : true or false
timestamp String Timestamp
PayloadPulse3 0x33 Set Register Status frame
DescriptionPulse3 0x33 Set Register Status Frame. Tag pulse3 associated to the device. Reply frame to a request for changing value of a register
Example :
Input3380040140
Output
{"type":"0x33 Set register status","status":{"frameCounter":4,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"requestStatus":"errorInvalidRegister","registerId":320}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Pulse 3 configuration
  • 0x10 Pulse 4 configuration
  • 0x11 Pulse 3 configuration
  • 0x11 Pulse 4 configuration
  • 0x12 Pulse 3 configuration
  • 0x12 Pulse 4 configuration
  • 0x20 Configuration
  • 0x30 Pulse 3 keep alive
  • 0x30 Pulse 4 keep alive
  • 0x46 Pulse 3 data
  • 0x46 Pulse 4 data
  • 0x47 Pulse 3 alarm
  • 0x47 Pulse 4 alarm
  • 0x5a Pulse 3 data - channel A
  • 0x5a Pulse 4 data - channel A
  • 0x5b Pulse 3 data - channel B
  • 0x5b Pulse 4 data - channel B
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
requestStatus String Request status. Values can be:
  • errorOtherReason
  • success
  • successNoUpdate
  • errorCoherency
  • errorInvalidRegister
  • errorInvalidValue
  • errorTruncatedValue
  • errorAccesNotAllowed
registerId int Indicates to the user the register that caused the error, only if requestStatus is different from success.
PayloadPulse3 0x46 Pulse 3 Data frame
DescriptionPulse3 0x46 Pulse 3 Data Frame. Tag pulse3 associated to the device. Data frame without historisation
Example :
Input46A300015C4F0000F74A
Output
{"type":"0x46 Pulse 3 data","status":{"frameCounter":5,"hardwareError":false,"lowBattery":true,"configurationDone":true,"configurationInconsistency":false},"decodingInfo":"counterValues: [Channel A, Channel B]","counterValues":[89167,63306]}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Pulse 3 configuration
  • 0x10 Pulse 4 configuration
  • 0x11 Pulse 3 configuration
  • 0x11 Pulse 4 configuration
  • 0x12 Pulse 3 configuration
  • 0x12 Pulse 4 configuration
  • 0x20 Configuration
  • 0x30 Pulse 3 keep alive
  • 0x30 Pulse 4 keep alive
  • 0x46 Pulse 3 data
  • 0x46 Pulse 4 data
  • 0x47 Pulse 3 alarm
  • 0x47 Pulse 4 alarm
  • 0x5a Pulse 3 data - channel A
  • 0x5a Pulse 4 data - channel A
  • 0x5b Pulse 3 data - channel B
  • 0x5b Pulse 4 data - channel B
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
decodingInfo String Values information: counterValues [Channel A, Channel B]
counterValues Array Counter values
timestamp String Timestamp
PayloadPulse3 0x47 Pulse 3 Alarm frame
DescriptionPulse3 0x47 Pulse 3 Alarm Frame. Tag pulse3 associated to the device. Alarm frame
Example :
Input47a00f780000
Output
{"type":"0x47 Pulse 3 alarm","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"decodingInfo":"flowValues: [Channel A, Channel B]","flowValues":[3960,0]}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Pulse 3 configuration
  • 0x10 Pulse 4 configuration
  • 0x11 Pulse 3 configuration
  • 0x11 Pulse 4 configuration
  • 0x12 Pulse 3 configuration
  • 0x12 Pulse 4 configuration
  • 0x20 Configuration
  • 0x30 Pulse 3 keep alive
  • 0x30 Pulse 4 keep alive
  • 0x46 Pulse 3 data
  • 0x46 Pulse 4 data
  • 0x47 Pulse 3 alarm
  • 0x47 Pulse 4 alarm
  • 0x5a Pulse 3 data - channel A
  • 0x5a Pulse 4 data - channel A
  • 0x5b Pulse 3 data - channel B
  • 0x5b Pulse 4 data - channel B
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
decodingInfo String Values information: flowValues [Channel A, Channel B]
flowValues Array Flow values
timestamp String Timestamp
PayloadPulse3 0x5a Pulse 3 Data Channel A frame
DescriptionPulse3 0x5a Pulse 3 Data Channel A Frame. Tag pulse3 associated to the device. Periodic frame with historisation
Example :
Input5AA300015C4FE6F3F74AE6F3E6F3E6F3E6F3E6F3E6F3E6F3E6F3E6F3E6F3E6F3E6F3E6F3E6F3E6F3E6F3E6F3E6F3E6F3F2AD
Output
{"type":"0x5a Pulse 3 data - channel A","status":{"frameCounter":5,"hardwareError":false,"lowBattery":true,"configurationDone":true,"configurationInconsistency":false},"decodingInfo":"counterValues: [t\u003d0, t-1, t-2, ...]","counterValues":[89167,95580,97810,104223,110636,117049,123462,129875,136288,142701,149114,155527,161940,168353,174766,181179,187592,194005,200418,206831,213244,219657,223068]}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Pulse 3 configuration
  • 0x10 Pulse 4 configuration
  • 0x11 Pulse 3 configuration
  • 0x11 Pulse 4 configuration
  • 0x12 Pulse 3 configuration
  • 0x12 Pulse 4 configuration
  • 0x20 Configuration
  • 0x30 Pulse 3 keep alive
  • 0x30 Pulse 4 keep alive
  • 0x46 Pulse 3 data
  • 0x46 Pulse 4 data
  • 0x47 Pulse 3 alarm
  • 0x47 Pulse 4 alarm
  • 0x5a Pulse 3 data - channel A
  • 0x5a Pulse 4 data - channel A
  • 0x5b Pulse 3 data - channel B
  • 0x5b Pulse 4 data - channel B
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
decodingInfo String Values information: counterValues: [t=0, t-1, t-2, ...]
counterValues Array Counter values
timestamp String Timestamp
PayloadPulse3 0x5b Pulse 3 Data Channel B frame
DescriptionPulse3 0x5b Pulse 3 Data Channel B Frame. Tag pulse3 associated to the device. Periodic frame with historisation
Example :
Input5B8200015C4FE6F3
Output
{"type":"0x5b Pulse 3 data - channel B","status":{"frameCounter":4,"hardwareError":false,"lowBattery":true,"configurationDone":false,"configurationInconsistency":false},"decodingInfo":"counterValues: [t\u003d0, t-1, t-2, ...]","counterValues":[89167,95580]}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Pulse 3 configuration
  • 0x10 Pulse 4 configuration
  • 0x11 Pulse 3 configuration
  • 0x11 Pulse 4 configuration
  • 0x12 Pulse 3 configuration
  • 0x12 Pulse 4 configuration
  • 0x20 Configuration
  • 0x30 Pulse 3 keep alive
  • 0x30 Pulse 4 keep alive
  • 0x46 Pulse 3 data
  • 0x46 Pulse 4 data
  • 0x47 Pulse 3 alarm
  • 0x47 Pulse 4 alarm
  • 0x5a Pulse 3 data - channel A
  • 0x5a Pulse 4 data - channel A
  • 0x5b Pulse 3 data - channel B
  • 0x5b Pulse 4 data - channel B
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
decodingInfo String Values information: counterValues: [t=0, t-1, t-2, ...]
counterValues Array Counter values
timestamp String Timestamp
PayloadPulse 0x10 Pulse Configuration
DescriptionPulse 0x10 Pulse Configuration. Tag pulse associated to the device. Information frame on device configuration
Example :
Input10A301003C390257003C27107530000A000000030005
Output
{"type":"0x10 Pulse configuration","status":{"frameCounter":5,"hardwareError":false,"lowBattery":true,"configurationDone":true},"productMode":"PRODUCTION","transmissionPeriod":{"unit":"m","value":60},"flowCalculationPeriod":{"unit":"m","value":60},"historicMode":"historicLogEvery1h","channels":[{"name":"channel A","state":"enabled","type":"otherPullUpOff","tamperActivated":true,"debouncingPeriod":{"unit":"ms","value":500},"leakageDetection":{"overflowAlarmTriggerThreshold":10000,"threshold":10,"dailyPeriodsBelowWhichLeakageAlarmTriggered":3}},{"name":"channel B","state":"enabled","type":"gasPullUpOn","tamperActivated":false,"debouncingPeriod":{"unit":"ms","value":100},"leakageDetection":{"overflowAlarmTriggerThreshold":30000,"threshold":0,"dailyPeriodsBelowWhichLeakageAlarmTriggered":5}}]}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Pulse configuration
  • 0x11 Pulse configuration
  • 0x12 Pulse configuration
  • 0x20 Configuration
  • 0x30 Pulse keep alive
  • 0x46 Pulse data
  • 0x47 Pulse alarm
  • 0x48 Pulse historic data
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
productMode String Product mode. Values can be:
  • PRODUCTION
  • PARK
transmissionPeriod PulsePeriod Periodicity of transmission
pulsePeriod.value int Period
pulsePeriod.unit String Period unit
flowCalculationPeriod PulsePeriod Flow Calculation Period
pulsePeriod.value int Period
pulsePeriod.unit String Period unit
historicMode String Historic mode. Period of historisation
channels Array Channels
channel Channel Channel
channel.name String Channel name. Values can be: channel A or channel B
channel.state String State. Values can be: enabled or disabled
channel.type String Type. Values can be: otherPullUpOff or gasPullUpOn
channel.tamperActivated Boolean Tamper input channel activated : true or false
channel.debouncingPeriod PulsePeriod Debouncing period
pulsePeriod.value int Period
pulsePeriod.unit String Period unit
channel.leakageDetection LeakageDetection Leakage Dectection
leakageDetection.overflowAlarmTriggerThreshold int Overflow Alarm Trigger Threshold
leakageDetection.threshold int Threshold
leakageDetection.dailyPeriodsBelowWhichLeakageAlarmTriggered int Daily Periods Below Which Leakage Alarm Triggered
PayloadPulse 0x11 Pulse Configuration
DescriptionPulse 0x11 Pulse Configuration. Tag pulse associated to the device. Information frame on device configuration
Example :
Input11400001000200030004
Output
{"type":"0x11 Pulse configuration","status":{"frameCounter":2,"hardwareError":false,"lowBattery":false,"configurationDone":false},"channels":[{"name":"channel A","leakageDetection":{"overflowAlarmTriggerThreshold":1,"threshold":3}},{"name":"channel B","leakageDetection":{"overflowAlarmTriggerThreshold":2,"threshold":4}}]}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Pulse configuration
  • 0x11 Pulse configuration
  • 0x12 Pulse configuration
  • 0x20 Configuration
  • 0x30 Pulse keep alive
  • 0x46 Pulse data
  • 0x47 Pulse alarm
  • 0x48 Pulse historic data
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
channels Array Channels
channel Channel Channel
channel.name String Channel name. Values can be: channel A or channel B
channel.leakageDetection LeakageDetection Leakage Dectection
leakageDetection.overflowAlarmTriggerThreshold int Overflow Alarm Trigger Threshold
leakageDetection.threshold int Threshold
PayloadPulse 0x12 Pulse Configuration
DescriptionPulse 0x12 Pulse Configuration. Tag pulse associated to the device. Information frame on device configuration
Example :
Input1280000500060203020301
Output
{"type":"0x12 Pulse configuration","status":{"frameCounter":4,"hardwareError":false,"lowBattery":false,"configurationDone":false},"channels":[{"name":"channel A","leakageDetection":{"dailyPeriodsBelowWhichLeakageAlarmTriggered":5}},{"name":"channel B","leakageDetection":{"dailyPeriodsBelowWhichLeakageAlarmTriggered":6}}]}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Pulse configuration
  • 0x11 Pulse configuration
  • 0x12 Pulse configuration
  • 0x20 Configuration
  • 0x30 Pulse keep alive
  • 0x46 Pulse data
  • 0x47 Pulse alarm
  • 0x48 Pulse historic data
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
channels Array Channels
channel Channel Channel
channel.name String Channel name. Values can be: channel A or channel B
channel.leakageDetection LeakageDetection Leakage Dectection
leakageDetection.dailyPeriodsBelowWhichLeakageAlarmTriggered int Daily Periods Below Which Leakage Alarm Triggered
PayloadPulse 0x20 Configuration
DescriptionPulse 0x20 Configuration. Tag pulse associated to the device. Frame of information on the network configuration
Example :
Input20A30501
Output
{"type":"0x20 Configuration","status":{"frameCounter":5,"hardwareError":false,"lowBattery":true,"configurationDone":true},"loraAdr":true,"loraProvisioningMode":"OTAA","loraDutycyle":"activated","loraClassMode":"CLASS A"}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Pulse configuration
  • 0x11 Pulse configuration
  • 0x12 Pulse configuration
  • 0x20 Configuration
  • 0x30 Pulse keep alive
  • 0x46 Pulse data
  • 0x47 Pulse alarm
  • 0x48 Pulse historic data
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
loraAdr Boolean Activation of the ADR : true if ON, false if OFF
loraProvisioningMode String Mode of activation : value can be ABP or OTAA (default value
loraDutycyle String Dutycycle : values can be activated or deactivated
loraClassMode String ClassMode : values can be CLASS A or CLASS C.
PayloadPulse 0x30 Keep Alive Frame
DescriptionPulse 0x30 Keep Alive Frame. Tag pulse associated to the device. Daily Keep-Alive Frame
Example :
Input3024E692C4310A80000010
Output
{"type":"0x30 Pulse keep alive","status":{"frameCounter":1,"hardwareError":true,"lowBattery":false,"configurationDone":false},"channels":[{"name":"channel A","flow":{"alarm":false,"last24hMin":32768,"last24hMax":37572},"tamperAlarm":true,"leakageAlarm":false},{"name":"channel B","flow":{"alarm":true,"last24hMin":16,"last24hMax":12554},"tamperAlarm":false,"leakageAlarm":true}]}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Pulse configuration
  • 0x11 Pulse configuration
  • 0x12 Pulse configuration
  • 0x20 Configuration
  • 0x30 Pulse keep alive
  • 0x46 Pulse data
  • 0x47 Pulse alarm
  • 0x48 Pulse historic data
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
channels Array Channels
channel Channel Channel
channel.name String Channel name. Values can be: channel A or channel B
channel.flow Flow Flow
flow.alarm Boolean True if alarm is activated
flow.last24hMin int Minimum measured flow on channel A within the last 24 hours
flow.last24hMax int Maximum measured flow on channel within the last 24 hours
channel.tamperAlarm Boolean Tamper decteted : true or false
channel.leakageAlarm Boolean Leak decteted : true or false
PayloadPulse 0x46 Pulse Data Frame
DescriptionPulse 0x46 Pulse Data Frame. Tag pulse associated to the device. Pulse data frame
Example :
Input46A300015C4F0000F74A
Output
{"type":"0x46 Pulse data","status":{"frameCounter":5,"hardwareError":false,"lowBattery":true,"configurationDone":true},"decodingInfo":"counterValues: [Channel A, Channel B]","counterValues":[89167,63306]}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Pulse configuration
  • 0x11 Pulse configuration
  • 0x12 Pulse configuration
  • 0x20 Configuration
  • 0x30 Pulse keep alive
  • 0x46 Pulse data
  • 0x47 Pulse alarm
  • 0x48 Pulse historic data
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
decodingInfo String Values information: counterValues [Channel A, Channel B]
counterValues Array Counter values
PayloadPulse 0x47 Pulse Alarm Frame
DescriptionPulse 0x47 Pulse Alarm Frame. Tag pulse associated to the device. Alarm frame
Example :
Input47a00f780000
Output
{"type":"0x47 Pulse alarm","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false},"decodingInfo":"flowValues: [Channel A, Channel B]","flowValues":[3960,0]}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Pulse configuration
  • 0x11 Pulse configuration
  • 0x12 Pulse configuration
  • 0x20 Configuration
  • 0x30 Pulse keep alive
  • 0x46 Pulse data
  • 0x47 Pulse alarm
  • 0x48 Pulse historic data
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
decodingInfo String Values information: flowValues [Channel A, Channel B]
flowValues Array Flow values
PayloadPulse 0x48 Pulse Historic Data Frame
DescriptionPulse 0x48 Pulse Historic Data Frame. Tag pulse associated to the device. Pulse historic data frame
Example :
Input4820000000010000000200000100020003000400050006000700080009000a000b000c000d000e000f00100011001200130014
Output
{"type":"0x48 Pulse historic data","status":{"frameCounter":1,"hardwareError":false,"lowBattery":false,"configurationDone":false},"frameIndex":0,"baseTime":1,"decodingInfo":"deltaValues: [t\u003d1 to t\u003d2, t\u003d2 to t\u003d3, ...]","channels":[{"name":"channel A","index":256,"deltaValues":[1,3,5,7,9,11,13,15,17,19]},{"name":"channel B","index":512,"deltaValues":[2,4,6,8,10,12,14,16,18,20]}]}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Pulse configuration
  • 0x11 Pulse configuration
  • 0x12 Pulse configuration
  • 0x20 Configuration
  • 0x30 Pulse keep alive
  • 0x46 Pulse data
  • 0x47 Pulse alarm
  • 0x48 Pulse historic data
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
frameIndex int Frame index
baseTime int Base time
decodingInfo String Values information: deltaValues [t=1 to t=2, t=2 to t=3, ...]
channels Array Channels
channel Channel Channel
channel.name String Channel name. Values can be: channel A or channel B
channel.index int Index of the frame in a multi-message sequence
channel.deltaValues Array Delta values : index variation of channel A and channel B during the time interval between 23 to 24 hours after transmitting the previous frame
PayloadTemp3 0x10 Product Configuration frame Production mode
DescriptionTemp3 0x10 Product Configuration frame Production mode. Default tag temp3 associated to the device. This frame is sent following the reception of a frame with code 0x01, or at the start of the product.
Example :
Input101021C000030002070800
Output
{"type":"0x10 Temp 3 configuration","status":{"frameCounter":0,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false,"configuration2ChannelsActivated":true},"transmissionPeriodKeepAlive":{"unit":"s","value":86400},"numberOfHistorizationBeforeSending":3,"numberOfSamplingBeforeHistorization":2,"samplingPeriod":{"unit":"s","value":3600},"redundantSamples":0,"calculatedPeriodRecording":{"unit":"s","value":7200},"calculatedSendingPeriod":{"unit":"s","value":21600}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Temp 3 configuration
  • 0x10 Temp 4 configuration
  • 0x20 Configuration
  • 0x2f Downlink ack
  • 0x30 Temp 3 keep alive
  • 0x30 Temp 4 keep alive
  • 0x33 Set register status
  • 0x36 Alert message
  • 0x37 Software version
  • 0x57 Temp 3 periodic data
  • 0x57 Temp 4 periodic data
  • 0x58 Temp 3 alarm
  • 0x58 Temp 4 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.configuration2ChannelsActivated boolean True if 2 channels are activated, false if 1 channel is activated
status.timestamp boolean True if timestamp is activated
transmissionPeriodKeepAlive Period Transmission period of the Keep Alive frame.
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
numberOfHistorizationBeforeSending int Transmission period of the periodic frame
numberOfSamplingBeforeHistorization int History period
samplingPeriod Period Sampling period
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
redundantSamples int Number of additional (redundant) samples per frame
calculatedPeriodRecording Period Calculated period recording
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
calculatedSendingPeriod Period Calculated sending period
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
PayloadTemp3 0x20 Network configuration frame
DescriptionTemp3 0x20 Network configuration frame. Default tag temp3 associated to the device. This frame is sent following the reception of a frame with code 0x02, or at the start of the product.
Example :
Input20300501
Output
{"type":"0x20 Configuration","status":{"frameCounter":1,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false,"configuration2ChannelsActivated":true},"loraAdr":true,"loraProvisioningMode":"OTAA","loraDutycyle":"activated","loraClassMode":"CLASS A"}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Temp 3 configuration
  • 0x10 Temp 4 configuration
  • 0x20 Configuration
  • 0x2f Downlink ack
  • 0x30 Temp 3 keep alive
  • 0x30 Temp 4 keep alive
  • 0x33 Set register status
  • 0x36 Alert message
  • 0x37 Software version
  • 0x57 Temp 3 periodic data
  • 0x57 Temp 4 periodic data
  • 0x58 Temp 3 alarm
  • 0x58 Temp 4 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.configuration2ChannelsActivated boolean True if 2 channels are activated, false if 1 channel is activated
status.timestamp boolean True if timestamp is activated
loraAdr Boolean Activation of the ADR : true if ON, false if OFF
loraProvisioningMode String Mode of activation : value can be ABP or OTAA (default value
loraDutycyle String Dutycycle : values can be activated or deactivated
loraClassMode String ClassMode : values can be CLASS A or CLASS C.
PayloadTemp3 0x30 Keep Alive frame
DescriptionTemp3 0x30 Keep Alive frame. Default tag temp3 associated to the device. Keep Alive Frame
Example :
Input
Output
Output json fields :
Fields
nametypedescription
PayloadTemp3 0x33 Set Register Status
DescriptionTemp3 0x33 Set Register Status. Default tag temp3 associated to the device. Response to Set register request
Example :
Input
Output
Output json fields :
Fields
nametypedescription
PayloadTemp3 0x57 Periodic Data
DescriptionTemp3 0x57 Periodic Data. Default tag temp3 associated to the device. Periodic Data Frames
Example :
Input57B0010D010B01180119012001220125012F0129013E01230136
Output
{"type":"0x57 Temp 3 periodic data","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false,"configuration2ChannelsActivated":true},"decodingInfo":"values: [t\u003d0, t-1, t-2, ...]","temperatures":[{"name":"temperature 1","unit":"°C","values":[26.9,28,28.8,29.3,29.7,29.1]},{"name":"temperature 2","unit":"°C","values":[26.7,28.1,29,30.3,31.8,31]}]}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Temp 3 configuration
  • 0x10 Temp 4 configuration
  • 0x20 Configuration
  • 0x2f Downlink ack
  • 0x30 Temp 3 keep alive
  • 0x30 Temp 4 keep alive
  • 0x33 Set register status
  • 0x36 Alert message
  • 0x37 Software version
  • 0x57 Temp 3 periodic data
  • 0x57 Temp 4 periodic data
  • 0x58 Temp 3 alarm
  • 0x58 Temp 4 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.configuration2ChannelsActivated boolean True if 2 channels are activated, false if 1 channel is activated
status.timestamp boolean True if timestamp is activated
decodingInfo String List of temperatures : t0, t-1, t-2, t-3,t-4, t-5, ...
temperatures Array Sensor Temperatures
sensorTemperature SensorTemperature SensorTemperature
sensorTemperature.name String Name : temperature 1 when sensor 1, temperature 2 when sensor 2
sensorTemperature.unit String Degrees Celcius
sensorTemperature.values Array Sensor temperature values in array
timestamp String Timestamp when timestamping is enable, in EPOCH 2013 format.
PayloadTemp3 0x58 Alarm
DescriptionTemp3 0x58 Alarm. Default tag temp3 associated to the device. This frame is sent during the appearance, or disappearance, of a threshold exceeding alarm.
Example :
Input5890000028020032
Output
{"type":"0x58 Temp 3 alarm","status":{"frameCounter":4,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false,"configuration2ChannelsActivated":true},"alarms":[{"name":"temperature 1","alarmStatus":"none","temperature":{"unit":"°C","value":4}},{"name":"temperature 2","alarmStatus":"lowThreshold","temperature":{"unit":"°C","value":5}}]}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Temp 3 configuration
  • 0x10 Temp 4 configuration
  • 0x20 Configuration
  • 0x2f Downlink ack
  • 0x30 Temp 3 keep alive
  • 0x30 Temp 4 keep alive
  • 0x33 Set register status
  • 0x36 Alert message
  • 0x37 Software version
  • 0x57 Temp 3 periodic data
  • 0x57 Temp 4 periodic data
  • 0x58 Temp 3 alarm
  • 0x58 Temp 4 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.configuration2ChannelsActivated boolean True if 2 channels are activated, false if 1 channel is activated
status.timestamp boolean True if timestamp is activated
alarms Array Sensor Alarms
sensorAlarm SensorAlarm SensorAlarm
sensorAlarm.name String Name : temperature 1 when sensor 1, temperature 2 when sensor 2
sensorAlarm.alarmStatus String Alarm Status. Values can be: none, highThreshold, lowThreshold.
sensorAlarm.temperature Temperature Sensor temperature in degrees Celcius
temperature.unit String Degrees Celcius
temperature.value Number Temperature value
timestamp String Timestamp when timestamping is enable, in EPOCH 2013 format.
PayloadTemp 0x10 Product Configuration frame Production mode
DescriptionTemp 0x10 Product Configuration frame Production mode. Tag temp associated to the device. The first frame after the reboot, all registers are in default values.
Example :
Input100090030003100301020a
Output
{"type":"0x10 Temperature configuration","status":{"frameCounter":0,"hardwareError":false,"lowBattery":false,"configurationDone":false,"probe1Alarm":false,"probe2Alarm":false},"transmissionPeriodKeepAlive":{"unit":"m","value":1440},"transmissionPeriodData":{"unit":"m","value":30},"samplingPeriod":{"unit":"m","value":10},"probes":[{"name":"probe 1","id":0,"threshold":"both","state":"deactivated"},{"name":"probe 2","id":1,"threshold":"both","state":"activated"}],"productMode":"PRODUCTION"}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Temperature configuration
  • 0x11 Temperature configuration
  • 0x12 Temperature configuration
  • 0x20 Configuration
  • 0x30 Temperature keep alive
  • 0x43 Temperature data
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.probe1Alarm boolean True if probe 1 alarm
status.probe2Alarm boolean True if probe 2 alarm
transmissionPeriodKeepAlive Period Transmission period of the Keep Alive frame.
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
transmissionPeriodData Period Transmission Period Data
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
samplingPeriod Period Sampling period
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
probes Array Probes
probe Probe Probe
probe.name String Name : probe 1 when sensor 1, probe 2 when sensor 2
probe.id Number Id
probe.threshold String Threshold. Values can be both, high, low
probe.state String State. Values can be activated or deactivated
productMode String Product mode : Park, Production, Test or Repli.
PayloadTemp 0x11 Internal sensor configuration frame
DescriptionTemp 0x11 Internal sensor configuration frame. Tag temp associated to the device. Internal sensor configuration - All registers are in default values. The frame counter is 1.
Example :
Input1120012c0a00320a02
Output
{"type":"0x11 Temperature configuration","status":{"frameCounter":1,"hardwareError":false,"lowBattery":false,"configurationDone":false,"probe1Alarm":false,"probe2Alarm":false},"threshold":{"name":"probe 1","unit":"°C","high":{"value":30,"hysteresis":1},"low":{"value":5,"hysteresis":1}},"superSamplingFactor":2}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Temperature configuration
  • 0x11 Temperature configuration
  • 0x12 Temperature configuration
  • 0x20 Configuration
  • 0x30 Temperature keep alive
  • 0x43 Temperature data
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.probe1Alarm boolean True if probe 1 alarm
status.probe2Alarm boolean True if probe 2 alarm
threshold Threshold Threshold
threshold.name String Name : probe 1 when sensor 1, probe 2 when sensor 2
threshold.unit String Unit in degrees celsius
threshold.high Hysteresis High threshold in celsius
hysteresis.value Number Value
hysteresis.hysteresis Number Hysteresis of the threshold in celsuis
threshold.low Hysteresis Low threshold in celsius
hysteresis.value Number Value
hysteresis.hysteresis Number Hysteresis of the threshold in celsuis
superSamplingFactor Number Super-sampling factor
PayloadTemp 0x12 External sensor configuration
DescriptionTemp 0x12 External sensor configuration. Tag temp associated to the device. External sensor configuration - All registers are in default values. The frame counter is 2.
Example :
Input1240012c0a00320a
Output
{"type":"0x12 Temperature configuration","status":{"frameCounter":2,"hardwareError":false,"lowBattery":false,"configurationDone":false,"probe1Alarm":false,"probe2Alarm":false},"threshold":{"name":"probe 2","unit":"°C","high":{"value":30,"hysteresis":1},"low":{"value":5,"hysteresis":1}}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Temperature configuration
  • 0x11 Temperature configuration
  • 0x12 Temperature configuration
  • 0x20 Configuration
  • 0x30 Temperature keep alive
  • 0x43 Temperature data
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.probe1Alarm boolean True if probe 1 alarm
status.probe2Alarm boolean True if probe 2 alarm
threshold Threshold Threshold
threshold.name String Name : probe 1 when sensor 1, probe 2 when sensor 2
threshold.unit String Unit in degrees celsius
threshold.high Hysteresis High threshold in celsius
hysteresis.value Number Value
hysteresis.hysteresis Number Hysteresis of the threshold in celsuis
threshold.low Hysteresis Low threshold in celsius
hysteresis.value Number Value
hysteresis.hysteresis Number Hysteresis of the threshold in celsuis
superSamplingFactor Number Super-sampling factor
PayloadTemp 0x20 Configuration frame
DescriptionTemp 0x20 Configuration frame. Tag temp associated to the device. The device is configured with OTAA and the adaptative data rate is enabled. The frame counter is 3.
Example :
Input20620101
Output
{"type":"0x20 Configuration","status":{"frameCounter":3,"hardwareError":false,"lowBattery":true,"configurationDone":false,"probe1Alarm":false,"probe2Alarm":false},"loraAdr":true,"loraProvisioningMode":"OTAA","loraClassMode":"CLASS A"}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Temperature configuration
  • 0x11 Temperature configuration
  • 0x12 Temperature configuration
  • 0x20 Configuration
  • 0x30 Temperature keep alive
  • 0x43 Temperature data
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.probe1Alarm boolean True if probe 1 alarm
status.probe2Alarm boolean True if probe 2 alarm
loraAdr Boolean Activation of the ADR : true if ON, false if OFF
loraProvisioningMode String Mode of activation : value can be ABP or OTAA (default value
loraClassMode String ClassMode : values can be CLASS A or CLASS C.
PayloadTemp 0x30 Keep alive frame
DescriptionTemp 0x30 Keep alive frame. Tag temp associated to the device. The frame counter is 5.
Example :
Input30a2018000128000
Output
{"type":"0x30 Temperature keep alive","status":{"frameCounter":5,"hardwareError":false,"lowBattery":true,"configurationDone":false,"probe1Alarm":false,"probe2Alarm":false},"temperatures":[{"name":"probe 1","id":0,"unit":"°C","value":-3276.8},{"name":"probe 2","id":1,"unit":"°C","value":-3276.8}]}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Temperature configuration
  • 0x11 Temperature configuration
  • 0x12 Temperature configuration
  • 0x20 Configuration
  • 0x30 Temperature keep alive
  • 0x43 Temperature data
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.probe1Alarm boolean True if probe 1 alarm
status.probe2Alarm boolean True if probe 2 alarm
temperatures Array Temperatures
temperature Temperature Temperature
temperature.unit String Degrees Celcius
temperature.value Number Temperature value
temperature.name String Name
temperature.id Number Id
PayloadTemp 0x43 Data frame
DescriptionTemp 0x43 Data frame. Tag temp associated to the device. The frame counter is 4.
Example :
Input43400100f4028000
Output
{"type":"0x43 Temperature data","status":{"frameCounter":2,"hardwareError":false,"lowBattery":false,"configurationDone":false,"probe1Alarm":false,"probe2Alarm":false},"temperatures":[{"name":"probe 1","id":0,"unit":"°C","value":24.4},{"name":"probe 2","id":0,"unit":"°C","value":-3276.8}]}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Temperature configuration
  • 0x11 Temperature configuration
  • 0x12 Temperature configuration
  • 0x20 Configuration
  • 0x30 Temperature keep alive
  • 0x43 Temperature data
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.probe1Alarm boolean True if probe 1 alarm
status.probe2Alarm boolean True if probe 2 alarm
temperatures Array Temperatures
temperature Temperature Temperature
temperature.unit String Degrees Celcius
temperature.value Number Temperature value
temperature.name String Name
temperature.id Number Id
PayloadTIC CBE Linky Mono 0x10 TIC configuration frame
DescriptionTIC CBE Linky Mono 0x10 TIC configuration frame. Tag ticCbeLinkyMono associated to the device.The following frame (0x10) representing the application configuration of the product is transmitted when switching to operating mode (PARC mode output) or following the reception of a downlink 0x01.
Example :
Input10A0480002010005
Output
{"type":"0x10 TIC configuration","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false,"readError":false},"transmissionPeriodKeepAlive":{"unit":"m","value":720},"samplingPeriod":{"unit":"m","value":5},"transmissionPeriodData":2,"productMode":"PRODUCTION"}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 TIC configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x49 TIC data
  • 0x4a TIC alarm
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.readError boolean Read error. True to indicate a read error. For example: checksum error, timeout, etc. Reset to false after sending a radio frame.
transmissionPeriodKeepAlive Period Transmission period of the Keep Alive frame.
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
samplingPeriod Period Sampling period
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
transmissionPeriodData int Period of issue (periodic data). Range 0 to 1440, 2 by default.
productMode String Product mode. Values can be:
  • PRODUCTION
  • PARK
  • TEST
PayloadTIC CBE Linky Mono 0x20 Network configuration frame
DescriptionTIC CBE Linky Mono 0x20 Network configuration frame. Tag ticCbeLinkyMono associated to the device. Frame of information on the network configuration
Example :
Input20A00101
Output
{"type":"0x20 Configuration","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false,"readError":false},"loraAdr":true,"loraProvisioningMode":"OTAA","loraClassMode":"CLASS A"}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 TIC configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x49 TIC data
  • 0x4a TIC alarm
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.readError boolean Read error. True to indicate a read error. For example: checksum error, timeout, etc. Reset to false after sending a radio frame.
loraAdr Boolean Activation of the ADR : true if ON, false if OFF
loraProvisioningMode String Mode of activation : value can be ABP or OTAA (default value
loraClassMode String ClassMode : values can be CLASS A or CLASS C.
PayloadTIC CBE Linky Mono 0x30 Keep Alive frame
DescriptionTIC CBE Linky Mono 0x30 Keep Alive frame. Tag ticCbeLinkyMono associated to the device.
Example :
Input30A3
Output
{"type":"0x30 Keep alive","status":{"frameCounter":5,"hardwareError":false,"lowBattery":true,"configurationDone":true,"configurationInconsistency":false,"readError":false}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 TIC configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x49 TIC data
  • 0x4a TIC alarm
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.readError boolean Read error. True to indicate a read error. For example: checksum error, timeout, etc. Reset to false after sending a radio frame.
PayloadTIC CBE Linky Mono 0x49 Periodical data frame
DescriptionTIC CBE Linky Mono 0x49 Periodical data frame. Tag ticCbeLinkyMono associated to the device. This frame is sent according to the period chosen by the user, and contains the configured periodic data.
Example :
Input498830323130323838313138353680000000000006960000004A48432E2E0000000000001784000000088000000080000000
Output
{"type":"0x49 TIC data","status":{"frameCounter":4,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":true,"readError":false},"ADCO":"021028811856","OPTARIF":"€","BASE":{"unit":"Wh","value":1686},"ISOUSC":{"unit":"A","value":74},"IINST":{"unit":"A","value":1212362286},"IMAX":{"unit":"A","value":0},"PAPP":{"unit":"VA","value":6020},"HCHC":{"unit":"Wh","value":8},"HCHP":"notFound","PTEC":"€"}
Output json fields :
Fields
nametypedescription
PayloadTIC CBE Linky Mono 0x4A Alarm frame
DescriptionTIC CBE Linky Mono 0x4A Alarm frame. Tag ticCbeLinkyMono associated to the device. Frame sent in case of crossing a threshold, appearance / disappearance of a label, positive or negative delta between the current data and a previous data, or after receiving frame 0x05.
Example :
Input4AA049494E53540000000000013130
Output
{"type":"0x4a TIC alarm","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false,"readError":false},"label":"IINST","alarmType":"labelAppearance","value":"10"}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 TIC configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x49 TIC data
  • 0x4a TIC alarm
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.readError boolean Read error. True to indicate a read error. For example: checksum error, timeout, etc. Reset to false after sending a radio frame.
label String Title of label concerned by the alarm.
alarmType String Cause of the sending of this frame. Values can be :
  • manualTrigger
  • labelAppearance
  • labelDisappearance
  • highTreshold
  • lowTreshold
  • endThresholdAlarm
  • deltaPositive
  • deltaNegative
value String Data corresponding to the label
PayloadTIC CBE Linky Tri 0x10 TIC configuration frame
DescriptionTIC CBE Linky Tri 0x10 TIC configuration frame. Tag ticCbeLinkyTri associated to the device.The following frame (0x10) representing the application configuration of the product is transmitted when switching to operating mode (PARC mode output) or following the reception of a downlink 0x01.
Example :
Input10A0480002010005
Output
{"type":"0x10 TIC configuration","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false,"readError":false},"transmissionPeriodKeepAlive":{"unit":"m","value":720},"samplingPeriod":{"unit":"m","value":5},"transmissionPeriodData":2,"productMode":"PRODUCTION"}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 TIC configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x49 TIC data
  • 0x4a TIC alarm
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.readError boolean Read error. True to indicate a read error. For example: checksum error, timeout, etc. Reset to false after sending a radio frame.
transmissionPeriodKeepAlive Period Transmission period of the Keep Alive frame.
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
samplingPeriod Period Sampling period
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
transmissionPeriodData int Period of issue (periodic data). Range 0 to 1440, 2 by default.
productMode String Product mode. Values can be:
  • PRODUCTION
  • PARK
  • TEST
PayloadTIC CBE Linky Tri 0x20 Network configuration frame
DescriptionTIC CBE Linky Tri 0x20 Network configuration frame. Tag ticCbeLinkyTri associated to the device. Frame of information on the network configuration
Example :
Input20A00101
Output
{"type":"0x20 Configuration","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false,"readError":false},"loraAdr":true,"loraProvisioningMode":"OTAA","loraClassMode":"CLASS A"}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 TIC configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x49 TIC data
  • 0x4a TIC alarm
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.readError boolean Read error. True to indicate a read error. For example: checksum error, timeout, etc. Reset to false after sending a radio frame.
loraAdr Boolean Activation of the ADR : true if ON, false if OFF
loraProvisioningMode String Mode of activation : value can be ABP or OTAA (default value
loraClassMode String ClassMode : values can be CLASS A or CLASS C.
PayloadTIC CBE Linky Tri 0x30 Keep Alive frame
DescriptionTIC CBE Linky Tri 0x30 Keep Alive frame. Tag ticCbeLinkyTri associated to the device.
Example :
Input30A3
Output
{"type":"0x30 Keep alive","status":{"frameCounter":5,"hardwareError":false,"lowBattery":true,"configurationDone":true,"configurationInconsistency":false,"readError":false}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 TIC configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x49 TIC data
  • 0x4a TIC alarm
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.readError boolean Read error. True to indicate a read error. For example: checksum error, timeout, etc. Reset to false after sending a radio frame.
PayloadTIC CBE Linky Tri 0x49 Periodical data frame
DescriptionTIC CBE Linky Tri 0x49 Periodical data frame. Tag ticCbeLinkyTri associated to the device. This frame is sent according to the period chosen by the user, and contains the configured periodic data.
Example :
Input4940303231373238303331383139000012340000002B0000002C0000002D0000001100000012000000130000002000000010
Output
{"type":"0x49 TIC data","status":{"frameCounter":2,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false,"readError":false},"ADCO":"021728031819","BASE":{"unit":"Wh","value":4660},"IINST1":{"unit":"A","value":43},"IINST2":{"unit":"A","value":44},"IINST3":{"unit":"A","value":45},"IMAX1":{"unit":"A","value":17},"IMAX2":{"unit":"A","value":18},"IMAX3":{"unit":"A","value":19},"PMAX":{"unit":"W","value":32},"PAPP":{"unit":"VA","value":16}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 TIC configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x49 TIC data
  • 0x4a TIC alarm
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.readError boolean Read error. True to indicate a read error. For example: checksum error, timeout, etc. Reset to false after sending a radio frame.
ADCO String Adresse du compteur - Counter address
ADCOstatus String Status Not found si absence d'adresse de compteur - Not found when no counter address
BASE Energy Index option base - Base option index
energy.unit String Watt-heure
energy.value int Energy value
BASEstatus String Status Not found si absence d'index option base - Not found when no base option index
PAPP MaxPower Puissante apparente - Apparent power
maxPower.unit String Volt-Ampere
maxPower.value int Power value
PAPPstatus String Status Not found si absence de puissante apparente - Not found when no apparent power
OPTARIF String Option tarifaire - Selected tariff option
OPTARIFstatus String Status Not found si absence d'option tarifaire - Not found when no selected tariff option
ISOUSC Intensity Intensité souscrite - Subscribed current
intensity.unit String Ampere
intensity.value int Intensity value
ISOUSCstatus String Status Not found si absence d'intensité souscrite - Not found when no subscribed current
IINST Intensity Intensité instantanée - Instantaneous current
intensity.unit String Ampere
intensity.value int Intensity value
IINSTstatus String Status Not found si absence d'intensité instantanée - Not found when no instantaneous current
IMAX Intensity Intensité Maximale appelée - Maximum current called
intensity.unit String Ampere
intensity.value int Intensity value
IMAXstatus String Status Not found si absence d'intensité maximale appelée - Not found when no maximum current called
HCHC Energy Index Heures Creuses - Off-peak times
energy.unit String Watt-heure
energy.value int Energy value
HCHCstatus String Status Not found lorsque pas d'index heures creuses - Not found when no off-peak times
HCHP Energy Index Heures Pleines - Peak times
energy.unit String Watt-heure
energy.value int Energy value
HCHPstatus String Status Not found lorsque pas d'index heures pleines - Not found when no peak times
PTEC String Période tarifaire en cours - Current tariff period
PTECstatus String Status Not found lorsque pas de période tarifaire en cours - Not found when no current tariff period
IINST1 Intensity Intensité instantanée phase 1 - Instantaneous current phase 1
intensity.unit String Ampere
intensity.value int Intensity value
IINST1status String Status Not found si absence d'intensité instantanée phase 1 - Not found when no instantaneous current phase 1
IINST2 Intensity Intensité instantanée phase 2 - Instantaneous current phase 2
intensity.unit String Ampere
intensity.value int Intensity value
IINST2status String Status Not found si absence d'intensité instantanée phase 2 - Not found when no instantaneous current phase 2
IINST3 Intensity Intensité instantanée phase 3 - Instantaneous current phase 3
intensity.unit String Ampere
intensity.value int Intensity value
IINST3status String Status Not found si absence d'intensité instantanée phase 3 - Not found when no instantaneous current phase 3
IMAX1 Intensity Intensité maximale appelée phase 1 - Maximum current called phase 1
intensity.unit String Ampere
intensity.value int Intensity value
IMAX1status String Status Not found si absence d'intensité maximale appelée phase 1 - Not found when no maximum current called phase 1
IMAX2 Intensity Intensité maximale appelée phase 2- Maximum current called phase 2
intensity.unit String Ampere
intensity.value int Intensity value
IMAX2status String Status Not found si absence d'intensité maximale appelée phase 2 - Not found when no maximum current called phase 2
IMAX3 Intensity Intensité maximale appelée phase 1- Maximum current called phase 3
intensity.unit String Ampere
intensity.value int Intensity value
IMAX3status String Status Not found si absence d'intensité maximale appelée phase 3 - Not found when no maximum current called phase 3
PMAX Power Puissance maximale atteinte - Maximum power reached
power.unit String Watt
power.value int Power value
PMAXstatus String Status Not found si absence de puissance maximale atteinte - Not found when no maximum power reached
DEMAIN String Couleur du lendemain - Colour of the day after next
BBRHCJB Energy Index Tempo Heures Creuses Jours Bleus - Blue Day Off-peak Times
energy.unit String Watt-heure
energy.value int Energy value
BBRHPJB Energy Index Tempo Heures Pleines Jours Bleus - Blue Day Peak Times
energy.unit String Watt-heure
energy.value int Energy value
DATE String Date et heure courante (JJ/MM/AA HH:MM:SS)
ES_s Energy Energie active soutirée (au primaire) depuis dernier top Td
energy.unit String Watt-heure
energy.value int Energy value
ERpos_s ReactiveEnergy Energie réactive positive (au primaire) depuis dernier top Td en période de soutirage d'énergie active
reactiveEnergy.unit String Var-Hour [varh]
reactiveEnergy.value int Reactive Energy value
ERneg_s ReactiveEnergy Energie réactive négative (au primaire) depuis dernier top Td en période de soutirage d'énergie active
reactiveEnergy.unit String Var-Hour [varh]
reactiveEnergy.value int Reactive Energy value
EAPP_s ApparentEnergy Energie apparente soutirée (au primaire) depuis dernier top Td
apparentEnergy.unit String Volt-Ampere-Hour [VAh]
apparentEnergy.value int Apparent Energy value
PTCOUR1 String Période tarifaire courante (chaîne associée de 3 caractères alphanumériques)
EAP_s ActiveEnergy Energie active soutirée de la période P pour la période tarifaire en cours
activeEnergy.unit String kilo-Watt-Hour [kWh]
activeEnergy.value int Active Energy value
ERposP_s ReactiveEnergyK Energie réactive positive de la période P pour la période tarifaire en cours en période de soutirage d'énergie active
reactiveEnergyK.unit String kilo-Var-Hour [varh]
reactiveEnergyK.value int Reactive Energy value
ERnegP_s ReactiveEnergyK Energie réactive négative de la période P pour la période tarifaire en cours en période de soutirage d'énergie active
reactiveEnergyK.unit String kilo-Var-Hour [varh]
reactiveEnergyK.value int Reactive Energy value
EaPneg1_s ActiveEnergy Energie active soutirée de la période P-1 pour la période tarifaire en cours
activeEnergy.unit String kilo-Watt-Hour [kWh]
activeEnergy.value int Active Energy value
ERposPdash1_s ReactiveEnergyK Energie réactive positive de la période P-1 pour la période tarifaire en cours en période de soutirage d'énergie active
reactiveEnergyK.unit String kilo-Var-Hour [varh]
reactiveEnergyK.value int Reactive Energy value
ERnegPdash1_s ReactiveEnergyK Energie réactive négative de la période P-1 pour la période tarifaire en cours en période de soutirage d'énergie active
reactiveEnergyK.unit String kilo-Var-Hour [varh]
reactiveEnergyK.value int Reactive Energy value
PayloadTIC CBE Linky Tri 0x4A Alarm frame
DescriptionTIC CBE Linky Tri 0x4A Alarm frame. Tag ticcbelinkytri associated to the device. Frame sent in case of crossing a threshold, appearance / disappearance of a label, positive or negative delta between the current data and a previous data, or after receiving frame 0x05.
Example :
Input4AA049494E53540000000000013130
Output
{"type":"0x4a TIC alarm","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false,"readError":false},"label":"IINST","alarmType":"labelAppearance","value":"10"}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 TIC configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x49 TIC data
  • 0x4a TIC alarm
  • Unsupported
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.readError boolean Read error. True to indicate a read error. For example: checksum error, timeout, etc. Reset to false after sending a radio frame.
label String Title of label concerned by the alarm.
alarmType String Cause of the sending of this frame. Values can be :
  • manualTrigger
  • labelAppearance
  • labelDisappearance
  • highTreshold
  • lowTreshold
  • endThresholdAlarm
  • deltaPositive
  • deltaNegative
value String Data corresponding to the label

ADEUNIS-Field Test Device - ARF8123AA

Product(s) version :
RTU : V01.02.00 APP : V01.00.07

Orange decoder : adeunis_fieldtest_lora_v1.0
Developer : Orange

Device documentation
PayloadData
DescriptionData frame payload
Example :
Input9f1d48094670017077904d01000f7d0e05
Output
{"temperature":{"value":29,"unit":"°C"},"gpsSignal":4,"sat":13,"location":{"lat":48.157783333333334,"lon":17.129833333333334},"up":1,"down":0,"battery":3965,"rssi":-14,"snr":5,"button":0,"accel":0}
Output json fields :
Fields
nametypedescription

ADEUNIS-Multidevices - Tag to associate to the device on LiveObjects

Product(s) version :
Adeunis online decoding tool: https://codec-adeunis.com/decoder Decoding based on Adeunis-codecs-1.6.1 library.
Declare tag according to the device type:


Orange decoder : adeunis_generic_decode_by_tag
Developer : Adeunis / Orange

Device documentation
PayloadAnalog 0x10 Analog configuration frame
DescriptionAnalog 0x10 Analog configuration frame. Tag Analog associated to the device. Following reception of a downlink frame with the code 0x01 or on switching to the operating mode (from the Park or Command Mode), the next frame (0x10) representing the application configuration of the product is transmitted
Example :
Input104248000203A1DD01
Output
{"type":"0x10 Analog configuration","status":{"frameCounter":2,"hardwareError":false,"lowBattery":true,"configurationDone":false,"alarmChannelA":false,"alarmChannelB":false},"transmissionPeriodKeepAlive":{"unit":"m","value":720},"transmissionPeriodData":{"unit":"m","value":0},"channels":[{"name":"channel A","id":0,"type":"4-20mA","threshold":"both","externalTrigger":{"type":"none","debounceDuration":{"unit":"s","value":0}}},{"name":"channel B","id":10,"type":"0-10V","threshold":"low","externalTrigger":{"type":"both","debounceDuration":{"unit":"s","value":60}}}],"productMode":"PRODUCTION"}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Analog configuration
  • 0x11 Analog configuration
  • 0x12 Analog configuration
  • 0x13 Analog configuration
  • 0x14 Analog configuration
  • 0x20 network configuration
  • 0x30 Analog keep alive
  • 0x42 Analog data
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
transmissionPeriodKeepAlive Period Transmission period of the Keep Alive frame.
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
transmissionPeriodData Period periodicity of the transmission, expressed in tens of minutes
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
channels Array Channels list : configuration of the events on channels
channel Channel Channel
channel.name String channel name
channel.id int free Id from 0 to 15
channel.type String type : values can be: deactivated, 0-10V or 4-20mA
channel.threshold String threshold : values can be: none, low, high or both
channel.externalTrigger ExternalTrigger Trigger by digital input
externalTrigger.type String type : values can be: none, low, high or both
externalTrigger.debounceDuration Duration Duration of the waiting period
  • ms
  • s
  • min
duration.value int Period duration
duration.unit String Duration value: can be ms, s or min
productMode String Product mode. Values can be: PRODUCTION, PARK, TEST or DEAD
PayloadAnalog 0x11 Analog configuration frame
DescriptionAnalog 0x11 Analog configuration frame. Tag Analog associated to the device. Following the frame 0x10
Example :
Input1140000000000000
Output
{"type":"0x11 Analog configuration","status":{"frameCounter":2,"hardwareError":false,"lowBattery":false,"configurationDone":false,"alarmChannelA":false,"alarmChannelB":false},"threshold":{"name":"channel A","unit":"µV or 10 nA","high":{"value":0,"hysteresis":0}}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Analog configuration
  • 0x11 Analog configuration
  • 0x12 Analog configuration
  • 0x13 Analog configuration
  • 0x14 Analog configuration
  • 0x20 network configuration
  • 0x30 Analog keep alive
  • 0x42 Analog data
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
threshold Threshold threshold for frames 0x11, 0x12, 0x13 and 0x14
threshold.name String channel name
threshold.unit String unit, only one value :
  • µV or 10 nA
threshold.high ThresholdValue High threshold value channel
thresholdValue.value int threshold value channel, depending of channel type
  • 4-20mA : 400,000 - 2,000,000
  • 0-10V : 0 - 10,000,000
thresholdValue.hysteresis int threshold hysteresis of channel, depending of channel type
  • 4-20mA : 0 - 1,600,000
  • 0-10V : 0 - 10,000,000
threshold.low ThresholdValue Low threshold value channel
thresholdValue.value int threshold value channel, depending of channel type
  • 4-20mA : 400,000 - 2,000,000
  • 0-10V : 0 - 10,000,000
thresholdValue.hysteresis int threshold hysteresis of channel, depending of channel type
  • 4-20mA : 0 - 1,600,000
  • 0-10V : 0 - 10,000,000
PayloadAnalog 0x12 Analog configuration frame
DescriptionAnalog 0x12 Analog configuration frame. Tag Analog associated to the device. Following the frame 0x11
Example :
Input1240000000000000
Output
{"type":"0x12 Analog configuration","status":{"frameCounter":2,"hardwareError":false,"lowBattery":false,"configurationDone":false,"alarmChannelA":false,"alarmChannelB":false},"threshold":{"name":"channel A","unit":"µV or 10 nA","low":{"value":0,"hysteresis":0}}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Analog configuration
  • 0x11 Analog configuration
  • 0x12 Analog configuration
  • 0x13 Analog configuration
  • 0x14 Analog configuration
  • 0x20 network configuration
  • 0x30 Analog keep alive
  • 0x42 Analog data
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
threshold Threshold threshold for frames 0x11, 0x12, 0x13 and 0x14
threshold.name String channel name
threshold.unit String unit, only one value :
  • µV or 10 nA
threshold.high ThresholdValue High threshold value channel
thresholdValue.value int threshold value channel, depending of channel type
  • 4-20mA : 400,000 - 2,000,000
  • 0-10V : 0 - 10,000,000
thresholdValue.hysteresis int threshold hysteresis of channel, depending of channel type
  • 4-20mA : 0 - 1,600,000
  • 0-10V : 0 - 10,000,000
threshold.low ThresholdValue Low threshold value channel
thresholdValue.value int threshold value channel, depending of channel type
  • 4-20mA : 400,000 - 2,000,000
  • 0-10V : 0 - 10,000,000
thresholdValue.hysteresis int threshold hysteresis of channel, depending of channel type
  • 4-20mA : 0 - 1,600,000
  • 0-10V : 0 - 10,000,000
PayloadAnalog 0x13 Analog configuration frame
DescriptionAnalog 0x13 Analog configuration frame. Tag Analog associated to the device. Following the frame 0x12
Example :
Input1380061A80186A00
Output
{"type":"0x13 Analog configuration","status":{"frameCounter":4,"hardwareError":false,"lowBattery":false,"configurationDone":false,"alarmChannelA":false,"alarmChannelB":false},"threshold":{"name":"channel B","unit":"µV or 10 nA","high":{"value":400000,"hysteresis":1600000}}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Analog configuration
  • 0x11 Analog configuration
  • 0x12 Analog configuration
  • 0x13 Analog configuration
  • 0x14 Analog configuration
  • 0x20 network configuration
  • 0x30 Analog keep alive
  • 0x42 Analog data
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
threshold Threshold threshold for frames 0x11, 0x12, 0x13 and 0x14
threshold.name String channel name
threshold.unit String unit, only one value :
  • µV or 10 nA
threshold.high ThresholdValue High threshold value channel
thresholdValue.value int threshold value channel, depending of channel type
  • 4-20mA : 400,000 - 2,000,000
  • 0-10V : 0 - 10,000,000
thresholdValue.hysteresis int threshold hysteresis of channel, depending of channel type
  • 4-20mA : 0 - 1,600,000
  • 0-10V : 0 - 10,000,000
threshold.low ThresholdValue Low threshold value channel
thresholdValue.value int threshold value channel, depending of channel type
  • 4-20mA : 400,000 - 2,000,000
  • 0-10V : 0 - 10,000,000
thresholdValue.hysteresis int threshold hysteresis of channel, depending of channel type
  • 4-20mA : 0 - 1,600,000
  • 0-10V : 0 - 10,000,000
PayloadAnalog 0x14 Analog configuration frame
DescriptionAnalog 0x14 Analog configuration frame. Tag Analog associated to the device. Following the frame 0x13
Example :
Input14C01E8480989680
Output
{"type":"0x14 Analog configuration","status":{"frameCounter":6,"hardwareError":false,"lowBattery":false,"configurationDone":false,"alarmChannelA":false,"alarmChannelB":false},"threshold":{"name":"channel B","unit":"µV or 10 nA","low":{"value":2000000,"hysteresis":10000000}}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Analog configuration
  • 0x11 Analog configuration
  • 0x12 Analog configuration
  • 0x13 Analog configuration
  • 0x14 Analog configuration
  • 0x20 network configuration
  • 0x30 Analog keep alive
  • 0x42 Analog data
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
threshold Threshold threshold for frames 0x11, 0x12, 0x13 and 0x14
threshold.name String channel name
threshold.unit String unit, only one value :
  • µV or 10 nA
threshold.high ThresholdValue High threshold value channel
thresholdValue.value int threshold value channel, depending of channel type
  • 4-20mA : 400,000 - 2,000,000
  • 0-10V : 0 - 10,000,000
thresholdValue.hysteresis int threshold hysteresis of channel, depending of channel type
  • 4-20mA : 0 - 1,600,000
  • 0-10V : 0 - 10,000,000
threshold.low ThresholdValue Low threshold value channel
thresholdValue.value int threshold value channel, depending of channel type
  • 4-20mA : 400,000 - 2,000,000
  • 0-10V : 0 - 10,000,000
thresholdValue.hysteresis int threshold hysteresis of channel, depending of channel type
  • 4-20mA : 0 - 1,600,000
  • 0-10V : 0 - 10,000,000
PayloadAnalog 0x20 Network configuration information frame
DescriptionAnalog 0x20 Network configuration information frame. Tag Analog associated to the device. Following reception of a downlink frame with the code 0x02 or on switching to the operating mode (from the Park or Command Mode), the next frame (0x20) representing the network configuration of the product is transmitted
Example :
Input20420000
Output
{"type":"0x20 Configuration","status":{"frameCounter":2,"hardwareError":false,"lowBattery":true,"configurationDone":false,"alarmChannelA":false,"alarmChannelB":false},"loraAdr":false,"loraProvisioningMode":"ABP"}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Analog configuration
  • 0x11 Analog configuration
  • 0x12 Analog configuration
  • 0x13 Analog configuration
  • 0x14 Analog configuration
  • 0x20 network configuration
  • 0x30 Analog keep alive
  • 0x42 Analog data
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
loraAdr Boolean Activation of the ADR : true if ON, false if OFF
loraProvisioningMode String Mode of activation : value can be ABP or OTAA (default value
loraClassMode String ClassMode : values can be CLASS A or CLASS C.
PayloadAnalog 0x30 Keep Alive frame
DescriptionAnalog 0x30 Keep Alive frame. Tag Analog associated to the device. This frame (0x30) is transmitted only in the event mode at the frequency defined by register 300
Example :
Input3080020186A0010186A0
Output
{"type":"0x30 Analog keep alive","status":{"frameCounter":4,"hardwareError":false,"lowBattery":false,"configurationDone":false,"alarmChannelA":false,"alarmChannelB":false},"channels":[{"name":"channel A","unit":"mA","value":1},{"name":"channel B","unit":"V","value":0.1}]}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Analog configuration
  • 0x11 Analog configuration
  • 0x12 Analog configuration
  • 0x13 Analog configuration
  • 0x14 Analog configuration
  • 0x20 network configuration
  • 0x30 Analog keep alive
  • 0x42 Analog data
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
channels Array List of channels : configuration of the events on channels
channel Channel Channel
channel.name String channel name
channel.unit String unit
channel.value float value measured on channel
PayloadAnalog 0x42 Data Frame
DescriptionAnalog 0x42 Data Frame. Tag Analog associated to the device. This frame (0x42) contains the values measured on the different sensors
Example :
Input4280020186A0010186A0
Output
{"type":"0x42 Analog data","status":{"frameCounter":4,"hardwareError":false,"lowBattery":false,"configurationDone":false,"alarmChannelA":false,"alarmChannelB":false},"channels":[{"name":"channel A","unit":"mA","value":1},{"name":"channel B","unit":"V","value":0.1}]}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Analog configuration
  • 0x11 Analog configuration
  • 0x12 Analog configuration
  • 0x13 Analog configuration
  • 0x14 Analog configuration
  • 0x20 network configuration
  • 0x30 Analog keep alive
  • 0x42 Analog data
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
channels Array List of channels : configuration of the events on channels
channel Channel Channel
channel.name String channel name
channel.unit String unit
channel.value float value measured on channel
PayloadBreath 0x10 (configuration) frame parser
DescriptionBreath 0x1f Digital Input Configuration. Tag Breath associated to the device. This frame is sent at the start-up of the device (except when it is a reboot after a downlink).
Example :
Input1000010001003C01025800
Output
{"type":"0x10 Breath configuration","status":{"frameCounter":0,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false,"sensorError":false},"dailyFrameActivated":true,"numberOfHistorizationBeforeSending":1,"historyPeriod":{"unit":"s","value":60},"alarmRepeatActivated":true,"alarmRepeatPeriod":{"unit":"s","value":600},"redundantSamples":0}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Breath configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Breath Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x51 digital input 1 (button) alarm
  • 0x52 digital input 2 alarm
  • 0x6d Breath data
  • 0x6e Breath alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.sensorError boolean True if : Error reading a sensor or poor sensor health status
dailyFrameActivated Boolean Daily frame transmission ( 0: Deactivated / 1: Activated)
numberOfHistorizationBeforeSending int Transmission period of the periodic frame
historyPeriod Period History period
period.unit String Unit
period.value int Value
alarmRepeatActivated Boolean Alarm repeat enable
alarmRepeatPeriod Period Alarm repeat period
period.unit String Unit
period.value int Value
redundantSamples int Number of additional (redundant) samples per frame
PayloadBreath 0x1f Digital Input Configuration
DescriptionBreath configuration frame parser. Tag Breath associated to the device. This frame is sent following the reception of a frame with code 0x01, or at the start of the product.
Example :
Input1f20410001410001
Output
{"type":"0x1f digital input configuration","status":{"frameCounter":1,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false,"sensorError":false},"digitalInput1":{"type":"highEdge","debouncingPeriod":{"unit":"ms","value":100},"threshold":1},"digitalInput2":{"type":"highEdge","debouncingPeriod":{"unit":"ms","value":100},"threshold":1}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Breath configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Breath Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x51 digital input 1 (button) alarm
  • 0x52 digital input 2 alarm
  • 0x6d Breath data
  • 0x6e Breath alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.sensorError boolean True if : Error reading a sensor or poor sensor health status
digitalInput1 DigitalInput Configuration of Digital Input 1 (Button)
digitalInput.type String Digital Input type. Values can be deactivated when off, highEdge when event ON, lowEdge when event OFF, or bothEdges when event ON/OFF
digitalInput.debouncingPeriod DebouncingPeriod Debouncing period
debouncingPeriod.unit String miliseconds
debouncingPeriod.value int Debouncing period value
digitalInput.threshold int Button alarm threshold value : when the detection counter becomes greater than this threshold, an alarm is triggered
digitalInput2 DigitalInput Configuration Digital Input 2 (Alarm)
digitalInput.type String Digital Input type. Values can be deactivated when off, highEdge when event ON, lowEdge when event OFF, or bothEdges when event ON/OFF
digitalInput.debouncingPeriod DebouncingPeriod Debouncing period
debouncingPeriod.unit String miliseconds
debouncingPeriod.value int Debouncing period value
digitalInput.threshold int Button alarm threshold value : when the detection counter becomes greater than this threshold, an alarm is triggered
PayloadBreath 0x20 Configuration frame
DescriptionBreath 0x20 Configuration frame. Tag Breath associated to the device. Frame of information on the network configuration
Example :
Input20C40101
Output
{"type":"0x20 Configuration","status":{"frameCounter":6,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false,"sensorError":true},"loraAdr":true,"loraProvisioningMode":"OTAA","loraDutycyle":"deactivated","loraClassMode":"CLASS A"}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Breath configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Breath Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x51 digital input 1 (button) alarm
  • 0x52 digital input 2 alarm
  • 0x6d Breath data
  • 0x6e Breath alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.sensorError boolean True if : Error reading a sensor or poor sensor health status
loraAdr Boolean Activation of the ADR : true if ON, false if OFF
loraProvisioningMode String Mode of activation : value can be ABP or OTAA (default value)
loraClassMode String ClassMode : values can be CLASS A or CLASS C.
loraDutycyle String Dutycyle : values can be activated or deactivated
PayloadBreath 0x30 Daily frame
DescriptionBreath 0x30 Daily frame. Tag Breath associated to the device. This frame is sent every 24 hours
Example :
Input3080000804D30066000500010020000400010001001900030002000100140002
Output
{"type":"0x30 Daily frame","status":{"frameCounter":4,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false,"sensorError":false},"tvoc":{"min":{"unit":"µg/m3","value":8},"max":{"unit":"µg/m3","value":1235},"average":{"unit":"µg/m3","value":102},"duration":{"unit":"min","value":5}},"pm10":{"min":{"unit":"µg/m3","value":1},"max":{"unit":"µg/m3","value":32},"average":{"unit":"µg/m3","value":4},"duration":{"unit":"min","value":1}},"pm25":{"min":{"unit":"µg/m3","value":1},"max":{"unit":"µg/m3","value":25},"average":{"unit":"µg/m3","value":3},"duration":{"unit":"min","value":2}},"pm1":{"min":{"unit":"µg/m3","value":1},"max":{"unit":"µg/m3","value":20},"average":{"unit":"µg/m3","value":2}}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Breath configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Breath Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x51 digital input 1 (button) alarm
  • 0x52 digital input 2 alarm
  • 0x6d Breath data
  • 0x6e Breath alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.sensorError boolean True if : Error reading a sensor or poor sensor health status
tvoc ReadingDetailsDuration Readings of TVOC particulate matter
readingDetailsDuration.min ReadingValue Minimum value of readings
readingValue.unit String Unit
readingValue.value int Value
readingDetailsDuration.max ReadingValue Maxinum value of readings
readingValue.unit String Unit
readingValue.value int Value
readingDetailsDuration.average ReadingValue Average value of readings
readingValue.unit String Unit
readingValue.value int Value
readingDetailsDuration.duration ReadingValue Duration above threshold
readingValue.unit String Unit
readingValue.value int Value
pm10 ReadingDetailsDuration Readings of PM10 particulate matter
readingDetailsDuration.min ReadingValue Minimum value of readings
readingValue.unit String Unit
readingValue.value int Value
readingDetailsDuration.max ReadingValue Maxinum value of readings
readingValue.unit String Unit
readingValue.value int Value
readingDetailsDuration.average ReadingValue Average value of readings
readingValue.unit String Unit
readingValue.value int Value
readingDetailsDuration.duration ReadingValue Duration above threshold
readingValue.unit String Unit
readingValue.value int Value
pm25 ReadingDetailsDuration Readings of PM2.5 particulate matter
readingDetailsDuration.min ReadingValue Minimum value of readings
readingValue.unit String Unit
readingValue.value int Value
readingDetailsDuration.max ReadingValue Maxinum value of readings
readingValue.unit String Unit
readingValue.value int Value
readingDetailsDuration.average ReadingValue Average value of readings
readingValue.unit String Unit
readingValue.value int Value
readingDetailsDuration.duration ReadingValue Duration above threshold
readingValue.unit String Unit
readingValue.value int Value
pm1 ReadingDetailsShort Readings of PM1 particulate matter
readingDetailsShort.min ReadingValue Minimum value of readings
readingValue.unit String Unit
readingValue.value int Value
readingDetailsShort.max ReadingValue Maxinum value of readings
readingValue.unit String Unit
readingValue.value int Value
readingDetailsShort.average ReadingValue Average value of readings
readingValue.unit String Unit
readingValue.value int Value
PayloadBreath 0x33 Set Register Status
DescriptionBreath 0x33 Set Register Status. Tag Breath associated to the device. Response frame following an update of register(s) via downlink
Example :
Input3380040140
Output
{"type":"0x33 Set register status","status":{"frameCounter":4,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false,"sensorError":false},"requestStatus":"errorInvalidRegister","registerId":320}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Breath configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Breath Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x51 digital input 1 (button) alarm
  • 0x52 digital input 2 alarm
  • 0x6d Breath data
  • 0x6e Breath alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.sensorError boolean True if : Error reading a sensor or poor sensor health status
requestStatus String Request status. Values can be:
  • errorOtherReason
  • success
  • successNoUpdate
  • errorCoherency
  • errorInvalidRegister
  • errorInvalidValue
  • errorAccessNotAllowed
registerId int Indicates to the user the register that caused the error, only if requestStatus is different from success.
PayloadBreath 0x37 Software version frame
DescriptionBreath 0x37 Software version. Tag Breath associated to the device. This frame is sent at the start of the product only if KARE+ is enabled.
Example :
Input3720020100020001
Output
{"type":"0x37 Software version","status":{"frameCounter":1,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false,"sensorError":false},"appVersion":"2.1.0","rtuVersion":"2.0.1"}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Breath configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Breath Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x51 digital input 1 (button) alarm
  • 0x52 digital input 2 alarm
  • 0x6d Breath data
  • 0x6e Breath alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.sensorError boolean True if : Error reading a sensor or poor sensor health status
appVersion String APP version
rtuVersion String RTU version
PayloadBreath 0x51 Breath Digital Input 1 Alarm
DescriptionBreath 0x51 Breath Digital Input 1 Alarm. Tag Breath associated to the device. This frame is sent when the number of detected events exceeds the threshold.
Example :
Input51a0010000017E0001
Output
{"type":"0x51 digital input 1 alarm","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false,"sensorError":false},"state":{"previousFrame":false,"current":true},"counter":{"global":382,"instantaneous":1}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Breath configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Breath Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x51 digital input 1 (button) alarm
  • 0x52 digital input 2 alarm
  • 0x6d Breath data
  • 0x6e Breath alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.sensorError boolean True if : Error reading a sensor or poor sensor health status
state State State
state.previousFrame boolean State of the digital input when sending the previous frame : true if ON/CLOSED, false if OFF/OPENED
state.current boolean Current state of the digital input : true if ON/CLOSED, false if OFF/OPENED
counter Counter Counters
counter.global int Global counter of the digital input
counter.instantaneous int Instantaneous counter of the digital input
timestamp String Timestamp
PayloadBreath 0x52 Breath Digital Input 2 Alarm
DescriptionBreath 0x52 Breath Digital Input 2 Alarm. Tag Breath associated to the device. This frame is sent when the number of detected events exceeds the threshold.
Example :
Input52a0010000017E0001
Output
{"type":"0x52 digital input 2 alarm","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false,"sensorError":false},"state":{"previousFrame":false,"current":true},"counter":{"global":382,"instantaneous":1}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Breath configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Breath Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x51 digital input 1 (button) alarm
  • 0x52 digital input 2 alarm
  • 0x6d Breath data
  • 0x6e Breath alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.sensorError boolean True if : Error reading a sensor or poor sensor health status
state State State
state.previousFrame boolean State of the digital input when sending the previous frame : true if ON/CLOSED, false if OFF/OPENED
state.current boolean Current state of the digital input : true if ON/CLOSED, false if OFF/OPENED
counter Counter Counters
counter.global int Global counter of the digital input
counter.instantaneous int Instantaneous counter of the digital input
timestamp String Timestamp
PayloadBreath 0x6e Breath alarm
DescriptionBreath 0x6e Breath alarm. Tag Breath associated to the device. This frame is sent when the number of detected events exceeds the threshold.
Example :
Input6E800502DB000C00070003
Output
{"type":"0x6e Breath alarm","status":{"frameCounter":4,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false,"sensorError":false},"tvoc":{"alarmStatus":"active","unit":"µg/m3","value":731},"pm10":{"alarmStatus":"inactive","unit":"µg/m3","value":12},"pm25":{"alarmStatus":"active","unit":"µg/m3","value":7},"pm1":{"alarmStatus":"inactive","unit":"µg/m3","value":3}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Breath configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Breath Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x51 digital input 1 (button) alarm
  • 0x52 digital input 2 alarm
  • 0x6d Breath data
  • 0x6e Breath alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.sensorError boolean True if : Error reading a sensor or poor sensor health status
tvoc Alarm Alarm status for TVOC sensor
alarm.alarmStatus String Alarm status: values can be active or inactive.
alarm.unit String Unit of sensor reading
alarm.value int Value of sensor reading
pm10 Alarm Alarm status for PM10 sensor
alarm.alarmStatus String Alarm status: values can be active or inactive.
alarm.unit String Unit of sensor reading
alarm.value int Value of sensor reading
pm25 Alarm Alarm status for PM2.5 sensor
alarm.alarmStatus String Alarm status: values can be active or inactive.
alarm.unit String Unit of sensor reading
alarm.value int Value of sensor reading
pm1 Alarm Alarm status for PM1 sensor
alarm.alarmStatus String Alarm status: values can be active or inactive.
alarm.unit String Unit of sensor reading
alarm.value int Value of sensor reading
PayloadBreath 0x6d Breath data
DescriptionBreath 0x6d Breath data. Tag Breath associated to the device. Periodic data frame
Example :
Input6D8001B3003E001E001401B3003E001E0014
Output
{"type":"0x6d Breath periodic data","status":{"frameCounter":4,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false,"sensorError":false},"decodingInfo":"values: [t\u003d0, t-1, t-2, ...]","tvoc":{"unit":"µg/m3","values":[435,435]},"pm10":{"unit":"µg/m3","values":[62,62]},"pm25":{"unit":"µg/m3","values":[30,30]},"pm1":{"unit":"µg/m3","values":[20,20]}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Breath configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Breath Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x51 digital input 1 (button) alarm
  • 0x52 digital input 2 alarm
  • 0x6d Breath data
  • 0x6e Breath alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.sensorError boolean True if : Error reading a sensor or poor sensor health status
decodingInfo String Values information: cvalues: [t=0, t-1, t-2, ...]
tvoc ReadingValues Reading values of TVOC particulate matter
readingValues.unit String Unit
readingValues.values Array Values in array
pm10 ReadingValues Reading values of PM10 particulate matter
readingValues.unit String Unit
readingValues.values Array Values in array
pm25 ReadingValues Reading values of PM2.5 particulate matter
readingValues.unit String Unit
readingValues.values Array Values in array
pm1 ReadingValues Reading values of PM1 particulate matter
readingValues.unit String Unit
readingValues.values Array Values in array
PayloadComfort 0x10 Comfort configuration frame
DescriptionComfort 0x10 Comfort configuration frame. Tag comfort associated to the device. When switching to operating mode (PARK or COMMAND mode output), this frame representing the application configuration of the device is transmitted
Example :
Input100021c000030002012c
Output
{"type":"0x10 Comfort configuration","status":{"frameCounter":0,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"transmissionPeriodKeepAlive":{"unit":"s","value":86400},"numberOfHistorizationBeforeSending":3,"numberOfSamplingBeforeHistorization":2,"samplingPeriod":{"unit":"s","value":600},"calculatedPeriodRecording":{"unit":"s","value":1200},"calculatedSendingPeriod":{"unit":"s","value":3600}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Comfort configuration
  • 0x10 Comfort 2 configuration
  • 0x10 Comfort CO2 configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Comfort CO2 Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x4c Comfort data
  • 0x4c Comfort 2 data
  • 0x4d Comfort alarm
  • 0x4d Comfort 2 alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x6a Comfort CO2 data
  • 0x6b Comfort CO2 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
transmissionPeriodKeepAlive Period Transmission period of the Keep Alive frame.
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
numberOfHistorizationBeforeSending int Transmission period of the periodic frame
numberOfSamplingBeforeHistorization int History period
samplingPeriod Period Sampling period
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
calculatedPeriodRecording Period Calculated period recording
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
calculatedSendingPeriod Period Calculated sending period
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
redundantSamples int Number of additional (redundant) samples per frame
dailyFrameActivated Boolean True if daily frame transmission is activated
PayloadComfort 0x1f Digital Input Configuration
DescriptionComfort 0x1f Digital Input Configuration. Tag comfort associated to the device. This frame is sent at the start-up of the device (except when it is a reboot after a downlink).
Example :
Input1f20410001410001
Output
{"type":"0x1f digital input configuration","status":{"frameCounter":1,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"digitalInput1":{"type":"highEdge","debouncingPeriod":{"unit":"ms","value":100},"threshold":1},"digitalInput2":{"type":"highEdge","debouncingPeriod":{"unit":"ms","value":100},"threshold":1}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Comfort configuration
  • 0x10 Comfort 2 configuration
  • 0x10 Comfort CO2 configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Comfort CO2 Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x4c Comfort data
  • 0x4c Comfort 2 data
  • 0x4d Comfort alarm
  • 0x4d Comfort 2 alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x6a Comfort CO2 data
  • 0x6b Comfort CO2 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
digitalInput1 DigitalInput Configuration of the button (Digital Input 1)
digitalInput.type String Digital Input type. Values can be deactivated when off, highEdge when event ON, lowEdge when event OFF, or bothEdges when event ON/OFF
digitalInput.debouncingPeriod DebouncingPeriod Debouncing period
debouncingPeriod.unit String milliseconds
debouncingPeriod.value int Debouncing period value
digitalInput.threshold int Button alarm threshold value : when the detection counter becomes greater than this threshold, an alarm is triggered
digitalInput2 DigitalInput Configuration of the button (Digital Input 2)
digitalInput.type String Digital Input type. Values can be deactivated when off, highEdge when event ON, lowEdge when event OFF, or bothEdges when event ON/OFF
digitalInput.debouncingPeriod DebouncingPeriod Debouncing period
debouncingPeriod.unit String milliseconds
debouncingPeriod.value int Debouncing period value
digitalInput.threshold int Button alarm threshold value : when the detection counter becomes greater than this threshold, an alarm is triggered
PayloadComfort 0x20 Configuration
DescriptionComfort 0x20 Configuration. Tag comfort associated to the device. Information frame on Network configuration
Example :
Input20a00501
Output
{"type":"0x20 Configuration","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"loraAdr":true,"loraProvisioningMode":"OTAA","loraDutycyle":"activated","loraClassMode":"CLASS A"}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Comfort configuration
  • 0x10 Comfort 2 configuration
  • 0x10 Comfort CO2 configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Comfort CO2 Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x4c Comfort data
  • 0x4c Comfort 2 data
  • 0x4d Comfort alarm
  • 0x4d Comfort 2 alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x6a Comfort CO2 data
  • 0x6b Comfort CO2 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
loraAdr Boolean Activation of the ADR : true if ON, false if OFF
loraProvisioningMode String Mode of activation : value can be ABP or OTAA (default value
loraClassMode String ClassMode : values can be CLASS A or CLASS C.
loraDutycyle String Dutycycle : values can be activated or deactivated
PayloadComfort 0x30 Keep alive
DescriptionComfort 0x30 Keep alive. Tag comfort associated to the device. Keep alive frame
Example :
Input30A0
Output
{"type":"0x30 Keep alive","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Comfort configuration
  • 0x10 Comfort 2 configuration
  • 0x10 Comfort CO2 configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Comfort CO2 Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x4c Comfort data
  • 0x4c Comfort 2 data
  • 0x4d Comfort alarm
  • 0x4d Comfort 2 alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x6a Comfort CO2 data
  • 0x6b Comfort CO2 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
icone int ICONE indicator (0-5)
qaiRedDuration Duration Duration above QAI red indicator. Min 0, max 24 hours)
duration.value int Duration
duration.unit String Time unit
temperatureMax Temperature Temperature max.
temperature.value Number Temperature value
temperature.unit String °C
temperatureMin Temperature Temperature min.
temperature.value Number Temperature value
temperature.unit String °C
temperatureAverage Temperature Temperature average.
temperature.value Number Temperature value
temperature.unit String °C
co2Max Co2 Co2 max.
co2.value int Co2 value
co2.unit String ppm
co2Min Co2 Co2 min.
co2.value int Co2 value
co2.unit String ppm
co2Average Co2 Co2 average.
co2.value int Co2 value
co2.unit String ppm
humidityMax Humidity Humidity max.
humidity.value int Humidity value
humidity.unit String %
humidityMin Humidity Humidity min.
humidity.value int Humidity value
humidity.unit String %
humidityAverage Humidity Humidity average.
humidity.value int Humidity value
humidity.unit String %
timestamp String Timestamp
PayloadComfort 0x33 Set Register Status
DescriptionComfort 0x33 Set Register Status. Tag comfort associated to the device. Response frame following an update of register(s) via downlink
Example :
Input3380040140
Output
{"type":"0x33 Set register status","status":{"frameCounter":4,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"requestStatus":"errorInvalidRegister","registerId":320}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Comfort configuration
  • 0x10 Comfort 2 configuration
  • 0x10 Comfort CO2 configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Comfort CO2 Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x4c Comfort data
  • 0x4c Comfort 2 data
  • 0x4d Comfort alarm
  • 0x4d Comfort 2 alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x6a Comfort CO2 data
  • 0x6b Comfort CO2 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
requestStatus String Request status. Values can be:
  • errorOtherReason
  • success
  • successNoUpdate
  • errorCoherency
  • errorInvalidRegister
  • errorInvalidValue
  • errorTruncatedValue
  • errorAccesNotAllowed
registerId int Indicates to the user the register that caused the error, only if requestStatus is different from success.
PayloadComfort 0x4c Comfort Data
DescriptionComfort 0x4c Comfort Data. Tag comfort associated to the device. Periodic data frame
Example :
Input4c2000c51f00c72000c82100ca2200cc2300cd24
Output
{"type":"0x4c Comfort data","status":{"frameCounter":1,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"decodingInfo":"values: [t\u003d0, t-1, t-2, ...]","temperature":{"unit":"°C","values":[19.7,19.9,20,20.2,20.4,20.5]},"humidity":{"unit":"%","values":[31,32,33,34,35,36]}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Comfort configuration
  • 0x10 Comfort 2 configuration
  • 0x10 Comfort CO2 configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Comfort CO2 Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x4c Comfort data
  • 0x4c Comfort 2 data
  • 0x4d Comfort alarm
  • 0x4d Comfort 2 alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x6a Comfort CO2 data
  • 0x6b Comfort CO2 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
decodingInfo String List of temperatures : t0, t-1, t-2, t-3,t-4, t-5, t-6
temperature Temperatures Sensor Temperatures
temperatures.unit String Degrees Celcius
temperatures.values Array Temperature values in array
humidities.unit String Pourcents
humidities.values Array Humidity values in array
timestamp String Timestamp
PayloadComfort 0x4d Comfort Alarm
DescriptionComfort 0x4d Comfort Alarm. Tag comfort associated to the device. Temperature and humidity alarm frame
Example :
Input4dc010010832
Output
{"type":"0x4d Comfort alarm","status":{"frameCounter":6,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"alarmTemperature":{"alarmStatus":"active","temperature":{"unit":"°C","value":26.4}},"alarmHumidity":{"alarmStatus":"inactive","humidity":{"unit":"%","value":50}}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Comfort configuration
  • 0x10 Comfort 2 configuration
  • 0x10 Comfort CO2 configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Comfort CO2 Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x4c Comfort data
  • 0x4c Comfort 2 data
  • 0x4d Comfort alarm
  • 0x4d Comfort 2 alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x6a Comfort CO2 data
  • 0x6b Comfort CO2 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
alarmTemperature AlarmTemperature Temperature alarm
alarmTemperature.alarmStatus String Alarm status. Values can be active when thresholds are exceeded, or inactive when thresholds are not reached
alarmTemperature.temperature Temperature Temperature
temperature.unit String Degrees Celcius
temperature.value Number Temperature value
temperature.name String Name
temperature.id Number Id
alarmHumidity AlarmHumidity Humidity alarm
alarmHumidity.alarmStatus String Alarm status. Values can be active when thresholds are exceeded, or inactive when thresholds are not reached
alarmHumidity.humidity Humidity Humidity
humidity.unit String Pourcents
humidity.value int Humidity value
timestamp String Timestamp
PayloadComfort 0x51 Comfort Digital Input 1 Alarm
DescriptionComfort 0x51 Comfort Digital Input 1 Alarm. Tag comfort associated to the device. Digital Input Digital Input 1 button alarm frame
Example :
Input51a0010000017E0001
Output
{"type":"0x51 digital input 1 alarm","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"state":{"previousFrame":false,"current":true},"counter":{"global":382,"instantaneous":1}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Comfort configuration
  • 0x10 Comfort 2 configuration
  • 0x10 Comfort CO2 configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Comfort CO2 Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x4c Comfort data
  • 0x4c Comfort 2 data
  • 0x4d Comfort alarm
  • 0x4d Comfort 2 alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x6a Comfort CO2 data
  • 0x6b Comfort CO2 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
state State State
state.previousFrame boolean State of the digital input when sending the previous frame : true if ON/CLOSED, false if OFF/OPENED
state.current boolean Current state of the digital input : true if ON/CLOSED, false if OFF/OPENED
counter Counter Counters
counter.global int Global counter of the digital input
counter.instantaneous int Instantaneous counter of the digital input
timestamp String Timestamp
PayloadComfort 0x52 Comfort Digital Input 2 Alarm
DescriptionComfort 0x52 Comfort Digital Input 2 Alarm. Tag comfort associated to the device. Digital Input 2 terminal block alarm frame
Example :
Input52a0010000017E0001
Output
{"type":"0x52 digital input 2 alarm","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false},"state":{"previousFrame":false,"current":true},"counter":{"global":382,"instantaneous":1}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Comfort configuration
  • 0x10 Comfort 2 configuration
  • 0x10 Comfort CO2 configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Comfort CO2 Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x4c Comfort data
  • 0x4c Comfort 2 data
  • 0x4d Comfort alarm
  • 0x4d Comfort 2 alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x6a Comfort CO2 data
  • 0x6b Comfort CO2 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
state State State
state.previousFrame boolean State of the digital input when sending the previous frame : true if ON/CLOSED, false if OFF/OPENED
state.current boolean Current state of the digital input : true if ON/CLOSED, false if OFF/OPENED
counter Counter Counters
counter.global int Global counter of the digital input
counter.instantaneous int Instantaneous counter of the digital input
timestamp String Timestamp
PayloadComfort2 0x10 Comfort 2 configuration frame
DescriptionComfort2 0x10 Comfort 2 configuration frame. Tag comfort2 associated to the device. This frame is sent following the reception of a frame with code 0x01, or at the start of the product.
Example :
Input101021c000010001070801
Output
{"type":"0x10 Comfort 2 configuration","status":{"frameCounter":0,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false,"timestamp":false},"transmissionPeriodKeepAlive":{"unit":"s","value":86400},"numberOfHistorizationBeforeSending":1,"numberOfSamplingBeforeHistorization":1,"samplingPeriod":{"unit":"s","value":3600},"redundantSamples":1,"calculatedPeriodRecording":{"unit":"s","value":3600},"calculatedSendingPeriod":{"unit":"s","value":3600}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Comfort configuration
  • 0x10 Comfort 2 configuration
  • 0x10 Comfort CO2 configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Comfort CO2 Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x4c Comfort data
  • 0x4c Comfort 2 data
  • 0x4d Comfort alarm
  • 0x4d Comfort 2 alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x6a Comfort CO2 data
  • 0x6b Comfort CO2 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
transmissionPeriodKeepAlive Period Transmission period of the Keep Alive frame.
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
numberOfHistorizationBeforeSending int Transmission period of the periodic frame
numberOfSamplingBeforeHistorization int History period
samplingPeriod Period Sampling period
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
calculatedPeriodRecording Period Calculated period recording
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
calculatedSendingPeriod Period Calculated sending period
period.value int Period duration
period.unit String Time unit: s for second, m for minute, ms for millisecond
redundantSamples int Number of additional (redundant) samples per frame
dailyFrameActivated Boolean True if daily frame transmission is activated
PayloadComfort2 0x1f Digital Input Configuration frame
DescriptionComfort2 0x1f Digital Input Configuration. Tag comfort2 associated to the device. This frame is sent at the start-up of the device (except when it is a reboot after a downlink).
Example :
Input1fa0410001210001
Output
{"type":"0x1f digital input configuration","status":{"frameCounter":5,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false,"timestamp":false},"digitalInput1":{"type":"highEdge","debouncingPeriod":{"unit":"ms","value":100},"threshold":1},"digitalInput2":{"type":"highEdge","debouncingPeriod":{"unit":"ms","value":20},"threshold":1}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Comfort configuration
  • 0x10 Comfort 2 configuration
  • 0x10 Comfort CO2 configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Comfort CO2 Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x4c Comfort data
  • 0x4c Comfort 2 data
  • 0x4d Comfort alarm
  • 0x4d Comfort 2 alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x6a Comfort CO2 data
  • 0x6b Comfort CO2 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
digitalInput1 DigitalInput Configuration of the button (Digital Input 1)
digitalInput.type String Digital Input type. Values can be deactivated when off, highEdge when event ON, lowEdge when event OFF, or bothEdges when event ON/OFF
digitalInput.debouncingPeriod DebouncingPeriod Debouncing period
debouncingPeriod.unit String milliseconds
debouncingPeriod.value int Debouncing period value
digitalInput.threshold int Button alarm threshold value : when the detection counter becomes greater than this threshold, an alarm is triggered
digitalInput2 DigitalInput Configuration of the button (Digital Input 2)
digitalInput.type String Digital Input type. Values can be deactivated when off, highEdge when event ON, lowEdge when event OFF, or bothEdges when event ON/OFF
digitalInput.debouncingPeriod DebouncingPeriod Debouncing period
debouncingPeriod.unit String milliseconds
debouncingPeriod.value int Debouncing period value
digitalInput.threshold int Button alarm threshold value : when the detection counter becomes greater than this threshold, an alarm is triggered
PayloadComfort2 0x20 Configuration frame
DescriptionComfort2 0x20 Configuration. Tag comfort2 associated to the device. Information frame on Network configuration
Example :
Input20200501
Output
{"type":"0x20 Configuration","status":{"frameCounter":1,"hardwareError":false,"lowBattery":false,"configurationDone":false,"configurationInconsistency":false,"timestamp":false},"loraAdr":true,"loraProvisioningMode":"OTAA","loraDutycyle":"activated","loraClassMode":"CLASS A"}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Comfort configuration
  • 0x10 Comfort 2 configuration
  • 0x10 Comfort CO2 configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Comfort CO2 Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x4c Comfort data
  • 0x4c Comfort 2 data
  • 0x4d Comfort alarm
  • 0x4d Comfort 2 alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x6a Comfort CO2 data
  • 0x6b Comfort CO2 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
loraAdr Boolean Activation of the ADR : true if ON, false if OFF
loraProvisioningMode String Mode of activation : value can be ABP or OTAA (default value
loraClassMode String ClassMode : values can be CLASS A or CLASS C.
loraDutycyle String Dutycycle : values can be activated or deactivated
PayloadComfort2 0x30 Keep alive frame
DescriptionComfort2 0x30 Keep alive. Tag comfort2 associated to the device. This frame is sent after an amount of time determined by S300 register (Keep alive period), or following the reception of a frame with code 0x02.
Example :
Input30E2
Output
{"type":"0x30 Keep alive","status":{"frameCounter":7,"hardwareError":false,"lowBattery":true,"configurationDone":false,"configurationInconsistency":false,"timestamp":false}}
Output json fields :
Fields
nametypedescription
type String MessageType. Values can be:
  • 0x10 Comfort configuration
  • 0x10 Comfort 2 configuration
  • 0x10 Comfort CO2 configuration
  • 0x1f digital input configuration
  • 0x20 Configuration
  • 0x30 Keep alive
  • 0x30 Comfort CO2 Daily frame
  • 0x33 Set register status
  • 0x37 Software version
  • 0x4c Comfort data
  • 0x4c Comfort 2 data
  • 0x4d Comfort alarm
  • 0x4d Comfort 2 alarm
  • 0x51 digital input 1 alarm
  • 0x52 digital input 2 alarm
  • 0x6a Comfort CO2 data
  • 0x6b Comfort CO2 alarm
status.frameCounter int Frame counter, it increments at each transmission and allows the user to seE quickly if a frame has been lost. It counts from 0 to 7 before looping back.
status.hardwareError boolean Hardware error has occurred, for example a writing problem in the EEPROM, a reading problem on the ADC, etc. The product must be returned to the service dept.
status.lowBattery boolean Battery voltage is less than 2.5V, otherwise 0. This information remains permanent.
status.configurationDone boolean True if configuration was carried out during the last downlink frame
status.configurationInconsistency boolean True to indicate that the configuration of the application is wrong. For example, if samples lost in periodic data frame because the payload is not sufficient, or the total number of bytes to go up in the periodic data frame is too great
status.timestamp boolean True if timestamp is activated
icone int ICONE indicator (0-5)
qaiRedDuration Duration Duration above QAI red indicator. Min 0, max 24 hours)
duration.value int Duration
duration.unit String Time unit
temperatureMax Temperature Temperature max.
temperature.value Number Temperature value
temperature.unit String °C
temperatureMin Temperature Temperature min.
temperature.value Number Temperature value
temperature.unit String °C
temperatureAverage Temperature Temperature average.
temperature.value Number Temperature value
temperature.unit String °C
co2Max Co2 Co2 max.
co2.value int Co2 value
co2.unit String ppm
co2Min Co2 Co2 min.
co2.value int Co2 value
co2.unit String ppm