Difference between revisions of "Codec JSON"

From Wiki Knowledge Base | Teltonika GPS
(Created page with "'''Codec JSON''' JSON (JavaScript Object Notation) it is a light data exchange format, that due its simplicity to be written and fast interpretation and generation for machin...")
 
(Add images)
Line 43: Line 43:
 
Authentication is same as AWS Shadow.
 
Authentication is same as AWS Shadow.
  
 +
[[File:Codec JSON.png|center|frameless|222x222px]]
 
Codec JSON is available as a transmission codec now ('''since the fw 03.27.05.Rev.250'''''), this parameter can be selected in the Teltonika’s Configurator>> System>> System Settings>> Data Protocol>> and selecting Codec JSON<br>
 
Codec JSON is available as a transmission codec now ('''since the fw 03.27.05.Rev.250'''''), this parameter can be selected in the Teltonika’s Configurator>> System>> System Settings>> Data Protocol>> and selecting Codec JSON<br>
 
+
[[File:MQTT Server.png|center|frameless|300x300px]]
 
  
 
Additionally, to develop the fully configuration in the teltonika device, make sure to use the MQTT protocol, this can be done in the Teltonika’s configurator>>GPRS Server Settings>> and in protocol selecting MQTT.
 
Additionally, to develop the fully configuration in the teltonika device, make sure to use the MQTT protocol, this can be done in the Teltonika’s configurator>>GPRS Server Settings>> and in protocol selecting MQTT.

Revision as of 01:46, 20 January 2023

Codec JSON

JSON (JavaScript Object Notation) it is a light data exchange format, that due its simplicity to be written and fast interpretation and generation for machines.

JSON is made up of two structures:

  • A collection of name/value pairs. In various languages this is known as an object, record, structure, dictionary, hash table, key list, or an associative array.
  • An ordered list of values. In most languages, this is implemented as arrays, vectors, lists, or sequences.

As this Codec is based on a subset of the JavaScript Programming Language, Standard ECMA-262 3rd Edition - December 1999. JSON is a text format that is completely language independent but uses conventions that are widely known to programmers of the C family of languages, including C, C++, C#, Java, JavaScript, Perl, Python, and many others. These properties make JSON an ideal language for data exchange. JSON is an open standard file format and data exchange format used between FMBXXX devices and AWS IoT Shadow Service: Its basic principles are:


  • AVL data will be uploaded to Amazon Web Services IOT Shadow service.
  • AVL data is JSON key value based


Data sending procedure and logic is same as sending to regular servers, except data is being packed to JSON document as required in Amazon Shadow service.

This codec is required to use in Amazon AWS console, it is important to note that AWS uses TLS encryption protocol, and it must be set up the FMBXXX device properly into the AWS IoT service.

  Since the 03.28.00. Rev.00Italic text AWS JSON codec is supported.


AWS Shadow
AWS shadow allows to retain device state, this service reports only latest Shadow state data. Using this mode does not allow to send commands to device or receive responses.

When using this mode JSON format must be enabled, otherwise data sending will not begin. Using this service device uses x509 certificates to authenticate. No other method is possible. https://docs.aws.amazon.com/iot/latest/developerguide/x509-client-certs.html

Doc: https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html


AWS Custom

This mode allows to configure custom topic names, where data will be published and commands received. When using this mode all Codec protocols are supported (Codec8, Codec8ext, Codec JSON). Authentication is same as AWS Shadow.

Codec JSON.png

Codec JSON is available as a transmission codec now (since the fw 03.27.05.Rev.250), this parameter can be selected in the Teltonika’s Configurator>> System>> System Settings>> Data Protocol>> and selecting Codec JSON

MQTT Server.png

Additionally, to develop the fully configuration in the teltonika device, make sure to use the MQTT protocol, this can be done in the Teltonika’s configurator>>GPRS Server Settings>> and in protocol selecting MQTT.

It is important to note that the communication to the AWS IoT Service uses a TLS certificate to authenticate, please follow this link where is explained how to obtain it: [[1]]


Codec JSON Structure

JSON format: {

 "reported": { - object as per AWS shadow documentation
   "tcxn": {
     "connection_status": 2
   },			- Current state of device
   "ts": 1510641143000,  - timestamp then record was generated
   "pr": 0, - record priority
   "lnglat": "0.000000,0.000000", - longitude latitude
   "alt": 0, - altitude
   "ang": 0, - angle
   "sat": 0, - num of visible satellites
   "sp": 0, - speed
   "evt": 0, - IO which generated event
   "21": 3, - „AVL_ID“:value
   "24": 0,
   "66": 13909,
   "67": 0,
   "68": 0,
   "69": 2,
   "80": 0,
   "181": 0,
   "182": 0,
   "200": 0,
   "239": 1,
   "240": 0
 }

}

Sending commands from AWS to device Any SMS command, which is interpretable by the device‘s firmware, can be used to control the device that was setup in AWS. SMS/GPRS commands:

https://wiki.teltonika-gps.com/view/FMB_SMS/GPRS_Commands


The structure for the JSON goes like this:

{ "CMD": "<SMS_Command> <Input>" }


An example for using the setdigout command:

{ "CMD": "setdigout 111" }