devices.PowerSupply Interface Reference

Inheritance diagram for devices.PowerSupply:

Collaboration diagram for devices.PowerSupply:

Public Member Functions
void	reset () throws IOException
Double	getVoltage () throws IOException
Double	getMeasuredVoltage () throws IOException
void	setVoltage (double newVoltage) throws IOException
Double	getCurrent () throws IOException
void	setCurrent (double newCurrent) throws IOException
int	getDeviceAddress ()
void	outputOn () throws IOException
void	outputOff () throws IOException

Public Attributes
String	GET_ADDRESS_COMMAND = "ADR %d\r"
String	GET_VOLTAGE_COMMAND = "PV?\r"
String	SET_VOLTAGE_COMMAND = "PV %.3f\r"
String	GET_CURRENT_COMMAND = "PC?\r"
String	SET_CURRENT_COMMAND = "PC %.3f\r"
String	SET_OUTPUT_COMMAND = "OUT %s\r"
String	RESET_COMMAND = "RST\r"
String	OK_RESPONSE = "OK"
String	OFF = "0"
String	ON = "1"
String	GET_MEASURED_VOLTAGE_COMMAND = "MV?\r"

Detailed Description

Describes all methods that the power supply implements

Definition at line 8 of file PowerSupply.java.

Member Function Documentation

Double devices.PowerSupply.getCurrent

(

)

throws IOException

Returns

The current in Amperes that the power supply is set to output.

Exceptions

IOException

If the command could not be sent to the device

Implemented in devices.TDKLambdaPowerSupply.

int devices.PowerSupply.getDeviceAddress

(

)

Returns

The address that this device is mapped to

Implemented in devices.TDKLambdaPowerSupply.

Double devices.PowerSupply.getMeasuredVoltage

(

)

throws IOException

Returns

The measured voltage

Exceptions

IOException

If the value cannot be retrieved

Implemented in devices.TDKLambdaPowerSupply.

Double devices.PowerSupply.getVoltage

(

)

throws IOException

Returns

The voltage value that the supply is set to output, in Volts.

Exceptions

IOException

if the command could not be sent

Implemented in devices.TDKLambdaPowerSupply.

void devices.PowerSupply.outputOff

(

)

throws IOException

Turn the output off

Exceptions

IOException

If the command could not be sent

Implemented in devices.TDKLambdaPowerSupply.

void devices.PowerSupply.outputOn

(

)

throws IOException

Turn the output on

Exceptions

IOException

If the command could not be sent to the device

Implemented in devices.TDKLambdaPowerSupply.

void devices.PowerSupply.reset

(

)

throws IOException

Bring the device to a known safe state

Exceptions

IOException

if the command could not be sent

Implemented in devices.TDKLambdaPowerSupply.

void devices.PowerSupply.setCurrent

(

double

newCurrent

)

throws IOException

Parameters

newCurrent

The current in Amperes, to set the device to

Exceptions

IOException

If the current could not be set

Implemented in devices.TDKLambdaPowerSupply.

void devices.PowerSupply.setVoltage

(

double

newVoltage

)

throws IOException

Parameters

newVoltage

The voltage to which the device output is to be set

Exceptions

IOException

If the command could not be sent to the device

Implemented in devices.TDKLambdaPowerSupply.

Member Data Documentation

String devices.PowerSupply.GET_ADDRESS_COMMAND = "ADR %d\r"

Command to send to the power supply to specify the address of the device. The format parameter is the address of the device to use.

This command MUST be sent to the power supply with the address matching that of the device address before the supply will accept remote commands

Definition at line 18 of file PowerSupply.java.

String devices.PowerSupply.GET_CURRENT_COMMAND = "PC?\r"

Command to return the current that the Power supply has been set to

Definition at line 34 of file PowerSupply.java.

String devices.PowerSupply.GET_VOLTAGE_COMMAND = "PV?\r"

Command to return the voltage that is set on the device

Definition at line 23 of file PowerSupply.java.

String devices.PowerSupply.OFF = "0"

Represents the device output mode being off

Definition at line 65 of file PowerSupply.java.

String devices.PowerSupply.OK_RESPONSE = "OK"

Command returned by the device to indicate that a command has been processed successfully.

Definition at line 60 of file PowerSupply.java.

String devices.PowerSupply.ON = "1"

Represents the device output mode being on

Definition at line 70 of file PowerSupply.java.

String devices.PowerSupply.RESET_COMMAND = "RST\r"

Command to bring the device to a known state.

Definition at line 54 of file PowerSupply.java.

String devices.PowerSupply.SET_CURRENT_COMMAND = "PC %.3f\r"

Command to set the current to a desired value. The format parameter is the current that the value should be set to.

Definition at line 40 of file PowerSupply.java.

String devices.PowerSupply.SET_OUTPUT_COMMAND = "OUT %s\r"

Command to set the output mode to a specific value. The format parameter should be either PowerSupply#OFF or PowerSupply#ON, to indicate the desired output status. An output status of PowerSupply#ON indicates that power is flowing out of the power supply.

Definition at line 49 of file PowerSupply.java.

String devices.PowerSupply.SET_VOLTAGE_COMMAND = "PV %.3f\r"

Command to set the voltage to a specific amount. The format parameter is a float representing the value of the voltage to be set

Definition at line 29 of file PowerSupply.java.

---

The documentation for this interface was generated from the following file:

• PowerSupply.java