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

Revision as of 11:52, 3 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

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

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

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

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

SocketClose

	SocketClose
Close the socket
- VOID	Return

AcceptOpen

	AcceptOpen

- BYTE	Return

AcceptClose

	AcceptClose
Close the accept socket
- VOID	Return

Initialise

	Initialise
Initialises the TCP/IP component
- VOID	Return

Property reference

	Properties
	Label

@@ Line 48: / Line 48: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 53: / Line 55: @@
 ==Macro reference==
+===Connect===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 76: / Line 79: @@
+===Receive===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 99: / Line 103: @@
+===Send===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 122: / Line 127: @@
+===Listen===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 140: / Line 146: @@
+===SocketOpen===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 158: / Line 165: @@
+===SocketClose===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 171: / Line 179: @@
+===AcceptOpen===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 184: / Line 193: @@
+===AcceptClose===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 197: / Line 207: @@
+===Initialise===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-