py-coreDAQ 1.0.0

Python driver for the coreDAQ 4-channel optical power meter.

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:

from py_coreDAQ import coreDAQ

Install

pip install .

For editable local development:

pip install -e .

Quick Start

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: first read, first capture, and first trigger-based capture
• Read Power: every read* method, n_samples, autoRange, and rich read fields
• Capture Data: get_data(...), CaptureResult, and capture status fields
• Capture with External Trigger: trigger-based capture workflows
• Ranges and AutoRange: range indices, power-based range selection, and autoRange behavior
• Units, Sample Rate, and Oversampling: units, sample rate, oversampling, and recommended setups
• Frames, Masking, and Memory Limits: capture masks, frame counts, and SDRAM limits
• Zeroing and Signal Health: zeroing, clipping, and signal health checks
• API Reference: grouped method signatures and examples

Documentation

The docs site is configured for Read the Docs:

https://py-coredaq.readthedocs.io/