org.lsst.ccs.subsystems.fcs.common

Interface PieceOfHardware

All Superinterfaces:

AlertRaiser, EmergencyMessageListener

All Known Subinterfaces:

ADCInterface, EPOSController, EPOSControllerForCarousel, EPOSControllerForLinearRail, EPOSControllerForOnlineClamp, EPOSControllerWithBrake, PlutoGatewayInterface, StrainGauge, TTC580Interface

All Known Implementing Classes:

CanCBXAI420, CanCBXAI814, CanOpenDAC, CanOpenDevice, CanOpenEPOS, CanOpenEPOSCarousel, CanOpenEPOSCarouselClamp, CanOpenEPOSLinearRailTruck, CanOpenEPOSOnlineClamp, CanOpenPlutoGateway, CanOpenStrainGauge, CanOpenSystecIO, CanOpenTTC580, CompactIO, PlutoGateway, SimuAutochangerLatchController, SimuAutochangerLinearRailController, SimuAutochangerOnlineClampController, SimuAutochangerPlutoGateway, SimuAutochangerStandalonePlutoGateway, SimuCanOpenADC, SimuCanOpenStrainGauge, SimuCarouselClampController, SimuCarouselController, SimuCarouselStandalonePlutoGateway, SimuCompactIO, SimuEPOSController, SimuLoaderCarrierController, SimuLoaderClampController, SimuLoaderPlutoGateway, SimuLoaderStandalonePlutoGateway, SimuPlutoGateway, SimuPlutoGatewayWithFilterID, SimuTTC580

public interface PieceOfHardware
extends EmergencyMessageListener, AlertRaiser

This is an interface for a piece of hardware on a can open network.

Author:

virieux

Field Summary

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

alertSeparator

Method Summary

Modifier and Type	Method and Description
default void	checkBooted()
default boolean	checkId(String id)
default void	checkInitialized()
default StatusDataPublishedByHardware	createStatusDataPublishedByHardware() Creates an object to be published on the STATUS bus by a PieceOfHardware.
void	doInitializePDOs() Initialize canOpenInterface in order to be able to retrieve PDOs if this PieceOfHardware sends PDOS.
String	getName()
int	getNodeID()
String	getSerialNB()
void	initializeAndCheckHardware() This methods write some configuration data on the hardware CPU.
default void	initializePDOs() Initialize PDOs if device is booted.
boolean	isBooted()
boolean	isInitialized()
default String	printState()
default void	publishData() Publish Data on status bus for trending data base and GUIs.
default void	raiseAlarmIfMissing() raise an ALARM if this device is not booted.
void	setBooted(boolean isBooted) set boolean isBooted in INITIALIZATION phase.
void	updateFromPDO(org.lsst.ccs.drivers.canopenjni.PDOData pdo)

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, raiseWarning, raiseWarning

Method Detail

getName

String getName()

Specified by:

getName in interface AlertRaiser

getSerialNB

String getSerialNB()

getNodeID

int getNodeID()

isBooted

boolean isBooted()

Returns:

true If this piece of hardware is booted and the nodeID on the hardware is the same than the one in the Configuration DB.

setBooted

void setBooted(boolean isBooted)

set boolean isBooted in INITIALIZATION phase.

Parameters:

isBooted -

isInitialized

boolean isInitialized()

Returns:

true if the hardware has been initialized with success, false otherwise.

initializeAndCheckHardware

void initializeAndCheckHardware()

This methods write some configuration data on the hardware CPU.

Throws:

FcsHardwareException

checkBooted

default void checkBooted()

checkInitialized

default void checkInitialized()

raiseAlarmIfMissing

default void raiseAlarmIfMissing()

raise an ALARM if this device is not booted.

checkId

default boolean checkId(String id)

doInitializePDOs

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

Initialize canOpenInterface in order to be able to retrieve PDOs if this PieceOfHardware sends PDOS.

Throws:

org.lsst.ccs.drivers.commons.DriverException

updateFromPDO

void updateFromPDO(org.lsst.ccs.drivers.canopenjni.PDOData pdo)
            throws org.lsst.ccs.drivers.commons.DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverException

initializePDOs

default void initializePDOs()
                     throws org.lsst.ccs.drivers.commons.DriverException

Initialize PDOs if device is booted. Does nothing if device is not booted.

Throws:

org.lsst.ccs.drivers.commons.DriverException

createStatusDataPublishedByHardware

default StatusDataPublishedByHardware createStatusDataPublishedByHardware()

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

Returns:

publishData

default void publishData()

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

printState

default String printState()