tunnel-SerialTunnel
This component is the server-side component used to support tunneling of Windows serial-connected PC applications to devices reachable in a station’s driver network. Typically, serial tunneling is used with a legacy vendor-specific PC program to access RS-232–connected devices attached to a controller.
You can add one or more SerialTunnels under a station’s TunnelService. Each SerialTunnel associates with one specific driver network (and corresponding controller serial port).
In addition to the standard property, Status, these properties are unique to this component.
| Name | Value | Description |
|---|---|---|
| Enabled | true (default) or false | Turns serial tunneling on (true) and off (false). |
| Connections | read-only | Indicates the number of tunnel connections, as either 0 (none) or 1 (maximum). |
| Identifier | read-only | Reports the entered Port Name slot in the Serial Port Config container (below) used as the tunnel name when configuring the client-side Serial Tunneling window. |
| Serial Port Config (container) | additional properties | Holds configuration properties for the controller serial port as used by the specific driver network. Refer to the separate topic, serial-SerialHelper for property descriptions. |
Actions
Disconnect All disconnects any active connection through this SerialTunnel (maximum of 1). This removes the TunnelConnection below it. The remote (serial tunnel client) side displays a popup message: Connection closed by remote host.
Note: Any TunnelConnection component also has its own Disconnect action, which effectively performs the same function.