py-coreDAQ 0.2.0__tar.gz

py_coredaq-0.2.0/MANIFEST.in

@@ -0,0 +1,6 @@
+include README.md
+include pyproject.toml
+
+# Never ship firmware binaries in the Python package
+prune LinearFirmware
+prune LogFirmware

py_coredaq-0.2.0/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: py_coreDAQ
+Version: 0.2.0
+Summary: Python driver for the coreDAQ 4-channel optical power meter.
+Author-email: Core Instrumentation <hello@coreinstrumentation.com>
+License: MIT
+Project-URL: Homepage, https://coreinstrumentation.com
+Project-URL: Repository, https://github.com/coreinstrumentation/py_coreDAQ
+Project-URL: Bug Tracker, https://github.com/coreinstrumentation/py_coreDAQ/issues
+Keywords: optical power meter,photonics,coreDAQ,instrumentation,DAQ
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+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 :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: pyserial>=3.5
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+
+# coreDAQ
+
+`coreDAQ` is a smart photonic data acquisition system for optical power measurement, programmable capture, and Python-driven lab automation.
+
+On initialization, the API configures the instrument to `500 Hz` sample rate and `OS 1`. You can change those global settings later with `set_sample_rate_hz(...)` and `set_oversampling(...)`.
+
+The runtime ships with embedded InGaAs and silicon responsivity curves, defaults to watt readings, and exposes a clean package import:
+
+```python
+from py_coreDAQ import coreDAQ
+```
+
+## Install
+
+```bash
+pip install .
+```
+
+For editable local development:
+
+```bash
+pip install -e .
+```
+
+## Quick Start
+
+```python
+from py_coreDAQ import coreDAQ
+
+with coreDAQ("/dev/tty.usbmodemXXXX") as meter:
+    print(meter.identify())
+    print(meter.frontend(), meter.detector())
+
+    meter.set_wavelength_nm(1550.0)
+    meter.set_reading_unit("w")
+    power_w = meter.read_channel(0, n_samples=8)
+    capture = meter.get_data(frames=1024, unit="w")
+
+    print(power_w)
+    print(capture.trace(0)[:5])
+```
+
+## Main User APIs
+
+- `read_all()` and `read_channel()` for live powermeter readings
+- `read_all_full()` and `read_channel_full()` when you want the full measurement object
+- `get_data()` and `get_data_channel()` for DAQ traces, including `trigger=True` external-trigger capture
+- `get_ranges()`, `get_range_all()`, `set_range()`, `set_range_power()`, and `set_ranges()`
+- `capture_channel_mask()`, `set_capture_channel_mask()`, `capture_channels()`, and `set_capture_channels()` for DAQ masking
+- `set_sample_rate_hz()` and `set_oversampling()` for global read settings
+- `set_reading_unit("w" | "dbm" | "v" | "mv" | "adc")`
+- `autoRange=True` by default on all `read*()` methods, with `autoRange=False` available for fixed-range reads
+- `zero_dark()` and `restore_factory_zero()`
+- `is_clipped()` and `signal_status()`
+
+## Documentation Map
+
+- [Quickstart](docs/quickstart.md): first read, first capture, and first trigger-based capture
+- [Read Power](docs/readings.md): every `read*` method, `n_samples`, `autoRange`, and rich read fields
+- [Capture Data](docs/capture.md): `get_data(...)`, `CaptureResult`, and capture status fields
+- [Capture with External Trigger](docs/trigger.md): trigger-based capture workflows
+- [Ranges and AutoRange](docs/ranges.md): range indices, power-based range selection, and autoRange behavior
+- [Units, Sample Rate, and Oversampling](docs/settings.md): units, sample rate, oversampling, and recommended setups
+- [Frames, Masking, and Memory Limits](docs/frames.md): capture masks, frame counts, and SDRAM limits
+- [Zeroing and Signal Health](docs/zeroing.md): zeroing, clipping, and signal health checks
+- [API Reference](docs/api-reference.md): grouped method signatures and examples
+
+## Documentation
+
+The docs site is configured for Read the Docs:
+
+`https://py-coredaq.readthedocs.io/`

py_coredaq-0.2.0/README.md

