Component: Network Communications (Comms: Networking)

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

Here are some examples showing the Network Communications component in action.

By itself the component provides a generic TCP/IP layer to drive the simulation runtime.

Here is a simple example showing the component used by itself to request data from a remote server on the internet.

Example Network Comms Client

Library Components

Components such as Webserver (GENERIC), MQTT and Modbus TCP can connect to and control the network comms layer.

Here is a simple example showing the component used with the Webserver (GENERIC) component.

Example Network Comms Web Server

Embedded Components

The Network Communications component can also be connected to embedded TCP/IP and WIFI style modules allowing for the abstraction to work with specific networking hardware modules.

Here is the current status of the Network Communications component with the various embedded modules.

Embedded Component	Other Variants of Component	Support Status
TCP/IP (Raspberry Pi)	N/A	Fully Supported
WLAN (ESP8266)	WLAN (ESP-12S), WIFI (BL0136), WIFI (ESP8266)	Fully Supported
TCP/IP (W5500)	N/A	Fully Supported
ENC28J60	N/A	On Hold
TCP/IP (NM7010A)	TCP/IP (EB023v1)	On Hold
TCP/IP (W5100)	TCP/IP (EB023v2), TCP/IP (WIZ810MJ)	On Hold
WLAN (WIZ610WI)	WIFI (EB069)	On Hold

We are working through and adding support as and when we get chance so if you have a module that isn't listed or would like to try and prioritise a specific module then you can let us know via the user forums.

Downloadable macro reference

	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.
[[File:]] -	Return

	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
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

	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.
[[File:]] -	Return

	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
[[File:]] -	Return

	SocketClose
Closes the current socket connection
- VOID	Return

	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

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

	Initialise
Initialises the network communications component.
- VOID	Return

	ReadDigitalInputs
Reads the state of a single digital input. Can pack a max of 8-bits together in a single operation
- UINT	StartAddress
Coil Address Range 0 to (NumCoils - 1)
- BYTE	AddressCount
Range 1-8
- BYTE	Return

	SetAnalogInput
Sets the state of a single analogue input.
- UINT	Address
Coil Address
- UINT	Value
Analogue Value range 0 - 65535
- VOID	Return

	Initialise
Starts up the UART to allow communications and initialises the states of the various Modbus Coils, Inputs and Registers to 0. Returns 1 if USB is started ok.
[[File:]] -	Return

	SetAnalogInput
Sets the state of a single analogue input.
- UINT	Address
Coil Address
- UINT	Value
Analogue Value range 0 - 65535
- VOID	Return

	Initialise
Starts up the UART to allow communications and initialises the states of the various Modbus Coils, Inputs and Registers to 0.
- VOID	Return

	Initialise
Initialises the MIDI component and sets up the UART.
- VOID	Return

	CommsBaud
Sets the Baud rate of the alt communications channel
- BYTE	Baud
Range: 0-7 : 0=1200 / 7=115200
- VOID	Return

	LCDOptions
Controls some of the LCD options
- BYTE	Foreground
Range: 0-1
- BYTE	Background
Range: 0-1
- BYTE	Transparent
Range: 0-1
- VOID	Return

	LCDVerbose
Controls the Verbose mode. When enabled the LCD automatically displays an account of the incoming API commands and parameters. When switched off the LCD is free for the user to control as required.
- BYTE	Mode
Range: 0-1 : 0=Off or User Mode / 1=API Verbose Mode
- VOID	Return

	ReadDigitalInput
Reads a single digital input.
- BYTE	Channel
- BYTE	Return

	PWMConfig
Sets the PWM configuration. Channel = 0 - 1 : 0 = EN_AB, A, B / 1 = EN_CD, C, D Period = 0 - 65535 Scaler = 0 - 3 : 0=1:1 1=1:8 2=1:64 3=1:256
- BYTE	Channel
Range 0-1
- UINT	Period
Range: 0-65535
- BYTE	Scaler
Range: 0-3
- VOID	Return

	PWMEnable
Allows pulse width modulated transistor outputs to be switched on or off. Bit 0 = Enable AB Bit 1 = A / Bit 2 = B Bit 3 = C / Bit 4 = D Bit 5 = Enable CD
- BYTE	EnableMask
Range 0-63 or 0b00000 to 0b111111
- VOID	Return

	PWMDuty
Sets a single PWM channel duty. Channel = 0 - 5 : 0=EN_AB, 1=A, 2=B, 3=C, 4=D, 5=EN_CD Duty = 0 - 65535
- BYTE	Channel
Range 0-5
- UINT	Duty
- VOID	Return

	LCDCursor
Sets the cursor position for the MIAC display
- BYTE	X
Range: 0-21
- BYTE	Y
Range: 0-4
- VOID	Return

	WriteTran
Allows a single transistor output to be switched on or off.
- BYTE	Channel
Range 1-4
- BYTE	Value
0 = Off, 1 = On
- VOID	Return

	Initialise
- VOID	Return

	LCDClear
Clears the MIAC display
- VOID	Return

Property reference

	Properties
	TCP/IP Component
Property to point to the TCP/IP or WIFI component you want to use. If unconnected then default to simulated TCP/IP network communications using the PC network adapter.
	Status
	Connections
	Simulations
	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.