Component: Network Communications (Comms: Networking): Difference between revisions

Revision as of 14:23, 13 July 2026

Author	Matrix TSL
Version	1.5
Category	Comms: Networking

Network Communications component

A component designed to simplify the process of TCP/IP communications. Compatible with most of the Flowcode supported TCP/IP and WIFI components. A useful building block for creating components such as IoT and Modbus TCP.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

AcceptClose

	AcceptClose
Goes with the AcceptOpen function to close the new thread handle.
- VOID	Return

AcceptOpen

	AcceptOpen
Required for systems where there can be multiple incoming threads Returns 1 if there is incoming comms requiring a new thread, else returns 0
- BYTE	Return

Connect

	Connect
Connects to an IP address as a client on the specified port. Some TCP/IP modules (RPI and ESP8266) will accept a URL instead of an IP address. Returns: 0=Fail, 1=OK
- STRING	Address
IP address as a string e.g. "192.168.1.1" or URL on some TCP/IP modules
- UINT	Port
Port number to connect to.
- BOOL	Return

Initialise

	Initialise
Initialises the network communications 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 host Returns: 0=Fail, 1=OK
- UINT	Port
Port number to listen on.
- BOOL	Return

Receive

	Receive
Attempts to receive up to a specified number of bytes from the active connection. Returns the number of bytes received.
- STRING	Data
Data Array to store the data into.
- UINT	Count
Maximum number of bytes to read
- UINT	Timeout
Maximum time to wait in mS (approx)
- UINT	Return

Send

	Send
Sends the specified number of bytes via the active connection. Returns the number of bytes sent, 0=Fail.
- STRING	Data
Array containing the data to send
- UINT	Count
Number of bytes to send from the data array
- UINT	Return

SocketClose

	SocketClose
Closes the current socket connection
- VOID	Return

SocketOpen

	SocketOpen
Attempts to create a socket on the local device. This must be succesful to allow TCP/IP communications with a remote destination. Returns: 0=Fail / 1=OK
- BOOL	Return

Property reference

	Properties
	LinkTo

	TCP IP Channel
Allows for several parallel TCP/IP communications channels to be active at once by selecting unique TCP IP channels for each Network Comms component. Default 0.
	Status

	Simulation
	Simulation Control
Allows the user to decide what happens when simulating. Simulation DLL forces all simulated TCP/IP comms to go directly via the simulation DLL bypassing any additional components. Component simulation forces the attached component to provide the simulation and maybe other aspects such as SPI/I2C communications.
	Network Interface
Some computers may have several network interfaces such as ethernet ports and wifi access. Select the correct network interface for the network you wish to connect to. Use the IP address to confirm you are connected to the right network.
	IP Address
IP Address of the selected network interface.

Component Source Code

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

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

@@ Line 59: / Line 59: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AcceptClose'''
+| width="90%" class="mtx-class-macrohead" | '''AcceptClose'''
 |-
 | colspan="2" | Goes with the AcceptOpen function to close the new thread handle.&nbsp;
@@ Line 73: / Line 73: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AcceptOpen'''
+| width="90%" class="mtx-class-macrohead" | '''AcceptOpen'''
 |-
 | colspan="2" | Required for systems where there can be multiple incoming threads Returns 1 if there is incoming comms requiring a new thread, else returns 0&nbsp;
@@ Line 87: / Line 87: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connect'''
+| width="90%" class="mtx-class-macrohead" | '''Connect'''
 |-
 | colspan="2" | Connects to an IP address as a client on the specified port. Some TCP/IP modules (RPI and ESP8266) will accept a URL instead of an IP address. Returns: 0=Fail, 1=OK&nbsp;
@@ Line 111: / Line 111: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
+| width="90%" class="mtx-class-macrohead" | '''Initialise'''
 |-
 | colspan="2" | Initialises the network communications component.&nbsp;
@@ Line 125: / Line 125: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Listen'''
+| width="90%" class="mtx-class-macrohead" | '''Listen'''
 |-
 | colspan="2" | Bind the socket to a port on the local host and set to listen mode. First Open a Socket on the local host Returns: 0=Fail, 1=OK&nbsp;
@@ Line 144: / Line 144: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Receive'''
+| width="90%" class="mtx-class-macrohead" | '''Receive'''
 |-
 | colspan="2" | Attempts to receive up to a specified number of bytes from the active connection. Returns the number of bytes received.&nbsp;
@@ Line 173: / Line 173: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Send'''
+| width="90%" class="mtx-class-macrohead" | '''Send'''
 |-
 | colspan="2" | Sends the specified number of bytes via the active connection. Returns the number of bytes sent, 0=Fail.&nbsp;
@@ Line 197: / Line 197: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SocketClose'''
+| width="90%" class="mtx-class-macrohead" | '''SocketClose'''
 |-
 | colspan="2" | Closes the current socket connection&nbsp;
@@ Line 211: / Line 211: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SocketOpen'''
+| width="90%" class="mtx-class-macrohead" | '''SocketOpen'''
 |-
 | colspan="2" | Attempts to create a socket on the local device. This must be succesful to allow TCP/IP communications with a remote destination. Returns: 0=Fail / 1=OK&nbsp;
@@ Line 226: / Line 226: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |-

SteveT (talk | contribs)