BenR: XML import - Pre 8.0 release

2018-05-22T15:08:48Z

XML import - Pre 8.0 release

New page

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| Matrix TSL
|-
| width="20%" style="color: gray;" | Version
| 2.0 (Release)
|-
| width="20%" style="color: gray;" | Category
| E-blocks 1
|}

==[[File:Component Icon 35d02098_c871_49c0_b34d_a3f86d764886.png|Image]] TCPIP (EB023 v2) component==
TCP/IP component designed to work with the WIZ810MJ module from Wiznet,
as used on version 2 EB023 E-block and the MIAC Industrial Addon module.

==Examples==
''No additional examples''

==Downloadable macro reference==

===<tt>TxSendMyIP</tt>===
This macro fills the specified channel's transmit buffer with 4 bytes of data representing this Internet E-Block's IP address as specified in the component's property page.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

'''Return value'''

:''This call does not return a value''

===<tt>RxMatchMyIP</tt>===
This macro returns a non-zero value when the next 4 bytes of data in the specified channel's reception buffer are the same as the Internet E-block's IP address.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>RxMatch_4_Bytes</tt>===
This macro returns a non-zero value when the next 4 bytes of data in the specified channel's reception buffer are the same as those passed as parameters. There are similar functions that check for 2 bytes and 6 bytes.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

:[[Variable Types|BYTE]] ''Byte1''
::Specifies the value of the first byte

:[[Variable Types|BYTE]] ''Byte2''
::Specifies the value of the second byte

:[[Variable Types|BYTE]] ''Byte3''
::Specifies the value of the third byte

:[[Variable Types|BYTE]] ''Byte4''
::Specifies the value of the fourth byte

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>SetMyIP</tt>===
This macro sets up the Internet E-Block's own IP address. In most circumstances, this macro will not be required as the IP address setting in the component property page will remain constant throughout your application.

'''Parameters'''

:[[Variable Types|BYTE]] ''IP0''
::First Byte of IP address

:[[Variable Types|BYTE]] ''IP1''
::Second Byte of IP address

:[[Variable Types|BYTE]] ''IP2''
::Third Byte of IP address

:[[Variable Types|BYTE]] ''IP3''
::Fourth Byte of IP address

'''Return value'''

:''This call does not return a value''

===<tt>TxSendString</tt>===
This macro fills the specified channel's transmit buffer with data. It can fill the buffer with a string of information.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

:[[Variable Types|<- STRING]] ''Data''
::Data byte to append to Tx buffer.
::''This parameter may be returned back to the caller''

:[[Variable Types|BYTE]] ''Length''

'''Return value'''

:''This call does not return a value''

===<tt>RxReadHeader</tt>===
Once data in a particular channel has been received, the header will be filled with information about the received data. This macro will return the information in the header. The idx parameter specifies which byte of information in the header to read

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

:[[Variable Types|BYTE]] ''Idx''
::Specifies the byte index to return

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>RxSkipBytes</tt>===
Often when receiving data packets, it may be necessary to ignore large sections of the data. This can be achieved by reading each byte individually (and ignoring the returned data), but a better way is to use this Rx_skipbytes macro.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

:[[Variable Types|BYTE]] ''Count''
::Specifies how many bytes to skip

'''Return value'''

:''This call does not return a value''

===<tt>CreateIPSocket</tt>===
Note that sockets on up to 4 channels can be simultaneously opened and these channels are numbered 0 to 3. Note that sockets with different modes can be opened on different channels.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

:[[Variable Types|BYTE]] ''Protocol''
::Specifies which IP protocol to use

:[[Variable Types|BYTE]] ''Broadcast''
::Allows broadcast type packets to be sent and received

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>SetDestination</tt>===
This is used in IP and UDP modes to set the destination of the intended data transfer. The destination IP address needs to be set for both IP and UDP modes.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

:[[Variable Types|BYTE]] ''Dst_IP0''
::Specifies the first byte of an IP address

:[[Variable Types|BYTE]] ''Dst_IP1''
::Specifies the second byte of an IP address

