Last updated on September 16th, 2024
The data is processed and pushed to your endpoint in JSON format.
- For all messages
Raw type Basic format V1.1
- MSG_ID: message identifier (as a text)
- MSG_DATE: message reception time at the satellite in UTC
- DEVICE_ID: transmitting device identifier
- Device metadata: optional device attribute, see Add metadata
- RAW_DATA: message payload in hexadecimal format
- BIT_LENGTH (since v1.1): message payload length in bits. If the length is not multiple of 8 bits, RAW_DATA is padded with extra 0 bits to the right, in order to fit to an even number of hexadecimal digits.
- SYSTEM (not available for 28-bit address devices)
- SF: Service Flag
- 0=No service
- 1=Mail request
- 2=BC Unicast ACK
- 3=BC Multicast ACK
- 4=PACK Normal request
- 5=PACK Emergency request
- MC: Message Counter [0..511]
- PRC: Processing Flag
- UPLK= Uplink only
- PROTOCOL_ERR= Protocol error
- DLK_SENT= Downlink message requested
- DLK_ERR= Detected issue on received message : downlink service error
- NONE= No processing (BC ACK)
- ACK_SENT= ACK requested
- ACK_ERR= Detected issue on received message : ACK service error
- SF: Service Flag
JSON example
{
"TYPE":"DEVICE_RAW",
"MODE":"BASIC",
"VERSION":"1.1",
"DATA":[
{
"MSG_ID":"959504271596851200",
"MSG_DATE":"2022-04-01T18:20:02.449Z",
"DEVICE_ID":1,
"RAW_DATA":"09118200",
"BIT_LENGTH":28,
"My_ID":"007", // device metadata
"SYSTEM": {
"SF": 0,
"MC": 2,
"PRC": “UPLK”
}
}
]
}
Raw type Expert format V1.1
Access granted on demand; network info available
- More formats for processed messages from 28-bit address devices with a codec declared
Processed type Basic
Only messages with correct integrity control are distributed.
- DEVICE_ID: transmitting device identifier
- MSG_ID: message identifier
- MSG_DATE: message reception time at the satellite in UTC
- CHECKED: message verification status
- RAW_DATA: message payload in hexadecimal format
- CRC_OK: integrity check status
JSON example
{
"TYPE":"DEVICE_PRC",
"MODE":"BASIC",
"VERSION":"1.1",
"DATA":[
{
"DEVICE_ID":86051,
"MSG_ID":"961014953249251328",
"MSG_DATE":"2022-04-01T18:20:02.449Z",
"CHECKED":"Y",
"SENSORS":{
"RAW_DATA":"00000000000000000000000000000000000000000000000000",
"CRC_OK":true
}
}
]
}
Processed type Expert
All messages are distributed regardless their integrity control.
- DEVICE_ID: transmitting device identifier
- MSG_ID: message identifier
- MSG_DATE: message reception time at the satellite in UTC
- CHECKED: message verification status
- RAW_DATA: message payload in hexadecimal format
- CRC_OK, BCH_STATUS, MC, SF: Kinéis protocolar fields, including integrity check status
JSON example
{
"TYPE":"DEVICE_PRC",
"MODE":"EXPERT",
"VERSION":"1.1",
"DATA":[
{
"DEVICE_ID":86051,
"MSG_ID":"961014953249251328",
"MSG_DATE":"2022-04-01T18:20:02.449Z",
"CHECKED":"Y",
"SENSORS":{
"RAW_DATA":"00000000000000000000000000000000000000000000000000",
"BCH_STATUS":2,
"CRC_OK":true
}
}
]
}
- For native location (Doppler) messages
Location type Kinéis format V2.1
- DEVICE_ID: transmitting device identifier
- SERVICE: type of the location. STANDARD by default (others are reserved for internal use only): new locations are distributed immediately and will receive further updates in the next hours.
- LOC_DATE: computed location date time in UTC
- LOC_ID: location identifier, a counter starting at 0 (the ID will be reset after 6 months without emissions).
- REVISION: number of revisions of the location, range [0..+10]
- LONGITUDE: longitude in degrees, range ]-180..+180]
- LATITUDE: latitude in degrees, range [-90..+90]
- ALTITUDE: ground altitude in meters
- ERROR_RADIUS: error radius of the location in meters
- FREQUENCY: frequency of the device in Hz
- MSG_IDS: raw messages ids linked with this localization info
JSON example
{
"TYPE":"DEVICE_DOP",
"MODE":"BASIC",
"VERSION":"2.1",
"DATA":[
{
"DEVICE_ID":98765,
"SERVICE":"STANDARD",
"LOC_DATE":"2022-04-05T21:11:40Z",
"LOC_ID":1234,
"REVISION":1,
"LONGITUDE":-1.59807,
"LATITUDE":55.37866
,
"ALTITUDE":200,
"ERROR_RADIUS":150,
"FREQUENCY":401567890.123,
"MSG_IDS":[
0123456789012345678,
1234567890123456789
]
}
]
}