Functions

Operations exposed by this device — schema-registered operations and @expose_to_api methods. See Usage for how to call them, locally or over a client.

configure_and_measure_power(wavelength: float, averaging: int = 1) → dict

custom

Set wavelength and averaging, then perform a power measurement.

Parameters:

• wavelength (float) – Operating wavelength in nm. Must be within the sensor’s supported range (typically 185–25000 nm).

• averaging (int) – Number of samples to average. Must be 1–3000. Default is 1.

Returns:

Dictionary with keys:

zero_and_measure_power() → dict

custom

Zero the sensor and then perform a power measurement.

Returns:

Dictionary with keys:

measure_power(averaging: int = None) → float

schema field: 4.1 ms

Perform a single power measurement and return the result. Optionally sets the averaging count first (wavelength is configured separately, once).

Parameters:

averaging (int) – Optional samples to average for this reading (~0.34 ms each). When omitted the meter’s current averaging setting is used. (1–3000)

Returns:

Measured optical power in Watts (or current unit if power_unit is changed). (W)

measure_energy() → float

schema

Perform a single energy measurement and return the result.

Returns:

Measured pulse energy in Joules. (J)

measure_current() → float

schema field: 4.5 ms

Perform a single current measurement and return the result.

Returns:

Measured photodiode current in Amperes. (A)

measure_voltage() → float

schema field: 4.3 ms

Perform a single voltage measurement and return the result.

Returns:

Measured thermopile voltage in Volts. (V)

measure_frequency() → float

schema field: 3.8 ms

Perform a single frequency measurement and return the result.

Returns:

Measured pulse repetition frequency in Hertz. (Hz)

measure_temperature() → float

schema

Perform a sensor temperature measurement and return the result.

Returns:

Measured sensor head temperature in degrees Celsius. (degC)

get_sensor_info() → dict

schema field: 4.6 ms

Query information about the connected sensor (name, SN, calibration, type, subtype, flags).

Returns:

Dictionary containing sensor name, serial number, calibration message, type, subtype, and flags.

zero_sensor() → bool

schema

Initiate and complete the zero-adjustment routine on the connected sensor.

Returns:

True if the zeroing procedure completed successfully.