Difference between revisions of "Component: TCP/IP (EB023 v2) (E-blocks 1)"

From Flowcode Help
Jump to navigationJump to search
Line 17: Line 17:
 
==Component Source Code==
 
==Component Source Code==
  
−
Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_TCPIP_EB023-00-2_EB.fcfx FC_Comp_Source_TCPIP_EB023-00-2_EB.fcfx]
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_TCPIP_EB023-00-2_EB.fcfx FC_Comp_Source_TCPIP_EB023-00-2_EB.fcfx]
  
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_TCPIP_EB023-00-2_EB.fcfx FC_Comp_Source_TCPIP_EB023-00-2_EB.fcfx]
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_TCPIP_EB023-00-2_EB.fcfx FC_Comp_Source_TCPIP_EB023-00-2_EB.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
  
Line 44: Line 46:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 66: Line 70:
  
 
==Macro reference==
 
==Macro reference==
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TxSendMyIP'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RxMatchMyIP'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RxMatch_4_Bytes'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Byte1
 +
|-
 +
| colspan="2" | Specifies the value of the first byte 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Byte2
 +
|-
 +
| colspan="2" | Specifies the value of the second byte 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Byte3
 +
|-
 +
| colspan="2" | Specifies the value of the third byte 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Byte4
 +
|-
 +
| colspan="2" | Specifies the value of the fourth byte 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetMyIP'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | IP0
 +
|-
 +
| colspan="2" | First Byte of IP address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | IP1
 +
|-
 +
| colspan="2" | Second Byte of IP address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | IP2
 +
|-
 +
| colspan="2" | Third Byte of IP address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | IP3
 +
|-
 +
| colspan="2" | Fourth Byte of IP address 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TxSendString'''
 +
|-
 +
| colspan="2" | This macro fills the specified channel's transmit buffer with data.  It can fill the buffer with a string of information. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" | Data byte to append to Tx buffer. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Length
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RxReadHeader'''
 +
|-
 +
| colspan="2" | 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  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Idx
 +
|-
 +
| colspan="2" | Specifies the byte index to return 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RxSkipBytes'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Count
 +
|-
 +
| colspan="2" | Specifies how many bytes to skip 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''MIAC_Module_SetData'''
 +
|-
 +
| colspan="2" |  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Count
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | D0
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | D1
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | D2
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | D3
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | D4
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | D5
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CreateIPSocket'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Protocol
 +
|-
 +
| colspan="2" | Specifies which IP protocol to use 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Broadcast
 +
|-
 +
| colspan="2" | Allows broadcast type packets to be sent and received 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetDestination'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Dst_IP0
 +
|-
 +
| colspan="2" | Specifies the first byte of an IP address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Dst_IP1
 +
|-
 +
| colspan="2" | Specifies the second byte of an IP address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Dst_IP2
 +
|-
 +
| colspan="2" | Specifies the third byte of an IP address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Dst_IP3
 +
|-
 +
| colspan="2" | Specifies the fourth byte of an IP address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Dst_Port
 +
|-
 +
| colspan="2" | Destination Port 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''MIAC_Module_GetData'''
 +
|-
 +
| colspan="2" |  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TxStart'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''MIAC_Module_Message'''
 +
|-
 +
| colspan="2" |  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | CAN_ID
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | CMD_ID
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RxReadByte'''
 +
|-
 +
| colspan="2" | 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  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CreateUDPSocket'''
 +
|-
 +
| colspan="2" | This macro creates a socket for sending and receiving UDP data. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Src_Port
 +
|-
 +
| colspan="2" | Port Number 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RxMatch_6_Bytes'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Byte1
 +
|-
 +
| colspan="2" | Specifies the value of the first byte 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Byte2
 +
|-
 +
| colspan="2" | Specifies the value of the second byte 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Byte3
 +
|-
 +
| colspan="2" | Specifies the value of the third byte 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Byte4
 +
|-
 +
| colspan="2" | Specifies the value of the fourth byte 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Byte5
 +
|-
 +
| colspan="2" | Specifies the value of the fifth byte 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Byte6
 +
|-
 +
| colspan="2" | Specifies the value of the sixth byte 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RxMatch_2_Bytes'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Byte1
 +
|-
 +
| colspan="2" | Specifies the value of the first byte 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Byte2
 +
|-
 +
| colspan="2" | Specifies the value of the second byte 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TxEnd'''
 +
|-
 +
| colspan="2" | Once the transmit buffer has been filled with data, call this macro to actually send the data. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RxReadString'''
 +
|-
 +
| colspan="2" | 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  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Length
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CreateTCPSocket'''
 +
|-
 +
| colspan="2" | This macro creates a socket for sending and receiving TCP data. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Src_Port
 +
|-
 +
| colspan="2" | Port Number 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RxDataAvailable'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''MIAC_Module_PushData'''
 +
|-
 +
| colspan="2" |  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TxSendByte'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" | Data byte to append to Tx buffer. 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TCPListen'''
 +
|-
 +
| colspan="2" | 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). 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TxSendByte_Sim'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" | Data byte to append to Tx buffer. 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RxFlushData'''
 +
|-
 +
