Component: USB Serial (Comms: USB) - Revision history

Wiki bot at 13:13, 7 February 2023

2023-02-07T13:13:23Z

Wiki bot at 12:22, 3 February 2023

2023-02-03T12:22:26Z

Wiki bot at 12:03, 3 February 2023

2023-02-03T12:03:40Z

Wiki bot at 11:52, 3 February 2023

2023-02-03T11:52:54Z

Wiki bot at 16:50, 30 January 2023

2023-01-30T16:50:45Z

Show changes

Wiki bot at 10:00, 27 January 2023

2023-01-27T10:00:36Z

Show changes

Wiki bot at 15:25, 20 January 2023

2023-01-20T15:25:12Z

Show changes

Wiki bot at 15:17, 20 January 2023

2023-01-20T15:17:38Z

Show changes

Wiki bot at 14:13, 20 January 2023

2023-01-20T14:13:54Z

Wiki bot at 14:43, 16 January 2023

2023-01-16T14:43:29Z

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/USBSerial.fcfx FC_Comp_Source_temp/USBSerial.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_USBSerial.fcfx FC_Comp_Source_USBSerial.fcfx]
-Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/USBSerial.fcfx FC_Comp_Source_temp/USBSerial.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_USBSerial.fcfx FC_Comp_Source_USBSerial.fcfx]
 ==Detailed description==
@@ Line 104: / Line 104: @@
 [[File:SerialComms.jpg]]

@@ Line 104: / Line 104: @@
 [[File:SerialComms.jpg]]
@@ Line 249: / Line 251: @@
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_USBSerial.fcfx FC_Comp_Source_USBSerial.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/USBSerial.fcfx FC_Comp_Source_temp/USBSerial.fcfx]
-Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_USBSerial.fcfx FC_Comp_Source_USBSerial.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/USBSerial.fcfx FC_Comp_Source_temp/USBSerial.fcfx]
 ==Detailed description==
@@ Line 104: / Line 104: @@
 [[File:SerialComms.jpg]]
@@ Line 111: / Line 113: @@
 ==Macro reference==
-===SendString===
+===Initialise===
 {| 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;" | '''SendString'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 |-
-| colspan="2" | Sends the specified data string to the host&nbsp;
+| colspan="2" | Starts up the USB communications and attempts to enumerate. Returns 0 for a successful startup or 255 for a enumeration timeout.&nbsp;
 |-
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
@@ Line 130: / Line 127: @@
-===SendNumber===
+===ReadByte===
 {| 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;" | '''SendNumber'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadByte'''
 |-
-| colspan="2" | Sends the specified numeric value as an ASCII string to the host.&nbsp;
+| colspan="2" | Retreives the byte from the incoming data buffer. If data is available then the macro will return straight away. If there is no data available then the macro waits up the the period specified by the timeout before returning the value 255.&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Number
+| width="90%" | Timeout_ms
 |-
-| colspan="2" | Range -32768 to 32767&nbsp;
+| colspan="2" | Number of milliseconds to wait before timing out&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| 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''
 |}
@@ Line 216: / Line 213: @@
-===ReadByte===
+===SendNumber===
 {| 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;" | '''ReadByte'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SendNumber'''
 |-
-| colspan="2" | Retreives the byte from the incoming data buffer. If data is available then the macro will return straight away. If there is no data available then the macro waits up the the period specified by the timeout before returning the value 255.&nbsp;
+| colspan="2" | Sends the specified numeric value as an ASCII string to the host.&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
-| width="90%" | Timeout_ms
+| width="90%" | Number
 |-
-| colspan="2" | Number of milliseconds to wait before timing out&nbsp;
+| colspan="2" | Range -32768 to 32767&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===Initialise===
+===SendString===
 {| 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;" | '''Initialise'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SendString'''
 |-
-| colspan="2" | Starts up the USB communications and attempts to enumerate. Returns 0 for a successful startup or 255 for a enumeration timeout.&nbsp;
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 |-
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE

@@ Line 104: / Line 104: @@
 [[File:SerialComms.jpg]]
@@ Line 109: / Line 111: @@
 ==Macro reference==
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 127: / Line 130: @@
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 145: / Line 149: @@
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 168: / Line 173: @@
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 186: / Line 192: @@
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 209: / Line 216: @@
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 227: / Line 235: @@
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-

@@ Line 20: / Line 20: @@
 ==Detailed description==
@@ Line 38: / Line 40: @@
 ==Examples==
@@ Line 83: / Line 87: @@
 [[File:SerialComms.jpg]]
-==Downloadable macro reference==
+==Macro reference==
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"

← Older revision		Revision as of 14:43, 16 January 2023
Line 20:		Line 20:

	==Detailed description==		==Detailed description==
		+
		+


Line 36:		Line 38:

	==Examples==		==Examples==
		+
		+