Santec TSL-500 Series Tunable Laser

class pymeasure.instruments.santec.tsl500series.TSL500Series(adapter, name='Santec TSL-500 Series', **kwargs)

Bases: SCPIMixin, Instrument

Represents a Santec TSL-500 Series Tunable Laser and provides a high-level interface for interacting with the instrument.

check_errors()

Read all errors from the instrument.

Returns:

List of error entries.

check_get_errors()

Check for errors after having gotten a property and log them.

Called if check_get_errors=True is set for that property.

If you override this method, you may choose to raise an Exception for certain errors.

Returns:

list – List of error entries.

check_set_errors()

Check for errors after having set a property and log them.

Called if check_set_errors=True is set for that property.

If you override this method, you may choose to raise an Exception for certain errors.

Returns:

list – List of error entries.

clear()

Clear the instrument status byte.

property complete: Any

Get the synchronization bit.

This property allows synchronization between a controller and a device. The Operation Complete query places an ASCII character 1 into the device’s Output Queue when all pending selected device operations have been finished.

property frequency_setpoint: Any

Control the output frequency.

property frequency_start: Any

Control the sweep start frequency.

property frequency_step: Any

Control the sweep step frequency when in step sweep mode.

property frequency_stop: Any

Control the sweep stop frequency.

property id: Any

Get the identification of the instrument.

property next_error: Any

Get the next error in the queue. If you want to read and log all errors, use check_errors() instead.

property options: Any

Get the device options installed.

property output_enabled: Any

Control whether output is enabled (bool).

property power: Any

Measure the monitored optical power, units determined by power_unit.

property power_setpoint: Any

Control the output optical power, units determined by power_unit.

property power_unit: Any

Control the unit of power (str, ‘dBm’ or ‘mW’).

read(**kwargs)

Read up to (excluding) read_termination or the whole read buffer.

Return type:

str

read_binary_values(**kwargs)

Read binary values from the device.

read_bytes(count, **kwargs)

Read a certain number of bytes from the instrument.

Parameters:

• count (int) – Number of bytes to read. A value of -1 indicates to read the whole read buffer.

• kwargs – Keyword arguments for the adapter.

Returns bytes:

Bytes response of the instrument (including termination).

Return type:

bytes

reset()

Reset the instrument.

shutdown()

Brings the instrument to a safe and stable state

Return type:

None

start_repeat()

Start repeated wavelength sweeps.

start_sweep()

Start a single wavelength sweep.

property status: Any

Get the status byte and Master Summary Status bit.

stop_sweep()

Stop the wavelength sweep.

property sweep_count: Any

Get the current number of completed sweeps.

property sweep_cycles: Any

Control the number of sweep repetitions.

property sweep_delay: Any

Control the wait time between consequent scans, in s (float strictly in range 0 to 999.9).

property sweep_dwell: Any

Control the wait time between consequent steps in step sweep mode, in s.

Does not include time for wavelength tuning. (float strictly in range 0 to 999.9)

property sweep_mode: Any

Control the sweep mode as a SweepMode enum.

property sweep_pattern: SweepPattern

Control the sweep pattern as a SweepPattern enum.

property sweep_routing: SweepRouting

Control the sweep routing as a SweepRouting enum.

property sweep_speed: Any

Control the sweep speed, in nm/s (int one of 1, 2, 5, 10, 20, 50, 100, 200).

property sweep_status: Any

Get the current sweep status as a SweepStatus enum.

wait_for(query_delay=None)

Wait for some time. Used by ‘ask’ to wait before reading.

Parameters:

query_delay (Optional[float]) – Delay between writing and reading in seconds. None is default delay. (default: None)

Return type:

None

property wavelength_setpoint: Any

Control the output wavelength.

property wavelength_start: Any

Control the sweep start wavelength.

property wavelength_step: Any

Control the sweep step wavelength when in step sweep mode.

property wavelength_stop: Any

Control the sweep stop wavelength.

write(command, **kwargs)

Write a string command to the instrument appending write_termination.

Parameters:

• command (str) – command string to be sent to the instrument

• kwargs – Keyword arguments for the adapter.

Return type:

None

write_binary_values(command, values, *args, **kwargs)

Write binary values to the device.

Parameters:

• command (str) – Command to send.

• values (Sequence[Union[int, float]]) – The values to transmit.

• **kwargs (*args,) – Further arguments to hand to the Adapter.

Return type:

None

write_bytes(content, **kwargs)

Write the bytes content to the instrument.

Return type:

None