Component: TCP/IP (EB023 v2) (E-blocks 1)
From Flowcode Help
Jump to navigationJump to search| Author | Matrix TSL |
| Version | 2.0 |
| Category | E-blocks 1 |
Contents
TCP/IP 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.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_TCPIP_EB023-00-2_EB.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_TCPIP_EB023-00-2_EB.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
Error creating thumbnail: Unable to save thumbnail to destination
|
TxSendMyIP |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxMatchMyIP |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxMatch_4_Bytes |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte1 |
| Specifies the value of the first byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte2 |
| Specifies the value of the second byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte3 |
| Specifies the value of the third byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte4 |
| Specifies the value of the fourth byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
SetMyIP |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP0 |
| First Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP1 |
| Second Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP2 |
| Third Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP3 |
| Fourth Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TxSendString |
| This macro fills the specified channel's transmit buffer with data. It can fill the buffer with a string of information. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - STRING
|
Data |
| Data byte to append to Tx buffer. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Length |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxReadHeader |
| 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 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Idx |
| Specifies the byte index to return | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxSkipBytes |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Count |
| Specifies how many bytes to skip | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
MIAC_Module_SetData |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Count |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
D0 |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
D1 |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
D2 |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
D3 |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
D4 |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
D5 |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
CreateIPSocket |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Protocol |
| Specifies which IP protocol to use | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Broadcast |
| Allows broadcast type packets to be sent and received | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
SetDestination |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Dst_IP0 |
| Specifies the first byte of an IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Dst_IP1 |
| Specifies the second byte of an IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Dst_IP2 |
| Specifies the third byte of an IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Dst_IP3 |
| Specifies the fourth byte of an IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - UINT
|
Dst_Port |
| Destination Port | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
MIAC_Module_GetData |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Index |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TxStart |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
MIAC_Module_Message |
Error creating thumbnail: Unable to save thumbnail to destination - UINT
|
CAN_ID |
Error creating thumbnail: Unable to save thumbnail to destination - UINT
|
CMD_ID |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxReadByte |
| 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 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
CreateUDPSocket |
| This macro creates a socket for sending and receiving UDP data. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - UINT
|
Src_Port |
| Port Number | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxMatch_6_Bytes |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte1 |
| Specifies the value of the first byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte2 |
| Specifies the value of the second byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte3 |
| Specifies the value of the third byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte4 |
| Specifies the value of the fourth byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte5 |
| Specifies the value of the fifth byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte6 |
| Specifies the value of the sixth byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxMatch_2_Bytes |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte1 |
| Specifies the value of the first byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte2 |
| Specifies the value of the second byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TxEnd |
| Once the transmit buffer has been filled with data, call this macro to actually send the data. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxReadString |
| 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 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Length |
Error creating thumbnail: Unable to save thumbnail to destination - STRING
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
CreateTCPSocket |
| This macro creates a socket for sending and receiving TCP data. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - UINT
|
Src_Port |
| Port Number | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxDataAvailable |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
MIAC_Module_PushData |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Data |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TxSendByte |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Data |
| Data byte to append to Tx buffer. | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TCPListen |
| 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). | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TxSendByte_Sim |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Data |
| Data byte to append to Tx buffer. | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxFlushData |
| Once data reception has been completed, this macro should be called to discard the data packet and allow other data packets to be read. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TCPConnect |
| 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). | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Dst_IP0 |
| First Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Dst_IP1 |
| Second Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Dst_IP2 |
| Third Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Dst_IP3 |
| Fourth Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - UINT
|
Dst_Port |
| Destination Port | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxReadByte_Sim |
| 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 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxMatchMyMAC |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxFlushData_Sim |
| Once data reception has been completed, this macro should be called to discard the data packet and allow other data packets to be read. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxDataSize |
| This macro is used to detect the size of data collected by the Rx_data_available macro. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - UINT
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
CreateMACSocket |
| This macro creates a socket for sending and receiving Ethernet data using raw data. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Promiscuous |
| Receive everything (1) or just data bound for your MAC (0) | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Broadcast |
| Allows broadcast messages to be accepted (1) or rejected (0) | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Error |
| Allowsmessages with errors to be accepted (1) or rejected (0) | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
CreateUDPSocket_Sim |
| This macro creates a socket for sending and receiving UDP data. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - UINT
|
Src_Port |
| Port Number | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TxSendMyMAC |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
SetMACAddress |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
MAC0 |
| First Byte of address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
MAC1 |
| Second Byte of address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
MAC2 |
| Third Byte of address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
MAC3 |
| Fourth Byte of address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
MAC4 |
| Fourth Byte of address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
MAC5 |
| Fifth Byte of address | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxMatch_4_Bytes_Sim |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte1 |
| Specifies the value of the first byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte2 |
| Specifies the value of the second byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte3 |
| Specifies the value of the third byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte4 |
| Specifies the value of the fourth byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxDataSize_Sim |
| This macro is used to detect the size of data collected by the Rx_data_available macro. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
SetSubnetMask |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP0 |
| First Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP1 |
| Second Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP2 |
| Third Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP3 |
| Fourth Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxMatch_2_Bytes_Sim |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte1 |
| Specifies the value of the first byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte2 |
| Specifies the value of the second byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxMatchMyMAC_Sim |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TCPClose |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
GetSocketStatus |
| This returns the state of the requested channel's socket. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
Initialise |
| 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 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
SetGateway |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP0 |
| First Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP1 |
| Second Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP2 |
| Third Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP3 |
| Fourth Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Property reference
Error creating thumbnail: Unable to save thumbnail to destination
|
Properties |
Error creating thumbnail: Unable to save thumbnail to destination
|
Connections |
Error creating thumbnail: Unable to save thumbnail to destination
|
Channel |
| SPI Channel selector | |
Error creating thumbnail: Unable to save thumbnail to destination
|
Prescale |
| Prescale option selector | |
Error creating thumbnail: Unable to save thumbnail to destination
|
MOSI |
| SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. | |
Error creating thumbnail: Unable to save thumbnail to destination
|
MISO |
| SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. | |
Error creating thumbnail: Unable to save thumbnail to destination
|
CLK |
| SPI Clock Pin CLK - The Clock signal is driven by the SPI master. | |
Error creating thumbnail: Unable to save thumbnail to destination
|
CS / 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. | |
Error creating thumbnail: Unable to save thumbnail to destination
|
Gateway IP |
Error creating thumbnail: Unable to save thumbnail to destination
|
Gateway0 |
Error creating thumbnail: Unable to save thumbnail to destination
|
Gateway1 |
Error creating thumbnail: Unable to save thumbnail to destination
|
Gateway2 |
Error creating thumbnail: Unable to save thumbnail to destination
|
Gateway3 |
Error creating thumbnail: Unable to save thumbnail to destination
|
Subnet Mask |
Error creating thumbnail: Unable to save thumbnail to destination
|
Subnet0 |
Error creating thumbnail: Unable to save thumbnail to destination
|
Subnet1 |
Error creating thumbnail: Unable to save thumbnail to destination
|
Subnet2 |
Error creating thumbnail: Unable to save thumbnail to destination
|
Subnet3 |
Error creating thumbnail: Unable to save thumbnail to destination
|
IP Address |
Error creating thumbnail: Unable to save thumbnail to destination
|
IP0 |
Error creating thumbnail: Unable to save thumbnail to destination
|
IP1 |
Error creating thumbnail: Unable to save thumbnail to destination
|
IP2 |
Error creating thumbnail: Unable to save thumbnail to destination
|
IP3 |
Error creating thumbnail: Unable to save thumbnail to destination
|
MAC Address |
Error creating thumbnail: Unable to save thumbnail to destination
|
MAC0 |
Error creating thumbnail: Unable to save thumbnail to destination
|
MAC1 |
Error creating thumbnail: Unable to save thumbnail to destination
|
MAC2 |
Error creating thumbnail: Unable to save thumbnail to destination
|
MAC3 |
Error creating thumbnail: Unable to save thumbnail to destination
|
MAC4 |
Error creating thumbnail: Unable to save thumbnail to destination
|
MAC5 |
Error creating thumbnail: Unable to save thumbnail to destination
|
Simulation |
Error creating thumbnail: Unable to save thumbnail to destination
|
Label |
Error creating thumbnail: Unable to save thumbnail to destination
|
Sim Type |
| Decides how to perform the simulation of the component. TCP IP - Communicates using the Windows TCP IP communications DLL SPI / API - Communicates using the CAL SPI to allow the communications to be analysed and debugged. | |
Error creating thumbnail: Unable to save thumbnail to destination
|
SPI Simulation |
Error creating thumbnail: Unable to save thumbnail to destination
|
Scope Traces |
| Selects if the scope traces are automatically generated or not | |
Error creating thumbnail: Unable to save thumbnail to destination
|
Console Data |
| Selects if the console data is automatically generated or not | |
Error creating thumbnail: Unable to save thumbnail to destination
|
API |
==Macro reference==
Error creating thumbnail: Unable to save thumbnail to destination
|
TxSendMyIP |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxMatchMyIP |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxMatch_4_Bytes |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte1 |
| Specifies the value of the first byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte2 |
| Specifies the value of the second byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte3 |
| Specifies the value of the third byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte4 |
| Specifies the value of the fourth byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
SetMyIP |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP0 |
| First Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP1 |
| Second Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP2 |
| Third Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP3 |
| Fourth Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TxSendString |
| This macro fills the specified channel's transmit buffer with data. It can fill the buffer with a string of information. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - STRING
|
Data |
| Data byte to append to Tx buffer. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Length |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxReadHeader |
| 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 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Idx |
| Specifies the byte index to return | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxSkipBytes |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Count |
| Specifies how many bytes to skip | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
MIAC_Module_SetData |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Count |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
D0 |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
D1 |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
D2 |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
D3 |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
D4 |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
D5 |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
CreateIPSocket |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Protocol |
| Specifies which IP protocol to use | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Broadcast |
| Allows broadcast type packets to be sent and received | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
SetDestination |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Dst_IP0 |
| Specifies the first byte of an IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Dst_IP1 |
| Specifies the second byte of an IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Dst_IP2 |
| Specifies the third byte of an IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Dst_IP3 |
| Specifies the fourth byte of an IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - UINT
|
Dst_Port |
| Destination Port | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
MIAC_Module_GetData |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Index |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TxStart |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
MIAC_Module_Message |
Error creating thumbnail: Unable to save thumbnail to destination - UINT
|
CAN_ID |
Error creating thumbnail: Unable to save thumbnail to destination - UINT
|
CMD_ID |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxReadByte |
| 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 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
CreateUDPSocket |
| This macro creates a socket for sending and receiving UDP data. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - UINT
|
Src_Port |
| Port Number | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxMatch_6_Bytes |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte1 |
| Specifies the value of the first byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte2 |
| Specifies the value of the second byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte3 |
| Specifies the value of the third byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte4 |
| Specifies the value of the fourth byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte5 |
| Specifies the value of the fifth byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte6 |
| Specifies the value of the sixth byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxMatch_2_Bytes |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte1 |
| Specifies the value of the first byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte2 |
| Specifies the value of the second byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TxEnd |
| Once the transmit buffer has been filled with data, call this macro to actually send the data. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxReadString |
| 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 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Length |
Error creating thumbnail: Unable to save thumbnail to destination - STRING
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
CreateTCPSocket |
| This macro creates a socket for sending and receiving TCP data. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - UINT
|
Src_Port |
| Port Number | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxDataAvailable |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
MIAC_Module_PushData |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Data |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TxSendByte |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Data |
| Data byte to append to Tx buffer. | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TCPListen |
| 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). | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TxSendByte_Sim |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Data |
| Data byte to append to Tx buffer. | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxFlushData |
| Once data reception has been completed, this macro should be called to discard the data packet and allow other data packets to be read. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TCPConnect |
| 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). | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Dst_IP0 |
| First Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Dst_IP1 |
| Second Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Dst_IP2 |
| Third Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Dst_IP3 |
| Fourth Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - UINT
|
Dst_Port |
| Destination Port | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxReadByte_Sim |
| 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 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxMatchMyMAC |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxFlushData_Sim |
| Once data reception has been completed, this macro should be called to discard the data packet and allow other data packets to be read. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxDataSize |
| This macro is used to detect the size of data collected by the Rx_data_available macro. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - UINT
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
CreateMACSocket |
| This macro creates a socket for sending and receiving Ethernet data using raw data. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Promiscuous |
| Receive everything (1) or just data bound for your MAC (0) | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Broadcast |
| Allows broadcast messages to be accepted (1) or rejected (0) | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Error |
| Allowsmessages with errors to be accepted (1) or rejected (0) | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
CreateUDPSocket_Sim |
| This macro creates a socket for sending and receiving UDP data. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - UINT
|
Src_Port |
| Port Number | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TxSendMyMAC |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
SetMACAddress |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
MAC0 |
| First Byte of address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
MAC1 |
| Second Byte of address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
MAC2 |
| Third Byte of address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
MAC3 |
| Fourth Byte of address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
MAC4 |
| Fourth Byte of address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
MAC5 |
| Fifth Byte of address | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxMatch_4_Bytes_Sim |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte1 |
| Specifies the value of the first byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte2 |
| Specifies the value of the second byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte3 |
| Specifies the value of the third byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte4 |
| Specifies the value of the fourth byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxDataSize_Sim |
| This macro is used to detect the size of data collected by the Rx_data_available macro. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
SetSubnetMask |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP0 |
| First Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP1 |
| Second Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP2 |
| Third Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP3 |
| Fourth Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxMatch_2_Bytes_Sim |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte1 |
| Specifies the value of the first byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte2 |
| Specifies the value of the second byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxMatchMyMAC_Sim |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TCPClose |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
GetSocketStatus |
| This returns the state of the requested channel's socket. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
Initialise |
| 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 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
SetGateway |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP0 |
| First Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP1 |
| Second Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP2 |
| Third Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP3 |
| Fourth Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Property reference
Error creating thumbnail: Unable to save thumbnail to destination
|
Properties |
Error creating thumbnail: Unable to save thumbnail to destination
|
Connections |
Error creating thumbnail: Unable to save thumbnail to destination
|
Channel |
| SPI Channel selector | |
Error creating thumbnail: Unable to save thumbnail to destination
|
Prescale |
| Prescale option selector | |
Error creating thumbnail: Unable to save thumbnail to destination
|
MOSI |
| SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. | |
Error creating thumbnail: Unable to save thumbnail to destination
|
MISO |
| SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. | |
Error creating thumbnail: Unable to save thumbnail to destination
|
CLK |
| SPI Clock Pin CLK - The Clock signal is driven by the SPI master. | |
Error creating thumbnail: Unable to save thumbnail to destination
|
CS / 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. | |
Error creating thumbnail: Unable to save thumbnail to destination
|
Gateway IP |
Error creating thumbnail: Unable to save thumbnail to destination
|
Gateway0 |
Error creating thumbnail: Unable to save thumbnail to destination
|
Gateway1 |
Error creating thumbnail: Unable to save thumbnail to destination
|
Gateway2 |
Error creating thumbnail: Unable to save thumbnail to destination
|
Gateway3 |
Error creating thumbnail: Unable to save thumbnail to destination
|
Subnet Mask |
Error creating thumbnail: Unable to save thumbnail to destination
|
Subnet0 |
Error creating thumbnail: Unable to save thumbnail to destination
|
Subnet1 |
Error creating thumbnail: Unable to save thumbnail to destination
|
Subnet2 |
Error creating thumbnail: Unable to save thumbnail to destination
|
Subnet3 |
Error creating thumbnail: Unable to save thumbnail to destination
|
IP Address |
Error creating thumbnail: Unable to save thumbnail to destination
|
IP0 |
Error creating thumbnail: Unable to save thumbnail to destination
|
IP1 |
Error creating thumbnail: Unable to save thumbnail to destination
|
IP2 |
Error creating thumbnail: Unable to save thumbnail to destination
|
IP3 |
Error creating thumbnail: Unable to save thumbnail to destination
|
MAC Address |
Error creating thumbnail: Unable to save thumbnail to destination
|
MAC0 |
Error creating thumbnail: Unable to save thumbnail to destination
|
MAC1 |
Error creating thumbnail: Unable to save thumbnail to destination
|
MAC2 |
Error creating thumbnail: Unable to save thumbnail to destination
|
MAC3 |
Error creating thumbnail: Unable to save thumbnail to destination
|
MAC4 |
Error creating thumbnail: Unable to save thumbnail to destination
|
MAC5 |
Error creating thumbnail: Unable to save thumbnail to destination
|
Simulation |
Error creating thumbnail: Unable to save thumbnail to destination
|
Label |
Error creating thumbnail: Unable to save thumbnail to destination
|
Sim Type |
| Decides how to perform the simulation of the component. TCP IP - Communicates using the Windows TCP IP communications DLL SPI / API - Communicates using the CAL SPI to allow the communications to be analysed and debugged. | |
Error creating thumbnail: Unable to save thumbnail to destination
|
SPI Simulation |
Error creating thumbnail: Unable to save thumbnail to destination
|
Scope Traces |
| Selects if the scope traces are automatically generated or not | |
Error creating thumbnail: Unable to save thumbnail to destination
|
Console Data |
| Selects if the console data is automatically generated or not | |
Error creating thumbnail: Unable to save thumbnail to destination
|
API |
==Macro reference==
Error creating thumbnail: Unable to save thumbnail to destination
|
TxSendMyIP |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxMatchMyIP |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxMatch_4_Bytes |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte1 |
| Specifies the value of the first byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte2 |
| Specifies the value of the second byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte3 |
| Specifies the value of the third byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte4 |
| Specifies the value of the fourth byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
SetMyIP |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP0 |
| First Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP1 |
| Second Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP2 |
| Third Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP3 |
| Fourth Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TxSendString |
| This macro fills the specified channel's transmit buffer with data. It can fill the buffer with a string of information. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - STRING
|
Data |
| Data byte to append to Tx buffer. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Length |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxReadHeader |
| 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 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Idx |
| Specifies the byte index to return | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxSkipBytes |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Count |
| Specifies how many bytes to skip | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
MIAC_Module_SetData |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Count |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
D0 |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
D1 |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
D2 |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
D3 |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
D4 |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
D5 |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
CreateIPSocket |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Protocol |
| Specifies which IP protocol to use | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Broadcast |
| Allows broadcast type packets to be sent and received | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
SetDestination |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Dst_IP0 |
| Specifies the first byte of an IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Dst_IP1 |
| Specifies the second byte of an IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Dst_IP2 |
| Specifies the third byte of an IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Dst_IP3 |
| Specifies the fourth byte of an IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - UINT
|
Dst_Port |
| Destination Port | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
MIAC_Module_GetData |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Index |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TxStart |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
MIAC_Module_Message |
Error creating thumbnail: Unable to save thumbnail to destination - UINT
|
CAN_ID |
Error creating thumbnail: Unable to save thumbnail to destination - UINT
|
CMD_ID |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxReadByte |
| 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 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
CreateUDPSocket |
| This macro creates a socket for sending and receiving UDP data. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - UINT
|
Src_Port |
| Port Number | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxMatch_6_Bytes |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte1 |
| Specifies the value of the first byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte2 |
| Specifies the value of the second byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte3 |
| Specifies the value of the third byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte4 |
| Specifies the value of the fourth byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte5 |
| Specifies the value of the fifth byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte6 |
| Specifies the value of the sixth byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxMatch_2_Bytes |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte1 |
| Specifies the value of the first byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte2 |
| Specifies the value of the second byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TxEnd |
| Once the transmit buffer has been filled with data, call this macro to actually send the data. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxReadString |
| 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 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Length |
Error creating thumbnail: Unable to save thumbnail to destination - STRING
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
CreateTCPSocket |
| This macro creates a socket for sending and receiving TCP data. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - UINT
|
Src_Port |
| Port Number | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxDataAvailable |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
MIAC_Module_PushData |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Data |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TxSendByte |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Data |
| Data byte to append to Tx buffer. | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TCPListen |
| 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). | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TxSendByte_Sim |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Data |
| Data byte to append to Tx buffer. | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxFlushData |
| Once data reception has been completed, this macro should be called to discard the data packet and allow other data packets to be read. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TCPConnect |
| 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). | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Dst_IP0 |
| First Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Dst_IP1 |
| Second Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Dst_IP2 |
| Third Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Dst_IP3 |
| Fourth Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - UINT
|
Dst_Port |
| Destination Port | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxReadByte_Sim |
| 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 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxMatchMyMAC |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxFlushData_Sim |
| Once data reception has been completed, this macro should be called to discard the data packet and allow other data packets to be read. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxDataSize |
| This macro is used to detect the size of data collected by the Rx_data_available macro. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - UINT
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
CreateMACSocket |
| This macro creates a socket for sending and receiving Ethernet data using raw data. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Promiscuous |
| Receive everything (1) or just data bound for your MAC (0) | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Broadcast |
| Allows broadcast messages to be accepted (1) or rejected (0) | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Error |
| Allowsmessages with errors to be accepted (1) or rejected (0) | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
CreateUDPSocket_Sim |
| This macro creates a socket for sending and receiving UDP data. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - UINT
|
Src_Port |
| Port Number | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TxSendMyMAC |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
SetMACAddress |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
MAC0 |
| First Byte of address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
MAC1 |
| Second Byte of address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
MAC2 |
| Third Byte of address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
MAC3 |
| Fourth Byte of address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
MAC4 |
| Fourth Byte of address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
MAC5 |
| Fifth Byte of address | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxMatch_4_Bytes_Sim |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte1 |
| Specifies the value of the first byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte2 |
| Specifies the value of the second byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte3 |
| Specifies the value of the third byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte4 |
| Specifies the value of the fourth byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxDataSize_Sim |
| This macro is used to detect the size of data collected by the Rx_data_available macro. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
SetSubnetMask |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP0 |
| First Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP1 |
| Second Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP2 |
| Third Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP3 |
| Fourth Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxMatch_2_Bytes_Sim |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte1 |
| Specifies the value of the first byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Byte2 |
| Specifies the value of the second byte | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
RxMatchMyMAC_Sim |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
TCPClose |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
GetSocketStatus |
| This returns the state of the requested channel's socket. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
Initialise |
| 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 | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
Return |
Error creating thumbnail: Unable to save thumbnail to destination
|
SetGateway |
| 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. | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP0 |
| First Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP1 |
| Second Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP2 |
| Third Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - BYTE
|
IP3 |
| Fourth Byte of IP address | |
Error creating thumbnail: Unable to save thumbnail to destination - VOID
|
Return |
Property reference
Error creating thumbnail: Unable to save thumbnail to destination
|
Properties |
Error creating thumbnail: Unable to save thumbnail to destination
|
Connections |
Error creating thumbnail: Unable to save thumbnail to destination
|
Channel |
| SPI Channel selector | |
Error creating thumbnail: Unable to save thumbnail to destination
|
Prescale |
| Prescale option selector | |
Error creating thumbnail: Unable to save thumbnail to destination
|
MOSI |
| SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. | |
Error creating thumbnail: Unable to save thumbnail to destination
|
MISO |
| SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. | |
Error creating thumbnail: Unable to save thumbnail to destination
|
CLK |
| SPI Clock Pin CLK - The Clock signal is driven by the SPI master. | |
Error creating thumbnail: Unable to save thumbnail to destination
|
CS / 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. | |
Error creating thumbnail: Unable to save thumbnail to destination
|
Gateway IP |
Error creating thumbnail: Unable to save thumbnail to destination
|
Gateway0 |
Error creating thumbnail: Unable to save thumbnail to destination
|
Gateway1 |
Error creating thumbnail: Unable to save thumbnail to destination
|
Gateway2 |
Error creating thumbnail: Unable to save thumbnail to destination
|
Gateway3 |
Error creating thumbnail: Unable to save thumbnail to destination
|
Subnet Mask |
Error creating thumbnail: Unable to save thumbnail to destination
|
Subnet0 |
Error creating thumbnail: Unable to save thumbnail to destination
|
Subnet1 |
Error creating thumbnail: Unable to save thumbnail to destination
|
Subnet2 |
Error creating thumbnail: Unable to save thumbnail to destination
|
Subnet3 |
Error creating thumbnail: Unable to save thumbnail to destination
|
IP Address |
Error creating thumbnail: Unable to save thumbnail to destination
|
IP0 |
Error creating thumbnail: Unable to save thumbnail to destination
|
IP1 |
Error creating thumbnail: Unable to save thumbnail to destination
|
IP2 |
Error creating thumbnail: Unable to save thumbnail to destination
|
IP3 |
Error creating thumbnail: Unable to save thumbnail to destination
|
MAC Address |
Error creating thumbnail: Unable to save thumbnail to destination
|
MAC0 |
Error creating thumbnail: Unable to save thumbnail to destination
|
MAC1 |
Error creating thumbnail: Unable to save thumbnail to destination
|
MAC2 |
Error creating thumbnail: Unable to save thumbnail to destination
|
MAC3 |
Error creating thumbnail: Unable to save thumbnail to destination
|
MAC4 |
Error creating thumbnail: Unable to save thumbnail to destination
|
MAC5 |
Error creating thumbnail: Unable to save thumbnail to destination
|
Simulation |
Error creating thumbnail: Unable to save thumbnail to destination
|
Label |
Error creating thumbnail: Unable to save thumbnail to destination
|
Sim Type |
| Decides how to perform the simulation of the component. TCP IP - Communicates using the Windows TCP IP communications DLL SPI / API - Communicates using the CAL SPI to allow the communications to be analysed and debugged. | |
Error creating thumbnail: Unable to save thumbnail to destination
|
SPI Simulation |
Error creating thumbnail: Unable to save thumbnail to destination
|
Scope Traces |
| Selects if the scope traces are automatically generated or not | |
Error creating thumbnail: Unable to save thumbnail to destination
|
Console Data |
| Selects if the console data is automatically generated or not | |
Error creating thumbnail: Unable to save thumbnail to destination
|
API |