:[[Variable Types|BYTE]] ''Dst_IP2''
::Specifies the third byte of an IP address

:[[Variable Types|BYTE]] ''Dst_IP3''
::Specifies the fourth byte of an IP address

:[[Variable Types|UINT]] ''Dst_Port''
::Destination Port

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>TxStart</tt>===
This macro indicates the start of data transmission for the specified buffer. In TCP mode, data transmission can only begin once the socket has become established. In other modes, data transmission can occur as soon as the socket has been opened.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

'''Return value'''

:''This call does not return a value''

===<tt>RxReadByte</tt>===
A call to this macro will return a byte of data in the reception buffer of the specified channel. It will also internally increment a pointer to that data so that the next call to 'Rx_readbyte' (or any other read function) will read the next byte

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>CreateUDPSocket</tt>===
This macro creates a socket for sending and receiving UDP data.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

:[[Variable Types|UINT]] ''Src_Port''
::Port Number

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>RxMatch_6_Bytes</tt>===
This macro returns a non-zero value when the next 6 bytes of data in the specified channel's reception buffer are the same as those passed as parameters. There are similar functions that check for 2 bytes and 4 bytes.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

:[[Variable Types|BYTE]] ''Byte1''
::Specifies the value of the first byte

:[[Variable Types|BYTE]] ''Byte2''
::Specifies the value of the second byte

:[[Variable Types|BYTE]] ''Byte3''
::Specifies the value of the third byte

:[[Variable Types|BYTE]] ''Byte4''
::Specifies the value of the fourth byte

:[[Variable Types|BYTE]] ''Byte5''
::Specifies the value of the fifth byte

:[[Variable Types|BYTE]] ''Byte6''
::Specifies the value of the sixth byte

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>RxMatch_2_Bytes</tt>===
This macro returns a non-zero value when the next 2 bytes of data in the specified channel's reception buffer are the same as those passed as parameters. There are similar functions that check for 4 bytes and 6 bytes.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

:[[Variable Types|BYTE]] ''Byte1''
::Specifies the value of the first byte

:[[Variable Types|BYTE]] ''Byte2''
::Specifies the value of the second byte

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>TxEnd</tt>===
Once the transmit buffer has been filled with data, call this macro to actually send the data.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

'''Return value'''

:''This call does not return a value''

===<tt>RxReadString</tt>===
A call to this macro will return a string of data in the reception buffer of the specified channel. It will also internally increment a pointer to that data so that the next call to 'Rx_readbyte' (or any other read function) will read the next byte

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

:[[Variable Types|BYTE]] ''Length''

'''Return value'''

:[[Variable Types|STRING]]

===<tt>CreateTCPSocket</tt>===
This macro creates a socket for sending and receiving TCP data.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

:[[Variable Types|UINT]] ''Src_Port''
::Port Number

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>RxDataAvailable</tt>===
This macro is used to check whether or not data has been received by the Internet E-Block. A return value of zero indicated that no data has been received. A positive return value indicates that data is available.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>TxSendByte</tt>===
This macro fills the specified channel's transmit buffer with data. It can fill the buffer with a single byte of data, or with a string of information.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

:[[Variable Types|BYTE]] ''Data''
::Data byte to append to Tx buffer.

'''Return value'''

:''This call does not return a value''

===<tt>TCPListen</tt>===
This macro puts a previously opened TCP channel in "passive open" mode. This is the required mode when writing a TCP server application (e.g. a web server to display HTML web pages).

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

'''Return value'''

:''This call does not return a value''

===<tt>RxFlushData</tt>===
Once data reception has been completed, this macro should be called to discard the data packet and allow other data packets to be read.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

'''Return value'''

:''This call does not return a value''

===<tt>TCPConnect</tt>===
This macro puts a previously opened TCP channel in "active open" mode. This is the required mode when writing a TCP client application (e.g. using SMTP to send an email).

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

:[[Variable Types|BYTE]] ''Dst_IP0''
::First Byte of IP address

:[[Variable Types|BYTE]] ''Dst_IP1''
::Second Byte of IP address

:[[Variable Types|BYTE]] ''Dst_IP2''
::Third Byte of IP address

:[[Variable Types|BYTE]] ''Dst_IP3''
::Fourth Byte of IP address

:[[Variable Types|UINT]] ''Dst_Port''
::Destination Port

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>RxMatchMyMAC</tt>===
This macro returns a non-zero value when the next 6 bytes of data in the specified channel's reception buffer are the same as the Internet E-block's MAC address entered in the component's property page.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>RxDataSize</tt>===
This macro is used to detect the size of data collected by the Rx_data_available macro.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

'''Return value'''

:[[Variable Types|UINT]]

===<tt>CreateMACSocket</tt>===
This macro creates a socket for sending and receiving Ethernet data using raw data.

'''Parameters'''

:[[Variable Types|BYTE]] ''Promiscuous''
::Receive everything (1) or just data bound for your MAC (0)

:[[Variable Types|BYTE]] ''Broadcast''
::Allows broadcast messages to be accepted (1) or rejected (0)

:[[Variable Types|BYTE]] ''Error''
::Allowsmessages with errors to be accepted (1) or rejected (0)

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>TxSendMyMAC</tt>===
This macro fills the specified channel's transmit buffer with 6 bytes of data representing this Internet E-Block's MAC address as specified in the component's property page.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

'''Return value'''

:''This call does not return a value''

===<tt>SetMACAddress</tt>===
This macro sets up the Internet E-Block's MAC address. In most circumstances, this macro will not be required as the MAC address setting in the component property page will remain constant throughout your application.

'''Parameters'''

:[[Variable Types|BYTE]] ''MAC0''
::First Byte of address

:[[Variable Types|BYTE]] ''MAC1''
::Second Byte of address

:[[Variable Types|BYTE]] ''MAC2''
::Third Byte of address

:[[Variable Types|BYTE]] ''MAC3''
::Fourth Byte of address

:[[Variable Types|BYTE]] ''MAC4''
::Fourth Byte of address

:[[Variable Types|BYTE]] ''MAC5''
::Fifth Byte of address

'''Return value'''

:''This call does not return a value''

===<tt>SetSubnetMask</tt>===
This macro sets up the Internet E-Block's Subnet Mask. In most circumstances, this macro will not be required as the subnet mask setting in the component property page will remain constant throughout your application.

'''Parameters'''

:[[Variable Types|BYTE]] ''IP0''
::First Byte of IP address

:[[Variable Types|BYTE]] ''IP1''
::Second Byte of IP address

:[[Variable Types|BYTE]] ''IP2''
::Third Byte of IP address

:[[Variable Types|BYTE]] ''IP3''
::Fourth Byte of IP address

'''Return value'''

:''This call does not return a value''

===<tt>TCPClose</tt>===
When an established TCP connection has finished transmission of data, either the local application (i.e. your code) or the remote application (i.e. the application at the other end of the connection) can initiate closure of the socket.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

'''Return value'''

:''This call does not return a value''

===<tt>GetSocketStatus</tt>===
This returns the state of the requested channel's socket.

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::Specifies the communications channel 0-3

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>Initialise</tt>===
Resets and initialises the Internet E-Block. It sets up the gateway address, subnet mask, device IP address and device MAC address as defined in the properties of the Flowcode component. This macro must be called before any other TCP_IP component macros

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:''This call does not return a value''

===<tt>SetGateway</tt>===
This macro sets up the Internet E-Block's Gateway address. In most circumstances, this macro will not be required as the gateway address setting in the component property page will remain constant throughout your application.

'''Parameters'''

:[[Variable Types|BYTE]] ''IP0''
::First Byte of IP address

:[[Variable Types|BYTE]] ''IP1''
::Second Byte of IP address

:[[Variable Types|BYTE]] ''IP2''
::Third Byte of IP address

:[[Variable Types|BYTE]] ''IP3''
::Fourth Byte of IP address

