TCP Server and Client Configuration TDK Standard Edition. In a teleoperation-over-WAN setup, there are one robot + one edge device on each side of the teleoperation. One edge device needs to function as a TCP server while the other device functions as a TCP client. It does not matter which side is configured as TCP server or client. However, while the edge device for TCP client doesn't need any additional configuration other than connecting to the Internet, the TCP server needs to complete the following additional steps:
More...
#include <data.hpp>
- In the settings of the network router that the edge device for TCP server is connected to, enable NAT (network address translation). This is usually enabled by default on modern routers.
- Note down the private (WAN) IPv4 address assigned to the edge device for TCP server.
- In the router settings, add TCP port forwarding rule for the IPv4 address noted in step 2. The port number can be set to any unoccupied one. Use this port number as the [listening_port] constructor parameter for BOTH sides of teleoperation.
- On the edge device for TCP server, open https://whatismyipaddress.com/ and note down its public IPv4 address. Use this address as the [public_ipv4_address] constructor parameter for BOTH sides of teleoperation.
- Examples
- transparent_cartesian_teleop_wan.cpp.
Definition at line 52 of file data.hpp.
◆ is_tcp_server
| bool flexiv::tdk::NetworkCfgStd::is_tcp_server |
- Parameters
-
| is_tcp_server | True : the machine running this instance functions as the TCP server; false: functions as the TCP client. If true, then the machine on the other side of teleoperation needs to function as the TCP client. It does not matter which side functions as the TCP server, however, the server side must configure its network router with NAT and TCP port forwarding. |
- Examples
- transparent_cartesian_teleop_wan.cpp.
Definition at line 61 of file data.hpp.
◆ lan_interface_whitelist
| std::vector<std::string> flexiv::tdk::NetworkCfgStd::lan_interface_whitelist = {} |
- Parameters
-
| lan_interface_whitelist | Limit the network interface(s) that can be used to try to establish connection with the robot via ethernet cable. The whitelisted network interface is defined by its associated IPv4 address. For example, {"10.42.0.1", "192.168.2.102"}. If left empty, all available network interfaces will be tried when searching for connection. |
- Examples
- transparent_cartesian_teleop_wan.cpp.
Definition at line 82 of file data.hpp.
◆ listening_port
| unsigned int flexiv::tdk::NetworkCfgStd::listening_port |
- Parameters
-
| listening_port | Number of the port configured with TCP port forwarding. Both sides of the teleoperation need to set the same listening port. |
- Examples
- transparent_cartesian_teleop_wan.cpp.
Definition at line 74 of file data.hpp.
◆ public_ipv4_address
| std::string flexiv::tdk::NetworkCfgStd::public_ipv4_address |
◆ wan_interface_whitelist
| std::vector<std::string> flexiv::tdk::NetworkCfgStd::wan_interface_whitelist = {} |
- Parameters
-
| wan_interface_whitelist | Limit the network interface(s) that can be used to try to establish connection with another participant. The whitelist uses OS-level interface names (for example {"wlo1", "enp3s0"}). If empty, all available network interfaces will be tried when searching for connection. |
- Examples
- transparent_cartesian_teleop_wan.cpp.
Definition at line 90 of file data.hpp.
The documentation for this struct was generated from the following file: