msl.equipment.resources.cmi.sia3 module

Establishes a connection to the Switched Integrator Amplifier (SIA3 board) that is designed by the Czech Metrology Institute.

class msl.equipment.resources.cmi.sia3.IntegrationTime(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: IntEnum

The amount of time to integrate the photo-diode signal.

TIME_50u = 5
TIME_100u = 6
TIME_1m = 7
TIME_10m = 8
TIME_20m = 9
TIME_100m = 10
TIME_200m = 11
TIME_500m = 12
TIME_1 = 13
TIME_2 = 14
class msl.equipment.resources.cmi.sia3.SIA3(record)[source]

Bases: ConnectionSerial

Establishes a connection to the Switched Integrator Amplifier (SIA3 board) that is designed by the Czech Metrology Institute.

Do not instantiate this class directly. Use the connect() method to connect to the equipment.

Parameters

record (EquipmentRecord) – A record from an Equipment-Register Database.

GAIN

The gain (i.e., the integration time)

alias of IntegrationTime

set_integration_time(time)[source]

Set the integration time (i.e., the gain).

Parameters

time (IntegrationTime) – The integration time as a IntegrationTime enum value or member name, e.g., sia.set_integration_time('10m'), sia.set_integration_time(sia.GAIN.TIME_10m) and sia.set_integration_time(8) are all equivalent statements.

set_ps(ps)[source]

Set the timer pre-scale value.

The timer pre-scale value divides the microprocessor internal frequency by something similar to 2^PS. Therefore, to reach a 2 second integration time the ps value must be set to the maximum value of 7.

Parameters

ps (int) – The timer pre-scale value. Must be in the range [0, 7].

Raises

ValueError – If the value of ps is invalid.