Modem Service JSON Formats

UPLINK_RESPONSE = {
  "operation":          null | STRING,            // Signals type of performed operation
  "file":               null | FILE,              // Optional. Received file
  "stream_records":     null | [ STREAM, .. ],    // Optional. Received stream records
  "position_solution":  null | POSITION_SOLUTION, // Optional. Solution of position calculation
  "fulfilled_requests": null | [ PENDING_REQUEST, .. ], // Optional. Fulfilled requests
  "dnlink":             null | LORA_DNLINK        // Optional. Downlink to issue
  "fports":             FPORTS,                   // Current device port settings
  "info_fields":        INFO_FIELDS,             // The updated device info fields
  "pending_requests": {
    "requests":         [ PENDING_REQUEST, .. ]  // List of pending requests
  },
  "log_messages":       [ LOG_MESSAGE, .. ]      // Log messages generated during processing
}
  

INFO_FIELDS = {
 "status":   null | { "timestamp": FLOAT, "value": STATUS_FIELD },
 "charge":   null | { "timestamp": FLOAT, "value": UINT2 },
 "voltage":  null | { "timestamp": FLOAT, "value": FLOAT },
 "temp":     null | { "timestamp": FLOAT, "value": INT },
 "signal":   null | { "timestamp": FLOAT, "value": { "rssi": INT, "snr": FLOAT }},
 "uptime":   null | { "timestamp": FLOAT, "value": UINT2 },
 "rxtime":   null | { "timestamp": FLOAT, "value": UINT2 },
 "firmware": null | { "timestamp": FLOAT, "value": { "fwcrc": HEX, "fwtotal": UINT2, "fwcompleted": UINT2 }},
 "adrmode":  null | { "timestamp": FLOAT, "value": ADRMODE },
 "joineui":  null | { "timestamp": FLOAT, "value": DEVEUI },
 "interval": null | { "timestamp": FLOAT, "value": REPINTV },
 "region":   null | { "timestamp": FLOAT, "value": UINT1 },
 "crashlog": null | { "timestamp": FLOAT, "value": STRING },
 "rstcount": null | { "timestamp": FLOAT, "value": UINT2 },
 "deveui":   null | { "timestamp": FLOAT, "value": DEVEUI },
 "rfu":      null | { "timestamp": FLOAT, "value": UINT2 },   // Reserved for future use
 "session":  null | { "timestamp": FLOAT, "value": UINT2 },
 "chipeui":  null | { "timestamp": FLOAT, "value": DEVEUI },
 "streampar":null | { "timestamp": FLOAT, "value": STREAMPAR },
 "appstatus":null | { "timestamp": FLOAT, "value": HEX },
 "alcsync":  null | { "timestamp": FLOAT, "value": ALCSYNC_FIELD }.
}

STATUS_FIELD = {
 "brownout":  BOOL,
 "crash":     BOOL,
 "mute":      BOOL,
 "joined":    BOOL,
 "suspend":   BOOL,
 "upload":    BOOL,
}

STREAMPAR = {
 "port":     UINT1,
 "encmode":  BOOL
}

ALCSYNC_FIELD = {
 "token": UINT1,  // Token, selected by modem
 "time":  UINT4   // Time reported by modem for time correction
}
  

REQUEST = {
  "type":     STRING, // Required. Request type.
  "param":    ANY,    // Optional. Request specific parameter.
}

RESET_REQUEST = {
  "type":      "RESET",   // RESET request
  "param":     UINT1      // 0x1, 0x2 or 0x3
}

REJOIN_REQUEST = {
  "type":      "REJOIN"   // REJOIN request
}

MUTE_REQUEST = {
  "type":      "MUTE"     // MUTE request
  "param":     UINT1      // Mute parameter
}

GETINFO_REQUEST = {
  "type":      "GETINFO", // GETINFO request
  "param":     [ FIELD, .. ]    // Required. List of field names given below
}

FIELD = [ "status", "charge", "voltage", "temp", "signal", "uptime",
          "rxtime", "firmware", "adrmode", "joineui", "interval", "region",
          "crashlog", "rstcount", "deveui", "session", "chipeui" ]

SETCONF_REQUEST = {
  "type":      "SETCONF",  // SETCONF request
  "param":     {           // Required. Map of SETCONF type to value
    "adrmode":   ADRMODE,  // Optional. ADR mode
    "joineui":   JOINEUI,  // Optional. EUI
    "interval":  REPINTV,  // Optional. Reporting interval
    "region":    UINT1,    // Optional. Regulatory region (according to device manual)
  }
}

ADRMODE: UINT1
  0x00: LNS controlled
  0x01: Mobile Long Range
  0x02: Mobile Low Power

REPINTV: UINT1
  Bits 7-6: unit (sec=0x00, day=0x01, hour=0x10, min=0x11)
  Bits 5-0: value (0-63)

FILEDONE_REQUEST = {
  "type":      "FILEDONE", // FILEDONE request
  "param":    {
    "sid":    INT,    // Required. File session id
    "sctr":   INT,    // Required. File counter
  }
}
  

PENDING_REQUEST = {
  "id":        INT,    // Request ID
  "cookie":    ANY,    // Value for request completion check
  "timestamp": FLOAT,  // Timestamp, UTC, of request generation
  "request" :  REQUEST // The request as generated by caller
}
  

[ 
  [ UINT,      // Required. Stream offset of the record
    HEX        // Required. HEX string, Stream record data
  ],
  ..
]
  

POSITION_SOLUTION = POSITION_SOLUTION_GNSS | POSITION_SOLUTION_GNSSNG | POSITION_SOLUTION_WIFI
  

POSITION_SOLUTION_GNSS = {
  "algorithm_type": "gnss",             // Required.
  "ecef":      [FLOAT, FLOAT, FLOAT],   // Required. Calculated position in ECEF coordinates [m, m, m]
  "llh":       [FLOAT, FLOAT, FLOAT],   // Required. Calculated position in WGS84 llh coordinates [deg, deg, m]
  "capture_time_gps":  FLOAT,           // Required. Calculated capture time in seconds GPST
  "gdop":      FLOAT,                   // Required. Geometric Dilution of Precision
  "accuracy":  FLOAT,                   // Required. Estimate of calculated position accuracy in meters
  "timestamp": FLOAT                    // Required. Uplink message timestamp corresponding to position solution
}
  

UPLINK_MSG = MSG_JOINING | MSG_UPDF | MSG_GNSS | MSG_GNSSNG | MSG_WIFI
  

MSG_JOINING = {
  "msgtype":   "joining"      // Required.
  "timestamp": FLOAT,         // Optional. RX timestamp in seconds UTC
  "dr":        UINT1,         // Optional. Data rate
  "freq":      UINT4,         // Optional. Frequency
}
  

MSG_UPDF = {
  "msgtype":                    "updf",         // Optional. 'updf' is implied if not present
  "fcnt":                       UINT4,          // Required. Frame counter
  "port":                       UINT1,          // Optional. Port
  "payload":                    HEX,            // Optional. HEX string with LoRaWAN message payload
  "dr":                         UINT1,          // Optional. Data rate
  "freq":                       UINT4,          // Optional. Frequency
  "timestamp":                  FLOAT,          // Optional. RX timestamp in seconds, UTC
  "dn_mtu":                     UINT4,          // Optional. Downlink MTU
  "gnss_capture_time":          FLOAT,          // Optional. Capture time estimate, GPST
  "gnss_capture_time_accuracy": FLOAT,          // Optional. Capture time accuracy, seconds
  "gnss_assist_position":       [FLOAT, FLOAT], // Optional. Assistance position WGS84, (latitude, longitude) [deg]
  "gnss_assist_altitude":       FLOAT,          // Optional. Assistance altitude, (meters above WGS84 reference ellipsoid) [m]
  "gnss_use_2D_solver":         BOOL            // Optional. True if the value gnss_assist_altitude is considered a precise altitude value. A fixed-altitude 2D fix is performed.
}
  

MSG_GNSS = {
  "msgtype":                    "gnss"|"gnssng", // Required.
  "payload":                    HEX,            // Required. HEX string with valid LoRa Edge GNSS positioning protocol payload
  "dn_mtu":                     UINT4,          // Optional. Downlink MTU
  "timestamp":                  FLOAT,          // Optional. RX timestamp in seconds UTC
  "gnss_capture_time":          FLOAT,          // Optional. Capture time estimate, GPST
  "gnss_capture_time_accuracy": FLOAT,          // Optional. Capture time accuracy, in seconds
  "gnss_assist_position":       [FLOAT, FLOAT], // Optional. Assistance position WGS84, (latitude, longitude) [deg]
  "gnss_assist_altitude":       FLOAT,          // Optional. Assistance altitude, (meters above WGS84 reference ellipsoid) [m]
  "gnss_use_2D_solver":         BOOL            // Optional. True if the value gnss_assist_altitude is considered a precise altitude value. A fixed-altitude 2D fix is performed.
}
  

MSG_WIFI = {
  "msgtype":    "wifi",       // Required.
  "payload":    HEX,          // Required. HEX string with valid LoRa Edge Wi-Fi positioning protocol payload
  "timestamp":  FLOAT,        // Optional.

LORA_DNLINK = {
  "port":      UINT1,   // Required. 0: undefined, >0: LoRaWAN FPort
  "payload":   HEX,     // Required. HEX string with valid modem payload
}
  

FILE = {
  "sctr":       UINT1,  // Required. File counter.
  "timestamp":  FLOAT,  // Required. UTC timestamp of the last message having led to a fully de-fragmented file
  "port":       UINT1,  // Required. Target port for uploaded files; may be null on error
  "data":       HEX,    // Required. Contents of an uploaded file; may be null on error
  "hash":       HEX,    // Required. SHA256 short hash over plain data (8/4 bytes for plain/encrypted upload); may be null on error
  "encmode":    BOOL,   // Required. File encrypted; may be null on error
  "message":    STRING, // Optional. May contain a log message of the service
}
  

STREAM = {
  "timestamp":  FLOAT,  // Required. UTC timestamp of the last message having led to a fully de-fragmented stream record
  "port":       UINT1,  // Required. Target port for the uploaded stream
  "data":       HEX,    // Required. Contents of the stream record
  "off":        UINT2   // Required. Application record counter (byte offset)
}
  

LOG_MESSAGE = {
  "logmsg":    STRING,  // Required. Log message
  "level":     STRING,  // Required. "WARNING", "INFO" or "ERROR"
  "timestamp": FLOAT    // Required. Timestamp, UTC, Float
}
  

FPORTS = {
  "dmport":      UINT1,   // Configured or default port for Modem messages
  "gnssport":    UINT1,   // Configured or default port for GNSS messages
  "gnssngport":  UINT1,   // Configured or default port for GNSSNG messages
  "wifiport":    UINT1,   // Configured or default port for Wi-Fi messages
  "streamport":  UINT1    // Configured or default port for Stream messages
}