| colspan="2" | Once data reception has been completed, this macro should be called to discard the data packet and allow other data packets to be read. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TCPConnect'''
 +
|-
 +
| colspan="2" | 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). 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Dst_IP0
 +
|-
 +
| colspan="2" | First Byte of IP address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Dst_IP1
 +
|-
 +
| colspan="2" | Second Byte of IP address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Dst_IP2
 +
|-
 +
| colspan="2" | Third Byte of IP address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Dst_IP3
 +
|-
 +
| colspan="2" | Fourth Byte of IP address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Dst_Port
 +
|-
 +
| colspan="2" | Destination Port 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RxReadByte_Sim'''
 +
|-
 +
| colspan="2" | 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  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RxMatchMyMAC'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RxFlushData_Sim'''
 +
|-
 +
| colspan="2" | Once data reception has been completed, this macro should be called to discard the data packet and allow other data packets to be read. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RxDataSize'''
 +
|-
 +
| colspan="2" | This macro is used to detect the size of data collected by the Rx_data_available macro. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CreateMACSocket'''
 +
|-
 +
| colspan="2" | This macro creates a socket for sending and receiving Ethernet data using raw data. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Promiscuous
 +
|-
 +
| colspan="2" | Receive everything (1) or just data bound for your MAC (0) 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Broadcast
 +
|-
 +
| colspan="2" | Allows broadcast messages to be accepted (1) or rejected (0) 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Error
 +
|-
 +
| colspan="2" | Allowsmessages with errors to be accepted (1) or rejected (0) 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CreateUDPSocket_Sim'''
 +
|-
 +
| colspan="2" | This macro creates a socket for sending and receiving UDP data. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Src_Port
 +
|-
 +
| colspan="2" | Port Number 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TxSendMyMAC'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetMACAddress'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | MAC0
 +
|-
 +
| colspan="2" | First Byte of address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | MAC1
 +
|-
 +
| colspan="2" | Second Byte of address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | MAC2
 +
|-
 +
| colspan="2" | Third Byte of address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | MAC3
 +
|-
 +
| colspan="2" | Fourth Byte of address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | MAC4
 +
|-
 +
| colspan="2" | Fourth Byte of address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | MAC5
 +
|-
 +
| colspan="2" | Fifth Byte of address 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RxMatch_4_Bytes_Sim'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Byte1
 +
|-
 +
| colspan="2" | Specifies the value of the first byte 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Byte2
 +
|-
 +
| colspan="2" | Specifies the value of the second byte 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Byte3
 +
|-
 +
| colspan="2" | Specifies the value of the third byte 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Byte4
 +
|-
 +
| colspan="2" | Specifies the value of the fourth byte 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RxDataSize_Sim'''
 +
|-
 +
| colspan="2" | This macro is used to detect the size of data collected by the Rx_data_available macro. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetSubnetMask'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | IP0
 +
|-
 +
| colspan="2" | First Byte of IP address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | IP1
 +
|-
 +
| colspan="2" | Second Byte of IP address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | IP2
 +
|-
 +
| colspan="2" | Third Byte of IP address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | IP3
 +
|-
 +
| colspan="2" | Fourth Byte of IP address 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RxMatch_2_Bytes_Sim'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Byte1
 +
|-
 +
| colspan="2" | Specifies the value of the first byte 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Byte2
 +
|-
 +
| colspan="2" | Specifies the value of the second byte 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RxMatchMyMAC_Sim'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TCPClose'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetSocketStatus'''
 +
|-
 +
| colspan="2" | This returns the state of the requested channel's socket. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Specifies the communications channel 0-3 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 +
|-
 +
| colspan="2" | 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  
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetGateway'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | IP0
 +
|-
 +
| colspan="2" | First Byte of IP address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | IP1
 +
|-
 +
| colspan="2" | Second Byte of IP address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | IP2
 +
|-
 +
| colspan="2" | Third Byte of IP address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | IP3
 +
|-
 +
| colspan="2" | Fourth Byte of IP address 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
 +
 +
==Property reference==
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
 +
|-
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | SPI Channel selector 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Prescale
 +
|-
 +
| colspan="2" | Prescale option selector 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | MOSI
 +
|-
 +
| colspan="2" | SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | MISO
 +
|-
 +
| colspan="2" | SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | CLK
 +
|-
 +
| colspan="2" | SPI Clock Pin CLK - The Clock signal is driven by the SPI master. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | CS / SS
 +
|-
 +
| colspan="2" | 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.  
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Gateway IP
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Gateway0
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Gateway1
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Gateway2
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Gateway3
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Subnet Mask
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Subnet0
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Subnet1
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Subnet2
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Subnet3
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | IP Address
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | IP0
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | IP1
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | IP2
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | IP3
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | MAC Address
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | MAC0
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | MAC1
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | MAC2
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | MAC3
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | MAC4
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | MAC5
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 +
| width="90%" | Label
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Sim Type
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | SPI Simulation
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Scope Traces
 +
|-
 +
| colspan="2" | Selects if the scope traces are automatically generated or not 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Console Data
 +
|-
 +
| colspan="2" | Selects if the console data is automatically generated or not 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | API
 +
|-
 +
| colspan="2" |  
 +
|}==Macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 10:00, 27 January 2023

Author Matrix TSL
Version 2.0
Category E-blocks 1


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

Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Byte1
Specifies the value of the first byte 
Fc9-u8-icon.png - BYTE Byte2
Specifies the value of the second byte 
Fc9-u8-icon.png - BYTE Byte3
Specifies the value of the third byte 
Fc9-u8-icon.png - BYTE Byte4
Specifies the value of the fourth byte 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE IP0
First Byte of IP address 
Fc9-u8-icon.png - BYTE IP1
Second Byte of IP address 
Fc9-u8-icon.png - BYTE IP2
Third Byte of IP address 
Fc9-u8-icon.png - BYTE IP3
Fourth Byte of IP address 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png TxSendString
This macro fills the specified channel's transmit buffer with data. It can fill the buffer with a string of information. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-string-icon.png - STRING Data
Data byte to append to Tx buffer. 
Fc9-u8-icon.png - BYTE Length
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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  
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Idx
Specifies the byte index to return 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Count
Specifies how many bytes to skip 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png MIAC_Module_SetData
 
Fc9-u8-icon.png - BYTE Count
 
Fc9-u8-icon.png - BYTE D0
 
Fc9-u8-icon.png - BYTE D1
 
Fc9-u8-icon.png - BYTE D2
 
Fc9-u8-icon.png - BYTE D3
 
Fc9-u8-icon.png - BYTE D4
 
Fc9-u8-icon.png - BYTE D5
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Protocol
Specifies which IP protocol to use 
Fc9-u8-icon.png - BYTE Broadcast
Allows broadcast type packets to be sent and received 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Dst_IP0
Specifies the first byte of an IP address 
Fc9-u8-icon.png - BYTE Dst_IP1
Specifies the second byte of an IP address 
Fc9-u8-icon.png - BYTE Dst_IP2
Specifies the third byte of an IP address 
Fc9-u8-icon.png - BYTE Dst_IP3
Specifies the fourth byte of an IP address 
Fc9-u16-icon.png - UINT Dst_Port
Destination Port 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png MIAC_Module_GetData
 
Fc9-u8-icon.png - BYTE Index
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png MIAC_Module_Message
 
Fc9-u16-icon.png - UINT CAN_ID
 
Fc9-u16-icon.png - UINT CMD_ID
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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  
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png CreateUDPSocket
This macro creates a socket for sending and receiving UDP data. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u16-icon.png - UINT Src_Port
Port Number 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Byte1
Specifies the value of the first byte 
Fc9-u8-icon.png - BYTE Byte2
Specifies the value of the second byte 
Fc9-u8-icon.png - BYTE Byte3
Specifies the value of the third byte 
Fc9-u8-icon.png - BYTE Byte4
Specifies the value of the fourth byte 
Fc9-u8-icon.png - BYTE Byte5
Specifies the value of the fifth byte 
Fc9-u8-icon.png - BYTE Byte6
Specifies the value of the sixth byte 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Byte1
Specifies the value of the first byte 
Fc9-u8-icon.png - BYTE Byte2
Specifies the value of the second byte 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png TxEnd
Once the transmit buffer has been filled with data, call this macro to actually send the data. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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  
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Length
 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png CreateTCPSocket
This macro creates a socket for sending and receiving TCP data. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u16-icon.png - UINT Src_Port
Port Number 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png MIAC_Module_PushData
 
Fc9-u8-icon.png - BYTE Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Data
Data byte to append to Tx buffer. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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). 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Data
Data byte to append to Tx buffer. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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). 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Dst_IP0
First Byte of IP address 
Fc9-u8-icon.png - BYTE Dst_IP1
Second Byte of IP address 
Fc9-u8-icon.png - BYTE Dst_IP2
Third Byte of IP address 
Fc9-u8-icon.png - BYTE Dst_IP3
Fourth Byte of IP address 
Fc9-u16-icon.png - UINT Dst_Port
Destination Port 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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  
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png RxDataSize
This macro is used to detect the size of data collected by the Rx_data_available macro. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png CreateMACSocket
This macro creates a socket for sending and receiving Ethernet data using raw data. 
Fc9-u8-icon.png - BYTE Promiscuous
Receive everything (1) or just data bound for your MAC (0) 
Fc9-u8-icon.png - BYTE Broadcast
Allows broadcast messages to be accepted (1) or rejected (0) 
Fc9-u8-icon.png - BYTE Error
Allowsmessages with errors to be accepted (1) or rejected (0) 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png CreateUDPSocket_Sim
This macro creates a socket for sending and receiving UDP data. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u16-icon.png - UINT Src_Port
Port Number 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE MAC0
First Byte of address 
Fc9-u8-icon.png - BYTE MAC1
Second Byte of address 
Fc9-u8-icon.png - BYTE MAC2
Third Byte of address 
Fc9-u8-icon.png - BYTE MAC3
Fourth Byte of address 
Fc9-u8-icon.png - BYTE MAC4
Fourth Byte of address 
Fc9-u8-icon.png - BYTE MAC5
Fifth Byte of address 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Byte1
Specifies the value of the first byte 
Fc9-u8-icon.png - BYTE Byte2
Specifies the value of the second byte 
Fc9-u8-icon.png - BYTE Byte3
Specifies the value of the third byte 
Fc9-u8-icon.png - BYTE Byte4
Specifies the value of the fourth byte 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png RxDataSize_Sim
This macro is used to detect the size of data collected by the Rx_data_available macro. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE IP0
First Byte of IP address 
Fc9-u8-icon.png - BYTE IP1
Second Byte of IP address 
Fc9-u8-icon.png - BYTE IP2
Third Byte of IP address 
Fc9-u8-icon.png - BYTE IP3
Fourth Byte of IP address 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Byte1
Specifies the value of the first byte 
Fc9-u8-icon.png - BYTE Byte2
Specifies the value of the second byte 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetSocketStatus
This returns the state of the requested channel's socket. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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  
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE IP0
First Byte of IP address 
Fc9-u8-icon.png - BYTE IP1
Second Byte of IP address 
Fc9-u8-icon.png - BYTE IP2
Third Byte of IP address 
Fc9-u8-icon.png - BYTE IP3
Fourth Byte of IP address 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Connections
Fc9-type-16-icon.png Channel
SPI Channel selector 
Fc9-type-16-icon.png Prescale
Prescale option selector 
Fc9-type-5-icon.png MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. 
Fc9-type-5-icon.png MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. 
Fc9-type-5-icon.png CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master. 
Fc9-type-5-icon.png 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.  
Fc9-conn-icon.png Gateway IP
Fc9-type-14-icon.png Gateway0
 
Fc9-type-14-icon.png Gateway1
 
Fc9-type-14-icon.png Gateway2
 
Fc9-type-14-icon.png Gateway3
 
Fc9-conn-icon.png Subnet Mask
Fc9-type-14-icon.png Subnet0
 
Fc9-type-14-icon.png Subnet1
 
Fc9-type-14-icon.png Subnet2
 
Fc9-type-14-icon.png Subnet3
 
Fc9-conn-icon.png IP Address
Fc9-type-14-icon.png IP0
 
Fc9-type-14-icon.png IP1
 
Fc9-type-14-icon.png IP2
 
Fc9-type-14-icon.png IP3
 
Fc9-conn-icon.png MAC Address
Fc9-type-14-icon.png MAC0
 
Fc9-type-14-icon.png MAC1
 
Fc9-type-14-icon.png MAC2
 
Fc9-type-14-icon.png MAC3
 
Fc9-type-14-icon.png MAC4
 
Fc9-type-14-icon.png MAC5
 
Fc9-conn-icon.png Simulation
Fc9-type-10-icon.png Label
 
Fc9-type-16-icon.png 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. 
Fc9-conn-icon.png SPI Simulation
Fc9-type-7-icon.png Scope Traces
Selects if the scope traces are automatically generated or not 
Fc9-type-7-icon.png Console Data
Selects if the console data is automatically generated or not 
Fc9-type-16-icon.png API
 

==Macro reference==

Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Byte1
Specifies the value of the first byte 
Fc9-u8-icon.png - BYTE Byte2
Specifies the value of the second byte 
Fc9-u8-icon.png - BYTE Byte3
Specifies the value of the third byte 
Fc9-u8-icon.png - BYTE Byte4
Specifies the value of the fourth byte 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE IP0
First Byte of IP address 
Fc9-u8-icon.png - BYTE IP1
Second Byte of IP address 
Fc9-u8-icon.png - BYTE IP2
Third Byte of IP address 
Fc9-u8-icon.png - BYTE IP3
Fourth Byte of IP address 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png TxSendString
This macro fills the specified channel's transmit buffer with data. It can fill the buffer with a string of information. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-string-icon.png - STRING Data
Data byte to append to Tx buffer. 
Fc9-u8-icon.png - BYTE Length
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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  
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Idx
Specifies the byte index to return 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Count
Specifies how many bytes to skip 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png MIAC_Module_SetData
 
Fc9-u8-icon.png - BYTE Count
 
Fc9-u8-icon.png - BYTE D0
 
Fc9-u8-icon.png - BYTE D1
 
Fc9-u8-icon.png - BYTE D2
 
Fc9-u8-icon.png - BYTE D3
 
Fc9-u8-icon.png - BYTE D4
 
Fc9-u8-icon.png - BYTE D5
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Protocol
Specifies which IP protocol to use 
Fc9-u8-icon.png - BYTE Broadcast
Allows broadcast type packets to be sent and received 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Dst_IP0
Specifies the first byte of an IP address 
Fc9-u8-icon.png - BYTE Dst_IP1
Specifies the second byte of an IP address 
Fc9-u8-icon.png - BYTE Dst_IP2
Specifies the third byte of an IP address 
Fc9-u8-icon.png - BYTE Dst_IP3
Specifies the fourth byte of an IP address 
Fc9-u16-icon.png - UINT Dst_Port
Destination Port 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png MIAC_Module_GetData
 
Fc9-u8-icon.png - BYTE Index
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png MIAC_Module_Message
 
Fc9-u16-icon.png - UINT CAN_ID
 
Fc9-u16-icon.png - UINT CMD_ID
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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  
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png CreateUDPSocket
This macro creates a socket for sending and receiving UDP data. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u16-icon.png - UINT Src_Port
Port Number 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Byte1
Specifies the value of the first byte 
Fc9-u8-icon.png - BYTE Byte2
Specifies the value of the second byte 
Fc9-u8-icon.png - BYTE Byte3
Specifies the value of the third byte 
Fc9-u8-icon.png - BYTE Byte4
Specifies the value of the fourth byte 
Fc9-u8-icon.png - BYTE Byte5
Specifies the value of the fifth byte 
Fc9-u8-icon.png - BYTE Byte6
Specifies the value of the sixth byte 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Byte1
Specifies the value of the first byte 
Fc9-u8-icon.png - BYTE Byte2
Specifies the value of the second byte 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png TxEnd
Once the transmit buffer has been filled with data, call this macro to actually send the data. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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  
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Length
 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png CreateTCPSocket
This macro creates a socket for sending and receiving TCP data. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u16-icon.png - UINT Src_Port
Port Number 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png MIAC_Module_PushData
 
Fc9-u8-icon.png - BYTE Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Data
Data byte to append to Tx buffer. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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). 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Data
Data byte to append to Tx buffer. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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). 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Dst_IP0
First Byte of IP address 
Fc9-u8-icon.png - BYTE Dst_IP1
Second Byte of IP address 
Fc9-u8-icon.png - BYTE Dst_IP2
Third Byte of IP address 
Fc9-u8-icon.png - BYTE Dst_IP3
Fourth Byte of IP address 
Fc9-u16-icon.png - UINT Dst_Port
Destination Port 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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  
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png RxDataSize
This macro is used to detect the size of data collected by the Rx_data_available macro. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png CreateMACSocket
This macro creates a socket for sending and receiving Ethernet data using raw data. 
Fc9-u8-icon.png - BYTE Promiscuous
Receive everything (1) or just data bound for your MAC (0) 
Fc9-u8-icon.png - BYTE Broadcast
Allows broadcast messages to be accepted (1) or rejected (0) 
Fc9-u8-icon.png - BYTE Error
Allowsmessages with errors to be accepted (1) or rejected (0) 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png CreateUDPSocket_Sim
This macro creates a socket for sending and receiving UDP data. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u16-icon.png - UINT Src_Port
Port Number 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE MAC0
First Byte of address 
Fc9-u8-icon.png - BYTE MAC1
Second Byte of address 
Fc9-u8-icon.png - BYTE MAC2
Third Byte of address 
Fc9-u8-icon.png - BYTE MAC3
Fourth Byte of address 
Fc9-u8-icon.png - BYTE MAC4
Fourth Byte of address 
Fc9-u8-icon.png - BYTE MAC5
Fifth Byte of address 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Byte1
Specifies the value of the first byte 
Fc9-u8-icon.png - BYTE Byte2
Specifies the value of the second byte 
Fc9-u8-icon.png - BYTE Byte3
Specifies the value of the third byte 
Fc9-u8-icon.png - BYTE Byte4
Specifies the value of the fourth byte 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png RxDataSize_Sim
This macro is used to detect the size of data collected by the Rx_data_available macro. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE IP0
First Byte of IP address 
Fc9-u8-icon.png - BYTE IP1
Second Byte of IP address 
Fc9-u8-icon.png - BYTE IP2
Third Byte of IP address 
Fc9-u8-icon.png - BYTE IP3
Fourth Byte of IP address 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Byte1
Specifies the value of the first byte 
Fc9-u8-icon.png - BYTE Byte2
Specifies the value of the second byte 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetSocketStatus
This returns the state of the requested channel's socket. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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  
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE IP0
First Byte of IP address 
Fc9-u8-icon.png - BYTE IP1
Second Byte of IP address 
Fc9-u8-icon.png - BYTE IP2
Third Byte of IP address 
Fc9-u8-icon.png - BYTE IP3
Fourth Byte of IP address 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Connections
Fc9-type-16-icon.png Channel
SPI Channel selector 
Fc9-type-16-icon.png Prescale
Prescale option selector 
Fc9-type-5-icon.png MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. 
Fc9-type-5-icon.png MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. 
Fc9-type-5-icon.png CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master. 
Fc9-type-5-icon.png 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.  
Fc9-conn-icon.png Gateway IP
Fc9-type-14-icon.png Gateway0
 
Fc9-type-14-icon.png Gateway1
 
Fc9-type-14-icon.png Gateway2
 
Fc9-type-14-icon.png Gateway3
 
Fc9-conn-icon.png Subnet Mask
Fc9-type-14-icon.png Subnet0
 
Fc9-type-14-icon.png Subnet1
 
Fc9-type-14-icon.png Subnet2
 
Fc9-type-14-icon.png Subnet3
 
Fc9-conn-icon.png IP Address
Fc9-type-14-icon.png IP0
 
Fc9-type-14-icon.png IP1
 
Fc9-type-14-icon.png IP2
 
Fc9-type-14-icon.png IP3
 
Fc9-conn-icon.png MAC Address
Fc9-type-14-icon.png MAC0
 
Fc9-type-14-icon.png MAC1
 
Fc9-type-14-icon.png MAC2
 
Fc9-type-14-icon.png MAC3
 
Fc9-type-14-icon.png MAC4
 
Fc9-type-14-icon.png MAC5
 
Fc9-conn-icon.png Simulation
Fc9-type-10-icon.png Label
 
Fc9-type-16-icon.png 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. 
Fc9-conn-icon.png SPI Simulation
Fc9-type-7-icon.png Scope Traces
Selects if the scope traces are automatically generated or not 
Fc9-type-7-icon.png Console Data
Selects if the console data is automatically generated or not 
Fc9-type-16-icon.png API
 

==Macro reference==

Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Byte1
Specifies the value of the first byte 
Fc9-u8-icon.png - BYTE Byte2
Specifies the value of the second byte 
Fc9-u8-icon.png - BYTE Byte3
Specifies the value of the third byte 
Fc9-u8-icon.png - BYTE Byte4
Specifies the value of the fourth byte 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE IP0
First Byte of IP address 
Fc9-u8-icon.png - BYTE IP1
Second Byte of IP address 
Fc9-u8-icon.png - BYTE IP2
Third Byte of IP address 
Fc9-u8-icon.png - BYTE IP3
Fourth Byte of IP address 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png TxSendString
This macro fills the specified channel's transmit buffer with data. It can fill the buffer with a string of information. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-string-icon.png - STRING Data
Data byte to append to Tx buffer. 
Fc9-u8-icon.png - BYTE Length
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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  
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Idx
Specifies the byte index to return 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Count
Specifies how many bytes to skip 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png MIAC_Module_SetData
 
Fc9-u8-icon.png - BYTE Count
 
Fc9-u8-icon.png - BYTE D0
 
Fc9-u8-icon.png - BYTE D1
 
Fc9-u8-icon.png - BYTE D2
 
Fc9-u8-icon.png - BYTE D3
 
Fc9-u8-icon.png - BYTE D4
 
Fc9-u8-icon.png - BYTE D5
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Protocol
Specifies which IP protocol to use 
Fc9-u8-icon.png - BYTE Broadcast
Allows broadcast type packets to be sent and received 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Dst_IP0
Specifies the first byte of an IP address 
Fc9-u8-icon.png - BYTE Dst_IP1
Specifies the second byte of an IP address 
Fc9-u8-icon.png - BYTE Dst_IP2
Specifies the third byte of an IP address 
Fc9-u8-icon.png - BYTE Dst_IP3
Specifies the fourth byte of an IP address 
Fc9-u16-icon.png - UINT Dst_Port
Destination Port 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png MIAC_Module_GetData
 
Fc9-u8-icon.png - BYTE Index
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png MIAC_Module_Message
 
Fc9-u16-icon.png - UINT CAN_ID
 
Fc9-u16-icon.png - UINT CMD_ID
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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  
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png CreateUDPSocket
This macro creates a socket for sending and receiving UDP data. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u16-icon.png - UINT Src_Port
Port Number 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Byte1
Specifies the value of the first byte 
Fc9-u8-icon.png - BYTE Byte2
Specifies the value of the second byte 
Fc9-u8-icon.png - BYTE Byte3
Specifies the value of the third byte 
Fc9-u8-icon.png - BYTE Byte4
Specifies the value of the fourth byte 
Fc9-u8-icon.png - BYTE Byte5
Specifies the value of the fifth byte 
Fc9-u8-icon.png - BYTE Byte6
Specifies the value of the sixth byte 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Byte1
Specifies the value of the first byte 
Fc9-u8-icon.png - BYTE Byte2
Specifies the value of the second byte 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png TxEnd
Once the transmit buffer has been filled with data, call this macro to actually send the data. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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  
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Length
 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png CreateTCPSocket
This macro creates a socket for sending and receiving TCP data. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u16-icon.png - UINT Src_Port
Port Number 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png MIAC_Module_PushData
 
Fc9-u8-icon.png - BYTE Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Data
Data byte to append to Tx buffer. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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). 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Data
Data byte to append to Tx buffer. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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). 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Dst_IP0
First Byte of IP address 
Fc9-u8-icon.png - BYTE Dst_IP1
Second Byte of IP address 
Fc9-u8-icon.png - BYTE Dst_IP2
Third Byte of IP address 
Fc9-u8-icon.png - BYTE Dst_IP3
Fourth Byte of IP address 
Fc9-u16-icon.png - UINT Dst_Port
Destination Port 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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  
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png RxDataSize
This macro is used to detect the size of data collected by the Rx_data_available macro. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png CreateMACSocket
This macro creates a socket for sending and receiving Ethernet data using raw data. 
Fc9-u8-icon.png - BYTE Promiscuous
Receive everything (1) or just data bound for your MAC (0) 
Fc9-u8-icon.png - BYTE Broadcast
Allows broadcast messages to be accepted (1) or rejected (0) 
Fc9-u8-icon.png - BYTE Error
Allowsmessages with errors to be accepted (1) or rejected (0) 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png CreateUDPSocket_Sim
This macro creates a socket for sending and receiving UDP data. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u16-icon.png - UINT Src_Port
Port Number 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE MAC0
First Byte of address 
Fc9-u8-icon.png - BYTE MAC1
Second Byte of address 
Fc9-u8-icon.png - BYTE MAC2
Third Byte of address 
Fc9-u8-icon.png - BYTE MAC3
Fourth Byte of address 
Fc9-u8-icon.png - BYTE MAC4
Fourth Byte of address 
Fc9-u8-icon.png - BYTE MAC5
Fifth Byte of address 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Byte1
Specifies the value of the first byte 
Fc9-u8-icon.png - BYTE Byte2
Specifies the value of the second byte 
Fc9-u8-icon.png - BYTE Byte3
Specifies the value of the third byte 
Fc9-u8-icon.png - BYTE Byte4
Specifies the value of the fourth byte 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png RxDataSize_Sim
This macro is used to detect the size of data collected by the Rx_data_available macro. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE IP0
First Byte of IP address 
Fc9-u8-icon.png - BYTE IP1
Second Byte of IP address 
Fc9-u8-icon.png - BYTE IP2
Third Byte of IP address 
Fc9-u8-icon.png - BYTE IP3
Fourth Byte of IP address 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Byte1
Specifies the value of the first byte 
Fc9-u8-icon.png - BYTE Byte2
Specifies the value of the second byte 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetSocketStatus
This returns the state of the requested channel's socket. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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  
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE IP0
First Byte of IP address 
Fc9-u8-icon.png - BYTE IP1
Second Byte of IP address 
Fc9-u8-icon.png - BYTE IP2
Third Byte of IP address 
Fc9-u8-icon.png - BYTE IP3
Fourth Byte of IP address 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Connections
Fc9-type-16-icon.png Channel
SPI Channel selector 
Fc9-type-16-icon.png Prescale
Prescale option selector 
Fc9-type-5-icon.png MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. 
Fc9-type-5-icon.png MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. 
Fc9-type-5-icon.png CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master. 
Fc9-type-5-icon.png 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.  
Fc9-conn-icon.png Gateway IP
Fc9-type-14-icon.png Gateway0
 
Fc9-type-14-icon.png Gateway1
 
Fc9-type-14-icon.png Gateway2
 
Fc9-type-14-icon.png Gateway3
 
Fc9-conn-icon.png Subnet Mask
Fc9-type-14-icon.png Subnet0
 
Fc9-type-14-icon.png Subnet1
 
Fc9-type-14-icon.png Subnet2
 
Fc9-type-14-icon.png Subnet3
 
Fc9-conn-icon.png IP Address
Fc9-type-14-icon.png IP0
 
Fc9-type-14-icon.png IP1
 
Fc9-type-14-icon.png IP2
 
Fc9-type-14-icon.png IP3
 
Fc9-conn-icon.png MAC Address
Fc9-type-14-icon.png MAC0
 
Fc9-type-14-icon.png MAC1
 
Fc9-type-14-icon.png MAC2
 
Fc9-type-14-icon.png MAC3
 
Fc9-type-14-icon.png MAC4
 
Fc9-type-14-icon.png MAC5
 
Fc9-conn-icon.png Simulation
Fc9-type-10-icon.png Label
 
Fc9-type-16-icon.png 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. 
Fc9-conn-icon.png SPI Simulation
Fc9-type-7-icon.png Scope Traces
Selects if the scope traces are automatically generated or not 
Fc9-type-7-icon.png Console Data
Selects if the console data is automatically generated or not 
Fc9-type-16-icon.png API
 

==Macro reference==

Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Byte1
Specifies the value of the first byte 
Fc9-u8-icon.png - BYTE Byte2
Specifies the value of the second byte 
Fc9-u8-icon.png - BYTE Byte3
Specifies the value of the third byte 
Fc9-u8-icon.png - BYTE Byte4
Specifies the value of the fourth byte 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE IP0
First Byte of IP address 
Fc9-u8-icon.png - BYTE IP1
Second Byte of IP address 
Fc9-u8-icon.png - BYTE IP2
Third Byte of IP address 
Fc9-u8-icon.png - BYTE IP3
Fourth Byte of IP address 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png TxSendString
This macro fills the specified channel's transmit buffer with data. It can fill the buffer with a string of information. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-string-icon.png - STRING Data
Data byte to append to Tx buffer. 
Fc9-u8-icon.png - BYTE Length
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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  
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Idx
Specifies the byte index to return 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Count
Specifies how many bytes to skip 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png MIAC_Module_SetData
 
Fc9-u8-icon.png - BYTE Count
 
Fc9-u8-icon.png - BYTE D0
 
Fc9-u8-icon.png - BYTE D1
 
Fc9-u8-icon.png - BYTE D2
 
Fc9-u8-icon.png - BYTE D3
 
Fc9-u8-icon.png - BYTE D4
 
Fc9-u8-icon.png - BYTE D5
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Protocol
Specifies which IP protocol to use 
Fc9-u8-icon.png - BYTE Broadcast
Allows broadcast type packets to be sent and received 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Dst_IP0
Specifies the first byte of an IP address 
Fc9-u8-icon.png - BYTE Dst_IP1
Specifies the second byte of an IP address 
Fc9-u8-icon.png - BYTE Dst_IP2
Specifies the third byte of an IP address 
Fc9-u8-icon.png - BYTE Dst_IP3
Specifies the fourth byte of an IP address 
Fc9-u16-icon.png - UINT Dst_Port
Destination Port 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png MIAC_Module_GetData
 
Fc9-u8-icon.png - BYTE Index
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png MIAC_Module_Message
 
Fc9-u16-icon.png - UINT CAN_ID
 
Fc9-u16-icon.png - UINT CMD_ID
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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  
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png CreateUDPSocket
This macro creates a socket for sending and receiving UDP data. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u16-icon.png - UINT Src_Port
Port Number 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Byte1
Specifies the value of the first byte 
Fc9-u8-icon.png - BYTE Byte2
Specifies the value of the second byte 
Fc9-u8-icon.png - BYTE Byte3
Specifies the value of the third byte 
Fc9-u8-icon.png - BYTE Byte4
Specifies the value of the fourth byte 
Fc9-u8-icon.png - BYTE Byte5
Specifies the value of the fifth byte 
Fc9-u8-icon.png - BYTE Byte6
Specifies the value of the sixth byte 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Byte1
Specifies the value of the first byte 
Fc9-u8-icon.png - BYTE Byte2
Specifies the value of the second byte 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png TxEnd
Once the transmit buffer has been filled with data, call this macro to actually send the data. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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  
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Length
 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png CreateTCPSocket
This macro creates a socket for sending and receiving TCP data. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u16-icon.png - UINT Src_Port
Port Number 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png MIAC_Module_PushData
 
Fc9-u8-icon.png - BYTE Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Data
Data byte to append to Tx buffer. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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). 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Data
Data byte to append to Tx buffer. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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). 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Dst_IP0
First Byte of IP address 
Fc9-u8-icon.png - BYTE Dst_IP1
Second Byte of IP address 
Fc9-u8-icon.png - BYTE Dst_IP2
Third Byte of IP address 
Fc9-u8-icon.png - BYTE Dst_IP3
Fourth Byte of IP address 
Fc9-u16-icon.png - UINT Dst_Port
Destination Port 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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  
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png RxDataSize
This macro is used to detect the size of data collected by the Rx_data_available macro. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png CreateMACSocket
This macro creates a socket for sending and receiving Ethernet data using raw data. 
Fc9-u8-icon.png - BYTE Promiscuous
Receive everything (1) or just data bound for your MAC (0) 
Fc9-u8-icon.png - BYTE Broadcast
Allows broadcast messages to be accepted (1) or rejected (0) 
Fc9-u8-icon.png - BYTE Error
Allowsmessages with errors to be accepted (1) or rejected (0) 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png CreateUDPSocket_Sim
This macro creates a socket for sending and receiving UDP data. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u16-icon.png - UINT Src_Port
Port Number 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE MAC0
First Byte of address 
Fc9-u8-icon.png - BYTE MAC1
Second Byte of address 
Fc9-u8-icon.png - BYTE MAC2
Third Byte of address 
Fc9-u8-icon.png - BYTE MAC3
Fourth Byte of address 
Fc9-u8-icon.png - BYTE MAC4
Fourth Byte of address 
Fc9-u8-icon.png - BYTE MAC5
Fifth Byte of address 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Byte1
Specifies the value of the first byte 
Fc9-u8-icon.png - BYTE Byte2
Specifies the value of the second byte 
Fc9-u8-icon.png - BYTE Byte3
Specifies the value of the third byte 
Fc9-u8-icon.png - BYTE Byte4
Specifies the value of the fourth byte 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png RxDataSize_Sim
This macro is used to detect the size of data collected by the Rx_data_available macro. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE IP0
First Byte of IP address 
Fc9-u8-icon.png - BYTE IP1
Second Byte of IP address 
Fc9-u8-icon.png - BYTE IP2
Third Byte of IP address 
Fc9-u8-icon.png - BYTE IP3
Fourth Byte of IP address 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Byte1
Specifies the value of the first byte 
Fc9-u8-icon.png - BYTE Byte2
Specifies the value of the second byte 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetSocketStatus
This returns the state of the requested channel's socket. 
Fc9-u8-icon.png - BYTE Channel
Specifies the communications channel 0-3 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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  
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE IP0
First Byte of IP address 
Fc9-u8-icon.png - BYTE IP1
Second Byte of IP address 
Fc9-u8-icon.png - BYTE IP2
Third Byte of IP address 
Fc9-u8-icon.png - BYTE IP3
Fourth Byte of IP address 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Connections
Fc9-type-16-icon.png Channel
SPI Channel selector 
Fc9-type-16-icon.png Prescale
Prescale option selector 
Fc9-type-5-icon.png MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. 
Fc9-type-5-icon.png MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. 
Fc9-type-5-icon.png CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master. 
Fc9-type-5-icon.png 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.  
Fc9-conn-icon.png Gateway IP
Fc9-type-14-icon.png Gateway0
 
Fc9-type-14-icon.png Gateway1
 
Fc9-type-14-icon.png Gateway2
 
Fc9-type-14-icon.png Gateway3
 
Fc9-conn-icon.png Subnet Mask
Fc9-type-14-icon.png Subnet0
 
Fc9-type-14-icon.png Subnet1
 
Fc9-type-14-icon.png Subnet2
 
Fc9-type-14-icon.png Subnet3
 
Fc9-conn-icon.png IP Address
Fc9-type-14-icon.png IP0
 
Fc9-type-14-icon.png IP1
 
Fc9-type-14-icon.png IP2
 
Fc9-type-14-icon.png IP3
 
Fc9-conn-icon.png MAC Address
Fc9-type-14-icon.png MAC0
 
Fc9-type-14-icon.png MAC1
 
Fc9-type-14-icon.png MAC2
 
Fc9-type-14-icon.png MAC3
 
Fc9-type-14-icon.png MAC4
 
Fc9-type-14-icon.png MAC5
 
Fc9-conn-icon.png Simulation
Fc9-type-10-icon.png Label
 
Fc9-type-16-icon.png 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. 
Fc9-conn-icon.png SPI Simulation
Fc9-type-7-icon.png Scope Traces
Selects if the scope traces are automatically generated or not 
Fc9-type-7-icon.png Console Data
Selects if the console data is automatically generated or not 
Fc9-type-16-icon.png API
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_TCP/IP_(EB023_v2)_(E-blocks_1)&oldid=34550"