org.lsst.ccs.drivers.optidrive
Class Optidrive

java.lang.Object
  org.lsst.ccs.drivers.optidrive.Optidrive

public class Optidrive
extends Object

Accesses an Optidrive controller

Author:

Owen Saxton

Field Summary

static short	CTRL_CONTROL_WORD Public constants
static short	CTRL_FREQUENCY_SETPOINT Public constants
static short	CTRL_MODBUS_RAMP_TIME Public constants
static short	PARM_ACCEL_RAMP_TIME
static short	PARM_ACCESS_CODE
static short	PARM_ACCESS_CODE_DEFN
static short	PARM_ANALOG_INPUT_FORMAT
static short	PARM_ANALOG_INPUT_OFFSET
static short	PARM_ANALOG_INPUT_SCALING
static short	PARM_ANALOG_OUTPUT_FUNC
static short	PARM_BAUDRATE_TRIP_TIME
static short	PARM_BOOST_VOLTAGE
static short	PARM_BRAKE_CIRCUIT_ENABLE
static short	PARM_CONTROL_MODE
static short	PARM_DC_INJECTION_ENABLE
static short	PARM_DECEL_RAMP_TIME
static short	PARM_DIGITAL_INPUT_FUNC
static short	PARM_DIGITAL_OUTPUT_LIMIT
static short	PARM_DISPLAY_SCALE_FACTOR
static short	PARM_EFF_SWITCH_FREQ
static short	PARM_ENERGY_SAVE
static short	PARM_KEYPAD_RESTART_MODE
static short	PARM_MAX_SPEED_LIMIT
static short	PARM_MIN_SPEED_LIMIT
static short	PARM_MOTOR_RATED_CURRENT
static short	PARM_MOTOR_RATED_FREQ
static short	PARM_MOTOR_RATED_SPEED
static short	PARM_MOTOR_RATED_VOLTAGE
static short	PARM_PARAMETER_LOCK
static short	PARM_PRESET_SPEED_1
static short	PARM_PRESET_SPEED_2
static short	PARM_PRESET_SPEED_3
static short	PARM_PRESET_SPEED_4
static short	PARM_RELAY_OUTPUT_FUNC
static short	PARM_SECOND_ANALOG_FORMAT
static short	PARM_SECOND_DECEL_RAMP
static short	PARM_SKIP_FREQENCY_BAND
static short	PARM_SKIP_FREQUENCY
static short	PARM_SPIN_START_ENABLE
static short	PARM_START_MODE
static short	PARM_STOP_MODE
static short	PARM_TRIP_LOG
static short	PARM_USER_PI_DIGITAL_REFC
static short	PARM_USER_PI_FEEDBACK
static short	PARM_USER_PI_I_TIME_CONST
static short	PARM_USER_PI_MODE
static short	PARM_USER_PI_P_GAIN
static short	PARM_USER_PI_REFERENCE
static short	PARM_VF_ADJUST_FREQUENCY
static short	PARM_VF_ADJUST_VOLTAGE
static short	STAT_ANALOG_INPUT_1
static short	STAT_ANALOG_INPUT_2
static short	STAT_DC_BUS_VOLTAGE
static short	STAT_DIGITAL_INPUT_STATUS
static short	STAT_DRIVE_TEMPERATURE
static short	STAT_DRIVE_TYPE
static short	STAT_ERROR_AND_STATUS
static short	STAT_IO_SOFTWARE_VERSN
static short	STAT_MOTOR_CURRENT
static short	STAT_MOTOR_SOFTWARE_VERSN
static short	STAT_OUTPUT_FREQUENCY
static short	STAT_POWER_RATING
static short	STAT_RATING_ID
static short	STAT_SPEED_REFERENCE
static short	STAT_VOLTAGE_RATING

Constructor Summary

Optidrive()
Constructors

Optidrive(Optidrive od, int busAddr)

Method Summary

void	close() Closes the connection to the controller
short	getControl(int ctrl) Gets a control register
short[]	getControl(int ctrl, int count) Gets multiple control registers
short	getParameter(int parm) Gets a parameter
short[]	getParameters(int parm, int count) Gets multiple parameters
short	getStatus(int stat) Gets a status register
short[]	getStatus(int stat, int count) Gets multiple status registers
void	open(int index, String serial, int busAddr) Opens a connection to the controller
void	open(String node, int index, String serial, int busAddr) Opens a connection to the controller
short	readRegister(int nmbr) Reads a register
short[]	readRegisters(int nmbr, int count) Reads multiple registers
void	setControl(int ctrl, int value) Sets a control register
void	setParameter(int parm, int value) Sets a parameter
void	writeRegister(int nmbr, int value) Writes a register

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CTRL_CONTROL_WORD

public static final short CTRL_CONTROL_WORD

Public constants

See Also:

Constant Field Values

CTRL_FREQUENCY_SETPOINT

public static final short CTRL_FREQUENCY_SETPOINT

Public constants

See Also:

Constant Field Values

CTRL_MODBUS_RAMP_TIME

public static final short CTRL_MODBUS_RAMP_TIME

Public constants

See Also:

Constant Field Values

STAT_ERROR_AND_STATUS

public static final short STAT_ERROR_AND_STATUS

See Also:

Constant Field Values

STAT_OUTPUT_FREQUENCY

public static final short STAT_OUTPUT_FREQUENCY

See Also:

Constant Field Values

STAT_MOTOR_CURRENT

public static final short STAT_MOTOR_CURRENT

See Also:

Constant Field Values

STAT_DIGITAL_INPUT_STATUS

public static final short STAT_DIGITAL_INPUT_STATUS

See Also:

Constant Field Values

STAT_RATING_ID

public static final short STAT_RATING_ID

See Also:

Constant Field Values

STAT_POWER_RATING

public static final short STAT_POWER_RATING

See Also:

Constant Field Values

STAT_VOLTAGE_RATING

public static final short STAT_VOLTAGE_RATING

See Also:

Constant Field Values

STAT_IO_SOFTWARE_VERSN

public static final short STAT_IO_SOFTWARE_VERSN

See Also:

Constant Field Values

STAT_MOTOR_SOFTWARE_VERSN

public static final short STAT_MOTOR_SOFTWARE_VERSN

See Also:

Constant Field Values

STAT_DRIVE_TYPE

public static final short STAT_DRIVE_TYPE

See Also:

Constant Field Values

STAT_ANALOG_INPUT_1

public static final short STAT_ANALOG_INPUT_1

See Also:

Constant Field Values

STAT_ANALOG_INPUT_2

public static final short STAT_ANALOG_INPUT_2

See Also:

Constant Field Values

STAT_SPEED_REFERENCE

public static final short STAT_SPEED_REFERENCE

See Also:

Constant Field Values

STAT_DC_BUS_VOLTAGE

public static final short STAT_DC_BUS_VOLTAGE

See Also:

Constant Field Values

STAT_DRIVE_TEMPERATURE

public static final short STAT_DRIVE_TEMPERATURE

See Also:

Constant Field Values

PARM_MAX_SPEED_LIMIT

public static final short PARM_MAX_SPEED_LIMIT

See Also:

Constant Field Values

PARM_MIN_SPEED_LIMIT

public static final short PARM_MIN_SPEED_LIMIT

See Also:

Constant Field Values

PARM_ACCEL_RAMP_TIME

public static final short PARM_ACCEL_RAMP_TIME

See Also:

Constant Field Values

PARM_DECEL_RAMP_TIME

public static final short PARM_DECEL_RAMP_TIME

See Also:

Constant Field Values

PARM_STOP_MODE

public static final short PARM_STOP_MODE

See Also:

Constant Field Values

PARM_ENERGY_SAVE

public static final short PARM_ENERGY_SAVE

See Also:

Constant Field Values

PARM_MOTOR_RATED_VOLTAGE

public static final short PARM_MOTOR_RATED_VOLTAGE

See Also:

Constant Field Values

PARM_MOTOR_RATED_CURRENT

public static final short PARM_MOTOR_RATED_CURRENT

See Also:

Constant Field Values

PARM_MOTOR_RATED_FREQ

public static final short PARM_MOTOR_RATED_FREQ

See Also:

Constant Field Values

PARM_MOTOR_RATED_SPEED

public static final short PARM_MOTOR_RATED_SPEED

See Also:

Constant Field Values

PARM_BOOST_VOLTAGE

public static final short PARM_BOOST_VOLTAGE

See Also:

Constant Field Values

PARM_CONTROL_MODE

public static final short PARM_CONTROL_MODE

See Also:

Constant Field Values

PARM_TRIP_LOG

public static final short PARM_TRIP_LOG

See Also:

Constant Field Values

PARM_ACCESS_CODE

public static final short PARM_ACCESS_CODE

See Also:

Constant Field Values

PARM_DIGITAL_INPUT_FUNC

public static final short PARM_DIGITAL_INPUT_FUNC

See Also:

Constant Field Values

PARM_ANALOG_INPUT_FORMAT

public static final short PARM_ANALOG_INPUT_FORMAT

See Also:

Constant Field Values

PARM_EFF_SWITCH_FREQ

public static final short PARM_EFF_SWITCH_FREQ

See Also:

Constant Field Values

PARM_RELAY_OUTPUT_FUNC

public static final short PARM_RELAY_OUTPUT_FUNC

See Also:

Constant Field Values

PARM_DIGITAL_OUTPUT_LIMIT

public static final short PARM_DIGITAL_OUTPUT_LIMIT

See Also:

Constant Field Values

PARM_PRESET_SPEED_1

public static final short PARM_PRESET_SPEED_1

See Also:

Constant Field Values

PARM_PRESET_SPEED_2

public static final short PARM_PRESET_SPEED_2

See Also:

Constant Field Values

PARM_PRESET_SPEED_3

public static final short PARM_PRESET_SPEED_3

See Also:

Constant Field Values

PARM_PRESET_SPEED_4

public static final short PARM_PRESET_SPEED_4

See Also:

Constant Field Values

PARM_SECOND_DECEL_RAMP

public static final short PARM_SECOND_DECEL_RAMP

See Also:

Constant Field Values

PARM_ANALOG_OUTPUT_FUNC

public static final short PARM_ANALOG_OUTPUT_FUNC

See Also:

Constant Field Values

PARM_SKIP_FREQUENCY

public static final short PARM_SKIP_FREQUENCY

See Also:

Constant Field Values

PARM_SKIP_FREQENCY_BAND

public static final short PARM_SKIP_FREQENCY_BAND

See Also:

Constant Field Values

PARM_VF_ADJUST_VOLTAGE

public static final short PARM_VF_ADJUST_VOLTAGE

See Also:

Constant Field Values

PARM_VF_ADJUST_FREQUENCY

public static final short PARM_VF_ADJUST_FREQUENCY

See Also:

Constant Field Values

PARM_START_MODE

public static final short PARM_START_MODE

See Also:

Constant Field Values

PARM_KEYPAD_RESTART_MODE

public static final short PARM_KEYPAD_RESTART_MODE

See Also:

Constant Field Values

PARM_DC_INJECTION_ENABLE

public static final short PARM_DC_INJECTION_ENABLE

See Also:

Constant Field Values

PARM_SPIN_START_ENABLE

public static final short PARM_SPIN_START_ENABLE

See Also:

Constant Field Values

PARM_BRAKE_CIRCUIT_ENABLE

public static final short PARM_BRAKE_CIRCUIT_ENABLE

See Also:

Constant Field Values

PARM_ANALOG_INPUT_SCALING

public static final short PARM_ANALOG_INPUT_SCALING

See Also:

Constant Field Values

PARM_BAUDRATE_TRIP_TIME

public static final short PARM_BAUDRATE_TRIP_TIME

See Also:

Constant Field Values

PARM_ACCESS_CODE_DEFN

public static final short PARM_ACCESS_CODE_DEFN

See Also:

Constant Field Values

PARM_PARAMETER_LOCK

public static final short PARM_PARAMETER_LOCK

See Also:

Constant Field Values

PARM_ANALOG_INPUT_OFFSET

public static final short PARM_ANALOG_INPUT_OFFSET

See Also:

Constant Field Values

PARM_DISPLAY_SCALE_FACTOR

public static final short PARM_DISPLAY_SCALE_FACTOR

See Also:

Constant Field Values

PARM_USER_PI_P_GAIN

public static final short PARM_USER_PI_P_GAIN

See Also:

Constant Field Values

PARM_USER_PI_I_TIME_CONST

public static final short PARM_USER_PI_I_TIME_CONST

See Also:

Constant Field Values

PARM_USER_PI_MODE

public static final short PARM_USER_PI_MODE

See Also:

Constant Field Values

PARM_USER_PI_REFERENCE

public static final short PARM_USER_PI_REFERENCE

See Also:

Constant Field Values

PARM_USER_PI_DIGITAL_REFC

public static final short PARM_USER_PI_DIGITAL_REFC

See Also:

Constant Field Values

PARM_USER_PI_FEEDBACK

public static final short PARM_USER_PI_FEEDBACK

See Also:

Constant Field Values

PARM_SECOND_ANALOG_FORMAT

public static final short PARM_SECOND_ANALOG_FORMAT

See Also:

Constant Field Values

Constructor Detail

Optidrive

public Optidrive()

Constructors

Optidrive

public Optidrive(Optidrive od,
                 int busAddr)

Method Detail

open

public void open(int index,
                 String serial,
                 int busAddr)
          throws OptidriveException

Opens a connection to the controller

Throws:

OptidriveException

open

public void open(String node,
                 int index,
                 String serial,
                 int busAddr)
          throws OptidriveException

Opens a connection to the controller

Throws:

OptidriveException

close

public void close()
           throws OptidriveException

Closes the connection to the controller

Throws:

OptidriveException

readRegister

public short readRegister(int nmbr)
                   throws OptidriveException

Reads a register

Throws:

OptidriveException

readRegisters

public short[] readRegisters(int nmbr,
                             int count)
                      throws OptidriveException

Reads multiple registers

Throws:

OptidriveException

writeRegister

public void writeRegister(int nmbr,
                          int value)
                   throws OptidriveException

Writes a register

Throws:

OptidriveException

getControl

public short getControl(int ctrl)
                 throws OptidriveException

Gets a control register

Throws:

OptidriveException

getControl

public short[] getControl(int ctrl,
                          int count)
                   throws OptidriveException

Gets multiple control registers

Throws:

OptidriveException

setControl

public void setControl(int ctrl,
                       int value)
                throws OptidriveException

Sets a control register

Throws:

OptidriveException

getStatus

public short getStatus(int stat)
                throws OptidriveException

Gets a status register

Throws:

OptidriveException

getStatus

public short[] getStatus(int stat,
                         int count)
                  throws OptidriveException

Gets multiple status registers

Throws:

OptidriveException

getParameter

public short getParameter(int parm)
                   throws OptidriveException

Gets a parameter

Throws:

OptidriveException

getParameters

public short[] getParameters(int parm,
                             int count)
                      throws OptidriveException

Gets multiple parameters

Throws:

OptidriveException

setParameter

public void setParameter(int parm,
                         int value)
                  throws OptidriveException

Sets a parameter

Throws:

OptidriveException