Mercury IPS

Mercury_IPS(uid, visa_resource)

Bases: Instrument

Class for controlling the Oxford Instruments Mercury IPS device.

clamp()

Sets the device to clamp mode.

Returns:

Name	Type	Description
int	int	The response.

force_heater_on()

Forces the heater to turn on.

Returns:

Name	Type	Description
int	int	The response.

get_current_sweep_rate()

Gets the current sweep rate.

Returns:

Name	Type	Description
float	float	The current sweep rate in amperes per second.

get_field_sweep_rate()

Gets the field sweep rate.

Returns:

Name	Type	Description
float	float	The field sweep rate in tesla per second.

get_lead_resistance()

Gets the lead resistance.

Returns:

Name	Type	Description
float	float	The lead resistance in ohms.

get_magnet_current()

Gets the magnet current.

Returns:

Name	Type	Description
float	float	The magnet current in amperes.

get_magnet_inductance()

Gets the magnet inductance.

Returns:

Name	Type	Description
float	float	The magnet inductance in henries.

get_negative_current_limit()

Gets the negative current limit.

Returns:

Name	Type	Description
float	float	The negative current limit in amperes.

get_output_current()

Gets the output current.

Returns:

Name	Type	Description
float	float	The output current in amperes.

get_output_field()

Gets the output magnetic field.

Returns:

Name	Type	Description
float	float	The output magnetic field in tesla.

get_persistent_current()

Gets the persistent current.

Returns:

Name	Type	Description
float	float	The persistent current in amperes.

get_persistent_field()

Gets the persistent magnetic field.

Returns:

Name	Type	Description
float	float	The persistent magnetic field in tesla.

get_positive_current_limit()

Gets the positive current limit.

Returns:

Name	Type	Description
float	float	The positive current limit in amperes.

get_setpoint_current()

Gets the setpoint current.

Returns:

Name	Type	Description
float	float	The setpoint current in amperes.

get_setpoint_field()

Gets the setpoint magnetic field.

Returns:

Name	Type	Description
float	float	The setpoint magnetic field in tesla.

get_software_voltage_limit()

Gets the software voltage limit.

Returns:

Name	Type	Description
float	float	The software voltage limit in volts.

get_supply_voltage()

Gets the supply voltage.

Returns:

Name	Type	Description
float	float	The supply voltage in volts.

get_switch_heater_current()

Gets the switch heater current.

Returns:

Name	Type	Description
float	float	The switch heater current in amperes.

get_trip_current()

Gets the trip current.

Returns:

Name	Type	Description
float	float	The trip current in amperes.

get_trip_field()

Gets the trip magnetic field.

Returns:

Name	Type	Description
float	float	The trip magnetic field in tesla.

hold()

Sets the device to hold mode.

Returns:

Name	Type	Description
int	int	The response.

identify()

Identifies the device.

Returns:

Name	Type	Description
str	str	The identification string.

local_and_unlocked()

Sets the device to local and unlocked mode.

Returns:

Name	Type	Description
str	str	The response.

remote_and_locked()

Sets the device to remote and locked mode.

Returns:

Name	Type	Description
str	str	The response.

remote_and_unlocked()

Sets the device to remote and unlocked mode.

Returns:

Name	Type	Description
str	str	The response.

set_current_sweep_rate(rate)

Sets the current sweep rate.

Parameters:

Name	Type	Description	Default
rate	float	The current sweep rate in amperes per second.	required

Returns:

Name	Type	Description
int	int	The response.

set_field_sweep_rate(rate)

Sets the field sweep rate.

Parameters:

Name	Type	Description	Default
rate	float	The field sweep rate in tesla per second.	required

Returns:

Name	Type	Description
int	int	The response.

set_target_current(current)

Sets the target current.

Parameters:

Name	Type	Description	Default
current	float	The target current in amperes.	required

Returns:

Name	Type	Description
int	int	The response.

set_target_field(field)

Sets the target magnetic field.

Parameters:

Name	Type	Description	Default
field	float	The target magnetic field in tesla.	required

Returns:

Name	Type	Description
int	int	The response.

switch_heater_off()

Turns off the heater.

Returns:

Name	Type	Description
str	str	The response.

switch_heater_on()

Turns on the heater.

Returns:

Name	Type	Description
str	str	The response.

to_setpoint()

Moves the device to the setpoint.

Returns:

Name	Type	Description
int	int	The response.

to_zero()

Moves the device to zero.

Returns:

Name	Type	Description
int	int	The response.