Carousel (LSST CCS - Subsystem FCS Main 5.0.3 API)

java.lang.Object
- org.lsst.ccs.subsystems.fcs.common.MobileItem
- - org.lsst.ccs.subsystems.fcs.Carousel

All Implemented Interfaces:

org.lsst.ccs.framework.HardwareController, org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.framework.SignalHandler, AlertRaiser, FilterHolder

Direct Known Subclasses:

SftCarousel
```
public class Carousel
extends MobileItem
implements org.lsst.ccs.framework.HardwareController, FilterHolder
```
This is a representation of the hardware of the carousel. It receives commands from the FCSMAinModule and send back an acknowledge. It publishes data on the status bus. In engineering mode it can receive commands from the engineering console.

Author:

virieux

Field Summary

Fields
Modifier and Type	Field and Description
`protected PieceOfHardware`	`ai814`
`int`	`encoderSign`
`protected Map<String,CarouselSocket>`	`socketsMap` A map to store the sockets by their names.

Fields inherited from class org.lsst.ccs.subsystems.fcs.common.MobileItem
currentAction, FCSLOG, hasToWaitForEndOfAction, lock, name, s, scheduler

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

Constructor Summary

Constructors
Constructor and Description

Carousel()

Constructors
Constructor and Description
`Carousel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`abortAction(FcsEnumerations.MobileItemAction action, long delay)` aborts action actually running.
`void`	`checkConditionsForRotation()` Check if carousel rotation is permitted.
`void`	`checkSensorTypeIncremental()`
`void`	`checkStarted()` CheckStarted is executed by completeInitialization when a first start has failed.
`int`	`computeNewPosition(int pos)`
`int`	`computeShortestRelativePosition(int d)`
`StatusDataPublishedByCarousel`	`createStatusDataPublishedByCarousel()` Create an object StatusDataPublishedByCarousel to be published on the STATUS bus.
`CarouselClamp`	`getClampXminus()` This method returns the clampX- which is at standby filterPosition.
`EPOSController`	`getClampXminusController()`
`CarouselClamp`	`getClampXplus()` This method returns the clampX+ which is at standby filterPosition.
`EPOSController`	`getClampXplusController()`
`int`	`getEncoderSign()`
`Filter`	`getFilterAtStandby()` This methods return the filter which is in the socketAtStandby at standby filterPosition.
`String`	`getFilterAtStandbyName()` Returns name of filter which is in the socket at STANDBY position or NO_FILTER if there is no filter at STANDBY.
`int`	`getPosition()` return carousel position.
`CarouselSocket`	`getSocketAtStandby()` Return the socket HALTED at STANDBY filterPosition if there is one.
`CarouselSocket`	`getSocketByName(String socketName)` Return a CarouselSocket which name is given as parameter.
`int`	`getStepNB()`
`String`	`grabFilterAtStandby(Filter filter)` This method has to be executed when a filter has just been moved on the carousel at standby filterPosition by the autochanger.
`String`	`grabFilterAtStandby(String filterName)` Grab a filter at STANDBY position.
`void`	`homing()` to be done before each rotation
`void`	`init()` * lifecycle methods ***********************************************
`boolean`	`isActionCompleted(FcsEnumerations.MobileItemAction action)`
`boolean`	`isAtHandoff()` This method returns true if the autochanger trucks are at HANDOFF position, false otherwise.
`boolean`	`isAtStandby()` Used to publish on the STATUS bus for the GUI.
`boolean`	`isAtStandby(Filter filter)` Return true if the filter given as argument is at STANDBY position.
`boolean`	`isAutochangerHoldingFilter()` This methods returns true if the autochanger is holding a filter at STANDBY position.
`boolean`	`isHoldingFilter()` Return true if carousel is holding a filter at STANDBY position.
`boolean`	`isHoldingFilterAtStandby()`
`boolean`	`isHomingDone()`
`boolean`	`isReadyToGrabAFilterAtStandby()` This method let us know if the carousel is ready to receive a filter at standby filterPosition : - the carousel must not rotate - an empty socketAtStandby is at standby filterPosition.
`boolean`	`isRotating()` Returns true if carousel is rotating
`boolean`	`myDevicesReady()` Return True if all CAN open devices useful for this MobileItemMobile are ready for an action.
`void`	`postAction(FcsEnumerations.MobileItemAction action)`
`void`	`postStart()` Executed when all components HasLifeCycle of subsystem have been checked.
`void`	`publishData()` Publish Data on status bus for trending data base and GUIs.
`void`	`quickStopAction(FcsEnumerations.MobileItemAction action, long delay)`
`void`	`releaseClamps()` Release clamps at standby position to get ready to clamp again.
`void`	`releaseClampsContact()`
`void`	`rotateEmptySocketAtStandby()` Move an empty socket to STANDBY position.
`void`	`rotateSocketToStandby(String socketName)` Rotate carousel to move a socket which name is given as argument to STANDBY position.
`void`	`rotateToRelativePosition(int relativePosition)` A command to rotate carousel.
`void`	`startAction(FcsEnumerations.MobileItemAction action)` Starts action ROTATE_CAROUSEL_TO_ABSOLUTE_POSITION or ROTATE_CAROUSEL_TO_RELATIVE_POSITION.
`String`	`toString()`
`void`	`ungrabFilterAtStandby(String filterName)` This unlock clamps at STANDBY.
`void`	`unlockClamps()` Unlocks the clamps at STANDBY.
`void`	`updateClampsStateWithSensors()` Read the clamps state from PDO : all the clamp sensors are read at one time.
`void`	`updateClampsStateWithSensorsFromPDO()` Read the clamps state from PDO : all the clamp sensors are read at one time.
`void`	`updateClampsStateWithSensorsFromSDO()` Read the clamp sensors one by one with RSDO command
`void`	`updateCurrent()` Updates the field current in reading the CPU of the controller.
`void`	`updatePosition()` Updates the filterPosition of the carousel in reading the CPU of the controller.
`void`	`updateStateWithSensors()` This method read values sent by the sensors and update state from this new values.
`void`	`updateStateWithSensorsToCheckIfActionIsCompleted()` reads sensors or any device and updates state from sensors it can be also reading a position or a current on a motor controller.

Methods inherited from class org.lsst.ccs.subsystems.fcs.common.MobileItem
abort, abort, checkReadyForAction, checkStopped, executeAction, getAlertService, getHaltRequired, getName, getSubsystem, isMoving, quickstop, readSensorsUntilActionIsCompleted, shutdownNow, signal, stop, stop

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lsst.ccs.framework.HardwareController
checkHardware, checkStopped

Methods inherited from interface org.lsst.ccs.subsystems.fcs.common.AlertRaiser
clearAlarm, raiseAlarm, raiseAlarm, raiseAlarm, raiseAlarm, raiseAlarm, raiseAlarm, raiseWarning, raiseWarning, raiseWarning, raiseWarning, raiseWarning

Methods inherited from interface org.lsst.ccs.framework.SignalHandler
sendSignal, sendSignalWithTimeLimit

Methods inherited from interface org.lsst.ccs.framework.HasLifecycle
build, postBuild, postInit, postStop, start

- Field Detail
  - encoderSign
```
@ConfigurationParameter(description="if encoderSign = 1, encoder goes from 0 to stepNB,if encoderSign = -1, encoder goes from 0 to stepNB")
public int encoderSign
```
  - ai814
```
@LookupField(strategy=BYNAME)
protected PieceOfHardware ai814
```
  - socketsMap
```
@LookupField(strategy=CHILDREN)
protected final Map<String,CarouselSocket> socketsMap
```
    A map to store the sockets by their names. The key of this map is the socket name.
- Constructor Detail
  - Carousel
```
public Carousel()
```
- Method Detail
  - init
```
public void init()
```
    *** lifecycle methods *************************************************
    
    Specified by:
    
    init in interface org.lsst.ccs.framework.HasLifecycle
  - isHomingDone
```
@Command(type=QUERY,
         level=0,
         description="Return true if carouselController homing is done.")
public boolean isHomingDone()
```
  - getStepNB
```
public int getStepNB()
```
  - getEncoderSign
```
public int getEncoderSign()
```
  - getSocketByName
```
public CarouselSocket getSocketByName(String socketName)
```
    Return a CarouselSocket which name is given as parameter.
    
    Parameters:
    
    socketName -
    
    Returns:
  - getPosition
```
@Command(type=QUERY,
         level=0,
         description="Return carousel position.",
         alias="printPosition")
public int getPosition()
```
    return carousel position.
    
    Returns:
  - getClampXminusController
```
public EPOSController getClampXminusController()
```
    Returns:
    
    the clampXminusController
  - getClampXplusController
```
public EPOSController getClampXplusController()
```
    Returns:
    
    the clampXminusController
  - getClampXminus
```
public CarouselClamp getClampXminus()
```
    This method returns the clampX- which is at standby filterPosition. It can returns null if there is no socketAtStandby halted at standby filterPosition.
    
    Returns:
  - getClampXplus
```
public CarouselClamp getClampXplus()
```
    This method returns the clampX+ which is at standby filterPosition. It can returns null if there is no socketAtStandby halted at standby filterPosition.
    
    Returns:
  - isAtStandby
```
@Command(type=QUERY,
         level=0,
         description="Return true if a socket is HALTED at STANDBY position, false otherwise.")
public boolean isAtStandby()
```
    Used to publish on the STATUS bus for the GUI. Returns
    
    Specified by:
    
    isAtStandby in interface FilterHolder
    
    Returns:
    
    true if a socket is HALTED at STANDBY filterPosition, false otherwise.
  - getSocketAtStandby
```
public CarouselSocket getSocketAtStandby()
```
    Return the socket HALTED at STANDBY filterPosition if there is one. Otherwise return null.
    
    Returns:
  - getFilterAtStandby
```
public Filter getFilterAtStandby()
```
    This methods return the filter which is in the socketAtStandby at standby filterPosition. When there is no filter at standby filterPosition it returns null.
    
    Returns:
    
    filter at standby filterPosition or null if there is no filter at standby filterPosition.
  - getFilterAtStandbyName
```
@Command(type=QUERY,
         level=0,
         description="Returns name of filter at STANDBY position  or NO_FILTER if there is no filter at STANDBY.")
public String getFilterAtStandbyName()
```
    Returns name of filter which is in the socket at STANDBY position or NO_FILTER if there is no filter at STANDBY.
    
    Returns:
  - isAutochangerHoldingFilter
```
@Command(type=QUERY,
         level=0,
         description="Return true if Autochanger is holding filter at STANDBY.")
public boolean isAutochangerHoldingFilter()
```
    This methods returns true if the autochanger is holding a filter at STANDBY position.
    
    Returns:
    
    Throws:
    
    FcsHardwareException
  - postStart
```
public void postStart()
```
    Executed when all components HasLifeCycle of subsystem have been checked.
    
    Specified by:
    
    postStart in interface org.lsst.ccs.framework.HasLifecycle
  - checkStarted
```
public void checkStarted()
```
    CheckStarted is executed by completeInitialization when a first start has failed. Because end user could have changed many things, we have to check again that all is correct.
    
    Specified by:
    
    checkStarted in interface org.lsst.ccs.framework.HardwareController
  - homing
```
@Command(type=ACTION,
         level=1,
         description="CarouselHoming")
public void homing()
```
    to be done before each rotation
  - checkSensorTypeIncremental
```
public void checkSensorTypeIncremental()
```
  - publishData
```
public void publishData()
```
    Publish Data on status bus for trending data base and GUIs.
    
    Specified by:
    
    publishData in class MobileItem
  - createStatusDataPublishedByCarousel
```
public StatusDataPublishedByCarousel createStatusDataPublishedByCarousel()
```
    Create an object StatusDataPublishedByCarousel to be published on the STATUS bus.
    
    Returns:
    
    status
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isReadyToGrabAFilterAtStandby
```
@Command(type=QUERY,
         level=1,
         description="Returns true if Carousel is stopped and no filter is at STANDBY position")
public boolean isReadyToGrabAFilterAtStandby()
```
    This method let us know if the carousel is ready to receive a filter at standby filterPosition : - the carousel must not rotate - an empty socketAtStandby is at standby filterPosition.
    
    Returns:
    
    true if the filterPosition of the carousel matches the filterPosition when one of its sockets is at standby filterPosition and this socketAtStandby is empty. false
    
    Throws:
    
    FcsHardwareException
  - isHoldingFilterAtStandby
```
@Command(type=QUERY,
         level=1,
         description="Returns true if a filter is clamped at STANDBY position")
public boolean isHoldingFilterAtStandby()
```
    Returns:
    
    true if a filter is clamped at STANDBY position and carousel is stopped
  - isRotating
```
@Command(type=QUERY,
         level=1,
         description="Returns true if carousel is rotating.")
public boolean isRotating()
```
    Returns true if carousel is rotating
    
    Returns:
  - updatePosition
```
@Command(type=ACTION,
         level=1,
         description="Update carousel position in reading controller.")
public void updatePosition()
```
    Updates the filterPosition of the carousel in reading the CPU of the controller.
    
    Throws:
    
    SDORequestException
  - updateCurrent
```
@Command(type=QUERY,
         level=1,
         description="Update field current in reading controller.")
public void updateCurrent()
```
    Updates the field current in reading the CPU of the controller.
    
    Throws:
    
    SDORequestException
  - updateClampsStateWithSensorsFromSDO
```
public void updateClampsStateWithSensorsFromSDO()
```
    Read the clamp sensors one by one with RSDO command
    
    Throws:
    
    FcsHardwareException
  - updateClampsStateWithSensorsFromPDO
```
public void updateClampsStateWithSensorsFromPDO()
```
    Read the clamps state from PDO : all the clamp sensors are read at one time.
    
    Throws:
    
    FcsHardwareException
  - updateClampsStateWithSensors
```
public void updateClampsStateWithSensors()
```
    Read the clamps state from PDO : all the clamp sensors are read at one time. Tested with success on single-filter-test in April 2013
    
    Throws:
    
    FcsHardwareException
  - grabFilterAtStandby
```
public String grabFilterAtStandby(String filterName)
```
    Grab a filter at STANDBY position. TO-DO : is this used ?
    
    Parameters:
    
    filterName -
    
    Returns:
    
    Throws:
    
    FcsHardwareException
  - grabFilterAtStandby
```
public String grabFilterAtStandby(Filter filter)
```
    This method has to be executed when a filter has just been moved on the carousel at standby filterPosition by the autochanger. It updates the carousel socket at standby or throw an exception. This method tests if the clamps are Locked on a filter at standby filterPosition The clamps Locks automaticaly, and the filter presence sensor tells us if the filter is here or not. If the clamps are Locked on a filter at standby filterPosition, this method updates the socketAtStandby at standby filterPosition : it puts the filter on the socketAtStandby.
    
    Parameters:
    
    filter -
    
    Returns:
    
    Throws:
    
    FcsHardwareException
  - ungrabFilterAtStandby
```
public void ungrabFilterAtStandby(String filterName)
```
    This unlock clamps at STANDBY.
    
    Parameters:
    
    filterName -
    
    Throws:
    
    FcsHardwareException
  - releaseClamps
```
@Command(type=ACTION,
         level=1,
         description="Release clamps at standby position to get ready to clamp again")
public void releaseClamps()
```
    Release clamps at standby position to get ready to clamp again.
  - unlockClamps
```
@Command(type=ACTION,
         level=3,
         description="Unlock the clamps at STANDBY.")
public void unlockClamps()
```
    Unlocks the clamps at STANDBY.
    
    Throws:
    
    FcsHardwareException
    
    FailedCommandException
    
    RejectedCommandException
  - isAtStandby
```
public boolean isAtStandby(Filter filter)
```
    Return true if the filter given as argument is at STANDBY position.
    
    Parameters:
    
    filter -
    
    Returns:
  - releaseClampsContact
```
public void releaseClampsContact()
```
  - myDevicesReady
```
public boolean myDevicesReady()
```
    Description copied from class: MobileItem
    
    Return True if all CAN open devices useful for this MobileItemMobile are ready for an action. As an example, if this mobil item is moved by a controller and sensors are read through a sensors gateway, this method will return True when the controller and the gateway are ready to be used (booted, configured, homing done if needed).
    
    Specified by:
    
    myDevicesReady in class MobileItem
    
    Returns:
  - checkConditionsForRotation
```
@Command(type=QUERY,
         level=1,
         description="Check if carousel rotation is permitted.")
public void checkConditionsForRotation()
```
    Check if carousel rotation is permitted.
    
    Throws:
    
    FcsHardwareException
    
    RejectedCommandException - (RuntimeException)
  - rotateToRelativePosition
```
@Command(type=ACTION,
         level=1,
         description="Rotate carousel to a relative position.",
         timeout=60000)
public void rotateToRelativePosition(int relativePosition)
```
    A command to rotate carousel.
    
    Parameters:
    
    relativePosition -
    
    Throws:
    
    FcsHardwareException
  - rotateSocketToStandby
```
@Command(type=ACTION,
         level=1,
         description="Move a socket which name is given as argument to STANDBY position.",
         alias="moveSocketToStandby",
         timeout=50000)
public void rotateSocketToStandby(String socketName)
```
    Rotate carousel to move a socket which name is given as argument to STANDBY position. This methods computes the shortest way to go to STANDBY position.
    
    Parameters:
    
    socketName -
    
    Throws:
    
    FcsHardwareException
  - rotateEmptySocketAtStandby
```
public void rotateEmptySocketAtStandby()
```
    Move an empty socket to STANDBY position. The socket moved is the first empty one in the socketsMap.
    
    Throws:
    
    FcsHardwareException
  - isActionCompleted
```
public boolean isActionCompleted(FcsEnumerations.MobileItemAction action)
```
    Specified by:
    
    isActionCompleted in class MobileItem
  - updateStateWithSensorsToCheckIfActionIsCompleted
```
public void updateStateWithSensorsToCheckIfActionIsCompleted()
```
    Description copied from class: MobileItem
    
    reads sensors or any device and updates state from sensors it can be also reading a position or a current on a motor controller. It's abstract because it'up to the sub-classes to know what to do.
    
    Specified by:
    
    updateStateWithSensorsToCheckIfActionIsCompleted in class MobileItem
  - startAction
```
public void startAction(FcsEnumerations.MobileItemAction action)
```
    Starts action ROTATE_CAROUSEL_TO_ABSOLUTE_POSITION or ROTATE_CAROUSEL_TO_RELATIVE_POSITION. This : - enable controller, - make controller go to required position previously written in field absoluteTargetPosition or relativeTargetPosition, - writeControlWord "3F" or "7F" on controller depending if we want to go to a relative position or to an absolute position.
    
    Specified by:
    
    startAction in class MobileItem
    
    Parameters:
    
    action -
  - abortAction
```
public void abortAction(FcsEnumerations.MobileItemAction action,
                        long delay)
```
    Description copied from class: MobileItem
    
    aborts action actually running. It has to be specified in sub-classes. It can be : write a zero value of current or send a stop command to a controller.
    
    Specified by:
    
    abortAction in class MobileItem
  - quickStopAction
```
public void quickStopAction(FcsEnumerations.MobileItemAction action,
                            long delay)
```
    Specified by:
    
    quickStopAction in class MobileItem
  - postAction
```
public void postAction(FcsEnumerations.MobileItemAction action)
```
    Specified by:
    
    postAction in class MobileItem
  - computeNewPosition
```
@Command(type=ACTION,
         level=1,
         description="compute new position to take in account tours which can have been runned")
public int computeNewPosition(int pos)
```
    Parameters:
    
    pos -
    
    Returns:
  - computeShortestRelativePosition
```
@Command(type=ACTION,
         level=1,
         description="Compute relative position to find the shortest way to run carousel.")
public int computeShortestRelativePosition(int d)
```
  - isHoldingFilter
```
public boolean isHoldingFilter()
```
    Return true if carousel is holding a filter at STANDBY position.
    
    Specified by:
    
    isHoldingFilter in interface FilterHolder
    
    Returns:
    
    Throws:
    
    FcsHardwareException
  - isAtHandoff
```
public boolean isAtHandoff()
```
    Description copied from interface: FilterHolder
    
    This method returns true if the autochanger trucks are at HANDOFF position, false otherwise.
    
    Specified by:
    
    isAtHandoff in interface FilterHolder
    
    Returns:
  - updateStateWithSensors
```
public void updateStateWithSensors()
```
    Description copied from interface: FilterHolder
    
    This method read values sent by the sensors and update state from this new values.
    
    Specified by:
    
    updateStateWithSensors in interface FilterHolder

Class Carousel

Field Summary

Fields inherited from class org.lsst.ccs.subsystems.fcs.common.MobileItem

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

Constructor Summary

Method Summary

Methods inherited from class org.lsst.ccs.subsystems.fcs.common.MobileItem

Methods inherited from class java.lang.Object

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

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

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

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

Field Detail

encoderSign

ai814

socketsMap

Constructor Detail

Carousel

Method Detail

init

isHomingDone

getStepNB

getEncoderSign

getSocketByName

getPosition

getClampXminusController

getClampXplusController

getClampXminus

getClampXplus

isAtStandby

getSocketAtStandby

getFilterAtStandby

getFilterAtStandbyName

isAutochangerHoldingFilter

postStart

checkStarted

homing

checkSensorTypeIncremental

publishData

createStatusDataPublishedByCarousel

toString

isReadyToGrabAFilterAtStandby

isHoldingFilterAtStandby

isRotating

updatePosition

updateCurrent

updateClampsStateWithSensorsFromSDO

updateClampsStateWithSensorsFromPDO

updateClampsStateWithSensors

grabFilterAtStandby

grabFilterAtStandby

ungrabFilterAtStandby

releaseClamps

unlockClamps

isAtStandby

releaseClampsContact

myDevicesReady

checkConditionsForRotation

rotateToRelativePosition

rotateSocketToStandby

rotateEmptySocketAtStandby

isActionCompleted

updateStateWithSensorsToCheckIfActionIsCompleted

startAction

abortAction

quickStopAction

postAction

computeNewPosition

computeShortestRelativePosition

isHoldingFilter

isAtHandoff

updateStateWithSensors