Component: TCP/IP DUMMY (NM7010A) (Comms: Networking): Difference between revisions
No edit summary |
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead"" |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 92: | Line 92: | ||
===CreateIPSocket=== | ===CreateIPSocket=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 121: | Line 121: | ||
===CreateIPSocket_Sim=== | ===CreateIPSocket_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CreateIPSocket_Sim''' | ||
|- | |- | ||
| 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. | | 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. | ||
| Line 150: | Line 150: | ||
===CreateMACSocket=== | ===CreateMACSocket=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CreateMACSocket''' | ||
|- | |- | ||
| colspan="2" | This macro creates a socket for sending and receiving Ethernet data using raw data. | | colspan="2" | This macro creates a socket for sending and receiving Ethernet data using raw data. | ||
| Line 179: | Line 179: | ||
===CreateMACSocket_Sim=== | ===CreateMACSocket_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CreateMACSocket_Sim''' | ||
|- | |- | ||
| colspan="2" | This macro creates a socket for sending and receiving Ethernet data using raw data. | | colspan="2" | This macro creates a socket for sending and receiving Ethernet data using raw data. | ||
| Line 208: | Line 208: | ||
===CreateTCPSocket=== | ===CreateTCPSocket=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CreateTCPSocket''' | ||
|- | |- | ||
| colspan="2" | This macro creates a socket for sending and receiving TCP data. | | colspan="2" | This macro creates a socket for sending and receiving TCP data. | ||
| Line 237: | Line 237: | ||
===CreateTCPSocket_Sim=== | ===CreateTCPSocket_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CreateTCPSocket_Sim''' | ||
|- | |- | ||
| colspan="2" | This macro creates a socket for sending and receiving TCP data. | | colspan="2" | This macro creates a socket for sending and receiving TCP data. | ||
| Line 266: | Line 266: | ||
===CreateUDPSocket=== | ===CreateUDPSocket=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CreateUDPSocket''' | ||
|- | |- | ||
| colspan="2" | This macro creates a socket for sending and receiving UDP data. | | colspan="2" | This macro creates a socket for sending and receiving UDP data. | ||
| Line 295: | Line 295: | ||
===CreateUDPSocket_Sim=== | ===CreateUDPSocket_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CreateUDPSocket_Sim''' | ||
|- | |- | ||
| colspan="2" | This macro creates a socket for sending and receiving UDP data. | | colspan="2" | This macro creates a socket for sending and receiving UDP data. | ||
| Line 324: | Line 324: | ||
===GetSocketStatus=== | ===GetSocketStatus=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetSocketStatus''' | ||
|- | |- | ||
| colspan="2" | This returns the state of the requested channel's socket. | | colspan="2" | This returns the state of the requested channel's socket. | ||
| Line 343: | Line 343: | ||
===GetSocketStatus_Sim=== | ===GetSocketStatus_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetSocketStatus_Sim''' | ||
|- | |- | ||
| colspan="2" | This returns the state of the requested channel's socket. | | colspan="2" | This returns the state of the requested channel's socket. | ||
| Line 362: | Line 362: | ||
===Initialise=== | ===Initialise=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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 | | 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 | ||
| Line 376: | Line 376: | ||
===InitialiseSim=== | ===InitialiseSim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''InitialiseSim''' | ||
|- | |- | ||
| 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 | | 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 | ||
| Line 390: | Line 390: | ||
===RxDataAvailable=== | ===RxDataAvailable=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 409: | Line 409: | ||
===RxDataAvailable_Sim=== | ===RxDataAvailable_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''RxDataAvailable_Sim''' | ||
|- | |- | ||
| 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. | | 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. | ||
| Line 428: | Line 428: | ||
===RxDataSize=== | ===RxDataSize=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''RxDataSize''' | ||
|- | |- | ||
| colspan="2" | This macro is used to detect the size of data collected by the Rx_data_available macro. | | colspan="2" | This macro is used to detect the size of data collected by the Rx_data_available macro. | ||
| Line 447: | Line 447: | ||
===RxDataSize_Sim=== | ===RxDataSize_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''RxDataSize_Sim''' | ||
|- | |- | ||
| colspan="2" | This macro is used to detect the size of data collected by the Rx_data_available macro. | | colspan="2" | This macro is used to detect the size of data collected by the Rx_data_available macro. | ||
| Line 466: | Line 466: | ||
===RxFlushData=== | ===RxFlushData=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 485: | Line 485: | ||
===RxFlushData_Sim=== | ===RxFlushData_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 504: | Line 504: | ||
===RxMatchMyIP=== | ===RxMatchMyIP=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 523: | Line 523: | ||
===RxMatchMyIP_Sim=== | ===RxMatchMyIP_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''RxMatchMyIP_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. | | 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. | ||
| Line 542: | Line 542: | ||
===RxMatchMyMAC=== | ===RxMatchMyMAC=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 561: | Line 561: | ||
===RxMatchMyMAC_Sim=== | ===RxMatchMyMAC_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 580: | Line 580: | ||
===RxMatch_2_Bytes=== | ===RxMatch_2_Bytes=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 609: | Line 609: | ||
===RxMatch_2_Bytes_Sim=== | ===RxMatch_2_Bytes_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 638: | Line 638: | ||
===RxMatch_4_Bytes=== | ===RxMatch_4_Bytes=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 677: | Line 677: | ||
===RxMatch_4_Bytes_Sim=== | ===RxMatch_4_Bytes_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 716: | Line 716: | ||
===RxMatch_6_Bytes=== | ===RxMatch_6_Bytes=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 765: | Line 765: | ||
===RxMatch_6_Bytes_Sim=== | ===RxMatch_6_Bytes_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''RxMatch_6_Bytes_Sim''' | ||
|- | |- | ||
| 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. | | 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. | ||
| Line 814: | Line 814: | ||
===RxReadByte=== | ===RxReadByte=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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 | | 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 | ||
| Line 833: | Line 833: | ||
===RxReadByte_Sim=== | ===RxReadByte_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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 | | 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 | ||
| Line 852: | Line 852: | ||
===RxReadHeader=== | ===RxReadHeader=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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 | | 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 | ||
| Line 876: | Line 876: | ||
===RxReadHeader_Sim=== | ===RxReadHeader_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''RxReadHeader_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 | | 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 | ||
| Line 900: | Line 900: | ||
===RxReadString=== | ===RxReadString=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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 | | 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 | ||
| Line 924: | Line 924: | ||
===RxReadString_Sim=== | ===RxReadString_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''RxReadString_Sim''' | ||
|- | |- | ||
| 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 | | 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 | ||
| Line 948: | Line 948: | ||
===RxSkipBytes=== | ===RxSkipBytes=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 972: | Line 972: | ||
===RxSkipBytes_Sim=== | ===RxSkipBytes_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''RxSkipBytes_Sim''' | ||
|- | |- | ||
| 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. | | 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. | ||
| Line 996: | Line 996: | ||
===SetDestination=== | ===SetDestination=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 1,045: | Line 1,045: | ||
===SetDestination_Sim=== | ===SetDestination_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetDestination_Sim''' | ||
|- | |- | ||
| 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. | | 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. | ||
| Line 1,094: | Line 1,094: | ||
===SetMyIP=== | ===SetMyIP=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 1,128: | Line 1,128: | ||
===TCPClose=== | ===TCPClose=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 1,147: | Line 1,147: | ||
===TCPClose_Sim=== | ===TCPClose_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''TCPClose_Sim''' | ||
|- | |- | ||
| 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. | | 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. | ||
| Line 1,166: | Line 1,166: | ||
===TCPConnect=== | ===TCPConnect=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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). | | 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). | ||
| Line 1,215: | Line 1,215: | ||
===TCPConnect_Sim=== | ===TCPConnect_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''TCPConnect_Sim''' | ||
|- | |- | ||
| 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). | | 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). | ||
| Line 1,264: | Line 1,264: | ||
===TCPListen=== | ===TCPListen=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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). | | 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). | ||
| Line 1,283: | Line 1,283: | ||
===TCPListen_Sim=== | ===TCPListen_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''TCPListen_Sim''' | ||
|- | |- | ||
| 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). | | 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). | ||
| Line 1,302: | Line 1,302: | ||
===TxEnd=== | ===TxEnd=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''TxEnd''' | ||
|- | |- | ||
| colspan="2" | Once the transmit buffer has been filled with data, call this macro to actually send the data. | | colspan="2" | Once the transmit buffer has been filled with data, call this macro to actually send the data. | ||
| Line 1,321: | Line 1,321: | ||
===TxEnd_Sim=== | ===TxEnd_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''TxEnd_Sim''' | ||
|- | |- | ||
| colspan="2" | Once the transmit buffer has been filled with data, call this macro to actually send the data. | | colspan="2" | Once the transmit buffer has been filled with data, call this macro to actually send the data. | ||
| Line 1,340: | Line 1,340: | ||
===TxSendByte=== | ===TxSendByte=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 1,364: | Line 1,364: | ||
===TxSendByte_Sim=== | ===TxSendByte_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 1,388: | Line 1,388: | ||
===TxSendMyIP=== | ===TxSendMyIP=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 1,407: | Line 1,407: | ||
===TxSendMyIP_Sim=== | ===TxSendMyIP_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''TxSendMyIP_Sim''' | ||
|- | |- | ||
| 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. | | 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. | ||
| Line 1,426: | Line 1,426: | ||
===TxSendMyMAC=== | ===TxSendMyMAC=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 1,445: | Line 1,445: | ||
===TxSendMyMAC_Sim=== | ===TxSendMyMAC_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''TxSendMyMAC_Sim''' | ||
|- | |- | ||
| 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. | | 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. | ||
| Line 1,464: | Line 1,464: | ||
===TxSendString=== | ===TxSendString=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''TxSendString''' | ||
|- | |- | ||
| colspan="2" | This macro fills the specified channel's transmit buffer with data. It can fill the buffer with a string of information. | | colspan="2" | This macro fills the specified channel's transmit buffer with data. It can fill the buffer with a string of information. | ||
| Line 1,493: | Line 1,493: | ||
===TxSendString_Sim=== | ===TxSendString_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''TxSendString_Sim''' | ||
|- | |- | ||
| colspan="2" | This macro fills the specified channel's transmit buffer with data. It can fill the buffer with a string of information. | | colspan="2" | This macro fills the specified channel's transmit buffer with data. It can fill the buffer with a string of information. | ||
| Line 1,522: | Line 1,522: | ||
===TxStart=== | ===TxStart=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 1,541: | Line 1,541: | ||
===TxStart_Sim=== | ===TxStart_Sim=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''TxStart_Sim''' | ||
|- | |- | ||
| 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. | | 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. | ||
| Line 1,561: | Line 1,561: | ||
==Property reference== | ==Property reference== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Properties''' | ||
|- | |- | ||
|} | |} | ||
Latest revision as of 14:23, 13 July 2026
| Author | Matrix Ltd |
| Version | 2.0 |
| Category | Comms: Networking |
TCP/IP DUMMY component
TCP/IP component designed to work with the WIZ3100 range of modules from Wiznet. Also available in the form of the version 1 EB023 E-block which uses the NM7010A module.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_TCPIP_EB023-00-1_Dummy.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_TCPIP_EB023-00-1_Dummy.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
CreateIPSocket
|
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. | |
 - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Protocol |
| Specifies which IP protocol to use | |
| - BYTE
|
Broadcast |
| Allows broadcast type packets to be sent and received | |
| - BYTE
|
Return |
CreateIPSocket_Sim
|
|
CreateIPSocket_Sim |
| 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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Protocol |
| Specifies which IP protocol to use | |
| - BYTE
|
Broadcast |
| Allows broadcast type packets to be sent and received | |
| - BYTE
|
Return |
CreateMACSocket
|
|
CreateMACSocket |
| This macro creates a socket for sending and receiving Ethernet data using raw data. | |
| - BYTE
|
Promiscuous |
| Receive everything (1) or just data bound for your MAC (0) | |
| - BYTE
|
Broadcast |
| Allows broadcast messages to be accepted (1) or rejected (0) | |
| - BYTE
|
Error |
| Allowsmessages with errors to be accepted (1) or rejected (0) | |
| - BYTE
|
Return |
CreateMACSocket_Sim
|
|
CreateMACSocket_Sim |
| This macro creates a socket for sending and receiving Ethernet data using raw data. | |
| - BYTE
|
Promiscuous |
| Receive everything (1) or just data bound for your MAC (0) | |
| - BYTE
|
Broadcast |
| Allows broadcast messages to be accepted (1) or rejected (0) | |
| - BYTE
|
Error |
| Allowsmessages with errors to be accepted (1) or rejected (0) | |
| - BYTE
|
Return |
CreateTCPSocket
|
|
CreateTCPSocket |
| This macro creates a socket for sending and receiving TCP data. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Src_Port_Hi |
| Port High Byte | |
| - BYTE
|
Src_Port_Lo |
| Port Low Byte | |
| - BYTE
|
Return |
CreateTCPSocket_Sim
|
|
CreateTCPSocket_Sim |
| This macro creates a socket for sending and receiving TCP data. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Src_Port_Hi |
| Port High Byte | |
| - BYTE
|
Src_Port_Lo |
| Port Low Byte | |
| - BYTE
|
Return |
CreateUDPSocket
|
|
CreateUDPSocket |
| This macro creates a socket for sending and receiving UDP data. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Src_Port_Hi |
| Port High Byte | |
| - BYTE
|
Src_Port_Lo |
| Port Low Byte | |
| - BYTE
|
Return |
CreateUDPSocket_Sim
|
|
CreateUDPSocket_Sim |
| This macro creates a socket for sending and receiving UDP data. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Src_Port_Hi |
| Port High Byte | |
| - BYTE
|
Src_Port_Lo |
| Port Low Byte | |
| - BYTE
|
Return |
GetSocketStatus
|
|
GetSocketStatus |
| This returns the state of the requested channel's socket. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Return |
GetSocketStatus_Sim
|
|
GetSocketStatus_Sim |
| This returns the state of the requested channel's socket. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Return |
Initialise
|
|
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 | |
 - VOID
|
Return |
InitialiseSim
|
|
InitialiseSim |
| 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 | |
| - VOID
|
Return |
RxDataAvailable
|
|
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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Return |
RxDataAvailable_Sim
|
|
RxDataAvailable_Sim |
| 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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Return |
RxDataSize
|
|
RxDataSize |
| This macro is used to detect the size of data collected by the Rx_data_available macro. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
 - UINT
|
Return |
RxDataSize_Sim
|
|
RxDataSize_Sim |
| This macro is used to detect the size of data collected by the Rx_data_available macro. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Return |
RxFlushData
|
|
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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - VOID
|
Return |
RxFlushData_Sim
|
|
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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - VOID
|
Return |
RxMatchMyIP
|
|
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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Return |
RxMatchMyIP_Sim
|
|
RxMatchMyIP_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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Return |
RxMatchMyMAC
|
|
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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Return |
RxMatchMyMAC_Sim
|
|
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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Return |
RxMatch_2_Bytes
|
|
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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Byte1 |
| Specifies the value of the first byte | |
| - BYTE
|
Byte2 |
| Specifies the value of the second byte | |
| - BYTE
|
Return |
RxMatch_2_Bytes_Sim
|
|
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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Byte1 |
| Specifies the value of the first byte | |
| - BYTE
|
Byte2 |
| Specifies the value of the second byte | |
| - BYTE
|
Return |
RxMatch_4_Bytes
|
|
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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Byte1 |
| Specifies the value of the first byte | |
| - BYTE
|
Byte2 |
| Specifies the value of the second byte | |
| - BYTE
|
Byte3 |
| Specifies the value of the third byte | |
| - BYTE
|
Byte4 |
| Specifies the value of the fourth byte | |
| - BYTE
|
Return |
RxMatch_4_Bytes_Sim
|
|
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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Byte1 |
| Specifies the value of the first byte | |
| - BYTE
|
Byte2 |
| Specifies the value of the second byte | |
| - BYTE
|
Byte3 |
| Specifies the value of the third byte | |
| - BYTE
|
Byte4 |
| Specifies the value of the fourth byte | |
| - BYTE
|
Return |
RxMatch_6_Bytes
|
|
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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Byte1 |
| Specifies the value of the first byte | |
| - BYTE
|
Byte2 |
| Specifies the value of the second byte | |
| - BYTE
|
Byte3 |
| Specifies the value of the third byte | |
| - BYTE
|
Byte4 |
| Specifies the value of the fourth byte | |
| - BYTE
|
Byte5 |
| Specifies the value of the fifth byte | |
| - BYTE
|
Byte6 |
| Specifies the value of the sixth byte | |
| - BYTE
|
Return |
RxMatch_6_Bytes_Sim
|
|
RxMatch_6_Bytes_Sim |
| 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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Byte1 |
| Specifies the value of the first byte | |
| - BYTE
|
Byte2 |
| Specifies the value of the second byte | |
| - BYTE
|
Byte3 |
| Specifies the value of the third byte | |
| - BYTE
|
Byte4 |
| Specifies the value of the fourth byte | |
| - BYTE
|
Byte5 |
| Specifies the value of the fifth byte | |
| - BYTE
|
Byte6 |
| Specifies the value of the sixth byte | |
| - BYTE
|
Return |
RxReadByte
|
|
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 | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Return |
RxReadByte_Sim
|
|
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 | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Return |
RxReadHeader
|
|
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 | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Idx |
| Specifies the byte index to return | |
| - BYTE
|
Return |
RxReadHeader_Sim
|
|
RxReadHeader_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 | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Idx |
| - BYTE
|
Return |
RxReadString
|
|
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 | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Length |
 - STRING
