Codec JSON - Revision history

Tomas.kriauciunas at 09:59, 10 February 2023

2023-02-10T09:59:15Z

← Older revision		Revision as of 12:59, 10 February 2023
Line 1:		Line 1:
	===Codec JSON Description===		==='''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.

Tomas.kriauciunas at 09:58, 10 February 2023

2023-02-10T09:58:40Z

← Older revision		Revision as of 12:58, 10 February 2023
Line 48:		Line 48:

	'''Note.''' communication to the AWS IoT Service uses a TLS certificate to authenticate, please follow this link where is explained how to obtain it:		'''Note.''' communication to the AWS IoT Service uses a TLS certificate to authenticate, please follow this link where is explained how to obtain it:
	MQTT Start with our devices
			[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'''===

Tomas.kriauciunas at 09:58, 10 February 2023

2023-02-10T09:58:09Z

← Older revision		Revision as of 12:58, 10 February 2023
Line 48:		Line 48:

	'''Note.''' communication to the AWS IoT Service uses a TLS certificate to authenticate, please follow this link where is explained how to obtain it:		'''Note.''' communication to the AWS IoT Service uses a TLS certificate to authenticate, please follow this link where is explained how to obtain it:
			MQTT Start with our devices
	~~[[https://wiki.teltonika-gps.com/view/Getting_Started_with_AWS_IoT_Core#Provision_the_Device_with_credentials]]~~

	==='''Codec JSON Structure'''===		==='''Codec JSON Structure'''===

Tomas.kriauciunas: /* Sending commands from AWS to device */

2023-02-10T09:56:26Z

Sending commands from AWS to device

← Older revision		Revision as of 12:56, 10 February 2023
Line 77:		Line 77:
	"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>
Line 87:		Line 87:
	'''{ "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" }'''

Tomas.kriauciunas: /* AWS Custom */

2023-02-10T09:54:41Z

AWS Custom

← Older revision		Revision as of 12:54, 10 February 2023
Line 22:		Line 22:

	==='''AWS Shadow'''===		==='''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

	~~When using this mode JSON format must be enabled, otherwise, data sending will not begin.~~		==='''AWS Custom'''===
	~~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<br><br>~~		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~~'''~~===~~		Full Codec description can be found [[Codec#Codec 8\|'''here''']].

	~~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, Codec8ext, Codec JSON).~~
	Authentication is the same as AWS Shadow.		Authentication is the same as AWS Shadow.

Line 38:		Line 37:


	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.'''''

	~~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:		'''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]]		[[https://wiki.teltonika-gps.com/view/Getting_Started_with_AWS_IoT_Core#Provision_the_Device_with_credentials]]

Tomas.kriauciunas at 09:47, 10 February 2023

2023-02-10T09:47:36Z

← Older revision		Revision as of 12:47, 10 February 2023
Line 10:		Line 10:
	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>
Line 46:		Line 46:
	[[https://wiki.teltonika-gps.com/view/Getting_Started_with_AWS_IoT_Core#Provision_the_Device_with_credentials]]		[[https://wiki.teltonika-gps.com/view/Getting_Started_with_AWS_IoT_Core#Provision_the_Device_with_credentials]]

	'''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": {

Tomas.kriauciunas at 09:40, 10 February 2023

2023-02-10T09:40:12Z

← Older revision		Revision as of 12:40, 10 February 2023
Line 21:		Line 21:
	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>

Line 29:		Line 29:
	Doc: https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html<br><br>		Doc: https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html<br><br>

	'''AWS Custom'''~~<br>~~		==='''AWS Custom'''===

	This mode allows configuring custom topic names, where data will be published and commands received.		This mode allows configuring custom topic names, where data will be published and commands received.

Tomas.kriauciunas at 09:39, 10 February 2023

2023-02-10T09:39:14Z

← Older revision		Revision as of 12:39, 10 February 2023
Line 1:		Line 1:
	===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.

Tomas.kriauciunas at 09:33, 10 February 2023

2023-02-10T09:33:54Z

← Older revision		Revision as of 12:33, 10 February 2023
Line 5:		Line 5:

	JSON is made up of two structures:		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 associative array.<br>		* A collection of name/value pairs. In various languages, this is known as an object, record, structure, dictionary, hash table, key list, or associative array.<br>
			* An ordered list of values. In most languages, this is implemented as arrays, vectors, lists, or sequences.<br>

	* An ordered list of values. In most languages, this is implemented as arrays, vectors, lists, or sequences.<br><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>
	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:<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>


	Data sending procedure and logic are the same as sending to regular servers, except data is being packed to JSON document as required in Amazon Shadow service.<br>		Data sending procedure and logic are the same as sending to regular servers, except data is being packed to JSON document as required in Amazon Shadow service.<br>
Line 24:		Line 19:
	This codec is required to use in the 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.<br>		This codec is required to use in the 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.<br>

			Since the firmware version '''03.28.00. Rev.00''' AWS JSON codec is supported.<br><br>
	Since the '''03.28.00. Rev.00'~~''''Italic text~~'' AWS JSON codec is supported.<br><br>

	'''AWS Shadow'''<br>		'''AWS Shadow'''<br>
Line 78:		Line 72:
	"240": 0		"240": 0
	} }		} }
	'''Sending commands from AWS to device'''		==='''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.		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:		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 <br>

			The structure for the JSON:<br>
	The structure for the JSON ~~goes like this~~:<br>

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


	An example for using the setdigout command:<br>		An example for using the setdigout command:<br>

	'''{ "CMD": "setdigout 111" }'''		'''{ "CMD": "setdigout 111" }'''

Tomas.kriauciunas at 09:30, 10 February 2023

2023-02-10T09:30:46Z

← Older revision		Revision as of 12:30, 10 February 2023
Line 1:		Line 1:
	~~'''~~Codec JSON~~'''~~		===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 (JavaScript Object Notation) is a light data exchange format, that due to its simplicity to be written and fast interpretation and generation for machines.
	<br><br>		<br><br>

	JSON is made up of two structures:		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.<br>		* A collection of name/value pairs. In various languages, this is known as an object, record, structure, dictionary, hash table, key list, or associative array.<br>

	* An ordered list of values. In most languages, this is implemented as arrays, vectors, lists, or sequences.<br><br>		* An ordered list of values. In most languages, this is implemented as arrays, vectors, lists, or sequences.<br><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.		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:		JSON is an open standard file format and data exchange format used between FMBXXX devices and AWS IoT Shadow Service:
	Its basic principles are:<br>		Its basic principles are:<br>
Line 17:		Line 17:
	* 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>


	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.<br>		Data sending procedure and logic are the same as sending to regular servers, except data is being packed to JSON document as required in Amazon Shadow service.<br>

	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.<br>		This codec is required to use in the 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.<br>


	Since the '''03.28.00. Rev.00'''''Italic text'' AWS JSON codec is supported.<br><br>		Since the '''03.28.00. Rev.00'''''Italic text'' AWS JSON codec is supported.<br><br>


	'''AWS Shadow'''<br>		'''AWS Shadow'''<br>
	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.<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.		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>		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<br><br>		Doc: https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html<br><br>


	'''AWS Custom'''<br>		'''AWS Custom'''<br>

	This mode allows ~~to configure~~ custom topic names, where data will be published and commands received.		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, Codec8ext, Codec JSON).		When using this mode all Codec protocols are supported (Codec8, Codec8ext, Codec JSON).
	Authentication is same as AWS Shadow.		Authentication is the same as AWS Shadow.

	[[File:Codec JSON.png\|center\|frameless\|222x222px]]		[[File:Codec JSON.png\|center\|frameless\|222x222px]]
Line 49:		Line 47:
	[[File:MQTT Server.png\|center\|frameless\|300x300px]]		[[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 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.'''''

	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:		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: