ser2tcp 2.1.0__tar.gz

ser2tcp-2.1.0/.github/workflows/publish.yml

@@ -0,0 +1,35 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+
+      - name: Install build dependencies
+        run: pip install build
+
+      - name: Install package
+        run: pip install .
+
+      - name: Run unit tests
+        run: python -m unittest discover -v tests/
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

ser2tcp-2.1.0/.github/workflows/tests.yml

@@ -0,0 +1,29 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ["3.10", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install package
+        run: pip install .
+
+      - name: Run unit tests
+        run: python -m unittest discover -v tests/

ser2tcp-2.1.0/.gitignore

@@ -0,0 +1,12 @@
+__pycache__
+build
+dist
+.*
+!.gitignore
+!.github
+!.mpyproject
+*.egg-info
+_version.py
+*.md
+!README*.md
+scripts/

ser2tcp-2.1.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Pavel Revak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ser2tcp-2.1.0/PKG-INFO

@@ -0,0 +1,247 @@
+Metadata-Version: 2.4
+Name: ser2tcp
+Version: 2.1.0
+Summary: Serial port proxy to TCP or TELNET
+Author-email: Pavel Revak <pavel.revak@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/cortexm/ser2tcp
+Keywords: serial,tcp,telnet,proxy
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Embedded Systems
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyserial>=3.0
+Dynamic: license-file
+
+# Ser2tcp
+
+Simple proxy for connecting over TCP or telnet 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 or TELNET 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
+- 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
+
+## Installation
+
+```
+pip install ser2tcp
+```
+
+or from source:
+
+```
+pip install .
+```
+
+### Uninstall
+
+```
+pip uninstall ser2tcp
+```
+
+## Command line options
+
+```
+  -h, --help            show this help message and exit
+  -V, --version         show program's version number and exit
+  -v, --verbose         Increase verbosity
+  -u, --usb             List USB serial devices and exit
+  -c CONFIG, --config CONFIG
+                        configuration in JSON format
+```
+
+### Verbose
+
+- By default print only ERROR and WARNING messages
+- `-v`: will print INFO messages
+- `-vv`: print also DEBUG messages
+
+## Configuration file example
+
+```json
+[
+    {
+        "serial": {
+            "port": "/dev/ttyUSB0",
+            "baudrate": 115200,
+            "parity": "NONE",
+            "stopbits": "ONE"
+        },
+        "servers": [
+            {
+                "address": "127.0.0.1",
+                "port": 10001,
+                "protocol": "tcp"
+            },
+            {
+                "address": "0.0.0.0",
+                "port": 10002,
+                "protocol": "telnet",
+                "send_timeout": 5.0,
+                "buffer_limit": 65536
+            }
+        ]
+    }
+]
+```
+
+### Serial configuration
+
+`serial` structure pass all parameters to [serial.Serial](https://pythonhosted.org/pyserial/pyserial_api.html#classes) constructor from pyserial library, this allows full control of the serial port.
+
+#### USB device matching
+
+Instead of specifying `port` directly, you can use `match` to find device by USB attributes:
+
+```json
+{
+    "serial": {
+        "match": {
+            "vid": "0x303A",
+            "pid": "0x4001",
+            "serial_number": "dcda0c2004bc0000"
+        },
+        "baudrate": 115200
+    }
+}
+```
+
+Use `ser2tcp --usb` to list available USB devices with their attributes:
+
+```
+$ ser2tcp --usb
+/dev/cu.usbmodem1101
+  vid: 0x303A
+  pid: 0x4001
+  serial_number: dcda0c2004bc0000
+  manufacturer: Espressif Systems
+  product: Espressif Device
+  location: 1-1
+```
+
+Match attributes: `vid`, `pid`, `serial_number`, `manufacturer`, `product`, `location`
+
+- Wildcard `*` supported (e.g. `"product": "CP210*"`)
+- Matching is case-insensitive
+- Error if multiple devices match the criteria
+- `baudrate` is optional (default 9600, CDC devices ignore it)
+
+### Server configuration
+
+| Parameter | Description | Default |
+|-----------|-------------|---------|
+| `address` | Bind address | required |
+| `port` | TCP port | required |
+| `protocol` | `tcp` or `telnet` | required |
+| `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 |
+
+## Usage examples
+
+```
+ser2tcp -c ser2tcp.conf
+```
+
+Direct running from repository:
+
+```
+python run.py -c ser2tcp.conf
+```
+
+### Connecting using telnet
+
+```
+telnet localhost 10002
+```
+
+(to exit telnet press `CTRL + ]` and type `quit`)
+
+## Installation as service
+
+### Linux - systemd user service
+
+1. Copy service file:
+    ```
+    cp ser2tcp.service ~/.config/systemd/user/
+    ```
+2. Create configuration file `~/.config/ser2tcp.conf`
+3. Reload user systemd services:
+    ```
+    systemctl --user daemon-reload
+    ```
+4. Start and enable service:
+    ```
+    systemctl --user enable --now ser2tcp
+    ```
+5. To allow user services running after boot you need to enable linger (if this is not configured, then service will start after user login and stop after logout):
+    ```
+    sudo loginctl enable-linger $USER
+    ```
+
+### Linux - systemd system service
+
+1. Create system user:
+    ```
+    sudo useradd -r -s /usr/sbin/nologin -G dialout ser2tcp
+    ```
+2. Copy service file:
+    ```
+    sudo cp ser2tcp-system.service /etc/systemd/system/ser2tcp.service
+    ```
+3. Create configuration file `/etc/ser2tcp.conf`
+4. Reload systemd and start service:
+    ```
+    sudo systemctl daemon-reload
+    sudo systemctl enable --now ser2tcp
+    ```
+
+### Useful commands
+
+```bash
+# Check status
+systemctl --user status ser2tcp
+
+# View logs
+journalctl --user-unit ser2tcp -e
+
+# Restart
+systemctl --user restart ser2tcp
+
+# Stop
+systemctl --user stop ser2tcp
+```
+
+For system service, use `sudo systemctl` instead of `systemctl --user`.
+
+## Requirements
+
+- Python 3.8+
+- pyserial 3.0+
+
+### Running on
+
+- Linux
+- macOS
+- Windows
+
+## Credits
+
+(c) 2016-2026 by Pavel Revak
+
+### Support
+
+- Basic support is free over GitHub issues.
+- Professional support is available over email: [Pavel Revak](mailto:pavel.revak@gmail.com?subject=[GitHub]%20ser2tcp).

ser2tcp-2.1.0/README.md

@@ -0,0 +1,229 @@
+# Ser2tcp
+
+Simple proxy for connecting over TCP or telnet 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 or TELNET 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
+- 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
+
+## Installation
+
+```
+pip install ser2tcp
+```
+
+or from source:
+
+```
+pip install .
+```
+
+### Uninstall
+
+```
+pip uninstall ser2tcp
+```
+
+## Command line options
+
+```
+  -h, --help            show this help message and exit
+  -V, --version         show program's version number and exit
+  -v, --verbose         Increase verbosity
+  -u, --usb             List USB serial devices and exit
+  -c CONFIG, --config CONFIG
+                        configuration in JSON format
+```
+
+### Verbose
+
+- By default print only ERROR and WARNING messages
+- `-v`: will print INFO messages
+- `-vv`: print also DEBUG messages
+
+## Configuration file example
+
+```json
+[
+    {
+        "serial": {
+            "port": "/dev/ttyUSB0",
+            "baudrate": 115200,
+            "parity": "NONE",
+            "stopbits": "ONE"
+        },
+        "servers": [
+            {
+                "address": "127.0.0.1",
+                "port": 10001,
+                "protocol": "tcp"
+            },
+            {
+                "address": "0.0.0.0",
+                "port": 10002,
+                "protocol": "telnet",
+                "send_timeout": 5.0,
+                "buffer_limit": 65536
+            }
+        ]
+    }
+]
+```
+
+### Serial configuration
+
+`serial` structure pass all parameters to [serial.Serial](https://pythonhosted.org/pyserial/pyserial_api.html#classes) constructor from pyserial library, this allows full control of the serial port.
+
+#### USB device matching
+
+Instead of specifying `port` directly, you can use `match` to find device by USB attributes:
+
+```json
+{
+    "serial": {
+        "match": {
+            "vid": "0x303A",
+            "pid": "0x4001",
+            "serial_number": "dcda0c2004bc0000"
+        },
+        "baudrate": 115200
+    }
+}
+```
+
+Use `ser2tcp --usb` to list available USB devices with their attributes:
+
+```
+$ ser2tcp --usb
+/dev/cu.usbmodem1101
+  vid: 0x303A
+  pid: 0x4001
+  serial_number: dcda0c2004bc0000
+  manufacturer: Espressif Systems
+  product: Espressif Device
+  location: 1-1
+```
+
+Match attributes: `vid`, `pid`, `serial_number`, `manufacturer`, `product`, `location`
+
+- Wildcard `*` supported (e.g. `"product": "CP210*"`)
+- Matching is case-insensitive
+- Error if multiple devices match the criteria
+- `baudrate` is optional (default 9600, CDC devices ignore it)
+
+### Server configuration
+
+| Parameter | Description | Default |
+|-----------|-------------|---------|
+| `address` | Bind address | required |
+| `port` | TCP port | required |
+| `protocol` | `tcp` or `telnet` | required |
+| `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 |
+
+## Usage examples
+
+```
+ser2tcp -c ser2tcp.conf
+```
+
+Direct running from repository:
+
+```
+python run.py -c ser2tcp.conf
+```
+
+### Connecting using telnet
+
+```
+telnet localhost 10002
+```
+
+(to exit telnet press `CTRL + ]` and type `quit`)
+
+## Installation as service
+
+### Linux - systemd user service
+
+1. Copy service file:
+    ```
+    cp ser2tcp.service ~/.config/systemd/user/
+    ```
+2. Create configuration file `~/.config/ser2tcp.conf`
+3. Reload user systemd services:
+    ```
+    systemctl --user daemon-reload
+    ```
+4. Start and enable service:
+    ```
+    systemctl --user enable --now ser2tcp
+    ```
+5. To allow user services running after boot you need to enable linger (if this is not configured, then service will start after user login and stop after logout):
+    ```
+    sudo loginctl enable-linger $USER
+    ```
+
+### Linux - systemd system service
+
+1. Create system user:
+    ```
+    sudo useradd -r -s /usr/sbin/nologin -G dialout ser2tcp
+    ```
+2. Copy service file:
+    ```
+    sudo cp ser2tcp-system.service /etc/systemd/system/ser2tcp.service
+    ```
+3. Create configuration file `/etc/ser2tcp.conf`
+4. Reload systemd and start service:
+    ```
+    sudo systemctl daemon-reload
+    sudo systemctl enable --now ser2tcp
+    ```
+
+### Useful commands
+
+```bash
+# Check status
+systemctl --user status ser2tcp
+
+# View logs
+journalctl --user-unit ser2tcp -e
+
+# Restart
+systemctl --user restart ser2tcp
+
+# Stop
+systemctl --user stop ser2tcp
+```
+
+For system service, use `sudo systemctl` instead of `systemctl --user`.
+
+## Requirements
+
+- Python 3.8+
+- pyserial 3.0+
+
+### Running on
+
+- Linux
+- macOS
+- Windows
+
+## Credits
+
+(c) 2016-2026 by Pavel Revak
+
+### Support
+
+- Basic support is free over GitHub issues.
+- Professional support is available over email: [Pavel Revak](mailto:pavel.revak@gmail.com?subject=[GitHub]%20ser2tcp).

ser2tcp-2.1.0/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["setuptools", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ser2tcp"
+dynamic = ["version"]
+description = "Serial port proxy to TCP or TELNET"
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.8"
+authors = [
+    { name = "Pavel Revak", email = "pavel.revak@gmail.com" }
+]
+keywords = ["serial", "tcp", "telnet", "proxy"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Embedded Systems",
+    "Programming Language :: Python :: 3",
+]
+dependencies = [
+    "pyserial>=3.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/cortexm/ser2tcp"
+
+[project.scripts]
+ser2tcp = "ser2tcp.main:main"
+
+[tool.setuptools.packages.find]
+include = ["ser2tcp*"]
+
+[tool.setuptools_scm]
+write_to = "ser2tcp/_version.py"
+fallback_version = "0.0.0"

ser2tcp-2.1.0/run.py

@@ -0,0 +1,7 @@
+"""__main__"""
+
+import ser2tcp.main
+
+
+if __name__ == '__main__':
+    ser2tcp.main.main()

ser2tcp-2.1.0/ser2tcp/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '2.1.0'
+__version_tuple__ = version_tuple = (2, 1, 0)
+
+__commit_id__ = commit_id = 'g92b2f585a'