org.lsst.ccs.subsystems.fcs.common

Interface EPOSControllerWithBrake

All Superinterfaces:

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

All Known Subinterfaces:

EPOSControllerForLinearRail, EPOSControllerForOnlineClamp

All Known Implementing Classes:

CanOpenEPOSLinearRailTruck, CanOpenEPOSOnlineClamp, SimuAutochangerLinearRailController, SimuAutochangerOnlineClampController

public interface EPOSControllerWithBrake
extends EPOSController

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 inherited from interface org.lsst.ccs.subsystems.fcs.common.AlertRaiser

alertSeparator

Method Summary

Modifier and Type	Method and Description
default void	activateBrake() Activate brake to prevent motion.
default void	activateBrakeAndDisable() activateBrakeAndDisable
default void	checkBrakeActivated()
default void	checkBrakeReleased()
default StatusDataPublishedByEPOSController	createStatusDataPublishedByEPOSController() Creates an object to be published on the STATUS bus by an EPOSController.
default void	doReleaseBrake() Release holding brake to be able to move linear rail trucks or open/close ONLINE clamps.
default void	enableAndReleaseBrake() enableAndReleaseBrake if this controller is a slave command is rejected because we have to check if master controller is enabled.
default boolean	isBrakeActivated() return true if brake if activated.
boolean	isBrakeActivatedPub() For GUI.
void	setBrakeActivatedPub(boolean brakeActivated)

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

canClearAlert, changeMode, changeProfileVelocity, checkEposMode, checkFault, checkHomingDone, checkParameters, checkState, checkTargetReached, convertEPOSValue, defineAbsolutePosition, definePositionFromNegativeLimitSwitch, disableOperation, disableVoltage, displayErrorHistory, enable, enableAndWriteAbsolutePosition, enableAndWriteCurrent, enableAndWriteRelativePosition, faultReset, getCurrent, getEposState, getErrorHistoryNB, getErrorRegister, getLastErrorCode, getLastErrorName, getMode, getPosition, getStatusWord, getVelocity, goToSwitchOnDisabled, isEnabled, isEnabledToPublish, isInError, isInMode, isInState, isOperationEnabled, isParametersOK, isReadyToSwitchOn, isSwitchedOn, isSwitchOnDisabled, isTargetReached, printStatusWordInBinary, quickStop, readControlWord, readCurrent, readCurrentAverageValue, readFollowingError, readMode, readParameter, readParameter, readParameters, readParameters, readParameters, readPosition, readPositionSensorType, readProfileVelocity, readSSIPosition, readStatusWord, readVelocity, setEnabledToPublish, setEposState, shutdownController, stopAction, stopPosition, stopVelocity, switchOnEnableOperation, updateEposState, updateEposState, updateStatusWord, writeControlWord, writeCurrent, writeParameter, writeParameters, writeParameters, writeParameters, writeTargetPosition, writeTargetVelocity

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

checkBooted, checkId, checkInitialized, createStatusDataPublishedByHardware, doInitializePDOs, getName, getNodeID, getSerialNB, initializeAndCheckHardware, initializePDOs, isBooted, isInitialized, printState, publishData, raiseAlarmIfMissing, raiseWarningIfMissing, setBooted, updateDeviceInfo, 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, 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, shutdown, start

Method Detail

isBrakeActivatedPub

boolean isBrakeActivatedPub()

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

Returns:

setBrakeActivatedPub

void setBrakeActivatedPub(boolean brakeActivated)

activateBrakeAndDisable

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

activateBrakeAndDisable

doReleaseBrake

default void doReleaseBrake()

Release holding brake to be able to move linear rail trucks or open/close ONLINE clamps. Check that brake is released within a timeout of 500 ms. doReleaseBrake for controller consists in forcing to ONE bit 15 of parameter DigitalOutputFonctionnalityState. It can't be a command because if this controller is a slave we have to check if master controller is enabled. See AutoChangerTwoTrucksModule.

Throws:

SDORequestException

enableAndReleaseBrake

@Command(type=ACTION,
         level=1,
         description="Enable and release brake to permit motion. Not allowed in MASTER_ENCODER mode.")
default void enableAndReleaseBrake()

enableAndReleaseBrake if this controller is a slave command is rejected because we have to check if master controller is enabled. See AutoChangerTwoTrucksModule.

activateBrake

@Command(type=ACTION,
         level=1,
         description="Activate brake to prevent motion and check that brake is activated within a timeout of 500ms.")
default void activateBrake()

Activate brake to prevent motion. A holding brake can be associated to a Controller. This brake is activated when the controller is powered on. A brake is associated with Autochanger Linear Rail trucks controllers and Autochanger Online Clamps controllers. activateBrake consists in forcing to ZERO bit 15 of parameter DigitalOutputFonctionnalityState.

Throws:

SDORequestException

isBrakeActivated

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

return true if brake if activated. This is when bit15 of Parameter.DigitalOutputFonctionnalityState is ZERO.

Returns:

checkBrakeActivated

@Command(type=QUERY,
         level=1,
         description="Check that controller brake is activated. If brake is not activated within a timeout of 500ms, throw an Exception.")
default void checkBrakeActivated()

checkBrakeReleased

@Command(type=QUERY,
         level=1,
         description="Check that controller brake is released. If brake is not released within a timeout of 500ms, throw an Exception.")
default void checkBrakeReleased()

createStatusDataPublishedByEPOSController

default StatusDataPublishedByEPOSController createStatusDataPublishedByEPOSController()

Description copied from interface: EPOSController

Creates an object to be published on the STATUS bus by an EPOSController.

Specified by:

createStatusDataPublishedByEPOSController in interface EPOSController

Returns: