2,410
edits
Changes
no edit summary
===Codec JSON===
==='''Codec JSON Description'''===
JSON (JavaScript Object Notation) is a light data exchange format, that due to its simplicity to be written and fast interpretation and generation for machines.
JSON (JavaScript Object Notation) is a light data exchange format, that due to its simplicity to be written and fast interpretation and generation for machines.
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.<br>
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.<br>
JSON is an open standard file format and data exchange format used between FMBXXX devices and AWS IoT Shadow Service:<br>
JSON is an open standard file format and data exchange format used between FMBXXX devices and AWS IoT Shadow Service:<br>
Its basic principles are:<br>
<br>
'''Its basic principles are:'''<br>
* AVL data will be uploaded to Amazon Web Services IOT Shadow service.<br>
* AVL data will be uploaded to Amazon Web Services IOT Shadow service.<br>
* AVL data is JSON key-value based<br><br>
* AVL data is JSON key-value based<br><br>
Since the firmware version '''03.28.00. Rev.00''' AWS JSON codec is supported.<br><br>
Since the firmware version '''03.28.00. Rev.00''' AWS JSON codec is supported.<br><br>
'''AWS Shadow'''<br>
==='''AWS Shadow'''===
AWS shadow allows to retain device state, this service reports only the latest Shadow state data. Using this mode does not allow sending commands to device or receiving responses.<br>
AWS shadow allows to retain device state, this service reports only the latest Shadow state data. Using this mode does not allow sending commands to device or receiving responses.<br>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<br>Doc: https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html
==='''AWS Custom'''===
This mode allows configuring custom topic names, where data will be published and commands received.
When using this mode all Codec protocols are supported (Codec8, Codec8E (E-Extended), Codec JSON).
'''AWS Custom'''<br>
Full Codec description can be found [[Codec#Codec 8|'''here''']].
Authentication is the same as AWS Shadow.
Authentication is the same as AWS Shadow.
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, ''this parameter can be selected in:''
'''''Teltonika Configurator >> System >> System Settings >> Data Protocol >> and selecting Codec JSON'''<br>''
[[File:MQTT Server.png|center|frameless|300x300px]]
[[File:MQTT Server.png|center|frameless|300x300px]]
Additionally, to develop the full 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 full configuration in the Teltonika device, make sure to use the '''MQTT protocol'''.
This can be done in '''''Teltonika configurator >> GPRS Server Settings >> and in protocol selecting MQTT.'''''
'''Note.''' communication to the AWS IoT Service uses a TLS certificate to authenticate, please follow this link where is explained how to obtain it:
[https://wiki.teltonika-gps.com/view/Getting_Started_with_AWS_IoT_Core#Provision_the_Device_with_credentials '''MQTT Start with our devices''']
'''Codec JSON Structure'''
==='''Codec JSON Structure'''===
JSON format: { "reported": { - object as per AWS shadow documentation
JSON format: { "reported": { - object as per AWS shadow documentation
"tcxn": {
"tcxn": {
"240": 0
"240": 0
} }
} }
==='''Sending commands from AWS to device'''===
==='''Sending commands from AWS to the device'''===
Any SMS command, which is interpretable by the device‘s firmware, can be used to control the device that was setup in AWS.
Any SMS command, which is interpretable by the device‘s firmware, can be used to control the device that was set up in AWS.
SMS/GPRS commands:<br>
SMS/GPRS commands:<br>
https://wiki.teltonika-gps.com/view/FMB_SMS/GPRS_Commands <br>
[https://wiki.teltonika-gps.com/view/FMB_SMS/GPRS_Commands '''SMS commands List''']<br>
The structure for the JSON:<br>
The structure for the JSON:<br>
'''{ "CMD": "<SMS_Command> <Input>" }'''<br>
'''{ "CMD": "<SMS_Command> <Input>" }'''<br>
An example for using the setdigout command:<br>
An example of using the '''setdigout''' command:<br>
'''{ "CMD": "setdigout 111" }'''
'''{ "CMD": "setdigout 111" }'''
