devices.TDKLambdaPowerSupply Class Reference

Inheritance diagram for devices.TDKLambdaPowerSupply:

Collaboration diagram for devices.TDKLambdaPowerSupply:

Public Member Functions
	TDKLambdaPowerSupply (String deviceName, PortCommunicator portCommunicator, int deviceAddress) throws IOException
String	getName ()
int	getDeviceAddress ()
Double	getVoltage () throws IOException
void	setVoltage (double newVoltage) throws IOException
void	reset () throws IOException
Double	getCurrent () throws IOException
void	setCurrent (double newCurrent) throws IOException
void	outputOff () throws IOException
void	outputOn () throws IOException

Additional Inherited Members
Public Attributes inherited from devices.PowerSupply
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"

Detailed Description

Contains methods for working with the power supply

Definition at line 11 of file TDKLambdaPowerSupply.java.

Constructor & Destructor Documentation

devices.TDKLambdaPowerSupply.TDKLambdaPowerSupply	(	String	deviceName,
		PortCommunicator	portCommunicator,
		int	deviceAddress
	)		throws IOException

Constructs an instance of the power supply, and places the device into a state where it's capable of accepting remote commands. For the TDK Lambda power supply, this means the "ADR" command must be sent to the device with its matching address. This command must return an "OK" response.

Parameters

deviceName	The name of the device
portCommunicator	A tool capable of communicating with the device
deviceAddress	An integer representing the address of the device on the given port

Exceptions

IOException

If the device cannot be initialized

Definition at line 31 of file TDKLambdaPowerSupply.java.

                         {
        super(deviceName, portCommunicator);
        this.deviceAddress = deviceAddress;
        this.startDevice();
    }

Member Function Documentation

Double devices.TDKLambdaPowerSupply.getCurrent

(

)

throws IOException

Returns

The currently-set value of the current that the device is to output

Exceptions

IOException

if the current value cannot be retrieved from the device

Implements devices.PowerSupply.

Definition at line 88 of file TDKLambdaPowerSupply.java.

                                                            {
        return this.writeWithDoubleResponse(GET_CURRENT_COMMAND);
    }

int devices.TDKLambdaPowerSupply.getDeviceAddress

(

)

Returns

The address of the device

Implements devices.PowerSupply.

Definition at line 50 of file TDKLambdaPowerSupply.java.

                                           {
        return this.deviceAddress;
    }

String devices.TDKLambdaPowerSupply.getName

(

)

Returns

The name of the device

Implements devices.NamedDevice.

Definition at line 43 of file TDKLambdaPowerSupply.java.

                                     {
        return deviceName;
    }

Double devices.TDKLambdaPowerSupply.getVoltage

(

)

throws IOException

Returns

The voltage that the device is currently set to output

Exceptions

IOException

if the command to get this value cannot be written

Implements devices.PowerSupply.

Definition at line 58 of file TDKLambdaPowerSupply.java.

                                                            {
        return this.writeWithDoubleResponse(GET_VOLTAGE_COMMAND);
    }

void devices.TDKLambdaPowerSupply.outputOff

(

)

throws IOException

Turn off the device output

Exceptions

IOException

If the command to turn the device off could not be sent

Implements devices.PowerSupply.

Definition at line 109 of file TDKLambdaPowerSupply.java.

                                                         {
        String commandToWrite = String.format(
            PowerSupply.SET_OUTPUT_COMMAND, PowerSupply.OFF
        );

        this.writeWithOKResponse(commandToWrite);
    }

void devices.TDKLambdaPowerSupply.outputOn

(

)

throws IOException

Turn the device output on

Exceptions

IOException

If the command to turn the power supply on could not be sent

Implements devices.PowerSupply.

Definition at line 122 of file TDKLambdaPowerSupply.java.

                                                        {
        String command = String.format(
            PowerSupply.SET_OUTPUT_COMMAND, PowerSupply.ON
        );

        this.writeWithOKResponse(command);
    }

void devices.TDKLambdaPowerSupply.reset

(

)

throws IOException

Bring the device to a safe, known state.

Exceptions

IOException

If this cannot be done

Implements devices.PowerSupply.

Definition at line 78 of file TDKLambdaPowerSupply.java.

                                                     {
        this.writeWithOKResponse(RESET_COMMAND);
    }

void devices.TDKLambdaPowerSupply.setCurrent

(

double

newCurrent

)

throws IOException

Parameters

newCurrent

The current in Amperes, to set the device to

Exceptions

IOException

If the command to set the current cannot be sent

Implements devices.PowerSupply.

Definition at line 96 of file TDKLambdaPowerSupply.java.

                                                                           {
        String commandToWrite = String.format(
            PowerSupply.SET_CURRENT_COMMAND, newCurrent
        );

        this.writeWithOKResponse(commandToWrite);
    }

void devices.TDKLambdaPowerSupply.setVoltage

(

double

newVoltage

)

throws IOException

Parameters

newVoltage

The voltage to which the device output is to be set

Exceptions

IOException

If the command to set this voltage could not be sent to the device

Implements devices.PowerSupply.

Definition at line 67 of file TDKLambdaPowerSupply.java.

                                                                           {
        String commandToWrite = String.format(
            PowerSupply.SET_VOLTAGE_COMMAND, newVoltage
        );
        this.writeWithOKResponse(commandToWrite);
    }

---

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

• TDKLambdaPowerSupply.java