darkmode, ui cleanup, control-data logic

Author: pavelrevak

README.md

@@ -1,25 +1,29 @@
 # Ser2tcp
 
-Simple proxy for connecting over TCP, TELNET, SSL or Unix socket to serial port
+Simple proxy for connecting over TCP, TELNET, SSL, WebSocket or Unix socket to serial port
 
 https://github.com/cortexm/ser2tcp
 
 ## Features
 
 - can serve multiple serial ports using pyserial library
 - each serial port can have multiple servers
-- server can use TCP, TELNET, SSL or SOCKET protocol
+- server can use TCP, TELNET, SSL, WebSocket or SOCKET protocol
   - TCP protocol just bridge whole RAW serial stream to TCP
   - TELNET protocol will send every character immediately and not wait for ENTER, it is useful to use standard `telnet` as serial terminal
   - SSL protocol provides encrypted TCP connection with optional mutual TLS (mTLS) client certificate verification
+  - WebSocket protocol connects through the HTTP server with binary frames for data and JSON text frames for signal control
   - SOCKET protocol uses Unix domain socket for local IPC
 - servers accepts multiple connections at one time
   - each connected client can sent to serial port
   - serial port send received data to all connected clients
 - non-blocking send with configurable timeout and buffer limit
+- serial signal control (RTS, DTR, CTS, DSR, RI, CD) via escape protocol or WebSocket JSON
 - built-in HTTP server with REST API for status monitoring
 - web interface for viewing configured ports and connections
+- web terminal clients (xterm.js VT100 terminal and raw colored view)
 - authentication with session management and API tokens
+- light/dark mode web UI (follows system preference)
 
 ## Installation
 
@@ -137,13 +141,42 @@ Match attributes: `vid`, `pid`, `serial_number`, `manufacturer`, `product`, `loc
 
 | Parameter | Description | Default |
 |-----------|-------------|---------|
-| `address` | Bind address (IP for tcp/telnet/ssl, path for socket) | required |
-| `port` | TCP port (not used for socket) | required |
-| `protocol` | `tcp`, `telnet`, `ssl` or `socket` | required |
+| `address` | Bind address (IP for tcp/telnet/ssl, path for socket) | required* |
+| `port` | TCP port (not used for socket/websocket) | required* |
+| `protocol` | `tcp`, `telnet`, `ssl`, `websocket` or `socket` | required |
+| `endpoint` | WebSocket URL path (websocket only), must be unique | required* |
+| `token` | Per-server auth token (websocket only) | - |
 | `ssl` | SSL configuration (required for `ssl` protocol) | - |
+| `data` | Forward serial data (default true), `false` = control-only | true |
+| `control` | Signal control configuration | - |
 | `send_timeout` | Disconnect client if data cannot be sent within this time (seconds) | 5.0 |
 | `buffer_limit` | Maximum send buffer size per client (bytes), `null` for unlimited | null |
 
+\* `address`/`port` required for tcp/telnet/ssl; `address` for socket; `endpoint` for websocket
+
+#### WebSocket configuration
+
+WebSocket connections go through the HTTP server — no separate listening port needed:
+
+```json
+{
+    "protocol": "websocket",
+    "endpoint": "my-device",
+    "control": {
+        "rts": true,
+        "signals": ["rts", "dtr", "cts", "dsr"]
+    }
+}
+```
+
+- Accessible at `ws://host:port/ws/my-device` (or `wss://` for HTTPS)
+- Available on all configured HTTP servers
+- Binary frames carry raw serial data (bidirectional)
+- Text frames carry JSON control messages: `{"rts": true}`, `{"signals": {...}}`
+- Signal state sent automatically on connect, then only on change
+- Auth: per-server `token`, global user session, or both accepted
+- Web terminals available at `/xterm/<endpoint>` (VT100) and `/raw/<endpoint>` (colored hex)
+
 #### Socket configuration
 
 For `socket` protocol, `address` is the path to the Unix domain socket:
@@ -289,7 +322,19 @@ HTTPS with SSL:
 | POST | `/api/login` | no | Authenticate, returns session token |
 | POST | `/api/logout` | no | Invalidate session |
 | GET | `/api/status` | yes | Runtime status (serial ports, servers, connections) |
-| GET | `/api/ports` | yes | Available serial ports with USB/device attributes |
+| GET | `/api/detect` | yes | Available serial ports with USB/device attributes |
+| POST | `/api/ports` | admin | Add new port configuration |
+| PUT | `/api/ports/<index>` | admin | Update port configuration |
+| DELETE | `/api/ports/<index>` | admin | Delete port configuration |
+| DELETE | `/api/ports/<p>/connections/<s>/<c>` | admin | Disconnect client |
+| PUT | `/api/ports/<index>/signals` | admin | Set RTS/DTR signals |
+| GET | `/api/signals` | yes | Signal states for all ports |
+| GET | `/api/users` | yes | List users |
+| POST | `/api/users` | admin | Add user |
+| PUT | `/api/users/<login>` | admin | Update user |
+| DELETE | `/api/users/<login>` | admin | Delete user |
+| GET | `/xterm/<endpoint>` | no | WebSocket VT100 terminal |
+| GET | `/raw/<endpoint>` | no | WebSocket raw terminal |
 
 Authentication: `Authorization: Bearer <token>` header or `?token=<token>` query parameter. Without `auth` configuration, all endpoints are accessible without authentication.
 
@@ -374,7 +419,7 @@ For system service, use `sudo systemctl` instead of `systemctl --user`.
 
 - Python 3.8+
 - pyserial 3.0+
-- uhttp-server 2.3.0+ (for HTTP/API)
+- uhttp-server 2.3.2+ (for HTTP/API and WebSocket)
 
 ### Running on
 

pyproject.toml

@@ -21,7 +21,7 @@ classifiers = [
 ]
 dependencies = [
     "pyserial>=3.0",
-    "uhttp-server>=2.3.1",
+    "uhttp-server>=2.3.2",
 ]
 
 [project.urls]

ser2tcp/connection_control.py

@@ -23,16 +23,19 @@
 SIGNAL_BITS = {name: i for i, name in enumerate(SIGNAL_NAMES)}
 
 
-def wrap_control(connection_class, control_config):
+def wrap_control(connection_class, control_config, data_enabled=True):
     """Wrap a connection class with control protocol handling.
 
     Returns a new class that escapes 0xFF in outgoing data and parses
     escape sequences in incoming data for signal control commands.
+    When data_enabled=False, only control commands are processed,
+    0xFF escaping is skipped and data bytes are ignored.
     """
     signals = control_config.get('signals', [])
     signal_set = set(s.lower() for s in signals)
     rts_enabled = bool(control_config.get('rts'))
     dtr_enabled = bool(control_config.get('dtr'))
+    forward_data = data_enabled
 
     class ControlConnection(connection_class):
 
@@ -42,9 +45,12 @@ def __init__(self, *args, **kwargs):
             self._ctl_signals = signal_set
             self._ctl_rts = rts_enabled
             self._ctl_dtr = dtr_enabled
+            self._ctl_data = forward_data
 
         def send(self, data):
-            """Send data with 0xFF escaped"""
+            """Send data with 0xFF escaped (skipped when data disabled)"""
+            if not self._ctl_data:
+                return 0
             return super().send(data.replace(b'\xff', b'\xff\xff'))
 
         def send_signal_report(self, bitmask):
@@ -70,12 +76,13 @@ def on_received(self, data):
                     continue
                 if ESCAPE in data:
                     index = data.index(ESCAPE)
-                    if index > 0:
+                    if self._ctl_data and index > 0:
                         clean.extend(data[:index])
                     del data[:index + 1]
                     self._ctl_escape = True
                 else:
-                    clean.extend(data)
+                    if self._ctl_data:
+                        clean.extend(data)
                     break
             if clean:
                 self._serial.send(bytes(clean))