Component: JSON Decoder (Comms: IoT/Cloud) - Revision history

Wiki bot at 09:56, 2 December 2024

2024-12-02T09:56:38Z

BenR at 17:05, 27 November 2023

2023-11-27T17:05:49Z

Wiki bot at 11:53, 8 November 2023

2023-11-08T11:53:27Z

BenR: /* Examples */

2023-11-03T12:19:02Z

Examples

BenR at 12:16, 3 November 2023

2023-11-03T12:16:51Z

Wiki bot: Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix TSL |- | width="20%" style="color:gray;" | Version | 1.0 |- | width="20%" style="color:gray..."

2023-11-03T11:57:24Z

Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix TSL |- | width="20%" style="color:gray;" | Version | 1.0 |- | width="20%" style="color:gray..."

New page

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix TSL
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| Comms: IoT/Cloud
|}

==JSON Decoder component==
Allows dynamic key and value pairs to be collected from a formatted JSON string.

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_JSONDecoder.fcfx FC_Comp_Source_JSONDecoder.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_JSONDecoder.fcfx FC_Comp_Source_JSONDecoder.fcfx]

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''<span style="color:red;">No additional examples</span>''

==Macro reference==

===FindName===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FindName'''
|-
| colspan="2" | Searches for a name in the JSON data. Returns the data index position. Returns -1 if the name was not found. 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Name
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | SkipCount
|-
| colspan="2" | Number of matches to skip before returning. 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ParseJSON===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ParseJSON'''
|-
| colspan="2" | Accepts a JSON formatted data string and stores locally in the data buffer ready for parsing. Returns the estimated number of name and data keys present. 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Data
|-
| colspan="2" | JSON data string to parse 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadDataAsFloat===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadDataAsFloat'''
|-
| colspan="2" | Reads the data of a specific element as a floating point value 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Element
|-
| colspan="2" | Index of the element to read 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadDataAsNumber===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadDataAsNumber'''
|-
| colspan="2" | Reads the data of a specific element as a numeric integer value 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Element
|-
| colspan="2" | Index of the element to read 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadDataAsString===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadDataAsString'''
|-
| colspan="2" | Reads the data of a specific element as a string value 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Element
|-
| colspan="2" | Index of the element to read 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadName===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadName'''
|-
| colspan="2" | Reads the name of a specific element 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Element
|-
| colspan="2" | The Index of the element to read 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Data Bytes
|-
| colspan="2" | Number of bytes used to store the entire data for the JSON message. Includes names and data values so make sure this is large enough to store everything you want to be able to put into a single JSON data string. 
|}

@@ Line 5: / Line 5: @@
 |-
 | width="20%" style="color:gray;" | Version
-| 1.0
+| 1.1
 |-
 | width="20%" style="color:gray;" | Category
@@ Line 15: / Line 15: @@
 Allows dynamic key and value pairs to be collected from a formatted JSON string.
-==Component Source Code==
+==Version information==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_JSONDecoder.fcfx FC_Comp_Source_JSONDecoder.fcfx]
+ Library Version, Component Version, Date, Author, Info
+, 1.1, 10-10-24, BR, Allowed for better support of nested array data
-Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_JSONDecoder.fcfx FC_Comp_Source_JSONDecoder.fcfx]
+, 1.1, 10-10-24, BR, Removed spaces and new lines etc from the stored data
 ==Detailed description==
@@ Line 176: / Line 177: @@
 | colspan="2" | Number of bytes used to store the entire data for the JSON message. Includes names and data values so make sure this is large enough to store everything you want to be able to put into a single JSON data string.&nbsp;
 |}

@@ Line 26: / Line 26: @@
 ==Examples==
 Example program showing how to take data and encode it into a JSON string to be sent out over comms.
@@ Line 32: / Line 40: @@
 {{Fcfile|JSON_Demo.fcfx|JSON_Demo}}

← Older revision		Revision as of 11:53, 8 November 2023
Line 32:		Line 32:

	{{Fcfile\|JSON_Demo.fcfx\|JSON_Demo}}		{{Fcfile\|JSON_Demo.fcfx\|JSON_Demo}}
		+
		+

	==Macro reference==		==Macro reference==

← Older revision		Revision as of 12:19, 3 November 2023
Line 27:		Line 27:
	==Examples==		==Examples==

		+	Example program showing how to take data and encode it into a JSON string to be sent out over comms.

		+	The example also hows how to decode a received JSON string and pull out values.
		+
		+	{{Fcfile\|JSON_Demo.fcfx\|JSON_Demo}}

	==Macro reference==		==Macro reference==