sds200 0.8.2__tar.gz

sds200-0.8.2/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,91 @@
+name: Bug report
+description: Report reproducible incorrect behavior
+title: "[Bug]: "
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for reporting a problem. Remove private scanner and network
+        information from logs before submitting.
+  - type: textarea
+    id: summary
+    attributes:
+      label: What happened?
+      description: Describe the observed behavior and what you expected.
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: sds200-python version or commit
+      placeholder: "0.5.3 or commit SHA"
+    validations:
+      required: true
+  - type: input
+    id: python
+    attributes:
+      label: Python version
+      placeholder: "3.14.4"
+    validations:
+      required: true
+  - type: input
+    id: platform
+    attributes:
+      label: Operating system
+      placeholder: "Ubuntu 26.04"
+    validations:
+      required: true
+  - type: dropdown
+    id: model
+    attributes:
+      label: Scanner model
+      options:
+        - SDS100
+        - SDS150
+        - SDS200
+        - Other or unknown
+    validations:
+      required: true
+  - type: input
+    id: firmware
+    attributes:
+      label: Scanner firmware
+      placeholder: "1.26.01"
+    validations:
+      required: true
+  - type: dropdown
+    id: transport
+    attributes:
+      label: Connection
+      options:
+        - USB serial
+        - SDS200 Ethernet UDP
+        - USB and SDS200 Ethernet
+        - Not applicable
+    validations:
+      required: true
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Reproduction steps
+      description: Include the exact command or a minimal Python example.
+      render: shell
+    validations:
+      required: true
+  - type: textarea
+    id: output
+    attributes:
+      label: Error output or sanitized trace
+      description: Redact private IPs, system names, channel names, and unit identifiers.
+      render: text
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: Checklist
+      options:
+        - label: I searched existing issues.
+          required: true
+        - label: I tested the latest default branch or release.
+          required: true
+        - label: I removed sensitive scanner and network information.
+          required: true

sds200-0.8.2/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Support and troubleshooting
+    url: https://github.com/stevenboyd78/sds200-python/blob/main/SUPPORT.md
+    about: Review the support guide before opening a bug.
+  - name: Security vulnerability
+    url: https://github.com/stevenboyd78/sds200-python/blob/main/SECURITY.md
+    about: Do not disclose vulnerabilities in a public issue.

sds200-0.8.2/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,54 @@
+name: Feature request
+description: Propose a focused addition or improvement
+title: "[Feature]: "
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem or use case
+      description: What limitation are you trying to solve?
+    validations:
+      required: true
+  - type: textarea
+    id: proposal
+    attributes:
+      label: Proposed behavior
+      description: Describe the API, CLI, protocol, or documentation change.
+    validations:
+      required: true
+  - type: dropdown
+    id: area
+    attributes:
+      label: Area
+      options:
+        - Python API
+        - CLI
+        - USB transport
+        - Ethernet transport
+        - Protocol parsing
+        - Discovery and profiles
+        - Monitoring and events
+        - Documentation
+        - Testing and tooling
+        - Other
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives considered
+      description: Describe current workarounds or other designs.
+  - type: textarea
+    id: hardware
+    attributes:
+      label: Hardware or firmware considerations
+      description: Include relevant scanner or firmware behavior without private data.
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: Checklist
+      options:
+        - label: I searched existing issues and the roadmap.
+          required: true
+        - label: This request does not expose private scanner or network information.
+          required: true

sds200-0.8.2/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,25 @@
+## Summary
+
+<!-- What changed and why? -->
+
+## Validation
+
+- [ ] `ruff check .`
+- [ ] `mypy src/sds200`
+- [ ] `pytest`
+- [ ] `python scripts/check_docs.py`
+- [ ] Documentation and changelog updated when needed
+
+## Hardware validation
+
+<!-- Optional. Include scanner firmware and transport; redact private data. -->
+
+- Scanner firmware:
+- Python version:
+- Operating system:
+- Transport:
+- Commands or workflows tested:
+
+## Compatibility and security
+
+<!-- Note public API, protocol, transport, privacy, or security implications. -->

sds200-0.8.2/.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+updates:
+  - package-ecosystem: pip
+    directory: "/"
+    schedule:
+      interval: monthly
+    labels:
+      - dependencies
+
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: monthly
+    labels:
+      - dependencies

