org.lsst.ccs.subsystems.fcs.drivers

Class CanOpenDevice

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CanCBXAI420, CanCBXAI814, CanOpenDAC, CanOpenEPOS, CanOpenMG550P, CanOpenPT100, CanOpenSeneca4RTD, CanOpenStrainGauge, CanOpenSystecIO, CanOpenTTC580, PlutoGateway, SimuMG550P

public class CanOpenDevice
extends Object
implements PieceOfHardware, org.lsst.ccs.framework.HasLifecycle

The goal of this class is to factorize all methods commun to all CANopen devices.

Author:

virieux

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	booted
protected org.lsst.ccs.services.DataProviderDictionaryService	dataProviderDictionaryService
protected int[]	errorHistory
protected String	errorRegister
protected boolean	inError
protected boolean	initialized
protected int	lastErrorCode
protected String	lastErrorName
protected String	name
protected int	nodeID
protected String	path
protected String	serialNB
protected org.lsst.ccs.Subsystem	subs
protected CanOpenProxy	tcpProxy

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

alertSeparator

Constructor Summary

Constructors

Constructor and Description
CanOpenDevice()

Method Summary

Modifier and Type	Method and Description
void	build()
void	configAsHeartbeatConsumer(int nodeID, int producerNodeID, int heartbeatTime) Configure a node as a hearbeat consumer.
void	configAsHeartbeatProducer(int nodeID, int heartbeatTime) Configure a node as a hearbeat producer.
StatusDataPublishedByCanOpenDevice	createStatusDataPublishedByCanOpenDevice() Creates an object to be published on the STATUS bus by a CanOpenDevice.
String	displayError(int err) read an error table to return an error name corresponding to the error code given as argument.
String	displayErrorHistory() Read error history on the device and return its String representation.
String	displayErrorRegister() Read Error Register on the controller (index 1001), retrieve error name and return a String representation of the error register.
void	doInitializePDOs() Do nothing if this device doesn't send PDOs except log for debug purpose.
org.lsst.ccs.services.alert.AlertService	getAlertService() return alertService
int[]	getErrorHistory() For the GUI
int	getErrorHistoryNB()
String	getErrorRegister() For the GUI
int	getLastErrorCode()
String	getLastErrorName()
String	getName() Return name.
int	getNodeID()
String	getPath()
String	getSerialNB()
org.lsst.ccs.Subsystem	getSubsystem()
CanOpenProxy	getTcpProxy() Return tcpProxy
void	init()
void	initializeAndCheckHardware() This methods has to be overridden if there is some initialization to do for the device.
boolean	isBooted() Returns true if this CANopen node is booted.
boolean	isInError() For the GUI
boolean	isInitialized() Returns true if this CANopen node is initialized.
void	onEmergencyMessage(EmergencyMessage emcyMsg) This method is to be used when receiving an EmergencyMessage from the CANbus for this device.
String	printSerialNumber() return a Hexadecimal String representation of serial number.
void	publishData() Publish Data on status bus for trending data base and GUIs.
int	readDeviceType()
int	readErrorRegister() Read Error Register on the controller (index 1001).
int	readNumberOfErrors() Read and return the number of errors registred in the Error History of the device.
long	readSDO(int index, int subindex) Sends a readSDO request to the CANopen device.
void	resetError() Reset fields which contains error messages.
void	saveParameters() End of methods to read errors on the device /*********************************************************************************** /** This method saves the parameters in the device memory.
void	setBooted(boolean isBooted) set boolean isBooted in INITIALIZATION phase.
String	toString()
void	updateDeviceInfo()
void	updateErrorHistory() read error history on the device and update error history fields : errorHistory, lastErrorCode, lastErrorName.
void	updateFromPDO(org.lsst.ccs.drivers.canopenjni.PDOData pdo) Do nothing if this device doesn't send PDOs except log for debug purpose.
void	writeSDO(int index, int subindex, int size, int newValue) Sends a writeSDO request to the CANopen device.
protected void	writeTransmissionTypeToDevice(int transmissionType) This methods writes the transmission type given as argument on the device.

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

checkBooted, checkId, checkInitialized, createStatusDataPublishedByHardware, initializePDOs, printState, raiseAlarmIfMissing, raiseWarningIfMissing

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

onFault, onFaultReset

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

clearAlarm, getAlertSeparator, raiseAlarm, raiseAlarm, raiseAlarm, raiseAlarm, raiseAlarmOnlyIfNew, raiseAlertOnlyEveryTenMinutes, raiseAlertOnlyEveryTenMinutes, raiseAlertOnlyIfNew, raiseWarning, raiseWarning, raiseWarning, raiseWarning, raiseWarningOnlyEveryTenMinutes, raiseWarningOnlyIfNew

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

postBuild, postInit, postShutdown, postStart, shutdown, start

Field Detail

nodeID

@ConfigurationParameter(isFinal=true,
                        description="CANOpen node ID of this CANOpen device",
                        units="unitless",
                        category="nodeID")
protected volatile int nodeID

serialNB

@ConfigurationParameter(description="serial number of this CANOpen device",
                        units="unitless",
                        category="serialNB")
protected volatile String serialNB

dataProviderDictionaryService

@LookupField(strategy=TREE)
protected org.lsst.ccs.services.DataProviderDictionaryService dataProviderDictionaryService

tcpProxy

@LookupField(strategy=ANCESTORS)
protected CanOpenProxy tcpProxy

initialized

protected boolean initialized

booted

protected volatile boolean booted

inError

protected boolean inError

errorHistory

protected int[] errorHistory

lastErrorCode

protected int lastErrorCode

lastErrorName

protected String lastErrorName

errorRegister

protected String errorRegister

name

@LookupName
protected String name

path

@LookupPath
protected String path

subs

@LookupField(strategy=TOP)
protected org.lsst.ccs.Subsystem subs

Constructor Detail

CanOpenDevice

public CanOpenDevice()

Method Detail

build

public void build()

Specified by:

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

init

public void init()

Specified by:

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

getAlertService

public org.lsst.ccs.services.alert.AlertService getAlertService()

Description copied from interface: AlertRaiser

return alertService

Specified by:

getAlertService in interface AlertRaiser

Returns:

getName

public String getName()

Return name. Need this method because EPOSController uses getName() to log events which concerns controllers.

Specified by:

getName in interface NamedComponent

Specified by:

getName in interface PieceOfHardware

Returns:

getPath

public String getPath()

Specified by:

getPath in interface NamedComponent

Specified by:

getPath in interface PieceOfHardware

getSubsystem

public org.lsst.ccs.Subsystem getSubsystem()

Specified by:

getSubsystem in interface AlertRaiser

getSerialNB

@Command(type=QUERY,
         level=1,
         description="Returns this CANopen device\'s serial number.")
public String getSerialNB()

Specified by:

getSerialNB in interface PieceOfHardware

getNodeID

@Command(type=QUERY,
         level=1,
         description="Returns this CANopen device\'s node ID and print it in decimal format.")
public int getNodeID()

Specified by:

getNodeID in interface PieceOfHardware

isBooted

@Command(type=QUERY,
         level=1,
         description="Returns true if this CANopen node is booted.")
public boolean isBooted()

Returns true if this CANopen node is booted.

Specified by:

isBooted in interface PieceOfHardware

Returns:

setBooted

public void setBooted(boolean isBooted)

Description copied from interface: PieceOfHardware

set boolean isBooted in INITIALIZATION phase.

Specified by:

setBooted in interface PieceOfHardware

isInitialized

@Command(type=QUERY,
         level=1,
         description="Returns true if this CANopen node is initialized.")
public boolean isInitialized()

Returns true if this CANopen node is initialized.

Specified by:

isInitialized in interface PieceOfHardware

Returns:

getErrorHistoryNB

public int getErrorHistoryNB()

getLastErrorCode

public int getLastErrorCode()

getLastErrorName

public String getLastErrorName()

getTcpProxy

public CanOpenProxy getTcpProxy()

Return tcpProxy

Returns:

getErrorHistory

public int[] getErrorHistory()

For the GUI

Returns:

a list of Errors - can be empty

getErrorRegister

public String getErrorRegister()

For the GUI

Returns:

isInError

public boolean isInError()

For the GUI

Returns:

updateDeviceInfo

@Command(type=QUERY,
         level=1,
         description="Check if device is booted and update device info.")
public void updateDeviceInfo()

Specified by:

updateDeviceInfo in interface PieceOfHardware

onEmergencyMessage

public void onEmergencyMessage(EmergencyMessage emcyMsg)

This method is to be used when receiving an EmergencyMessage from the CANbus for this device. An emergency message for a controller can be received from the CANbus in 2 cases: - a faultReset has been previously sent to the controller, in this case the error code of the emergency message is 0, - or when a new error is detected by the controller device, in this case the error code is different from 0. This method raises an ALARM, updates the boolean inError and publishes data. It's useful for the GUI and the monitoring of the hardware.

Specified by:

onEmergencyMessage in interface EmergencyMessageListener

Parameters:

emcyMsg - the emergency message to be processed.

resetError

public void resetError()

Reset fields which contains error messages.

initializeAndCheckHardware

@Command(type=ACTION,
         level=1,
         description="Initialize the device.")
public void initializeAndCheckHardware()

This methods has to be overridden if there is some initialization to do for the device.

Specified by:

initializeAndCheckHardware in interface PieceOfHardware

writeTransmissionTypeToDevice

@Command(type=ACTION,
         level=3,
         description="Write transmission type to the device.")
protected void writeTransmissionTypeToDevice(int transmissionType)

This methods writes the transmission type given as argument on the device.

Parameters:

transmissionType -

Throws:

FcsHardwareException

writeSDO

@Command(type=ACTION,
         level=3,
         description="Write on the Can Open Device with a command wsdo.")
public void writeSDO(int index,
                                                                                                                                       int subindex,
                                                                                                                                       int size,
                                                                                                                                       int newValue)

Sends a writeSDO request to the CANopen device.

Parameters:

index -

subindex -

size -

newValue -

Throws:

FcsHardwareException

readSDO

@Command(type=QUERY,
         level=3,
         description="Read Can Open Device with a command rsdo.")
public long readSDO(int index,
                                                                                                                             int subindex)

Sends a readSDO request to the CANopen device.

Parameters:

index -

subindex -

Returns:

Throws:

FcsHardwareException

readDeviceType

public int readDeviceType()

Specified by:

readDeviceType in interface PieceOfHardware

printSerialNumber

@Command(type=QUERY,
         level=3,
         description="return a Hexadecimal representation of serial number.")
public String printSerialNumber()

return a Hexadecimal String representation of serial number. For end user.

Returns:

readErrorRegister

@Command(type=QUERY,
         level=3,
         description="Reads Error Register on the controller (index 1001).")
public int readErrorRegister()

Read Error Register on the controller (index 1001).

Returns:

error code

Throws:

SDORequestException

displayErrorRegister

@Command(type=QUERY,
         level=3,
         description="Display Error Register on the controller (index 1001).")
public String displayErrorRegister()

Read Error Register on the controller (index 1001), retrieve error name and return a String representation of the error register. For end user usage at console.

Returns:

updateErrorHistory

public void updateErrorHistory()

read error history on the device and update error history fields : errorHistory, lastErrorCode, lastErrorName. Error history holds errors that have occurred on the device.

displayErrorHistory

@Command(type=QUERY,
         level=1,
         description="Display Error History for this device (index 1003).")
public String displayErrorHistory()

Read error history on the device and return its String representation.

Returns:

displayError

public String displayError(int err)

read an error table to return an error name corresponding to the error code given as argument.

Parameters:

err -

Returns:

string representation of error code given as argument

readNumberOfErrors

@Command(type=QUERY,
         level=1,
         description="Read and returns the number of errors registred in the Error History.")
public int readNumberOfErrors()

Read and return the number of errors registred in the Error History of the device.

Returns:

Throws:

SDORequestException

saveParameters

@Command(type=ACTION,
         level=3,
         description="This method saves the parameters in the device memory.")
public void saveParameters()

End of methods to read errors on the device /*********************************************************************************** /** This method saves the parameters in the device memory.

Throws:

SDORequestException

configAsHeartbeatProducer

@Command(type=ACTION,
         level=3,
         description="Configure a CANopen device as a heartbeat producer.")
public void configAsHeartbeatProducer(int nodeID,
                                                                                                                                                          int heartbeatTime)

Configure a node as a hearbeat producer. Every heartbeatTime milliseconds this node will produce a message like: 0x700+nodeID: 05 - 1340268404.980000

Parameters:

nodeID - node ID

heartbeatTime - heartbeat in milliseconds

Throws:

SDORequestException

configAsHeartbeatConsumer

public void configAsHeartbeatConsumer(int nodeID,
                                      int producerNodeID,
                                      int heartbeatTime)

Configure a node as a hearbeat consumer. Every heartbeatTime milliseconds this node will produce a message like: 0x700+nodeID: 05 - 1340268404.980000

Parameters:

nodeID - node ID in decimal

producerNodeID -

heartbeatTime - FORMAT=decimal UNIT=milliseconds

Throws:

SDORequestException

doInitializePDOs

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

Do nothing if this device doesn't send PDOs except log for debug purpose. To be overriden if this device sends PDOS.

Specified by:

doInitializePDOs in interface PieceOfHardware

Throws:

org.lsst.ccs.drivers.commons.DriverException

updateFromPDO

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

Do nothing if this device doesn't send PDOs except log for debug purpose. To be overriden if this device sends PDOS.

Specified by:

updateFromPDO in interface PieceOfHardware

Parameters:

pdo -

toString

@Command(type=QUERY,
         level=1,
         description="Print CANopen device.")
public String toString()

Overrides:

toString in class Object

createStatusDataPublishedByCanOpenDevice

public StatusDataPublishedByCanOpenDevice createStatusDataPublishedByCanOpenDevice()

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

Returns:

publishData

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

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

Specified by:

publishData in interface PieceOfHardware