org.lsst.ccs.subsystems.fcs.drivers

Class CanOpenEPOS

java.lang.Object

org.lsst.ccs.subsystems.fcs.drivers.CanOpenDevice

org.lsst.ccs.subsystems.fcs.drivers.CanOpenEPOS

All Implemented Interfaces:

org.lsst.ccs.framework.HasLifecycle, AlertRaiser, EPOSController, PieceOfHardware, EmergencyMessageListener

Direct Known Subclasses:

CanOpenEPOSCarousel, CanOpenEPOSLinearRailTruck, CanOpenEPOSOnlineClamp, SimuEPOSController

public class CanOpenEPOS
extends CanOpenDevice
implements EPOSController

A general model for a controller EPOS.

Author:

virieux

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	enabledToPublish Used to publish on the status bus for the GUI*
protected EPOSEnumerations.EposMode	mode
protected boolean	parametersOK used in checkParameters and initializeAndCheckHardware methods

Fields inherited from class org.lsst.ccs.subsystems.fcs.drivers.CanOpenDevice

booted, errorHistory, errorRegister, inError, initialized, name, nodeID, serialNB, subs, tcpProxy

Fields inherited from interface org.lsst.ccs.subsystems.fcs.common.AlertRaiser

alertSeparater

Constructor Summary

Constructors

Constructor and Description
CanOpenEPOS(int nodeID, String serialNB, Map<String,Integer> paramsForCurrent, Map<String,Integer> paramsForProfilePosition, Map<String,Integer> paramsForHoming) Construction of a CanOpenEPOS.

Method Summary

Modifier and Type	Method and Description
void	changeEPOSParameter(String key, int value) Changes an EPOS parameter for this controller.
void	changeMode(EPOSEnumerations.EposMode newMode) This methods changes the mode to the new mode given as an argument.
void	changeProfileVelocity(int newVelocity) change ProfileVelocity to a new value.
void	checkFault() Check if the Controller is in fault.
void	checkParameters(EPOSEnumerations.EposMode aMode) For every parameter to be defined for this mode this method compares the values in configuration with the value stored in controller CPU and throws a FcsHardwareException if these values are not equal.
void	checkParameters(Map<String,Integer> paramsMap) Compare values of parameters in the map with the values of parameters in the controller CPU.
void	faultReset() Clear faults on the controller and clear alarm that was raised for this controller.
EPOSEnumerations.EposMode	getMode() Return Epos mode for GUI.
void	initializeAndCheckHardware() Check if the parameters in the cPU of the controller have the right values.
boolean	isEnabledToPublish() For GUI.
boolean	isParametersOK() This methods returns true if the values of parameters stored in CPU are the same than those stored in the configuration system.
void	publishData() Publish Data on status bus for trending data base and GUIs.
String	readControlWord() Read the control world (index=6040, subindex=0,size=2)
int	readCurrent() In Current Mode this methods returns the unsCurrent actualy received by the motor.
int	readCurrentAverageValue() In Current Mode this methods returns the average of the unsCurrent received by the motor.
EPOSEnumerations.EposMode	readMode() Reads the EPOS mode in the CPU of the EPOS device, updates the field mode and returns the mode as a String.
int	readParameter(EPOSEnumerations.Parameter param) Reads in the EPOS CPU the value of the Parameter.
protected String	readParameterInHexa(String parameterName) Reads in the EPOS CPU the hexadecimal value of the Parameter and display it in hexadecimal format.
String	readStatusWord() Read the status world (index=6041, subindex=0,size=2)
int	readVelocity() return motor velocity read on controller CPU Unit = RPM
void	restoreParameters() Restore default parameters.
void	setEnabledToPublish(boolean enabledToPublish)
void	writeControlWord(int value) Write a value in hexa in the control world (index=6040, subindex=0,size=2)
void	writeCurrent(int aValue) In unsCurrent mode this methods send a unsCurrent to the motor.
void	writeParameter(EPOSEnumerations.Parameter param, int value) This method writes a parameter in the CPU of the EPOS.
void	writeParameters(EPOSEnumerations.EposMode mode) This methods writes in the CPU of the EPOS devis the values of the parameters set for the mode.
void	writeTargetPosition(int aValue) In PROFILE_POSITION mode this methods set the target position.
void	writeTargetVelocity(int velocity) set target velocity in mode PROFILE_VELOCITY

Methods inherited from class org.lsst.ccs.subsystems.fcs.drivers.CanOpenDevice

configAsHeartbeatConsumer, configAsHeartbeatProducer, createStatusDataPublishedByCanOpenDevice, displayErrorHistory, displayErrorRegister, doInitializePDOs, getAlertService, getErrorHistory, getErrorRegister, getName, getNodeID, getSerialNB, getSubsystem, getTcpProxy, isBooted, isInError, isInitialized, onEmergencyMessage, readErrorHistory, readErrorRegister, readNumberOfErrors, readSDO, readStringSerialNumber, resetError, saveParameters, setBooted, toString, updateFromPDO, writeSDO

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.subsystems.fcs.common.EPOSController

checkCurrent, checkEnabled, checkTargetReached, createStatusDataPublishedByEPOSController, defineAbsolutePosition, disable, displayErrorHistory, enable, enableAndWriteAbsolutePosition, enableAndWriteCurrent, enableAndWriteRelativePosition, getErrorHistory, getErrorRegister, isEnabled, isInError, isInMode, isTargetReached, quickStop, readNumberOfErrors, readParameter, readParameters, readParameters, readParameters, readPosition, readPositionSensorType, readProfileVelocity, readSSIPosition, startVelocity, stopAction, stopPosition, stopVelocity, switchOnEnableOperation, writeParameters, writeParameters

Methods inherited from interface org.lsst.ccs.subsystems.fcs.common.PieceOfHardware

checkBooted, checkId, checkInitialized, createStatusDataPublishedByHardware, doInitializePDOs, getName, getNodeID, getSerialNB, initializePDOs, isBooted, isInitialized, printState, raiseAlarmIfMissing, setBooted, updateFromPDO

Methods inherited from interface org.lsst.ccs.subsystems.fcs.drivers.EmergencyMessageListener

onEmergencyMessage, onFault, onFaultReset

Methods inherited from interface org.lsst.ccs.subsystems.fcs.common.AlertRaiser

clearAlarm, getAlertService, getSubsystem, raiseAlarm, raiseAlarm, raiseAlarm, raiseAlarm, raiseAlarm, raiseAlarm, raiseWarning, raiseWarning, raiseWarning, raiseWarning, raiseWarning

Methods inherited from interface org.lsst.ccs.framework.HasLifecycle

build, init, postBuild, postInit, postStart, postStop, shutdownNow, start, stop

Field Detail

parametersOK

protected boolean parametersOK

used in checkParameters and initializeAndCheckHardware methods

mode

protected EPOSEnumerations.EposMode mode

enabledToPublish

protected boolean enabledToPublish

Used to publish on the status bus for the GUI*

Constructor Detail

CanOpenEPOS

public CanOpenEPOS(int nodeID,
                   String serialNB,
                   Map<String,Integer> paramsForCurrent,
                   Map<String,Integer> paramsForProfilePosition,
                   Map<String,Integer> paramsForHoming)

Construction of a CanOpenEPOS.

Parameters:

nodeID -

serialNB -

paramsForCurrent -

paramsForProfilePosition -

paramsForHoming -

Method Detail

isEnabledToPublish

public boolean isEnabledToPublish()

Description copied from interface: EPOSController

For GUI. Doesn't read again controller CPU. Return true if controller is enabled.

Specified by:

isEnabledToPublish in interface EPOSController

Returns:

setEnabledToPublish

public void setEnabledToPublish(boolean enabledToPublish)

Specified by:

setEnabledToPublish in interface EPOSController

isParametersOK

public boolean isParametersOK()

Description copied from interface: EPOSController

This methods returns true if the values of parameters stored in CPU are the same than those stored in the configuration system.

Specified by:

isParametersOK in interface EPOSController

Returns:

true if parameters in the CPU of the controllers have the same values than in configuration system.

getMode

public EPOSEnumerations.EposMode getMode()

Return Epos mode for GUI.

Specified by:

getMode in interface EPOSController

Returns:

readMode

@Command(type=QUERY,
         level=1,
         description="Reads the EPOS mode in the CPU of the EPOS device and updates the field mode.")
public EPOSEnumerations.EposMode readMode()

Reads the EPOS mode in the CPU of the EPOS device, updates the field mode and returns the mode as a String.

Specified by:

readMode in interface EPOSController

Returns:

Throws:

SDORequestException

ShortResponseToSDORequestException

changeMode

@Command(type=ACTION,
         level=1,
         description="Changes EPOS mode in the CPU of the EPOS device and updates the field mode.")
public void changeMode(EPOSEnumerations.EposMode newMode)

This methods changes the mode to the new mode given as an argument. It writes the new mode in the CPU of the EPOS controller and updates the field mode.

Specified by:

changeMode in interface EPOSController

Parameters:

newMode -

Throws:

SDORequestException

changeProfileVelocity

public void changeProfileVelocity(int newVelocity)

change ProfileVelocity to a new value. Used by loader carrier controller to reduce speed.

Specified by:

changeProfileVelocity in interface EPOSController

Parameters:

newVelocity -

changeEPOSParameter

@Command(type=QUERY,
         level=1,
         description="Changes an EPOS parameter for this controller. Writes the new value on the CPU of the controller.Changes the new value in the configuration. But doesn\'t save the new parameter in the CPU. To save in CPU controller, use command saveParameters and saveAllChanges.To save configuration, use command saveAllChanges.")
public void changeEPOSParameter(String key,
                                                                                                                                                                                                                                                                                                                                                                                                                        int value)

Changes an EPOS parameter for this controller. Writes the new value on the CPU of the controller. Changes the new value in the configuration. But doesn't save the new parameter in the CPU. To save it, use command saveAllChanges.

Parameters:

key -

value -

writeParameters

@Command(type=ACTION,
         level=3,
         description="This methods writes in the CPU of the EPOS device the values of the parameters set for the mode given as argument")
public void writeParameters(EPOSEnumerations.EposMode mode)

This methods writes in the CPU of the EPOS devis the values of the parameters set for the mode. Usually the values of the parameters are given by the configuration system.

Specified by:

writeParameters in interface EPOSController

Parameters:

mode -

Throws:

SDORequestException

writeParameter

@Command(type=ACTION,
         level=3,
         description="Set EPOS parameter with the value given as argument.")
public void writeParameter(EPOSEnumerations.Parameter param,
                                                                                                                                                int value)

This method writes a parameter in the CPU of the EPOS. For end user at the console

Specified by:

writeParameter in interface EPOSController

Parameters:

param -

value - in decimal

Throws:

SDORequestException

readParameter

public int readParameter(EPOSEnumerations.Parameter param)

Reads in the EPOS CPU the value of the Parameter.

Specified by:

readParameter in interface EPOSController

Parameters:

param -

Returns:

value of the parameter in decimal format.

Throws:

FcsHardwareException

readParameterInHexa

@Command(type=QUERY,
         level=1,
         description="Reads in the EPOS CPU the value of the Parameter which parameter name is given as argument.")
protected String readParameterInHexa(String parameterName)

Reads in the EPOS CPU the hexadecimal value of the Parameter and display it in hexadecimal format. For end user.

Parameters:

parameterName -

Returns:

value of the parameter in hexa format.

Throws:

FcsHardwareException

initializeAndCheckHardware

@Command(type=QUERY,
         level=1,
         description="Read controller\'s parameter in the CPU for each mode and warn if a parameter has not the same value as in the configuration.Then publish data.")
public void initializeAndCheckHardware()

Check if the parameters in the cPU of the controller have the right values. And if the controller is not in fault.

Specified by:

initializeAndCheckHardware in interface PieceOfHardware

Overrides:

initializeAndCheckHardware in class CanOpenDevice

Throws:

FcsHardwareException

restoreParameters

@Command(type=ACTION,
         level=3,
         description="Restore default parameters. AT YOUR OWN RISK.")
public void restoreParameters()

Restore default parameters.

Throws:

SDORequestException

writeControlWord

@Command(type=ACTION,
         level=1,
         description="Write a value in hexa in the control world (index=6040, subindex=0,size=2)")
public void writeControlWord(int value)

Write a value in hexa in the control world (index=6040, subindex=0,size=2)

Specified by:

writeControlWord in interface EPOSController

Parameters:

value - in hexa

Throws:

SDORequestException

readControlWord

@Command(type=QUERY,
         level=1,
         description="Read the control world (index=6040, subindex=0,size=2)")
public String readControlWord()

Read the control world (index=6040, subindex=0,size=2)

Returns:

value in hexa

Throws:

SDORequestException

ShortResponseToSDORequestException

readStatusWord

@Command(type=QUERY,
         level=1,
         description="Read the status world (index=6041, subindex=0,size=2)")
public String readStatusWord()

Read the status world (index=6041, subindex=0,size=2)

Specified by:

readStatusWord in interface EPOSController

Returns:

value in hexa

Throws:

SDORequestException

ShortResponseToSDORequestException

writeCurrent

@Command(type=ACTION,
         level=3,
         description="Sent current to controller the EPOS CPU. UNIT=mA / FORMAT=decimal")
public void writeCurrent(int aValue)

In unsCurrent mode this methods send a unsCurrent to the motor. This make run the motor.

Specified by:

writeCurrent in interface EPOSController

Parameters:

aValue - UNIT=mA / FORMAT=decimal the value of the unsCurrent to be sent.

Throws:

FcsHardwareException

readCurrent

@Command(type=QUERY,
         level=1,
         alias="readCurrentActualValue",
         description="In Current Mode this methods returns the current actualy received by the motor.")
public int readCurrent()

In Current Mode this methods returns the unsCurrent actualy received by the motor.

Specified by:

readCurrent in interface EPOSController

Returns:

the unsCurrent UNIT=mA / FORMAT=decimal

Throws:

SDORequestException

ShortResponseToSDORequestException

readCurrentAverageValue

@Command(type=QUERY,
         level=1,
         alias="readCurrentAverage",
         description="In Current Mode this methods returns the average of the current  received by the motor.")
public int readCurrentAverageValue()

In Current Mode this methods returns the average of the unsCurrent received by the motor.

Returns:

the unsCurrent UNIT=mA / FORMAT=decimal

Throws:

SDORequestException

ShortResponseToSDORequestException

readVelocity

@Command(type=QUERY,
         level=1,
         description="return motor velocity read on controller CPU. Unit:rpm")
public int readVelocity()

return motor velocity read on controller CPU Unit = RPM

Specified by:

readVelocity in interface EPOSController

Returns:

writeTargetPosition

@Command(type=ACTION,
         level=1,
         description="In PROFILE_POSITION mode this methods set the target position. Target position has to be given in microns.")
public void writeTargetPosition(int aValue)

In PROFILE_POSITION mode this methods set the target position. This make run the motor.

Specified by:

writeTargetPosition in interface EPOSController

Parameters:

aValue - UNIT=mA / FORMAT=decimal the value of the unsCurrent to be sent.

Throws:

RejectedCommandException

SDORequestException

writeTargetVelocity

@Command(type=ACTION,
         level=1,
         description="set target velocity in mode PROFILE_VELOCITY.")
public void writeTargetVelocity(int velocity)

set target velocity in mode PROFILE_VELOCITY

Specified by:

writeTargetVelocity in interface EPOSController

Parameters:

velocity -

checkFault

@Command(type=QUERY,
         level=1,
         description="Check if the Controller is in fault.")
public void checkFault()

Check if the Controller is in fault.

Specified by:

checkFault in interface EPOSController

Throws:

FcsHardwareException

faultReset

@Command(type=ACTION,
         level=1,
         description="Clear faults on the controller.",
         alias="resetFault")
public void faultReset()

Clear faults on the controller and clear alarm that was raised for this controller.

checkParameters

@Command(type=QUERY,
         level=1,
         description="For every parameter to be defined for this mode this method compares the values in configuration with the value stored in controller CPUand throws a FcsHardwareException if these values are not equal.")
public void checkParameters(EPOSEnumerations.EposMode aMode)

For every parameter to be defined for this mode this method compares the values in configuration with the value stored in controller CPU and throws a FcsHardwareException if these values are not equal. values stored in the controller CPU.

Specified by:

checkParameters in interface EPOSController

Throws:

SDORequestException

ShortResponseToSDORequestException

checkParameters

public void checkParameters(Map<String,Integer> paramsMap)

Compare values of parameters in the map with the values of parameters in the controller CPU.

Parameters:

paramsMap -

Throws:

SDORequestException

ShortResponseToSDORequestException

publishData

@Command(type=QUERY,
         level=1,
         alias="refreshGUI",
         description="Publish data for the controller on the status bus.")
public void publishData()

Publish Data on status bus for trending data base and GUIs.

Specified by:

publishData in interface PieceOfHardware

Overrides:

publishData in class CanOpenDevice