Remote serial

RFC 2217 server

Share this machine's physical port, with the client able to change baud rate, framing and DTR/RTS.

On this page

RFC 2217 server (share this machine's serial port)

An RFC 2217 server exposes this machine's physical serial port over TCP. A remote client can not only exchange data but also change baud rate, framing, flow control and DTR/RTS — that control travels over the same connection as the data.

Plain TCP forwarding only carries bytes. If the remote side must change baud rate, parity or control lines, both ends must use RFC 2217.

The client must be able to reach this machine's IP address and listening port directly. This usually means the same LAN or an already connected VPN. For the trade-off between the three remote paths, see Choosing a remote access path.

Quick share from the status bar

If all you want is "let a remote client drive this port", start here. Select the serial connection, click Live Sync in the status bar and choose RFC 2217 Server…. The dialog asks one question — which TCP port to listen on, with a free one already filled in — and optionally, under Restrict to specific addresses / subnets, who may connect. Everything else takes the same settings the manual path below spells out: both directions, one client at a time, RFC 2217 protocol, the port opened automatically.

The menu the status bar's Live Sync cell opens, listing RFC 2217 Server..., Live Console, a greyed-out Live Relay and Live Share..., with the Live Sync cell and Not signed in visible in the status bar below it
The Live Sync cell opens onto the four peers. Live Relay is greyed here because Live Console, the channel it rides, is switched off.
The Share via RFC 2217 dialog: it says the port will accept one RFC 2217 client at a time on the TCP port below and that clients connect with rfc2217://host:port or a virtual COM driver, a TCP port field filled in with 2217, an unticked Restrict to specific addresses / subnets box, and Cancel and OK
One question, with a free port already filled in. The allowlist is the only other thing it asks about.

The network end here is a listener built into the bridge rather than a second connection, so it spends no grid slot and does not count against the sixteen-port limit. Under Tools → Bridges… it appears as RFC 2217 Server :2217 with TCP :2217 (built-in) as its second end, and its listening port, traffic and state can be changed or watched like any other link.

While it is running the status bar's Live Sync cell reads Shared, and In use once a client is actually driving the port; if the TCP port turns out to be taken, it reads Not listening and stays that way until you fix it. To stop sharing, click the bridge badge above the receive view and then its close button, or remove the link in the bridge manager.

The workspace while the quick share runs: a pale blue Bridged to :2217 badge above the receive view, and Shared in amber in the status bar where the cell normally reads Live Sync
Both halves of "this port is open to somebody": the badge above the receive view, and the amber word in the status bar.
The Bridges window with one link: RFC 2217 Server :2217, End A 1: cu.usbmodem11303, End B TCP :2217 (built-in), status Running, and a state line reading Running, no client connected above zeroed traffic and dropped counters for both directions
The quick share as the bridge manager sees it: a real link whose network end is the built-in listener, editable and removable like any other.

Quick share is available in every edition — it asks for no account and no Pro licence.

Set it up by hand

Use this path when the port should also be visible as a pane on screen, when you want a bridge that is not exclusive, or when you are editing an existing link.

The site needs two connections: one opens the physical serial port and one listens as a TCP Server. An RFC 2217 bridge joins them.

  1. Configure the first connection for the device's physical serial port and match the parameters in its manual.
  2. Choose Edit → Add Port for the second connection; pick TCP/UDP, then choose TCP Server.
  3. For another machine, listen on AnyIPv4 or the site's LAN address and enter a port such as 6000. A server bound to 127.0.0.1 cannot be reached remotely.
  4. Open Tools → Bridges… → New, choose the serial port and TCP Server as the two ends, and select A ⇄ B (both ways).
  5. Enable the bridge and Open both ends automatically. On Protocol, choose RFC 2217 server and keep Forward immediately framing.
  6. Keep One client at a time.
Multi-port workspace: the left connection has usbmodem11303 open and shows the device's reply, the right connection is TCP/UDP with Mode set to TCP Server, Bind Any and Port 6000, and the status bar reports waiting for connections on 0.0.0.0:6000
Both connections are ready before the bridge exists: the physical serial port is open and the TCP Server is listening.
Bridge dialog Connection tab named Bridge 1, with End A set to 1: cu.usbmodem11303, Direction A to B both ways, End B set to 2: 0.0.0.0:6000, Enabled and Open both ends automatically ticked, and an Access section whose Allowed clients box takes one address or subnet per line
A bridge joins two connections that already exist; it is not a separate port mode.
Bridge dialog Protocol tab with Mode set to RFC 2217 server (remote client sets the serial parameters), noting that clients connect with rfc2217://host:port or a virtual COM driver, Framing set to Forward immediately, and TCP server clients set to One client at a time
The protocol must be RFC 2217 server, not the default Transparent mode.

Access control and security

An empty Allowed clients list does not restrict the source. To restrict access, enter trusted IP addresses or CIDR subnets there, one per line.

RFC 2217 provides no encryption or authentication. Do not expose it directly to an untrusted public network. Prefer a LAN or trusted VPN, and allow the selected port through the host firewall.

Server-side checks

Confirm this end is ready before telling the remote to connect:

  1. The TCP Server connection shows that it is waiting or connected, on the same address and port you will give the client.
  2. The bridge manager reports Running, with dropped staying at 0 in both A→B and B→A directions.
  3. The physical serial port is open and the device answers a known command.
Bridge manager showing RFC2217-Server as Running, with traffic and dropped counters for both directions
A running bridge with no drops in either direction is the server-side baseline.

For the end that connects to this port, see RFC 2217 client. For end-to-end acceptance and layered troubleshooting across both ends, see Connect directly to a remote serial port with RFC 2217.

Was this document helpful?