PicoPulse module
This module interfaces with the pico-pulse sequence synthesizer device.
- class PicoPulse.PicoPulse(rm, addr, pinoutName=None, configFile=PosixPath('Config/PicoPulse.json'))[source]
Bases:
objectDriver for the pico-pulse sequence synthesizer.
- Parameters:
rm (pyvisa.ResourceManager) – Pass a pyvisa ResourceManager object to use for opening the device.
addr (str) – VISA address of the pico-pulse device.
pinoutName (str, optional) – Name of the config file entry for the device’s pin layout.
configFile (Path, default: Config/PicoPulse.json)
- property currentLimit
Get or set the laser diode current limit in amperes
- Type:
float
- getCurrentLimit()[source]
Get the laser diode current limit.
- Returns:
limit – Current limit in amperes
- Return type:
float
- getLaser()[source]
Gets whether or not the laser driver is enabled.
- Returns:
state – Whether the laser driver is enabled
- Return type:
bool
- getLaserError()[source]
Gets whether or not the laser driver is in an error state.
- Returns:
state – Whether the laser driver is in an error state (true is error)
- Return type:
bool
- getMonitorTarget()[source]
Set the monitor diode target current.
- Returns:
limit – Monitor diode current achived in amperes
- Return type:
float
- property laser
Get or set the state of the laser driver
- Type:
bool
- property laserError
Get the laser driver’s error state
- Type:
bool
- property monitorTarget
Get or set the monitor diode target current in amperes
- Type:
float
- sendSequence(seq, **kwargs)[source]
Encode a sequence and transmit it to the pico-pulse.
- Parameters:
seq (pandas.DataFrame) – Sequence to be encoded. Should have at least one column from ‘ch1’ to ‘ch5’, or the mapped pins.
cycle (bool, default : False) – Whther the timing is given in CPU cycles rather than ns. True is CPU cycles, False is ns.
innerLoop (int, default : 0) – Numer of times the sequence should be copied into the transmit buffer. Helps with short sequences. A value of 0 will instruct the pico-pulse device to fill the entire buffer with copies.
outerLoop (int, default: None) – Numer of times the pico-pulse should repeat the sequence. A value of None will instruct it to repeat the sequence indefinitely.
- setCurrentLimit(target: float)[source]
Set the laser diode current limit.
- Parameters:
target (float) – Current limit in amperes
- Returns:
achieved – Current limit achived in amperes
- Return type:
float
- setLaser(target: bool, force: bool = False)[source]
Enables or disables the laser driver.
- Parameters:
target (bool) – Whether the laser driver should be enabled
force (bool, default: False) – Whether to override the limit and monitor safety interlocks. Leaving it False is strongly recommended, especially if the external power was applied before the microcontroller was plugged in.
- Returns:
success – Indicate success
- Return type:
bool