'''Return value'''

:''This call does not return a value''

==Simulation macro reference==

''This component does not contain any simulation macros''

==Property reference==
MIAC Industrial Addon

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''ORDINAL''.

''No additional information''

Channel

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi::CHANNEL''.

SPI Channel selector

Prescale

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi::PR_SCALE''.

Prescale option selector

MOSI

This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi::MOSI''.

SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.

MISO

This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi::MISO''.

SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.

CLK

This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi::CLK''.

SPI Clock Pin CLK - The Clock signal is driven by the SPI master.

CS / SS

This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi::SS''.

Chip Select / Slave Select Pin

Master Mode: General purpose output pin used to select the remote SPI device.

Slave Mode: Hardware chip select pin input used to select the SPI device.

Int Pin

This property is of type ''Single digital pin'' and can be referenced with the variable name ''int_pin''.

''No additional information''

CS Pin

This property is of type ''Single digital pin'' and can be referenced with the variable name ''cs_pin''.

''No additional information''

Gateway0

This property is of type ''Signed integer'' and can be referenced with the variable name ''gateway0''.

''No additional information''

Gateway1

This property is of type ''Signed integer'' and can be referenced with the variable name ''gateway1''.

''No additional information''

Gateway2

This property is of type ''Signed integer'' and can be referenced with the variable name ''gateway2''.

''No additional information''

Gateway3

This property is of type ''Signed integer'' and can be referenced with the variable name ''gateway3''.

''No additional information''

Subnet0

This property is of type ''Signed integer'' and can be referenced with the variable name ''subnet0''.

''No additional information''

Subnet1

This property is of type ''Signed integer'' and can be referenced with the variable name ''subnet1''.

''No additional information''

Subnet2

This property is of type ''Signed integer'' and can be referenced with the variable name ''subnet2''.

''No additional information''

Subnet3

This property is of type ''Signed integer'' and can be referenced with the variable name ''subnet3''.

''No additional information''

IP0

This property is of type ''Signed integer'' and can be referenced with the variable name ''ip0''.

''No additional information''

IP1

This property is of type ''Signed integer'' and can be referenced with the variable name ''ip1''.

''No additional information''

IP2

This property is of type ''Signed integer'' and can be referenced with the variable name ''ip2''.

''No additional information''

IP3

This property is of type ''Signed integer'' and can be referenced with the variable name ''ip3''.

''No additional information''

MAC0

This property is of type ''Signed integer'' and can be referenced with the variable name ''mac0''.

''No additional information''

MAC1

This property is of type ''Signed integer'' and can be referenced with the variable name ''mac1''.

''No additional information''

MAC2

This property is of type ''Signed integer'' and can be referenced with the variable name ''mac2''.

''No additional information''

MAC3

This property is of type ''Signed integer'' and can be referenced with the variable name ''mac3''.

''No additional information''

MAC4

This property is of type ''Signed integer'' and can be referenced with the variable name ''mac4''.

''No additional information''

MAC5

This property is of type ''Signed integer'' and can be referenced with the variable name ''mac5''.

''No additional information''

Label

This property is of type ''Line of text'' and can be referenced with the variable name ''label''.

''No additional information''

Sim Type

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''SimType''.

Decides how to perform the simulation of the component.

TCP IP - Communicates using the Windows TCP IP communications DLL

SPI / Injector - Communicates using the CAL SPI to allow the communications to be analysed and debugged.

Scope Traces

This property is of type ''True or false'' and can be referenced with the variable name ''cal_spi::ScopeTraces''.

Selects if the scope traces are automatically generated or not

Console Data

This property is of type ''True or false'' and can be referenced with the variable name ''cal_spi::ConsoleData''.

Selects if the console data is automatically generated or not

Injector

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi::Injector''.

''No additional information''

Network Interface

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''TCP_Base::interface''.

List of network interfaces connected to the PC.

Sets which interface we are communicating via.

Component: TCPIP (EB023 v2) (E-blocks 1) - Revision history

BenR: XML import - Pre 8.0 release