herosdevices.hardware.bristol.wlm

Includes classes for controlling Bristol Instruments wavemeters.

Module Contents

herosdevices.hardware.bristol.wlm.DEFAULT_OBSERVABLES

class herosdevices.hardware.bristol.wlm.WLM871(address: str, *args, **kwargs)

Bases: herosdevices.core.templates.TelnetDeviceTemplate

Controller for the Bristol Instruments 871A Laser Wavelength Meter with network interface.

wavelength

frequency

wavenumber

power

temperature

pressure

light_type

auto_exposure

observables: dict

set_averaging(state: Literal['ON', 'OFF'] | bool, count: int | None = None) → None

Set averaging state and optionally count.

Parameters:

• state – Averaging state (‘ON’, ‘OFF’, or boolean)

• count – Number of readings to average (2-128), if None, current set value is not changes

get_averaging() → dict[str, Any]

Get current averaging settings.

Returns:

Dictionary with ‘state’ (str) and ‘count’ (int)

get_averaged_data(data_type: Literal['POW', 'FREQ', 'WAV', 'WNUM'] = 'WAV') → float

Get averaged data for the specified type.

Parameters:

data_type – Type of data to get (‘POW’, ‘FREQ’, ‘WAV’, ‘WNUM’)

Returns:

Averaged value as float

calibrate() → None

Initiate instrument calibration.

get_calibration_settings() → dict[str, Any]

Get all calibration settings.

Returns:

Dictionary with calibration method, temperature, and timer settings

set_calibration_settings(method: Literal['OFF', 'TIME', 'TEMP'] | None = None, temperature_change: int | None = None, timer_minutes: int | None = None) → None

Set calibration settings at once.

Settings not specified or None are not changed.

Parameters:

• method – Calibration method (‘OFF’, ‘TIME’, ‘TEMP’)

• temperature_change – Temperature change in 1/10th °C (1-50)

• timer_minutes – Time between calibrations in minutes (5-1440)

memory_clear() → None

Clear all measurements in the memory buffer.

memory_start_record() → None

Start writing measured data to the memory buffer.

memory_stop_record() → None

Stop writing measured data to the memory buffer.

memory_get_data() → numpy.ndarray

Get buffered data from memory.

Returns:

Buffered data as numpy array (format defined in manual)

get_identity() → str

Get instrument identification.

Returns:

Instrument identification string

get_error() → tuple[int, str]

Get error from error queue.

Returns:

Tuple of (error_number, error_message)

save_settings() → None

Save current instrument settings.

recall_settings() → None

Recall saved instrument settings.

reset_instrument() → None

Reset instrument to default state.

address

connection

write

read