sds200-0.8.2/.github/workflows/ci.yml

@@ -0,0 +1,69 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ci-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v7
+
+      - uses: actions/setup-python@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install project
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[dev]"
+
+      - name: Ruff
+        run: ruff check .
+
+      - name: MyPy
+        run: mypy src/sds200
+
+      - name: Pytest
+        run: pytest --cov=sds200 --cov-report=term-missing
+
+  package:
+    name: Documentation and package
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v7
+
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.14"
+          cache: pip
+
+      - name: Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[dev]"
+
+      - name: Check documentation links
+        run: python scripts/check_docs.py
+
+      - name: Build distributions
+        run: python -m build
+
+      - name: Check distributions
+        run: python -m twine check dist/*

sds200-0.8.2/.gitignore

@@ -0,0 +1,12 @@
+.venv/
+__pycache__/
+*.py[cod]
+*.egg-info/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+build/
+dist/
+*.log

sds200-0.8.2/CHANGELOG.md

@@ -0,0 +1,195 @@
+# Changelog
+
+All notable changes to this project are documented here. The format is based on
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project aims
+to follow [Semantic Versioning](https://semver.org/) as the public API matures.
+
+## [Unreleased]
+
+### Planned
+
+- Validated SDS200 network audio transport after control reliability work
+- Optional preferred-transport recovery without connection flapping
+
+## [0.8.2] - 2026-07-24
+
+### Added
+
+- Optional SDS100 battery telemetry through the documented `GSI`/`PSI` `Property.Battery` attribute
+- Immediate `CommandRejectedError` handling for generic scanner `ERR` and `NG` replies
+- Extended `scanner-info` output for RSSI, optional battery, recording, and mute state
+- Opt-in Uniden SDS-series udev rule for desktop ACLs and ModemManager exclusion
+
+### Changed
+
+- Corrected SDS100 capabilities after firmware 1.26.01 hardware testing showed
+  that `GCS` returns `ERR`
+- Kept SDS150 detailed `GCS` charge status as specification-based and hardware unverified
+- Package version advanced to 0.8.2
+
+## [0.8.1] - 2026-07-24
+
+### Changed
+
+- Replaced the model-specific `sds200` executable with the model-neutral `sdsctl` command
+- Updated CLI help, shell completion, documentation, support guidance, and tests for `sdsctl`
+- Kept the distribution, Python import package, configuration directory, and repository named `sds200`
+- Package version advanced to 0.8.1
+
+## [0.8.0] - 2026-07-24
+
+### Added
+
+- USB serial control support for the Uniden SDS100 and SDS150
+- Model-neutral `SDSScanner` API while retaining the historical `SDS200` alias
+- Scanner capability metadata and model-specific volume and squelch limits
+- SDS100/SDS150 `GCS` battery and charge-status parsing and CLI output
+- Model-aware USB discovery, selection, profiles, repair, and completions
+- SDS150 `SDS150GBT` and Uniden internal model-name normalization
+- LF, CR, and CRLF serial response framing for shared SDS-series commands
+- Multi-model protocol, profile, discovery, and command regression tests
+
+### Changed
+
+- Network discovery and UDP profiles are explicitly restricted to the SDS200
+- Profile documents advance to version 3 and can retain the scanner model
+- Documentation distinguishes protocol support from physical-hardware validation
+- Package version advanced to 0.8.0
+
+## [0.7.0] - 2026-07-23
+
+### Added
+
+- Configurable exponential reconnect backoff with finite or unlimited attempts
+- Structured `RadioEvent` notifications and `events --json` JSON Lines output
+- Bounded health history with latency, error-rate, reconnect, and failover summaries
+- Health thresholds for healthy, degraded, unhealthy, and disconnected states
+- Discovery-based profile repair for stale USB paths and changed network addresses
+- Detailed failover telemetry including previous and active endpoints
+- Reliability regression tests for backoff, history, events, and profile repair
+
+### Changed
+
+- Serial, UDP, and fallback reconnect loops now share one recovery policy
+- `health --history` can include historical metrics in human or JSON output
+- Network audio remains deferred and documented as future work
+- Package version advanced to 0.7.0
+
+## [0.6.0] - 2026-07-23
+
+### Added
+
+- Discovery-driven serial, network, or fallback profile creation
+- Configurable serial/network preference with runtime transport failover
+- One-time command retry after a successful failover
+- Continuous `health --watch` output and JSON health reports
+- Connection, response, state, serial, network, and failover diagnostics
+- Independent `AudioTransport`, `AudioStream`, and `AudioChunk` API groundwork
+
+### Changed
+
+- Profile files now use version 2 and can store both control endpoints
+- Package version advanced to 0.6.0
+
+## [0.5.3] - 2026-07-23
+
+First planned GitHub prerelease.
+
+### Added
+
+- Reliable active LAN discovery with isolated per-host UDP sockets
+- Bounded discovery parallelism and configurable worker count
+- USB and network connection profiles stored as TOML
+- Network health checks, statistics, diagnostics, and XML retry limits
+- User-focused README and project documentation
+- Contribution, support, security, and conduct guidance
+- GitHub issue forms, pull-request template, and Dependabot configuration
+- Package metadata, typed-package marker, build verification, and release checklist
+
+### Changed
+
+- CI now uses Node 24-based GitHub Actions majors
+- CI verifies documentation links and built distribution metadata
+- LAN discovery uses per-host timeouts and bounded concurrency
+
+### Fixed
+
+- `/24` discovery could miss a scanner because unrelated UDP errors, ARP delays,
+  and shared-socket behavior interfered with valid replies
+- Network XML handling now supports bare and fragmented `GSI`/`PSI` responses
+- Strict MyPy narrowing in network XML decoding
+
+## [0.5.2]
+
+- Continued discovery after transient UDP refusal, reset, host-unreachable, and
+  network-unreachable errors.
+
+## [0.5.1]
+
+- Improved discovery timeout placement, batching, and response draining.
+
+## [0.5.0]
+
+- Added LAN discovery, profiles, health checks, UDP counters, diagnostics, and
+  bounded XML retries.
+
+## [0.4.2]
+
+- Completed strict typing for bare network XML response handling.
+
+## [0.4.1]
+
+- Added command-aware handling for bare `ScannerInfo` XML over UDP.
+
+## [0.4.0]
+
+- Added native SDS200 UDP control, multi-datagram XML reassembly, and network
+  support across the existing command, state, trace, and monitor APIs.
+
+## [0.3.1]
+
+- Correctly handled the SDS200 `PSI` acknowledgment followed by streamed XML.
+
+## [0.3.0]
+
+- Added continuous `PSI` monitoring, state-difference events, live terminal
+  display, traffic timestamps, and the public transport abstraction.
+
+## [0.2.4]
+
+- Added Ruff- and MyPy-clean shell completion integration.
+
+## [0.2.3]
+
+- Added Bash and Zsh completion for commands, flags, ports, profiles, and common
+  scanner protocol commands.
+
+## [0.2.2]
+
+- Completed strict PySerial factory and write-return typing.
+
+## [0.2.1]
+
+- Fixed a serial-reader shutdown race and added regression coverage.
+
+## [0.2.0]
+
+- Added typed command objects, structured scanner XML, synchronized radio state,
+  state events, traffic tracing, and the `scanner-info` command.
+
+## [0.1.2]
+
+- Established a Ruff-, MyPy-, and Pytest-clean transport baseline.
+
+## [0.1.0]
+
+- Added serial discovery, transport, packet framing, core responses, CLI tools,
+  examples, tests, and CI.
+
+[Unreleased]: https://github.com/stevenboyd78/sds200-python/compare/v0.8.2...HEAD
+[0.8.2]: https://github.com/stevenboyd78/sds200-python/compare/v0.8.1...v0.8.2
+[0.8.1]: https://github.com/stevenboyd78/sds200-python/compare/v0.8.0...v0.8.1
+[0.8.0]: https://github.com/stevenboyd78/sds200-python/compare/v0.7.0...v0.8.0
+[0.7.0]: https://github.com/stevenboyd78/sds200-python/compare/v0.6.0...v0.7.0
+[0.6.0]: https://github.com/stevenboyd78/sds200-python/compare/v0.5.3...v0.6.0
+[0.5.3]: https://github.com/stevenboyd78/sds200-python/releases/tag/v0.5.3

sds200-0.8.2/CODE_OF_CONDUCT.md

@@ -0,0 +1,27 @@
+# Code of Conduct
+
+## Our standard
+
+Project participation should be respectful, constructive, and focused on making
+the software and documentation better.
+
+Examples of welcome behavior include:
+
+- Giving specific, actionable technical feedback
+- Assuming good faith while asking for clarification
+- Respecting differing experience levels and communication styles
+- Protecting private information found in scanner traces or diagnostics
+- Accepting maintainer decisions about project scope and safety
+
+Unacceptable behavior includes harassment, personal attacks, discriminatory
+language, deliberate disruption, publishing another person's private
+information, or pressuring contributors to disclose sensitive radio or network
+details.
+
+## Enforcement
+
+Report conduct concerns privately to the maintainer through the GitHub profile.
+Do not use a public issue when doing so would expose the affected person.
+
+The maintainer may edit or remove contributions, lock discussions, or restrict
+participation when necessary to protect the project community.

sds200-0.8.2/CONTRIBUTING.md

@@ -0,0 +1,108 @@
+# Contributing
+
+Thank you for helping improve `sds200-python`.
+
+The project is hardware-facing alpha software, so contributions should preserve
+a clear separation between transport behavior, protocol parsing, scanner state,
+and user interfaces.
+
+## Before opening an issue
+
+Search existing issues and review [SUPPORT.md](SUPPORT.md). Include the project
+version, Python version, operating system, scanner firmware, connection type,
+and a minimal reproduction.
+
+Remove private or location-sensitive information from traces before posting.
+Scanner output can contain system names, channel names, IP addresses, and unit
+identifiers.
+
+Security vulnerabilities should follow [SECURITY.md](SECURITY.md), not a public
+issue.
+
+## Development setup
+
+```bash
+git clone https://github.com/stevenboyd78/sds200-python.git
+cd sds200-python
+
+python3 -m venv .venv
+source .venv/bin/activate
+
+python -m pip install --upgrade pip
+python -m pip install -e ".[dev]"
+```
+
+## Required checks
+
+Run these before submitting a pull request:
+
+```bash
+ruff check .
+mypy src/sds200
+pytest
+python scripts/check_docs.py
+python -m build
+python -m twine check dist/*
+```
+
+The automated test suite must run without scanner hardware.
+
+## Project structure
+
+- `src/sds200/transport.py`: transport contract and USB serial transport
+- `src/sds200/network.py`: UDP transport and network XML datagram handling
+- `src/sds200/fallback.py`: ordered control-transport activation and failover
+- `src/sds200/audio.py`: control-independent audio lifecycle contracts
+- `src/sds200/scanner.py`: model names, aliases, capabilities, and limits
+- `src/sds200/commands.py`: typed command objects
+- `src/sds200/parser.py`: CR-delimited response parsing
+- `src/sds200/xml_protocol.py`: scanner-information XML parsing
+- `src/sds200/state.py`: synchronized state and change detection
+- `src/sds200/cli.py`: command-line interface
+- `tests/`: hardware-independent regression tests
+- `examples/`: focused usage examples
+- `docs/`: architecture and operational guidance
+
+## Adding protocol support
+
+When adding or changing a scanner command:
+
+1. Preserve the raw protocol response in a trace or sanitized fixture.
+2. Add a typed command or response model when practical.
+3. Keep transport-specific framing out of high-level command code.
+4. Add positive, malformed-response, timeout, and validation tests.
+5. Document hardware validation separately from simulated tests.
+6. Avoid assuming that USB and UDP return identical framing.
+
+Do not add tests that require a live scanner or a specific LAN.
+
+## Hardware validation
+
+A pull request may include optional manual validation notes:
+
+```text
+Scanner: SDS100 / SDS150 / SDS200
+Firmware: ...
+Python: 3.14.x
+Transport: USB / UDP (SDS200 only)
+Commands tested: ...
+Observed result: ...
+```
+
+Sanitize system, department, channel, unit, and network information before
+sharing logs publicly.
+
+## Pull requests
+
+Keep pull requests focused. Describe:
+
+- What changed
+- Why it changed
+- Tests added or updated
+- Local check results
+- Hardware validation, when applicable
+- Compatibility or security implications
+
+Update documentation and `CHANGELOG.md` when behavior or public APIs change.
+
+By participating, you agree to follow [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).

sds200-0.8.2/LICENSE

@@ -0,0 +1,17 @@
+MIT License
+
+Copyright (c) 2026 Steven Boyd
+
+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.