depz-sensor-sdk 0.1.0__tar.gz

depz_sensor_sdk-0.1.0/NOTICE

@@ -0,0 +1,6 @@
+depz-sensor-sdk bundles VL53L8CX/CH sensor-firmware and configuration blobs
+(depz_sensor_sdk/vl53l8/data/{cx,ch}/*.bin) that are © STMicroelectronics,
+distributed under the BSD-3-Clause license (from the ST VL53L8CX ULD).
+The VL53L8 host-side ULD port and its advanced plugins (detection thresholds,
+xtalk, motion indicator) are derived from the ST VL53L8CX ULD (BSD-3-Clause,
+stm32duino/VL53L8CX). All other code is © DEPZ, MIT.

depz_sensor_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: depz-sensor-sdk
+Version: 0.1.0
+Summary: Python SDK for the DEPZ USB sensor line — HC-SR04 ultrasonic, VL53L8CX/CH 8x8 ToF, BNO086 IMU.
+Author: DEPZ
+License: MIT
+Project-URL: Homepage, https://github.com/depz-ai/depz-sensor-sdk-and-viewer
+Project-URL: Repository, https://github.com/depz-ai/depz-sensor-sdk-and-viewer
+Keywords: depz,sensor,usb,cdc,vl53l8,bno086,hc-sr04,tof,imu,ultrasonic
+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: Operating System :: POSIX :: Linux
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: MacOS
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: System :: Hardware :: Hardware Drivers
+Classifier: Intended Audience :: Developers
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: NOTICE
+Requires-Dist: pyserial>=3.5
+Requires-Dist: numpy>=1.24
+Dynamic: license-file
+
+# depz-sensor-sdk
+
+Python SDK for the **DEPZ USB sensor line** — three USB CDC-ACM sensors that
+speak one shared framed protocol:
+
+- **HC-SR04** — ultrasonic distance
+- **VL53L8CX / VL53L8CH** — 8×8 multizone Time-of-Flight (host runs the ST ULD)
+- **BNO086** — 9-axis IMU (host runs the SH-2 stack)
+
+Sync API with a background reader thread: open a device, configure it, consume
+a stream of decoded, timestamped results. A TypeScript SDK
+([`@depz/sensor-sdk`](https://www.npmjs.com/package/@depz/sensor-sdk)) mirrors
+this one byte-for-byte via shared golden test vectors.
+
+## Install
+
+```bash
+pip install depz-sensor-sdk
+```
+
+Linux: your user needs serial access (group `dialout`); `ModemManager` can
+grab CDC-ACM ports — disable it or add a udev rule if opens time out.
+
+## Quick start
+
+```python
+from depz_sensor_sdk import open_device
+from depz_sensor_sdk.vl53l8 import Vl53l8Cx, RESOLUTION_8X8
+
+dev = open_device()                    # first DEPZ sensor by USB id; raises if none
+if isinstance(dev, Vl53l8Cx):
+    dev.init(progress=print)           # ~25 s: downloads the sensor firmware
+    dev.set_resolution(RESOLUTION_8X8)
+    dev.set_ranging_frequency_hz(15)   # must be >= 2 Hz
+    dev.start_ranging()
+    for frame in dev.frames():
+        print(frame.grid())            # 8×8 numpy array of mm
+```
+
+`open_device()` finds the device by USB VID/PID; pass a serial (`open_device(serial="...")`),
+an index, or an explicit port. `depz-sensor list` shows what's connected.
+
+See `docs/guide.md` for the full guide and `docs/api.md` for the API reference.
+
+## License
+
+MIT. Bundled VL53L8 sensor-firmware blobs are © STMicroelectronics
+(BSD-3-Clause); see `NOTICE`.

depz_sensor_sdk-0.1.0/README.md

@@ -0,0 +1,48 @@
+# depz-sensor-sdk
+
+Python SDK for the **DEPZ USB sensor line** — three USB CDC-ACM sensors that
+speak one shared framed protocol:
+
+- **HC-SR04** — ultrasonic distance
+- **VL53L8CX / VL53L8CH** — 8×8 multizone Time-of-Flight (host runs the ST ULD)
+- **BNO086** — 9-axis IMU (host runs the SH-2 stack)
+
+Sync API with a background reader thread: open a device, configure it, consume
+a stream of decoded, timestamped results. A TypeScript SDK
+([`@depz/sensor-sdk`](https://www.npmjs.com/package/@depz/sensor-sdk)) mirrors
+this one byte-for-byte via shared golden test vectors.
+
+## Install
+
+```bash
+pip install depz-sensor-sdk
+```
+
+Linux: your user needs serial access (group `dialout`); `ModemManager` can
+grab CDC-ACM ports — disable it or add a udev rule if opens time out.
+
+## Quick start
+
+```python
+from depz_sensor_sdk import open_device
+from depz_sensor_sdk.vl53l8 import Vl53l8Cx, RESOLUTION_8X8
+
+dev = open_device()                    # first DEPZ sensor by USB id; raises if none
+if isinstance(dev, Vl53l8Cx):
+    dev.init(progress=print)           # ~25 s: downloads the sensor firmware
+    dev.set_resolution(RESOLUTION_8X8)
+    dev.set_ranging_frequency_hz(15)   # must be >= 2 Hz
+    dev.start_ranging()
+    for frame in dev.frames():
+        print(frame.grid())            # 8×8 numpy array of mm
+```
+
+`open_device()` finds the device by USB VID/PID; pass a serial (`open_device(serial="...")`),
+an index, or an explicit port. `depz-sensor list` shows what's connected.
+
+See `docs/guide.md` for the full guide and `docs/api.md` for the API reference.
+
+## License
+
+MIT. Bundled VL53L8 sensor-firmware blobs are © STMicroelectronics
+(BSD-3-Clause); see `NOTICE`.

depz_sensor_sdk-0.1.0/depz_sensor_sdk/__init__.py

@@ -0,0 +1,110 @@
+"""DEPZ sensor line SDK — SR04, VL53L8CX/CH, BNO086 over USB CDC-ACM.
+
+Public surface is defined by contracts/07_SDK_FACADE.md.
+"""
+
+from . import transport, protocol
+from .device import (
+    DeviceBase,
+    DeviceEvent,
+    DisconnectedEvent,
+    LinkCrcErrorEvent,
+    LinkStats,
+    SequenceErrorEvent,
+    StreamQueue,
+    TemperatureEvent,
+    TextEvent,
+    TimeSync,
+    TrashEvent,
+    UnsolicitedStatusEvent,
+    host_now_us,
+    sync_time_all,
+)
+from .bootloader import BootloaderDevice, find_bootloader_port, update_firmware
+from .dataset import DatasetReader, DatasetRecord, SessionRecorder
+from .protocol.bootloader import FwDepzImage
+from .device import StreamIterator
+from .discovery import DeviceInfo, list_depz_devices, open_device, probe_port
+from .vl53l8 import CnhConfig, Vl53l8, Vl53l8Ch, Vl53l8Cx, Vl53l8Frame
+from .errors import (
+    BusyError,
+    DepzError,
+    DepzTimeoutError,
+    DeviceLostError,
+    LinkClosedError,
+    NoDepzDeviceError,
+    StatusError,
+)
+from .usb_ids import (
+    DEPZ_USB_VID,
+    DEPZ_PID_MODEL,
+    is_known_depz_usb,
+    usb_model_hint,
+)
+from .sr04 import Sr04, Sr04Measurement
+from .bno086 import Bno086, GyroIntegratedRV, RotationVector, SensorId
+
+__version__ = "0.1.0"
+
+__all__ = [
+    # modules
+    "transport",
+    "protocol",
+    # discovery
+    "DeviceInfo",
+    "list_depz_devices",
+    "probe_port",
+    "open_device",
+    # usb identity table
+    "DEPZ_USB_VID",
+    "DEPZ_PID_MODEL",
+    "is_known_depz_usb",
+    "usb_model_hint",
+    # device
+    "DeviceBase",
+    "TimeSync",
+    "LinkStats",
+    "StreamQueue",
+    "host_now_us",
+    "sync_time_all",
+    # events
+    "DeviceEvent",
+    "SequenceErrorEvent",
+    "LinkCrcErrorEvent",
+    "TrashEvent",
+    "UnsolicitedStatusEvent",
+    "TextEvent",
+    "TemperatureEvent",
+    "DisconnectedEvent",
+    # sensors
+    "Sr04",
+    "Sr04Measurement",
+    "Vl53l8",
+    "Vl53l8Cx",
+    "Vl53l8Ch",
+    "Vl53l8Frame",
+    "CnhConfig",
+    "Bno086",
+    "SensorId",
+    "RotationVector",
+    "GyroIntegratedRV",
+    "StreamIterator",
+    # datasets (contract 09)
+    "SessionRecorder",
+    "DatasetReader",
+    "DatasetRecord",
+    # bootloader / firmware update (contract 06)
+    "BootloaderDevice",
+    "FwDepzImage",
+    "update_firmware",
+    "find_bootloader_port",
+    # errors
+    "DepzError",
+    "DepzTimeoutError",
+    "StatusError",
+    "BusyError",
+    "DeviceLostError",
+    "LinkClosedError",
+    "NoDepzDeviceError",
+    "__version__",
+]