Difference between revisions of "Component: TCP/IP (Raspberry Pi) (Comms: Networking)"

Latest revision as of 13:13, 7 February 2023

Author	Matrix Ltd.
Version	1.9
Category	Comms: Networking

TCP/IP (Raspberry Pi) component

TCP/IP sockets component for use with Raspberry Pi. Raspberry Pi Only

Component Source Code

Please click here to download the component source project: FC_Comp_Source_TCPIP_RPI.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_TCPIP_RPI.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

AcceptClose

	AcceptClose
Close the accept socket
- VOID	Return

AcceptOpen

	AcceptOpen

- BYTE	Return

Connect

	Connect
Attempt to connect to the given address and port. First open a socket on the local device using the Socket function and check that it is successful.
- STRING	Address
Remote destination address
- UINT	Port
Remote destination port
- BYTE	Return

Initialise

	Initialise
Initialises the TCP/IP component
- VOID	Return

Listen

	Listen
Bind the socket to a port on the local host and set to listen mode. First open a socket on the local device using the Socket function and check that it is successful.
- UINT	Port

- BYTE	Return

Receive

	Receive
Receive data into the data buffer. Returns the number of bytes received
- STRING	Data
Data byte buffer to receive the data
- UINT	Count
Maximum number of bytes to read
- UINT	Return

Send

	Send
Send data
- STRING	Data
Data byte buffer to send
- UINT	Count
Number of bytes to send
- UINT	Return

SocketClose

	SocketClose
Close the socket
- VOID	Return

SocketOpen

	SocketOpen
Attempts to create a socket on the local device. Type =0 for TCP, =1 for UDP This must be successfully done before attempting connection with a remote destination. Returns 1 if successful, 0 if not.
- BYTE	Type
Type of socket to create
- BYTE	Return

Property reference

	Properties
	Label

@@ Line 48: / Line 48: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 55: / Line 61: @@
 ==Macro reference==
-===Connect===
+===AcceptClose===
 {| 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;" | '''Connect'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AcceptClose'''
 |-
-| colspan="2" | Attempt to connect to the given address and port. First open a socket on the local device using the Socket function and check that it is successful. &nbsp;
+| colspan="2" | Close the accept socket&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" | Address
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===AcceptOpen===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
-| colspan="2" | Remote destination address&nbsp;
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AcceptOpen'''
 |-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| colspan="2" | &nbsp;
-| width="90%" | Port
 |-
-| colspan="2" | Remote destination port&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
@@ Line 79: / Line 89: @@
-===Receive===
+===Connect===
 {| 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;" | '''Receive'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connect'''
 |-
-| colspan="2" | Receive data into the data buffer. Returns the number of bytes received&nbsp;
+| colspan="2" | Attempt to connect to the given address and port. First open a socket on the local device using the Socket function and check that it is successful. &nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-| width="90%" | Data
+| width="90%" | Address
 |-
-| colspan="2" | Data byte buffer to receive the data&nbsp;
+| colspan="2" | Remote destination address&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | Count
+| width="90%" | Port
 |-
-| colspan="2" | Maximum number of bytes to read&nbsp;
+| colspan="2" | Remote destination port&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''
 |}
-===Send===
+===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;" | '''Send'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 |-
-| colspan="2" | Send data&nbsp;
+| colspan="2" | Initialises the TCP/IP component&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" | Data
-|-
-| colspan="2" | Data byte buffer to send&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | Count
-|-
-| colspan="2" | Number of bytes to send&nbsp;
-|-
-| 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 146: / Line 146: @@
-===SocketOpen===
+===Receive===
 {| 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;" | '''SocketOpen'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Receive'''
+|-
+| colspan="2" | Receive data into the data buffer. Returns the number of bytes received&nbsp;
+|-
 |-
-| colspan="2" | Attempts to create a socket on the local device. Type =0 for TCP, =1 for UDP This must be successfully done before attempting connection with a remote destination. Returns 1 if successful, 0 if not.&nbsp;
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Data
 |-
+| colspan="2" | Data byte buffer to receive the data&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | Type
+| width="90%" | Count
 |-
-| colspan="2" | Type of socket to create&nbsp;
+| colspan="2" | Maximum number of bytes to read&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''
 |}
-===SocketClose===
+===Send===
 {| 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;" | '''SocketClose'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Send'''
 |-
-| colspan="2" | Close the socket&nbsp;
+| colspan="2" | Send data&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
+| width="90%" | Data
-|}
-===AcceptOpen===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| colspan="2" | Data byte buffer to send&nbsp;
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AcceptOpen'''
 |-
-| colspan="2" | &nbsp;
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | Count
 |-
+| colspan="2" | Number of bytes to send&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''
 |}
-===AcceptClose===
+===SocketClose===
 {| 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;" | '''AcceptClose'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SocketClose'''
 |-
-| colspan="2" | Close the accept socket&nbsp;
+| colspan="2" | Close the socket&nbsp;
 |-
 |-
@@ Line 207: / Line 208: @@
-===Initialise===
+===SocketOpen===
 {| 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;" | '''SocketOpen'''
+|-
+| colspan="2" | Attempts to create a socket on the local device. Type =0 for TCP, =1 for UDP This must be successfully done before attempting connection with a remote destination. Returns 1 if successful, 0 if not.&nbsp;
+|-
 |-
-| colspan="2" | Initialises the TCP/IP component&nbsp;
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Type
 |-
+| colspan="2" | Type of socket to create&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| 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''
 |}