|
Return |
RxReadString_Sim
|
|
RxReadString_Sim |
| 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 | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Length |
| - STRING
|
Return |
RxSkipBytes
|
|
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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Count |
| Specifies how many bytes to skip | |
| - VOID
|
Return |
RxSkipBytes_Sim
|
|
RxSkipBytes_Sim |
| 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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Count |
| Specifies how many bytes to skip | |
| - VOID
|
Return |
SetDestination
|
|
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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Dst_IP0 |
| Specifies the first byte of an IP address | |
| - BYTE
|
Dst_IP1 |
| Specifies the second byte of an IP address | |
| - BYTE
|
Dst_IP2 |
| Specifies the third byte of an IP address | |
| - BYTE
|
Dst_IP3 |
| Specifies the fourth byte of an IP address | |
| - BYTE
|
Dst_Port_Hi |
| Port High Byte | |
| - BYTE
|
Dst_Port_Lo |
| Port Low Byte | |
| - BYTE
|
Return |
SetDestination_Sim
|
|
SetDestination_Sim |
| 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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Dst_IP0 |
| Specifies the first byte of an IP address | |
| - BYTE
|
Dst_IP1 |
| Specifies the second byte of an IP address | |
| - BYTE
|
Dst_IP2 |
| Specifies the third byte of an IP address | |
| - BYTE
|
Dst_IP3 |
| Specifies the fourth byte of an IP address | |
| - BYTE
|
Dst_Port_Hi |
| Port High Byte | |
| - BYTE
|
Dst_Port_Lo |
| Port Low Byte | |
| - VOID
|
Return |
SetMyIP
|
|
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. | |
| - BYTE
|
IP0 |
| First Byte of IP address | |
| - BYTE
|
IP1 |
| Second Byte of IP address | |
| - BYTE
|
IP2 |
| Third Byte of IP address | |
| - BYTE
|
IP3 |
| Fourth Byte of IP address | |
| - VOID
|
Return |
TCPClose
|
|
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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - VOID
|
Return |
TCPClose_Sim
|
|
TCPClose_Sim |
| 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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - VOID
|
Return |
TCPConnect
|
|
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). | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Dst_IP0 |
| First Byte of IP address | |
| - BYTE
|
Dst_IP1 |
| Second Byte of IP address | |
| - BYTE
|
Dst_IP2 |
| Third Byte of IP address | |
| - BYTE
|
Dst_IP3 |
| Fourth Byte of IP address | |
| - BYTE
|
Dst_Port_Hi |
| High Byte of destination port | |
| - BYTE
|
Dst_Port_Lo |
| Low Byte of destination port | |
| - BYTE
|
Return |
TCPConnect_Sim
|
|
TCPConnect_Sim |
| 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). | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Dst_IP0 |
| First Byte of IP address | |
| - BYTE
|
Dst_IP1 |
| Second Byte of IP address | |
| - BYTE
|
Dst_IP2 |
| Third Byte of IP address | |
| - BYTE
|
Dst_IP3 |
| Fourth Byte of IP address | |
| - BYTE
|
Dst_Port_Hi |
| High Byte of destination port | |
| - BYTE
|
Dst_Port_Lo |
| Low Byte of destination port | |
| - BYTE
|
Return |
TCPListen
|
|
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). | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - VOID
|
Return |
TCPListen_Sim
|
|
TCPListen_Sim |
| 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). | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - VOID
|
Return |
TxEnd
|
|
TxEnd |
| Once the transmit buffer has been filled with data, call this macro to actually send the data. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - VOID
|
Return |
TxEnd_Sim
|
|
TxEnd_Sim |
| Once the transmit buffer has been filled with data, call this macro to actually send the data. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - VOID
|
Return |
TxSendByte
|
|
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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Data |
| Data byte to append to Tx buffer. | |
| - VOID
|
Return |
TxSendByte_Sim
|
|
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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - BYTE
|
Data |
| Data byte to append to Tx buffer. | |
| - VOID
|
Return |
TxSendMyIP
|
|
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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - VOID
|
Return |
TxSendMyIP_Sim
|
|
TxSendMyIP_Sim |
| 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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - VOID
|
Return |
TxSendMyMAC
|
|
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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - VOID
|
Return |
TxSendMyMAC_Sim
|
|
TxSendMyMAC_Sim |
| 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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - VOID
|
Return |
TxSendString
|
|
TxSendString |
| This macro fills the specified channel's transmit buffer with data. It can fill the buffer with a string of information. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - STRING
|
Data |
| Data byte to append to Tx buffer. | |
| - BYTE
|
Length |
| - VOID
|
Return |
TxSendString_Sim
|
|
TxSendString_Sim |
| This macro fills the specified channel's transmit buffer with data. It can fill the buffer with a string of information. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - STRING
|
Data |
| Data byte to append to Tx buffer. | |
| - BYTE
|
Length |
| - VOID
|
Return |
TxStart
|
|
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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - VOID
|
Return |
TxStart_Sim
|
|
TxStart_Sim |
| 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. | |
| - BYTE
|
Channel |
| Specifies the communications channel 0-3 | |
| - VOID
|
Return |
Property reference
|
Properties |