@@ -0,0 +1,72 @@
+# coreDAQ
+
+`coreDAQ` is a smart photonic data acquisition system for optical power measurement, programmable capture, and Python-driven lab automation.
+
+On initialization, the API configures the instrument to `500 Hz` sample rate and `OS 1`. You can change those global settings later with `set_sample_rate_hz(...)` and `set_oversampling(...)`.
+
+The runtime ships with embedded InGaAs and silicon responsivity curves, defaults to watt readings, and exposes a clean package import:
+
+```python
+from py_coreDAQ import coreDAQ
+```
+
+## Install
+
+```bash
+pip install .
+```
+
+For editable local development:
+
+```bash
+pip install -e .
+```
+
+## Quick Start
+
+```python
+from py_coreDAQ import coreDAQ
+
+with coreDAQ("/dev/tty.usbmodemXXXX") as meter:
+    print(meter.identify())
+    print(meter.frontend(), meter.detector())
+
+    meter.set_wavelength_nm(1550.0)
+    meter.set_reading_unit("w")
+    power_w = meter.read_channel(0, n_samples=8)
+    capture = meter.get_data(frames=1024, unit="w")
+
+    print(power_w)
+    print(capture.trace(0)[:5])
+```
+
+## Main User APIs
+
+- `read_all()` and `read_channel()` for live powermeter readings
+- `read_all_full()` and `read_channel_full()` when you want the full measurement object
+- `get_data()` and `get_data_channel()` for DAQ traces, including `trigger=True` external-trigger capture
+- `get_ranges()`, `get_range_all()`, `set_range()`, `set_range_power()`, and `set_ranges()`
+- `capture_channel_mask()`, `set_capture_channel_mask()`, `capture_channels()`, and `set_capture_channels()` for DAQ masking
+- `set_sample_rate_hz()` and `set_oversampling()` for global read settings
+- `set_reading_unit("w" | "dbm" | "v" | "mv" | "adc")`
+- `autoRange=True` by default on all `read*()` methods, with `autoRange=False` available for fixed-range reads
+- `zero_dark()` and `restore_factory_zero()`
+- `is_clipped()` and `signal_status()`
+
+## Documentation Map
+
+- [Quickstart](docs/quickstart.md): first read, first capture, and first trigger-based capture
+- [Read Power](docs/readings.md): every `read*` method, `n_samples`, `autoRange`, and rich read fields
+- [Capture Data](docs/capture.md): `get_data(...)`, `CaptureResult`, and capture status fields
+- [Capture with External Trigger](docs/trigger.md): trigger-based capture workflows
+- [Ranges and AutoRange](docs/ranges.md): range indices, power-based range selection, and autoRange behavior
+- [Units, Sample Rate, and Oversampling](docs/settings.md): units, sample rate, oversampling, and recommended setups
+- [Frames, Masking, and Memory Limits](docs/frames.md): capture masks, frame counts, and SDRAM limits
+- [Zeroing and Signal Health](docs/zeroing.md): zeroing, clipping, and signal health checks
+- [API Reference](docs/api-reference.md): grouped method signatures and examples
+
+## Documentation
+
+The docs site is configured for Read the Docs:
+
+`https://py-coredaq.readthedocs.io/`

py_coredaq-0.2.0/py_coreDAQ/__init__.py

@@ -0,0 +1,62 @@
+"""py_coreDAQ — Python driver for the coreDAQ 4-channel optical power meter.
+
+Quick start::
+
+    from py_coreDAQ import coreDAQ
+
+    with coreDAQ.connect() as coredaq:       # auto-discovers real hardware
+        print(coredaq.read_all())            # [W, W, W, W]
+
+    with coreDAQ.connect(simulator=True) as coredaq:
+        result = coredaq.capture(frames=500)
+        print(result.trace(0))
+
+All public names are importable from this top-level package::
+
+    from py_coreDAQ import (
+        coreDAQ, CaptureResult, ChannelReading, MeasurementSet,
+        coreDAQError, coreDAQConnectionError, coreDAQTimeoutError,
+    )
+"""
+__version__ = "0.2.0"
+
+from ._coredaq import (
+    CaptureChannelStatus,
+    CaptureLayout,
+    CaptureResult,
+    ChannelProxy,
+    ChannelReading,
+    DeviceInfo,
+    MeasurementSet,
+    SignalStatus,
+    coreDAQ,
+)
+from ._exceptions import (
+    coreDAQCalibrationError,
+    coreDAQConnectionError,
+    coreDAQError,
+    coreDAQTimeoutError,
+    coreDAQUnsupportedError,
+)
+
+__all__ = [
+    "__version__",
+    # Main class
+    "coreDAQ",
+    # Channel proxy
+    "ChannelProxy",
+    # Dataclasses
+    "DeviceInfo",
+    "SignalStatus",
+    "ChannelReading",
+    "MeasurementSet",
+    "CaptureLayout",
+    "CaptureChannelStatus",
+    "CaptureResult",
+    # Exceptions
+    "coreDAQError",
+    "coreDAQConnectionError",
+    "coreDAQTimeoutError",
+    "coreDAQCalibrationError",
+    "coreDAQUnsupportedError",
+]