org.lsst.ccs.subsystems.fcs.drivers

Class CanOpenProxy

java.lang.Object

org.lsst.ccs.subsystems.fcs.drivers.CanOpenProxy

All Implemented Interfaces:

org.lsst.ccs.framework.AlertHandler, org.lsst.ccs.framework.ClearAlertHandler, org.lsst.ccs.framework.HardwareController, org.lsst.ccs.framework.HasLifecycle, AlertRaiser, BridgeToHardware, CanOpenEventListener

public class CanOpenProxy
extends Object
implements org.lsst.ccs.framework.HardwareController, org.lsst.ccs.framework.ClearAlertHandler, BridgeToHardware, org.lsst.ccs.framework.HasLifecycle, AlertRaiser, CanOpenEventListener

This Module starts a tcpip server, waits for the connection of a client whose name is the value of the field clientName. This client is supposed to be a CANopen C-wrapper. When the client starts it scans the CANopen network and send to the server some information on the CANopen bootedNodes living on the CAN bus. The main job of the class CanOpenProxy is to check that the CANopen devices booted on the CAN bus are the CANopen devices which are listed in the configuration system.

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	bootedDeviceNB
protected boolean	hardwareBootProcessEnded
protected Map<String,PieceOfHardware>	hardwareMapByName
protected Map<Integer,PieceOfHardware>	hardwareMapByNodeID This map of PieceOfHardware which key is CANopen nodeID of the hardware represents the list of pieces of hardware (CANopen devices) this CanOpenProxy manages.
protected String	name

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

alertSeparater

Constructor Summary

Constructors

Constructor and Description
CanOpenProxy(long hardwareBootTimeout) Creates a CanOpenProxy with a tcpip port number to start the tcp server on, a client name, and a hardware booting process timeout.

Method Summary

Modifier and Type	Method and Description
boolean	allDevicesBooted() This method returns true if : all the hardware items are booted and identified and the hardware have the node ID expected within the configuration and the hardware is initialized.
void	bootProcess() Check if all pieces of hardware in the configuration are booted with the corect serial number.
org.lsst.ccs.framework.ClearAlertHandler.ClearAlertCode	canClearAlert(org.lsst.ccs.bus.data.Alert alert) Overridden method from ClearAlertHandler interface to define conditions when Alerts can be cleared.
void	checkNodeID(int nodeID) Check that a nodeID entered by an end user at the console is a valid one: - nodeID should be in the hardwareMapByNodeID.
void	checkStarted()
void	connectHardware() This method is used when the loader CANbus is connected.
void	disconnectHardware() *********************************************************************************************** ******************** END OF SETTERS AND GETTERS ********************************************** *********************************************************************************************** /** /** This methods stops the CWrapper client, and the TCP server.
org.lsst.ccs.AlertService	getAlertService() return alertService
String	getName()
String	getNodeName(int aNodeID) For a piece of hardware that this tcpProxy manages, this methods returns the name of the device when the CANopen node id is given as argument.
PDOStorage	getPdoStorage()
org.lsst.ccs.Subsystem	getSubsystem()
void	init()
boolean	isReady() This method should return true when connection to hardware is effective and all devices connected to that bridge have been correctly identified.
String	listBootedNodes() List the can open bootedNodes which are in the bootedNodes table.
List<String>	listHardwareNames() For the GUI : Return an Array containing hardware names handled by this component.
void	onBootMessage(int nodeID)
void	onEmergencyMessage(int nodeID, int errCode, int errReg) Process an emergency message received from a CANopen device on the status bus : - ALARM or WARNING Alert is raised, - a message is logged, - Observers are notified.
void	postStart() check that all pieces of hardware is booted.
String	printHardwareList() Return a String with the list of hardware expected in this subsystem.
String	printHardwareState() Return a printed list of hardware with the initialization state.
String	printPDOStorage() For tests.
void	publishData() Publish Data on status bus for trending data base and GUIs.
void	readDevicesInfo() This method is called in the checkHardware method during the initialization process.
PDOStorage	readPDOs() This method sends a sync command to the can open stack and returns the reply.
int	readSDO(int nodeID, int index, int subindex) Read a SDO with the given index and subindex RETURNS the value read in hexa (String) if no error occured or throws an Exception if an error occured.
String	readSDOCommand(int nodeID, int index, int subindex) Command to be used by the end user at the console in engineering mode.
int	readSDOLong(int nodeID, int index, int subindex)
void	retrieveHardwareInfo() Identification of the hardware : we want to retrieve the information stored in the hardware of the booted bootedNodes and update the array of bootedNodes with this information.
void	shutdownNow() This shutdowns the scheduler.
void	start()
String	toString()
String	writeSDO(int nodeID, int index, int subindex, int size, int value) Command to be used by the end user at the console.

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.framework.HasLifecycle

build, postBuild, postInit, postStop, stop

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

clearAlarm, raiseAlarm, raiseAlarm, raiseAlarm, raiseAlarm, raiseAlarm, raiseAlarm, raiseWarning, raiseWarning, raiseWarning, raiseWarning, raiseWarning

Field Detail

name

@LookupName
protected String name

hardwareMapByNodeID

protected final Map<Integer,PieceOfHardware> hardwareMapByNodeID

This map of PieceOfHardware which key is CANopen nodeID of the hardware represents the list of pieces of hardware (CANopen devices) this CanOpenProxy manages.

hardwareMapByName

@LookupField(strategy=CHILDREN)
protected final Map<String,PieceOfHardware> hardwareMapByName

hardwareBootProcessEnded

protected boolean hardwareBootProcessEnded

bootedDeviceNB

protected int bootedDeviceNB

Constructor Detail

CanOpenProxy

public CanOpenProxy(long hardwareBootTimeout)

Creates a CanOpenProxy with a tcpip port number to start the tcp server on, a client name, and a hardware booting process timeout.

Parameters:

hardwareBootTimeout -

Method Detail

getName

public String getName()

Specified by:

getName in interface AlertRaiser

getSubsystem

public org.lsst.ccs.Subsystem getSubsystem()

Specified by:

getSubsystem in interface AlertRaiser

getPdoStorage

public PDOStorage getPdoStorage()

disconnectHardware

public void disconnectHardware()

*********************************************************************************************** ******************** END OF SETTERS AND GETTERS ********************************************** *********************************************************************************************** /** /** This methods stops the CWrapper client, and the TCP server.

Specified by:

disconnectHardware in interface BridgeToHardware

connectHardware

public void connectHardware()

Description copied from interface: BridgeToHardware

This method is used when the loader CANbus is connected.

Specified by:

connectHardware in interface BridgeToHardware

init

public void init()

Specified by:

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

bootProcess

@Command(type=ACTION,
         description="Check if all pieces of hardware are booted with the corect serial number.")
public void bootProcess()

Check if all pieces of hardware in the configuration are booted with the corect serial number. Raise alerts if not. Waits until all hardware is booted or timeout is reached.

Specified by:

bootProcess in interface BridgeToHardware

start

public void start()

Specified by:

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

postStart

public void postStart()

check that all pieces of hardware is booted.

Specified by:

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

readDevicesInfo

public void readDevicesInfo()

This method is called in the checkHardware method during the initialization process. It check devices at fixed rate with a scheduler until all devices are booted or booting timeout is exceeded.

checkStarted

public void checkStarted()

Specified by:

checkStarted in interface org.lsst.ccs.framework.HardwareController

shutdownNow

public void shutdownNow()

This shutdowns the scheduler. This is executed during CLOSING phase when the CanOpenProxy is stopped. cf checkStopped

Specified by:

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

getNodeName

public String getNodeName(int aNodeID)

For a piece of hardware that this tcpProxy manages, this methods returns the name of the device when the CANopen node id is given as argument.

Parameters:

aNodeID -

Returns:

listBootedNodes

@Command(type=QUERY,
         level=3,
         description="Print the list of CANopen nodes which are booted on the CAN bus. (values are in HEXA)")
public String listBootedNodes()

List the can open bootedNodes which are in the bootedNodes table.

Returns:

the list of can open bootedNodes and the information stored in this.bootedNodes.

checkNodeID

public void checkNodeID(int nodeID)

Check that a nodeID entered by an end user at the console is a valid one: - nodeID should be in the hardwareMapByNodeID.

Parameters:

nodeID -

writeSDO

@Command(type=ACTION,
         level=3,
         description="Send a CanOpen writeSDO command to the Can Bus.  \nValues of the argument are to be given in hexadecimal format for: index and subindex\n and in decimal format for size and value.\n size represents the number of bytes on which the value is encoded. See device documentation.")
public String writeSDO(int nodeID,
                                                                                                                                                                                                                                                                                                                                                                          int index,
                                                                                                                                                                                                                                                                                                                                                                          int subindex,
                                                                                                                                                                                                                                                                                                                                                                          int size,
                                                                                                                                                                                                                                                                                                                                                                          int value)

Command to be used by the end user at the console. (for internal usage, see writeSDO(String,String,String,String,String); Write a SDO message and send it to the can open stack. The parameters are given in the following format:

Parameters:

nodeID - FORMAT=hexa

index - FORMAT=HEXA

subindex - FORMAT=HEXA

size - FORMAT=decimal between 0 and 4.

value - FORMAT=decimal

Returns:

Throws:

FcsHardwareException

readSDO

public int readSDO(int nodeID,
                   int index,
                   int subindex)

Read a SDO with the given index and subindex RETURNS the value read in hexa (String) if no error occured or throws an Exception if an error occured.

Parameters:

nodeID -

index -

subindex -

Returns:

Throws:

SDORequestException

ShortResponseToSDORequestException

readSDOLong

public int readSDOLong(int nodeID,
                       int index,
                       int subindex)

readSDOCommand

@Command(type=QUERY,
         level=3,
         description="Send a CANOpen readSDO command to the Can Bus.")
public String readSDOCommand(int nodeID,
                                                                                                                                           int index,
                                                                                                                                           int subindex)

Command to be used by the end user at the console in engineering mode. Send a CANOpen readSDO command to the Can Bus and returns the response in hexadecimal format. Check CANOpen nodeID.

Parameters:

nodeID - the node id

index - the index

subindex - the sub index

Returns:

an hex string representation.

Throws:

FcsHardwareException

readPDOs

public PDOStorage readPDOs()

This method sends a sync command to the can open stack and returns the reply. example of sync reply we can receive : sync,23_1=25a7,23_2=113,23_3=10,23_4=109,23_5=108,23_6=104,23_7=101,23_8=112

Specified by:

readPDOs in interface BridgeToHardware

Returns:

Throws:

FcsHardwareException

retrieveHardwareInfo

@Command(type=QUERY,
         level=0,
         description="Identification of the hardware : we want to retrieve the information stored in the hardware of the CANopen devices")
public void retrieveHardwareInfo()

Identification of the hardware : we want to retrieve the information stored in the hardware of the booted bootedNodes and update the array of bootedNodes with this information. So for each booted node, we send a command : - info,node_ID to the CWrapper and then we update the bootedNodes list with the information returned in the command result. The serial number is a main information to retrieve.

allDevicesBooted

@Command(type=QUERY,
         level=0,
         description="Return true if all CANopen devices are booted and identified.Identified means that the serial numbers match the CANopen nodeID which reside inconfiguration.")
public boolean allDevicesBooted()

This method returns true if : all the hardware items are booted and identified and the hardware have the node ID expected within the configuration and the hardware is initialized.

Specified by:

allDevicesBooted in interface BridgeToHardware

Returns:

a boolean

onBootMessage

public void onBootMessage(int nodeID)

Specified by:

onBootMessage in interface CanOpenEventListener

onEmergencyMessage

public void onEmergencyMessage(int nodeID,
                               int errCode,
                               int errReg)

Process an emergency message received from a CANopen device on the status bus : - ALARM or WARNING Alert is raised, - a message is logged, - Observers are notified.

Specified by:

onEmergencyMessage in interface CanOpenEventListener

Parameters:

nodeID -

errCode -

errReg -

printHardwareList

@Command(type=QUERY,
         level=1,
         description="Return a printed list of hardware expected in this subsystem.")
public String printHardwareList()

Return a String with the list of hardware expected in this subsystem. For debug purpose.

Specified by:

printHardwareList in interface BridgeToHardware

Returns:

printHardwareState

@Command(type=QUERY,
         level=1,
         description="Return a printed list of hardware with the initialization state.")
public String printHardwareState()

Return a printed list of hardware with the initialization state. For debug purpose.

Specified by:

printHardwareState in interface BridgeToHardware

Returns:

listHardwareNames

@Command(type=QUERY,
         level=1,
         description="Return an Array containing hardware names handled by this component.")
public List<String> listHardwareNames()

For the GUI : Return an Array containing hardware names handled by this component.

Specified by:

listHardwareNames in interface BridgeToHardware

Returns:

canClearAlert

public org.lsst.ccs.framework.ClearAlertHandler.ClearAlertCode canClearAlert(org.lsst.ccs.bus.data.Alert alert)

Overridden method from ClearAlertHandler interface to define conditions when Alerts can be cleared.

Specified by:

canClearAlert in interface org.lsst.ccs.framework.ClearAlertHandler

Parameters:

alert -

Returns:

publishData

@Command(type=QUERY,
         level=1,
         description="Publish booting information for all CANopen devices.")
public void publishData()

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

Specified by:

publishData in interface BridgeToHardware

printPDOStorage

@Command(type=QUERY,
         level=1,
         description="Return a printed format of PDOStorage.")
public String printPDOStorage()

For tests. Return a printed format of PDOStorage.

Returns:

toString

public String toString()

Overrides:

toString in class Object

isReady

public boolean isReady()

Description copied from interface: BridgeToHardware

This method should return true when connection to hardware is effective and all devices connected to that bridge have been correctly identified.

Specified by:

isReady in interface BridgeToHardware

Returns:

getAlertService

public org.lsst.ccs.AlertService getAlertService()

Description copied from interface: AlertRaiser

return alertService

Specified by:

getAlertService in interface AlertRaiser

Returns: