org.lsst.ccs.subsystems.fcs.drivers

Class CanOpenEPOSLinearRailTruck

java.lang.Object

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

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

org.lsst.ccs.subsystems.fcs.drivers.CanOpenEPOSLinearRailTruck

All Implemented Interfaces:

org.lsst.ccs.framework.AlertHandler, org.lsst.ccs.framework.ClearAlertHandler, org.lsst.ccs.framework.HasLifecycle, AlertRaiser, EPOSController, EPOSControllerForLinearRail, EPOSControllerWithBrake, PieceOfHardware, EmergencyMessageListener

public class CanOpenEPOSLinearRailTruck
extends CanOpenEPOS
implements EPOSControllerForLinearRail

This class is the driver of the EPOS controller EPOS24 which controls motion of Autochanger Trucks on the linear rails.

Author:

virieux

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.framework.ClearAlertHandler

org.lsst.ccs.framework.ClearAlertHandler.ClearAlertCode

Field Summary

Fields

Modifier and Type	Field and Description
protected int	cobid1 define cobid to be able to read values from PDO data.
protected int	cobid2

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

current, enabledToPublish, followingError, mode, parametersOK, position, statusWord, velocity

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

booted, dataProviderDictionaryService, errorHistory, errorRegister, inError, initialized, lastErrorCode, lastErrorName, name, nodeID, serialNB, subs, tcpProxy

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

alertSeparator

Constructor Summary

Constructors

Constructor and Description
CanOpenEPOSLinearRailTruck(int nodeID, String serialNB)

Method Summary

Modifier and Type	Method and Description
void	activateBrakeAndDisable() activateBrakeAndDisable
void	checkConfigDigitalInputOfLinearRails()
void	checkConfigDigitalOutputOfLinearRails()
void	configureDigitalInputOfLinearRails() Configure this controller to be used as an autochanger linear rail truck controller.
void	configureDigitalOutputOfLinearRails() Configuration of an EPOS controller to work with a holding brake.
void	doInitializePDOs() methods for managing PDOs
void	homing()
boolean	isBrakeActivated() return true if brake if activated.
boolean	isHomingDone() return true if homing is done: the controller knows its absolute position.
String	printValuesUpdatedByPDOs() For tests and debug
void	shutdown()
void	updateFromPDO(org.lsst.ccs.drivers.canopenjni.PDOData pdo) process PDOData to retrieve data from this device.

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

build, changeEPOSParameter, changeMode, changeProfileVelocity, checkFault, checkParameters, checkParameters, faultReset, getCurrent, getFollowingError, getMode, getPosition, getVelocity, initializeAndCheckHardware, isEnabledToPublish, isInError, isParametersOK, printControlWord, publishData, readControlWord, readCurrent, readCurrentAverageValue, readFollowingError, readMode, readParameter, readStatusWord, readVelocity, restoreParameters, setEnabledToPublish, writeControlWord, writeCurrent, writeParameter, writeParameters, writeTargetPosition, writeTargetVelocity

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

configAsHeartbeatConsumer, configAsHeartbeatProducer, createStatusDataPublishedByCanOpenDevice, displayError, displayErrorHistory, displayErrorRegister, getAlertService, getErrorHistory, getErrorHistoryNB, getErrorRegister, getLastErrorCode, getLastErrorName, getName, getNodeID, getSerialNB, getSubsystem, getTcpProxy, isBooted, isInitialized, onEmergencyMessage, printSerialNumber, readErrorRegister, readNumberOfErrors, readSDO, resetError, saveParameters, setBooted, toString, updateDeviceInfo, updateErrorHistory, writeSDO, writeTransmissionTypeToDevice

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.EPOSControllerWithBrake

activateBrake, createStatusDataPublishedByEPOSController, doReleaseBrake, enableAndReleaseBrake

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

canClearAlert, changeMode, changeProfileVelocity, checkDisabled, checkEnabled, checkFault, checkHomingDone, checkParameters, checkTargetReached, convertEPOSValue, defineAbsolutePosition, definePositionFromNegativeLimitSwitch, disableOperation, disableVoltage, displayErrorHistory, enable, enableAndWriteAbsolutePosition, enableAndWriteCurrent, enableAndWriteRelativePosition, faultReset, getCurrent, getErrorHistoryNB, getErrorRegister, getLastErrorCode, getLastErrorName, getMode, getPosition, getVelocity, isDisabled, isEnabled, isEnabledToPublish, isInError, isInMode, isParametersOK, isTargetReached, printStatusWordInBinary, quickStop, readControlWord, readCurrent, readCurrentAverageValue, readFollowingError, readMode, readParameter, readParameter, readParameters, readParameters, readParameters, readPosition, readPositionSensorType, readProfileVelocity, readSSIPosition, readStatusWord, readVelocity, setEnabledToPublish, shutdownController, stopAction, stopPosition, stopVelocity, switchOn, switchOnEnableOperation, writeControlWord, writeCurrent, writeParameter, writeParameters, writeParameters, writeParameters, writeTargetPosition, writeTargetVelocity

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

checkBooted, checkId, checkInitialized, createStatusDataPublishedByHardware, getName, getNodeID, getSerialNB, initializeAndCheckHardware, initializePDOs, isBooted, isInitialized, printState, publishData, raiseAlarmIfMissing, raiseWarningIfMissing, setBooted, updateDeviceInfo

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, getAlertSeparator, getAlertService, getSubsystem, raiseAlarm, raiseAlarm, raiseAlarm, raiseAlarm, raiseAlarmOnlyIfNew, raiseAlertOnlyEveryTenMinutes, raiseAlertOnlyEveryTenMinutes, raiseAlertOnlyIfNew, raiseWarning, raiseWarning, raiseWarningOnlyEveryTenMinutes, raiseWarningOnlyIfNew

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

build, init, postBuild, postInit, postShutdown, postStart, start

Field Detail

cobid1

protected int cobid1

define cobid to be able to read values from PDO data.

cobid2

protected int cobid2

Constructor Detail

CanOpenEPOSLinearRailTruck

public CanOpenEPOSLinearRailTruck(int nodeID,
                                  String serialNB)

Method Detail

isHomingDone

@Command(type=QUERY,
         level=1,
         description="return true if homing is done: the controller knows its absolute position.")
public boolean isHomingDone()

return true if homing is done: the controller knows its absolute position.

Specified by:

isHomingDone in interface EPOSControllerForLinearRail

Returns:

homing

@Command(type=QUERY,
         level=1,
         description="Do homing of the controller.")
public void homing()

Specified by:

homing in interface EPOSControllerForLinearRail

activateBrakeAndDisable

@Command(type=ACTION,
         level=1,
         description="activate brake to prevent motion and disable controller.")
public void activateBrakeAndDisable()

activateBrakeAndDisable

Specified by:

activateBrakeAndDisable in interface EPOSControllerWithBrake

isBrakeActivated

@Command(type=QUERY,
         level=1,
         description="return true if brake if activated.")
public boolean isBrakeActivated()

return true if brake if activated. This is when bit13 of Parameter.DigitalInputFonctionnalityState is ZERO.

Specified by:

isBrakeActivated in interface EPOSControllerWithBrake

Returns:

configureDigitalInputOfLinearRails

@Command(type=ACTION,
         level=1,
         description="To configure the autochanger linear rails controllers.")
public void configureDigitalInputOfLinearRails()

Configure this controller to be used as an autochanger linear rail truck controller. This method is to be executed during initialization phase. This configures the digital inputs of the EPOS controller to work with a holding brake. Digital Inputs activated for Linear Rails : ************************************************************************** Drive Enable Input=01 Mask=Enabled Polarity=HighActive QuickStop Input=02 Mask=Enabled Polarity=HighActive ************************************************************************** 1 - Configure the Digital Input Functionnality index 0x2070 subindex 01 to 04 Functionnality tab Value = 15 General Purpose A Value = 14 General Purpose B Value = 13 General Purpose C Value = 12 General Purpose D Value = 11 General Purpose E Value = 10 General Purpose F Value = 9 General Purpose G Value = 8 General Purpose H Value = 7 General Purpose I Value = 6 General Purpose J Value = 5 QuickStop 1 Value = 4 Drive enable 1 Value = 3 Position marker 0 Value = 2 Home switch 0 Value = 1 Positive Limit switch 0 Value = 0 Negative Limit switch 0 ************************************************************************** 2 - Configure the Digital Input Polarity index 0x2071 subindex 03 Value=0 HighActive Value=1 Low Active ************************************************************************** 3 - Configure the Digital Input Mask index 0x2071 subindex 02 Value=0 HighActive Value=1 Low Active ************************************************************************** 4 - Configure the Digital Input Execution Mask index 0x2071 subindex 04 Used to suppress execution of the digital input functionalities. The function (Negative or Positive Limit Switch Error Routine) will be executed when the associated bit in functionalities state register goes high and the bit in this execution mask is set. Functionnality tab Value = 15 General Purpose A 0 Value = 14 General Purpose B 0 Value = 13 General Purpose C 0 Value = 12 General Purpose D 0 Value = 11 General Purpose E 0 Value = 10 General Purpose F 0 Value = 9 General Purpose G 0 Value = 8 General Purpose H 0 Value = 7 General Purpose I 0 Value = 6 General Purpose J 0 Value = 5 QuickStop 1 Value = 4 Drive enable 1 Value = 3 Position marker 0 Value = 2 Home switch 0 Value = 1 Positive Limit switch 0 Value = 0 Negative Limit switch 0

Specified by:

configureDigitalInputOfLinearRails in interface EPOSControllerForLinearRail

Throws:

SDORequestException

checkConfigDigitalInputOfLinearRails

@Command(type=QUERY,
         level=1,
         description="check configuration of digital input of linear rail controller.")
public void checkConfigDigitalInputOfLinearRails()

configureDigitalOutputOfLinearRails

@Command(type=ACTION,
         level=1,
         description="To configure the autochanger linear rails controllers.")
public void configureDigitalOutputOfLinearRails()

Configuration of an EPOS controller to work with a holding brake. This is used for controllers of the Autochanger Linear Rails. Digital Outputsactivated for Linear Rails are: General_A Output=01 Mask=Enabled Polarity=HighActive Ready/Fault Output=02 Mask=Enabled Polarity=HighActive Holding Brake Output=03 Mask=Enabled Polarity=LowActive ******************************************************************************** 1- First of all, mask all outputs index 0x2079 subindex 01 ******************************************************************************** 2- Configure the Digital Output Fonctionnalities index 0x2079 subindex 01 to 03 Functionnality tab Value = 15 General Purpose Out_A Value = 14 General Purpose Out_B Value = 13 General Purpose Out_C Value = 12 General Purpose Out_D Value = 11 General Purpose Out_E Value = 10..8 not used Value = 7..3 reserved Value = 2 Holding Brake Value = 1 Position compare Value = 0 Ready/Fault ******************************************************************************** 3 - Configure the Digital Output Functionnality Polarity index 0x2078 subindex 0x03 Value = 0 associated output not change => HighActive Value = 1 associated output inverted => LowActive Tab Digital Output Functionnality Mask Value Bit_15 General Purpose Out_A 0 Bit_14 General Purpose Out_B 0 Bit_13 General Purpose Out_C 0 Bit_12 General Purpose Out_D 0 Bit_11 General Purpose Out_E 0 Bit_10 General Purpose Out_F 0 Bit_9 General Purpose Out_G 0 Bit_8 General Purpose Out_H 0 Bit_7 reserved 0 Bit_6 reserved 0 Bit_5 reserved 0 Bit_4 reserved 0 Bit_3 reserved 0 Bit_2 Holding Brake 1 (read only) Bit_1 Position Compare 0 (read only) Bit_0 Ready/Fault 0 (read only) ******************************************************************************** 4 - Configure the Digital Output Functionnality Mask index 0x2078 subindex 0x02 Value = 0 functionnality not activatd Value = 1 functionnality activated ******************************************************************************** Digital Output Functionnality Mask Value Bit_15 General Purpose Out_A 1 Bit_14 General Purpose Out_B 0 Bit_13 General Purpose Out_C 0 Bit_12 General Purpose Out_D 0 Bit_11 General Purpose Out_E 0 Bit_10 General Purpose Out_F 0 Bit_9 General Purpose Out_G 0 Bit_8 General Purpose Out_H 0 Bit_7 reserved 0 Bit_6 reserved 0 Bit_5 reserved 0 Bit_4 reserved 0 Bit_3 reserved 0 Bit_2 Holding Brake 1 Bit_1 Position Compare 0 Bit_0 Ready/Fault 1 ******************************************************************************** To configure the autochanger linear rails controllers. This method is to be executed during initialization phase.

Specified by:

configureDigitalOutputOfLinearRails in interface EPOSControllerForLinearRail

Throws:

SDORequestException

checkConfigDigitalOutputOfLinearRails

@Command(type=QUERY,
         level=1,
         description="check configuration of digital output of linear rail controller.")
public void checkConfigDigitalOutputOfLinearRails()

shutdown

public void shutdown()

Specified by:

shutdown in interface org.lsst.ccs.framework.HasLifecycle

doInitializePDOs

public void doInitializePDOs()
                      throws org.lsst.ccs.drivers.commons.DriverException

methods for managing PDOs

Specified by:

doInitializePDOs in interface PieceOfHardware

Overrides:

doInitializePDOs in class CanOpenDevice

Throws:

org.lsst.ccs.drivers.commons.DriverException

updateFromPDO

public void updateFromPDO(org.lsst.ccs.drivers.canopenjni.PDOData pdo)

process PDOData to retrieve data from this device.

Specified by:

updateFromPDO in interface PieceOfHardware

Overrides:

updateFromPDO in class CanOpenDevice

Parameters:

pdo -

printValuesUpdatedByPDOs

@Command(type=QUERY,
         level=1,
         description="print values updated by PDOs to debug and test")
public String printValuesUpdatedByPDOs()

For tests and debug

Returns:

values updated by PDOs