hw-vx-config 0.1.0__tar.gz

hw_vx_config-0.1.0/PKG-INFO

@@ -0,0 +1,177 @@
+Metadata-Version: 2.4
+Name: hw-vx-config
+Version: 0.1.0
+Summary: Network configuration tool for HW-VX6330K / HW-VX6346KL serial-to-Ethernet modules
+Author: xynogen
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/xynogen/hw-vx-config
+Project-URL: Repository, https://github.com/xynogen/hw-vx-config
+Project-URL: Issues, https://github.com/xynogen/hw-vx-config/issues
+Keywords: hw-vx6330k,hw-vx6346kl,serial-to-ethernet,network-config,udp
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Networking
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+
+# hw-vx-config
+
+Network configuration tool for HW-VX6330K / HW-VX6346KL serial-to-Ethernet modules on Linux.
+Sends UDP packets directly to the device — no DLLs, no runtime dependencies, pure stdlib.
+
+Accepts a device IP or discovers via broadcast; reads and writes all network, serial, and
+advanced settings over the HW-VX UDP protocol (port 65535).
+
+## Table of Contents
+
+- [Requirements](#requirements)
+- [Quick Start](#quick-start)
+- [CLI Reference](#cli-reference)
+- [Interactive Menu](#interactive-menu)
+- [Protocol](#protocol)
+- [Examples](#examples)
+- [Development](#development)
+- [License](#license)
+
+## Requirements
+
+- Python 3.10 or later
+- Linux (uses `SO_BROADCAST`; port 65535 requires no root)
+- Device reachable on the local network (same subnet or routed UDP)
+
+## Quick Start
+
+```bash
+python -m venv .venv && source .venv/bin/activate
+pip install -e .
+
+# Discover all readers on the network
+hw-vx-config search
+
+# Or run directly without installing
+python main.py
+```
+
+## CLI Reference
+
+All operations take the current device IP as the first positional argument.
+
+```bash
+# Discover all readers via broadcast
+hw-vx-config search
+
+# Print full configuration for a device
+hw-vx-config config <ip>
+
+# Change static IP and reboot
+hw-vx-config set-ip <current-ip> <new-ip>
+
+# Enable or disable DHCP and reboot
+hw-vx-config dhcp <ip> on|off
+
+# Send reboot command
+hw-vx-config reboot <ip>
+
+# Launch interactive menu
+hw-vx-config interactive
+hw-vx-config              # same — interactive is the default
+```
+
+## Interactive Menu
+
+The interactive menu (`hw-vx-config` with no arguments) provides a numbered prompt:
+
+```
+1. Search for readers          — broadcast discovery, select from results
+2. Connect to specific IP      — skip discovery, target a known address directly
+3. Show current configuration
+4. Change IP address
+5. Enable/Disable DHCP
+6. Edit & save full configuration — field-by-field editor, confirm before write
+7. Change remote server        — set Remote IP, Remote Port, Work Mode
+8. Reboot reader
+q. Quit
+```
+
+Option 2 is useful when the device is on a different subnet and broadcast cannot reach it.
+
+## Protocol
+
+UDP on port **65535**. Every packet is ASCII. Replies are prefixed with `A`.
+
+| Prefix | Direction | Action |
+|:---|:---|:---|
+| `X` | → device | Broadcast echo — triggers discovery reply |
+| `W{mac}` | → device | Select device by MAC |
+| `L` | → device | Login |
+| `O` | → device | Logout |
+| `G{code}` | → device | Get one setting |
+| `S{code}{value}\|{seq}` | → device | Set one setting |
+| `E` | → device | Save and reboot |
+| `A{payload}` | ← device | All replies |
+
+Discovery reply format: `A{mac}/{port}/.../{username}/{device_name}` from the device's source IP.
+
+Setting codes of note: `IP` (IP address), `NM` (subnet mask), `GI` (gateway), `DH` (DHCP),
+`BR` (baud rate), `TP` (protocol), `RM` (work mode). Full table in `src/hw_vx_config/constants.py`.
+
+## Examples
+
+The `examples/` directory contains companion scripts.
+
+| File | Description |
+|:---|:---|
+| `server_uhf.py` | TCP server that receives RFID tag data from the reader on port 2077. Run this alongside the reader when `Work Mode` is set to `Client` and `Remote Port` is `2077`. |
+| `library_usage.py` | Shows how to use `HwVxDevice` and `HwVxNetworking` directly in Python code — discover, read config, change settings, and quick operations. |
+
+```bash
+python examples/server_uhf.py
+# Listening on 0.0.0.0:2077
+```
+
+## Development
+
+Install with dev extras, then use the standard toolchain:
+
+```bash
+pip install -e ".[dev]"
+
+# Lint and format
+ruff check --fix src/ tests/
+ruff format src/ tests/
+
+# Type check
+mypy src/
+
+# Run tests
+pytest
+
+# Tests with coverage
+pytest --cov=hw_vx_config --cov-report=term-missing
+```
+
+Tests live in `tests/` and mock the UDP socket — no device needed to run them.
+
+## Tested with
+
+- Package version: **0.1.0**
+- Hardware: HW-VX6330K, HW-VX6346KL
+- Protocol: UDP port 65535, ASCII request/reply
+- OS: Linux (Ubuntu 22.04+)
+
+## License
+
+MIT

hw_vx_config-0.1.0/README.md

@@ -0,0 +1,148 @@
+# hw-vx-config
+
+Network configuration tool for HW-VX6330K / HW-VX6346KL serial-to-Ethernet modules on Linux.
+Sends UDP packets directly to the device — no DLLs, no runtime dependencies, pure stdlib.
+
+Accepts a device IP or discovers via broadcast; reads and writes all network, serial, and
+advanced settings over the HW-VX UDP protocol (port 65535).
+
+## Table of Contents
+
+- [Requirements](#requirements)
+- [Quick Start](#quick-start)
+- [CLI Reference](#cli-reference)
+- [Interactive Menu](#interactive-menu)
+- [Protocol](#protocol)
+- [Examples](#examples)
+- [Development](#development)
+- [License](#license)
+
+## Requirements
+
+- Python 3.10 or later
+- Linux (uses `SO_BROADCAST`; port 65535 requires no root)
+- Device reachable on the local network (same subnet or routed UDP)
+
+## Quick Start
+
+```bash
+python -m venv .venv && source .venv/bin/activate
+pip install -e .
+
+# Discover all readers on the network
+hw-vx-config search
+
+# Or run directly without installing
+python main.py
+```
+
+## CLI Reference
+
+All operations take the current device IP as the first positional argument.
+
+```bash
+# Discover all readers via broadcast
+hw-vx-config search
+
+# Print full configuration for a device
+hw-vx-config config <ip>
+
+# Change static IP and reboot
+hw-vx-config set-ip <current-ip> <new-ip>
+
+# Enable or disable DHCP and reboot
+hw-vx-config dhcp <ip> on|off
+
+# Send reboot command
+hw-vx-config reboot <ip>
+
+# Launch interactive menu
+hw-vx-config interactive
+hw-vx-config              # same — interactive is the default
+```
+
+## Interactive Menu
+
+The interactive menu (`hw-vx-config` with no arguments) provides a numbered prompt:
+
+```
+1. Search for readers          — broadcast discovery, select from results
+2. Connect to specific IP      — skip discovery, target a known address directly
+3. Show current configuration
+4. Change IP address
+5. Enable/Disable DHCP
+6. Edit & save full configuration — field-by-field editor, confirm before write
+7. Change remote server        — set Remote IP, Remote Port, Work Mode
+8. Reboot reader
+q. Quit
+```
+
+Option 2 is useful when the device is on a different subnet and broadcast cannot reach it.
+
+## Protocol
+
+UDP on port **65535**. Every packet is ASCII. Replies are prefixed with `A`.
+
+| Prefix | Direction | Action |
+|:---|:---|:---|
+| `X` | → device | Broadcast echo — triggers discovery reply |
+| `W{mac}` | → device | Select device by MAC |
+| `L` | → device | Login |
+| `O` | → device | Logout |
+| `G{code}` | → device | Get one setting |
+| `S{code}{value}\|{seq}` | → device | Set one setting |
+| `E` | → device | Save and reboot |
+| `A{payload}` | ← device | All replies |
+
+Discovery reply format: `A{mac}/{port}/.../{username}/{device_name}` from the device's source IP.
+
+Setting codes of note: `IP` (IP address), `NM` (subnet mask), `GI` (gateway), `DH` (DHCP),
+`BR` (baud rate), `TP` (protocol), `RM` (work mode). Full table in `src/hw_vx_config/constants.py`.
+
+## Examples
+
+The `examples/` directory contains companion scripts.
+
+| File | Description |
+|:---|:---|
+| `server_uhf.py` | TCP server that receives RFID tag data from the reader on port 2077. Run this alongside the reader when `Work Mode` is set to `Client` and `Remote Port` is `2077`. |
+| `library_usage.py` | Shows how to use `HwVxDevice` and `HwVxNetworking` directly in Python code — discover, read config, change settings, and quick operations. |
+
+```bash
+python examples/server_uhf.py
+# Listening on 0.0.0.0:2077
+```
+
+## Development
+
+Install with dev extras, then use the standard toolchain:
+
+```bash
+pip install -e ".[dev]"
+
+# Lint and format
+ruff check --fix src/ tests/
+ruff format src/ tests/
+
+# Type check
+mypy src/
+
+# Run tests
+pytest
+
+# Tests with coverage
+pytest --cov=hw_vx_config --cov-report=term-missing
+```
+
+Tests live in `tests/` and mock the UDP socket — no device needed to run them.
+
+## Tested with
+
+- Package version: **0.1.0**
+- Hardware: HW-VX6330K, HW-VX6346KL
+- Protocol: UDP port 65535, ASCII request/reply
+- OS: Linux (Ubuntu 22.04+)
+
+## License
+
+MIT

hw_vx_config-0.1.0/pyproject.toml

@@ -0,0 +1,87 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "hw-vx-config"
+version = "0.1.0"
+description = "Network configuration tool for HW-VX6330K / HW-VX6346KL serial-to-Ethernet modules"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+authors = [{ name = "xynogen" }]
+keywords = [
+  "hw-vx6330k",
+  "hw-vx6346kl",
+  "serial-to-ethernet",
+  "network-config",
+  "udp",
+]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Environment :: Console",
+  "Intended Audience :: System Administrators",
+  "Operating System :: POSIX :: Linux",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: System :: Networking",
+  "Typing :: Typed",
+]
+
+# No runtime dependencies — pure stdlib
+dependencies = []
+
+[project.optional-dependencies]
+dev = ["pytest>=7.0", "pytest-cov>=4.0", "mypy>=1.0", "ruff>=0.4"]
+
+[project.urls]
+Homepage = "https://github.com/xynogen/hw-vx-config"
+Repository = "https://github.com/xynogen/hw-vx-config"
+Issues = "https://github.com/xynogen/hw-vx-config/issues"
+
+[project.scripts]
+hw-vx-config = "hw_vx_config.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+# ─── Ruff ────────────────────────────────────────────────────────────
+
+[tool.ruff]
+target-version = "py310"
+line-length = 100
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "N", "UP", "B", "A", "SIM", "RUF"]
+ignore = ["E501"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["hw_vx_config"]
+
+# ─── Pytest ──────────────────────────────────────────────────────────
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-v --tb=short"
+
+# ─── Mypy ────────────────────────────────────────────────────────────
+
+[tool.mypy]
+python_version = "3.10"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+
+# ─── Coverage ────────────────────────────────────────────────────────
+
+[tool.coverage.run]
+source = ["hw_vx_config"]
+omit = ["*/cli.py"]
+
+[tool.coverage.report]
+show_missing = true
+skip_empty = true

hw_vx_config-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

hw_vx_config-0.1.0/src/hw_vx_config/__init__.py

@@ -0,0 +1,21 @@
+"""
+HW-VX6330K / HW-VX6346KL Network Configuration Tool for Linux.
+
+Ported from the C# Demo v2.11 (Networking.cs + Form1.cs).
+Protocol: UDP packets to port 65535 (HW-VX IP Protocol).
+
+No DLLs needed — pure Python sockets.
+"""
+
+__version__ = "1.0.0"
+
+from hw_vx_config.device import HwVxDevice
+from hw_vx_config.models import DeviceConfig, SearchResult
+from hw_vx_config.transport import HwVxNetworking
+
+__all__ = [
+    "DeviceConfig",
+    "HwVxDevice",
+    "HwVxNetworking",
+    "SearchResult",
+]

hw_vx_config-0.1.0/src/hw_vx_config/__main__.py

@@ -0,0 +1,6 @@
+"""Allow running as ``python -m hw_vx_config``."""
+
+from hw_vx_config.cli import main
+
+if __name__ == "__main__":
+    main()