Difference between revisions of "Component: TCP/IP Dummy (Raspberry Pi) (Comms: Networking)"

From Flowcode Help
Jump to navigationJump to search
 
(7 intermediate revisions by the same user not shown)
Line 17: Line 17:
 
==Component Source Code==
 
==Component Source Code==
  
−
Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_TCPIP_RPI_Dummy.fcfx FC_Comp_Source_TCPIP_RPI_Dummy.fcfx]
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_TCPIP_RPI_Dummy.fcfx FC_Comp_Source_TCPIP_RPI_Dummy.fcfx]
 +
 
 +
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_TCPIP_RPI_Dummy.fcfx FC_Comp_Source_TCPIP_RPI_Dummy.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
 +
 +
 +
 +
 +
 +
  
  
Line 40: Line 50:
  
 
==Examples==
 
==Examples==
 +
 +
 +
 +
 +
 +
 +
 +
  
  
Line 67: Line 85:
  
 
{{Fcfile|NetworkComms-RPI-Server.fcfx|Example RPI HTML Webserver}}
 
{{Fcfile|NetworkComms-RPI-Server.fcfx|Example RPI HTML Webserver}}
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
 
==Macro reference==
 
==Macro reference==
  
 +
===AcceptClose===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connect'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AcceptClose'''
 
|-
 
|-
−
| colspan="2" | Attempt to connect to the given address and port. First open a socket on the local device using the Socket function and check that it is successful.  
+
| colspan="2" | Close the accept socket 
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
−
| width="90%" | Address
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 
 +
 
 +
===AcceptOpen===
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
−
| colspan="2" | Remote destination address 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AcceptOpen'''
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+
| colspan="2" |  
−
| width="90%" | Port
 
 
|-
 
|-
−
| colspan="2" | Remote destination port 
 
 
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
Line 93: Line 126:
  
  
 +
===Connect===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Receive'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connect'''
 
|-
 
|-
−
| colspan="2" | Receive data into the data buffer. Returns the number of bytes received 
+
| colspan="2" | Attempt to connect to the given address and port. First open a socket on the local device using the Socket function and check that it is successful.  
 
|-
 
|-
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
−
| width="90%" | Data
+
| width="90%" | Address
 
|-
 
|-
−
| colspan="2" | Data byte buffer to receive the data 
+
| colspan="2" | Remote destination address 
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
−
| width="90%" | Count
+
| width="90%" | Port
 
|-
 
|-
−
| colspan="2" | Maximum number of bytes to read 
+
| colspan="2" | Remote destination port 
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
+
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
 +
===Initialise===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Send'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 
|-
 
|-
−
| colspan="2" | Send data 
+
| colspan="2" |  
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
−
| width="90%" | Data
 
−
|-
 
−
| colspan="2" | Data byte buffer to send 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Count
 
−
|-
 
−
| colspan="2" | Number of bytes to send 
 
−
|-
 
−
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
 +
===Listen===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 157: Line 183:
  
  
 +
===Receive===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SocketOpen'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Receive'''
 +
|-
 +
| colspan="2" | Receive data into the data buffer. Returns the number of bytes received 
 +
|-
 
|-
 
|-
−
| colspan="2" | Attempts to create a socket on the local device. Type =0 for TCP, =1 for UDP This must be successfully done before attempting connection with a remote destination. Returns 1 if successful, 0 if not. 
+
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Data
 
|-
 
|-
 +
| colspan="2" | Data byte buffer to receive the data 
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
−
| width="90%" | Type
+
| width="90%" | Count
 
|-
 
|-
−
| colspan="2" | Type of socket to create 
+
| colspan="2" | Maximum number of bytes to read 
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
 +
===Send===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SocketClose'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Send'''
 
|-
 
|-
−
| colspan="2" | Close the socket 
+
| colspan="2" | Send data 
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
+
| width="90%" | Data
−
|}
 
−
 
 
−
 
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
 
|-
 
|-
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+
| colspan="2" | Data byte buffer to send 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AcceptOpen'''
 
 
|-
 
|-
−
| colspan="2" |  
+
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Count
 
|-
 
|-
 +
| colspan="2" | Number of bytes to send 
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
 +
===SocketClose===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AcceptClose'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SocketClose'''
 
|-
 
|-
−
| colspan="2" | Close the accept socket 
+
| colspan="2" | Close the socket 
 
|-
 
|-
 
|-
 
|-
Line 214: Line 245:
  
  
 +
===SocketOpen===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SocketOpen'''
 +
|-
 +
| colspan="2" | Attempts to create a socket on the local device. Type =0 for TCP, =1 for UDP This must be successfully done before attempting connection with a remote destination. Returns 1 if successful, 0 if not. 
 +
|-
 
|-
 
|-
−
| colspan="2" |  
+
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Type
 
|-
 
|-
 +
| colspan="2" | Type of socket to create 
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
−
 
−
 
  
  

Latest revision as of 13:13, 7 February 2023

Author Matrix Ltd.
Version 1.8
Category Comms: Networking


TCP/IP Dummy component

TCP/IP sockets component for use with Raspberry Pi. Raspberry Pi Only

Component Source Code

Please click here to download the component source project: FC_Comp_Source_TCPIP_RPI_Dummy.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_TCPIP_RPI_Dummy.fcfx

Detailed description

No detailed description exists yet for this component

Examples

Here is an example of using the TCP/IP component as a means to request data from a remote server on the internet or local network.

FC6 Icon.png Example RPI Client Request Data


Here is an example of using the TCP/IP component as a means to serve data to a client via the internet or local network.

FC6 Icon.png Example RPI HTML Webserver






Macro reference

AcceptClose

Fc9-comp-macro.png AcceptClose
Close the accept socket 
Fc9-void-icon.png - VOID Return


AcceptOpen

Fc9-comp-macro.png AcceptOpen
 
Fc9-u8-icon.png - BYTE Return


Connect

Fc9-comp-macro.png Connect
Attempt to connect to the given address and port. First open a socket on the local device using the Socket function and check that it is successful.  
Fc9-string-icon.png - STRING Address
Remote destination address 
Fc9-u16-icon.png - UINT Port
Remote destination port 
Fc9-u8-icon.png - BYTE Return


Initialise

Fc9-comp-macro.png Initialise
 
Fc9-void-icon.png - VOID Return


Listen

Fc9-comp-macro.png Listen
Bind the socket to a port on the local host and set to listen mode. First open a socket on the local device using the Socket function and check that it is successful.  
Fc9-u16-icon.png - UINT Port
 
Fc9-u8-icon.png - BYTE Return


Receive

Fc9-comp-macro.png Receive
Receive data into the data buffer. Returns the number of bytes received 
Fc9-string-icon.png - STRING Data
Data byte buffer to receive the data 
Fc9-u16-icon.png - UINT Count
Maximum number of bytes to read 
Fc9-u16-icon.png - UINT Return


Send

Fc9-comp-macro.png Send
Send data 
Fc9-string-icon.png - STRING Data
Data byte buffer to send 
Fc9-u16-icon.png - UINT Count
Number of bytes to send 
Fc9-u16-icon.png - UINT Return


SocketClose

Fc9-comp-macro.png SocketClose
Close the socket 
Fc9-void-icon.png - VOID Return


SocketOpen

Fc9-comp-macro.png SocketOpen
Attempts to create a socket on the local device. Type =0 for TCP, =1 for UDP This must be successfully done before attempting connection with a remote destination. Returns 1 if successful, 0 if not. 
Fc9-u8-icon.png - BYTE Type
Type of socket to create 
Fc9-u8-icon.png - BYTE Return


Property reference

Fc9-prop-icon.png Properties
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_TCP/IP_Dummy_(Raspberry_Pi)_(Comms:_Networking)&oldid=38361"