Welcome to DP700’s documentation!¶

General Instructions¶

This software provides ARTIQ support for the RIGOL DP700 series power supplies.

Note

The software is configured for RS232 communication.

Installation¶

Install the DP700 package to your environment using pip with git:

$ python -m pip install git+https://github.com/ARTIQ-Controllers/DP700

DP700 Controller Usage Example¶

First, run the DP700 controller:

$ aqctl_AGUC8 --bind ::1 -p 3251 -s COM1

Note

Anything compatible with serial_for_url can be given as a serial port in -s argument.

For instance, if you want to specify a host IP address and its port:

-s "socket://<host>:<port>". for instance:

-d "socket://192.168.1.220:10001"

Then, send commands via the sipyco_rpctool utility:

$ sipyco_rpctool ::1 3251 list-targets
Target(s):   DP700
$ sipyco_rpctool ::1 3251 call apply(5.0, 1.0) # will apply 5.0V, 1.0A to channel CH1
$ sipyco_rpctool ::1 3251 call measure_all() # will return the measured voltage, current, and power on channel CH1
$ sipyco_rpctool ::1 3251 call channel_on_off('ON') # will turn on channel CH1
$ sipyco_rpctool ::1 3251 call timer_parameter(1, 5.0, 0.5, 3.0) # will set timing parameters for group 1 to 5.0V, 0.5A, 3.0s
$ sipyco_rpctool ::1 3251 call close() # close the device

API¶

class DP700.driver.DP700(portName)¶

Class that builds support for Rigol D700 series power supplies. Creates an instance of Serial using DPPort

Parameters:	portName – Serial port (Uses pySerial serial_for_url)
PortName type:	str

apply(v, i, ch='CH1')¶

Set the channel output voltage and current.

Parameters:	v – voltage i – current in amps (defaults to 5A for DP711 and 3A for DP712) ch – channel (defaults to CH1)
V type:	float (defaults to 0V)
I type:	float
Ch type:	str

channel_mode(ch='CH1')¶

Returns the channel mode. Returns either: ‘CC’ (constant current) ‘CV’ (constant voltage) ‘UR’ (unregulated)

Parameters:	ch – channel (defaults to CH1)
Ch type:	str
Returns:	mode
Return type:	str

channel_on_off(on_off, ch='CH1')¶

Enable or disable the channel output.

Parameters:	on_off – ‘ON’ or ‘OFF’ ch – channel (defaults to CH1)
On_off type:	str
Ch type:	str

clear_ocp(ch='CH1')¶

Clears the internal OCP flag.

Parameters:	ch – channel (defaults to CH1)
Ch type:	str

clear_ovp(ch='CH1')¶

Clears the internal OVP flag.

Parameters:	ch – channel (defaults to CH1)
Ch type:	str

close()¶: Close serial connection.

display(on_off)¶

Turns the display on or off.

Parameters:	on_off – either ‘ON’ or ‘OFF’
On_off type:	str

identify()¶

Returns the device identification.

Returns:	(<make>, <model>, <serial number>, <software version>)
Return type:	tuple

installation_status()¶

Returns the installation status of the following options: Trigger, Timer, and High Resolution

Returns:	(<trigger state>, <timer state>, <high resolution state>)
Return type:	tuple

is_ocp(ch='CH1')¶

Returns whether overcurrent protection (OCP) has occurred.

Parameters:	ch – channel (defaults to CH1)
Ch type:	str
Returns:	‘YES’ or ‘NO’
Return type:	str

is_ovp(ch='CH1')¶

Returns whether overvoltage protection (OVP) has occurred.

Parameters:	ch – channel (defaults to CH1)
Ch type:	str
Returns:	‘YES’ or ‘NO’
Return type:	str

last_error()¶

Returns the last error message in the error queue and clears the error message.

Returns:	error message
Return type:	str

measure_all(ch='CH1')¶

Returns the measured voltage (V), current (A), and power (W) on the selected channel.

Parameters:	ch – channel (defaults to CH1)
Ch type:	str
Returns:	(<voltage>, <current>, <power>)
Return type:	tuple

measure_current(ch='CH1')¶

Returns the measured current on the selected channel.

Parameters:	ch – channel (defaults to CH1)
Ch type:	str
Returns:	current in amps
Return type:	str

measure_power(ch='CH1')¶

Returns the measured power on the selected channel.

Parameters:	ch – channel (defaults to CH1)
Ch type:	str
Returns:	power in watts
Return type:	str

measure_voltage(ch='CH1')¶

Returns the measured voltage on the selected channel.

Parameters:	ch – channel (defaults to CH1)
Ch type:	str
Returns:	voltage
Return type:	str

ocp_on_off(on_off, ch='CH1')¶

Enable or disable OCP.

Parameters:	on_off – ‘ON’ or ‘OFF’ ch – channel (defaults to CH1)
On_off type:	str
Ch type:	str

ocp_value(i, ch='CH1')¶

Sets the channel OCP value.

Parameters:	i – ocp value in amps ch – channel (defaults to CH1)
I type:	float
Ch type:	str

ocp_value_query(ch='CH1')¶

Queries the channel OCP value.

Parameters:	ch – channel (defaults to CH1)
Ch type:	str
Returns:	OCP value in amps
Return type:	str

ovp_on_off(on_off, ch='CH1')¶

Enable or disable OVP.

Parameters:	on_off – ‘ON’ or ‘OFF’ ch – channel (defaults to CH1)
On_off type:	str
Ch type:	str

ovp_value(v, ch='CH1')¶

Sets the channel OVP value.

Parameters:	v – ovp value in volts ch – channel (defaults to CH1)
V type:	float
Ch type:	str

ovp_value_query(ch='CH1')¶

Queries the channel OVP value.

Parameters:	ch – channel (defaults to CH1)
Ch type:	str
Returns:	OVP value in volts
Return type:	str

self_test()¶

Returns the self-test result.

Returns:	self test result
Return type:	str

set_local()¶: Enables the power supply to shift from remote mode to local mode.

set_remote()¶: Enables the power supply to shift from local mode to remote mode.

timer_cycles(num_cycles)¶

Sets the number of cycles for the timer.

Num_cycles type:
Parameters:	num_cycles – Number of cycles. Allowed range is [1, 99999].
	int

timer_cycles_infinite()¶: Sets the number of cycles to infinite.

timer_end_state(end_state)¶

Sets the end state of the timer. Allowed values for end_state are: OFF: output will be turned off after timer cycles are complete LAST: output will be kept at the state of the last group after cycles are complete

Parameters:	end_state – ‘OFF’ or ‘LAST’
End_state type:	str

timer_groups(num_groups)¶

Sets the number of output groups.

Num_groups type:
Parameters:	num_groups – Number of output groups. Allowed range is [1, 2048].
	int

timer_on_off(on_off)¶

Enables or disables the timing output.

Parameters:	on_off – ‘ON’ or ‘OFF’
On_off type:	str

timer_parameter(num, v, i, t)¶

Sets the timing parameters for a specified group.

Parameters:	num – Group ID. Allowed range is [1, 2048] v – Output voltage in volts i – Output current in amps t – Duration time in seconds. Allowed range is [0.01, 99999]
Num type:	int
V type:	float
I type:	float
T type:	float

timer_trigger(trig_mode='DEFAULT')¶

Sets the trigger mode of the timer. Allowed options are: DEFAULT: when timing output is enabled, instrument automatically outputs based on timer parameters SINGLE: when time output is enabled, single press of OK button enables single output of single group

Parameters:	trig_mode – ‘DEFAULT’ or ‘SINGLE’
Trig_mode type:	str

class DP700.dpPort.DPPort(portName=None)¶

Class that extends the functionality of Serial for use with the Agilis controller commands. Creates an instance of Serial

Parameters:	portName – Serial port (Uses pySerial serial_for_url)
PortName type:	str

amInull()¶

Returns whether port has been successfully opened.

Returns:	True if port is open. False if not.
Return type:	bool

close()¶: Close serial connection.

isAquery(command)¶

Returns whether command is a query, as defined by Agilis command reference.

Parameters:	command – Command to check
Command type:	str
Returns:	True if command is a query. False if not.
Return type:	bool

sendString(command)¶

Sends a serial command to the device. Returns a response if command is a query. Else returns 0.

Parameters:	command – Command to send
Command type:	str
Returns:	Return reponse if command is a query. Else returns 0.
Return type:	str or int

ARTIQ Controller¶

Rigol DP700 controller.

Use this controller to drive DP700 series power supplies.

usage: aqctl_DP700 [-h] [--bind BIND] [--no-localhost-bind] [-p PORT]
                   [-s SERIALPORT] [-v] [-q]

Named Arguments¶

`-s, --serialPort`
	Serial port. See documentation for how to specify port.

network server¶

`--bind`	additional hostname or IP address to bind to; use ‘*’ to bind to all interfaces (default: []) Default: []
`--no-localhost-bind`
	do not implicitly also bind to localhost addresses Default: False
`-p, --port`	TCP port to listen on (default: 3251) Default: 3251

verbosity¶

-v, --verbose

increase logging level

Default: 0

-q, --quiet

decrease logging level

Default: 0

Welcome to DP700’s documentation!¶

General Instructions¶

Installation¶

DP700 Controller Usage Example¶

API¶

ARTIQ Controller¶

Named Arguments¶

network server¶

verbosity¶

Indices and tables¶

DP700

Navigation

Related Topics