org.lsst.ccs.subsystems.fcs.drivers

Class CanOpenProxy

java.lang.Object

java.util.Observable

org.lsst.ccs.framework.Module

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

All Implemented Interfaces:

Observer, org.lsst.ccs.config.ConfigurationBulkChangeHandler, org.lsst.ccs.framework.ClearAlertHandler, org.lsst.ccs.framework.Configurable, org.lsst.ccs.framework.HardwareController, org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.framework.SignalHandler, AlertRaiser, TcpProxyInterface, org.lsst.ccs.UsesSubsystem

Direct Known Subclasses:

LoaderCanOpenProxy, SimuCanOpenProxy

public class CanOpenProxy
extends org.lsst.ccs.framework.Module
implements org.lsst.ccs.framework.HardwareController, org.lsst.ccs.framework.ClearAlertHandler, TcpProxyInterface

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. This class launch ALERTS : - FCS001 in sendCanOpenCommand, readDeviceInfo - FCS002 in processEmcyMessage, processErrorRegister - FCS003 in processBootMessage

Author:

virieux

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	FcsTcpProxy.ClientContext A class to handle the tcpip connexion.

Nested classes/interfaces inherited from class org.lsst.ccs.framework.Module

org.lsst.ccs.framework.Module.ValueUpdate

Nested classes/interfaces inherited from interface org.lsst.ccs.framework.ClearAlertHandler

org.lsst.ccs.framework.ClearAlertHandler.ClearAlertCode

Nested classes/interfaces inherited from interface org.lsst.ccs.framework.Configurable

org.lsst.ccs.framework.Configurable.Environment

Field Summary

Fields

Modifier and Type	Field and Description
protected Condition	bootingCompleted
protected FcsTcpProxy.ClientContext	clientContext
protected int	fieldBusTimeout
protected Condition	hardwareBooted
protected ArrayList<PieceOfHardware>	hardwareList An array of CANopen hardware controled by this subsystem.
protected Lock	lock
protected int	portNumber
protected boolean	stopped
protected boolean	stopping
protected boolean	tcpServerStarted

Fields inherited from class org.lsst.ccs.framework.Module

name, nObserverThreads, tickMillis

Constructor Summary

Constructors

Constructor and Description
CanOpenProxy(int portNumber, int fieldBusTimeout, String clientName, 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
Object	call(String clientName, String command) This methods send a command to the tcp client.
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	checkBootedCanOpenNodes() Check if the list of the booted CANopen devices on the CANbus is identical to the hardware list we have in the description.
protected void	checkCanOpenCommand(String command) Tests that a CANOpen command is valid.
org.lsst.ccs.framework.TreeWalkerDiag	checkHardware() This method has to be tested on test benches.
void	checkHardwareID(PieceOfHardware pieceOfHardware) When the hardware is booted and we have retrieve the information (serial number), we want to check for each piece of hardware that we have the good node ID and the good serial number: so we compare the serial number found on the CANopen bus (in Map bootedNodes) with the serial number in the configuration file.
void	checkNewHardware() checkNewHardware is called by command checkStarted() in higher level Modules and is executed when a command completeInitialization is sent to the subsystem.
void	checkNodeID(String nodeID) Check that a nodeID entered by an end user at the console is a valid one: - nodeID should be in the hardwareMapByNodeID.
void	checkNumberOfBootedNodes() This methods checks if the number of booted nodes is correct : it has to be equal to the number of hardware that this tcpProxy manages.
void	checkStarted()
void	checkStopped()
void	connectHardware() This method is used when the loader CANbus is connected.
void	disconnectHardware() This methods stops the CWrapper client, and the TCP server.
CanOpenNode	getBootedNodeBySerialNumber(String sn) Find a node by its serial number in the list of booted bootedNodes.
String	getClientName() For simulation ONLY.
String	getMyClientName()
String	getNodeName(String 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()
int	getPortNumber()
void	identifyHardware() 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	initialize() This method initializes the fields of the tcpProxy.
void	initModule()
boolean	isBooted(String aNodeID) Check if the String nodeID already exists in the bootedNodes table.
boolean	isCANDevicesReady() 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.
boolean	isHardwareIdentified()
boolean	isReady(String clientName)
boolean	isTcpServerStarted() returns true if this server is started.
String	listBootedNodes() List the can open bootedNodes which are in the bootedNodes table.
List<String>	listHardwareNames() Return an Array containing hardware names handled by this component.
String	printBootedNodeBySerialNumber(String sn) Returns a String representation of a CANopen node booted on the CANbus for the device which serial number is given as a parameter.
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	processEmcyMessage(String message) 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 (CANopen devices are CanOpenProxy Observers).
String	processResponseToReadSDO(String response, String nodeID, String request) Check a response to a readSDO command.
String	processSDORequestError(String request, String response, String nodeID, String errorCode, org.lsst.ccs.bus.states.AlertState alertState) When we receive a response with an error to a SDO request, this methods retreives the errorName in the CANOpen tables, create an error message and raise an Alert.
void	publishData() Publish Data on status bus for trending data base and GUIs.
void	publishHardwareData(PieceOfHardware device) Publish Data on status bus for trending data base and GUIs.
void	publishHardwareData(String nodeID) Publish Data on status bus for trending data base and GUIs for a CANopen device.
void	readDevicesInfo(long beginTime, long timeout) 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.
String	readSDO(String nodeID, String index, String subindex) Read a SDO with the given index and subindex RETURNS the value read in hexa (String) if no error occured or returns the error code if a error was detected.
String	readSDOCommand(String nodeID, String index, String subindex) Command to be used by the end user at the console in engineering mode.
String	sendCanOpenCommand(String command) For end users, in engineering mode, this method can be used to send Can Open commands to the Wrapper.
void	setCanOpenNodeNumbersOK(boolean canOpenNodeNumbersOK) For the simulator
void	setHardwareBootProcessEnded(boolean hardwareBootProcessEnded)
void	setHardwareIdentified(boolean hardwareIdentified) For the simulator
protected void	setHardwareList(ArrayList<PieceOfHardware> devices) Set hardwareList and initialize hardwareMapByNodeID.
void	shutdownNow() This shutdowns the scheduler.
void	start()
void	startServer() Starts the server tcp on the port portNumber.
void	startThreadReader() Starts a thread which read on the tcp socket, waiting for messages coming from tcp proxy.
void	stopServer() Stops the tcp server.
String	toString()
void	updateDeviceInfo(String bootedNodeID) This method sends a message info,nodeID to the CANbus and update the CANopen device information from data received from the device.
String	writeSDO(String nodeID, String index, String subindex, int size, int value) Command to be used by the end user at the console.
String	writeSDO(String nodeID, String index, String subindex, String size, String value) Write a SDO request and send it to the can open stack, then analyses the response or throws an exception if the request failed.

Methods inherited from class org.lsst.ccs.framework.Module

getNObserverThreads, getObservables, getTickMillis, init, listens, processUpdate, sendSignal, sendSignalWithTimeLimit, setNObserverThreads, setObservables, setTickMillis, signal, startTicking, tick, update

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

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

raiseAlarm, raiseAlarm, raiseAlarm, raiseWarning, raiseWarning, raiseWarning

Methods inherited from interface org.lsst.ccs.UsesSubsystem

getComponentConfigurationEnvironment, getComponentLookup, getName, getSubsystem

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

change, dropSubmittedChanges, getChildren, getComponentByName, getEnvironment, getParent, getParentObject, getSubmittedChanges, isParameterConfigurable, postStart, printConfigurableParameters, setBulkParameter, submitChange, submitChanges, validateBulkChange

Methods inherited from interface org.lsst.ccs.config.ConfigurationBulkChangeHandler

setParameterBulk

Field Detail

hardwareList

protected ArrayList<PieceOfHardware> hardwareList

An array of CANopen hardware controled by this subsystem. This represents the hardware listed in the configuration file which are children of BridgeToHardware and implement PieceOfHardware. This list of hardware is initialized in the method initModule of the Module BridgeToCanOpenHardware. protected because used by SimuCanOpenProxy

bootingCompleted

protected final Condition bootingCompleted

portNumber

@ConfigurationParameter(isFinal=true,
                        range="1024..99000",
                        description="tcpip port number on which this tcpip server starts on.")
protected int portNumber

fieldBusTimeout

@ConfigurationParameter(description="Timeout in Millisecond. If a command sent to the CANbus doesn\'t respond during this amount of time, we considere that they could be an issue on the hardware.")
protected int fieldBusTimeout

stopped

protected volatile boolean stopped

stopping

protected volatile boolean stopping

tcpServerStarted

protected volatile boolean tcpServerStarted

clientContext

protected FcsTcpProxy.ClientContext clientContext

lock

protected final Lock lock

hardwareBooted

protected final Condition hardwareBooted

Constructor Detail

CanOpenProxy

public CanOpenProxy(int portNumber,
                    int fieldBusTimeout,
                    String clientName,
                    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:

portNumber -

fieldBusTimeout -

clientName -

hardwareBootTimeout -

Method Detail

setHardwareList

protected void setHardwareList(ArrayList<PieceOfHardware> devices)

Set hardwareList and initialize hardwareMapByNodeID.

Parameters:

devices -

getMyClientName

public String getMyClientName()

Returns:

the clientName

getPdoStorage

public PDOStorage getPdoStorage()

isHardwareIdentified

public boolean isHardwareIdentified()

setHardwareIdentified

public void setHardwareIdentified(boolean hardwareIdentified)

For the simulator

Parameters:

hardwareIdentified -

setCanOpenNodeNumbersOK

public void setCanOpenNodeNumbersOK(boolean canOpenNodeNumbersOK)

For the simulator

Parameters:

canOpenNodeNumbersOK -

setHardwareBootProcessEnded

public void setHardwareBootProcessEnded(boolean hardwareBootProcessEnded)

disconnectHardware

public void disconnectHardware()

This methods stops the CWrapper client, and the TCP server.

Specified by:

disconnectHardware in interface TcpProxyInterface

connectHardware

public void connectHardware()
                     throws org.lsst.ccs.HardwareException

Description copied from interface: TcpProxyInterface

This method is used when the loader CANbus is connected.

Specified by:

connectHardware in interface TcpProxyInterface

Throws:

org.lsst.ccs.HardwareException

initModule

public void initModule()

initialize

public void initialize()

This method initializes the fields of the tcpProxy. It's used when we start the Module and when we disconnect hardware.

checkHardware

public org.lsst.ccs.framework.TreeWalkerDiag checkHardware()
                                                    throws org.lsst.ccs.HardwareException

This method has to be tested on test benches. It should replace checkHardware.

Specified by:

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

Returns:

Throws:

org.lsst.ccs.HardwareException

readDevicesInfo

public void readDevicesInfo(long beginTime,
                            long timeout)

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.

Parameters:

beginTime -

timeout -

checkNewHardware

@Command(type=QUERY,
         level=0,
         description="Retrieve information for booted devices and checks if CANopen node ID and serial number match thosein description file .")
public void checkNewHardware()
                                                                                                                                                                                                              throws org.lsst.ccs.HardwareException

checkNewHardware is called by command checkStarted() in higher level Modules and is executed when a command completeInitialization is sent to the subsystem. The command completeInitialization is sent by the end-user to complete the initialization phase when the subsystem was stopped during this phase because of an error (HardwareException).

Specified by:

checkNewHardware in interface TcpProxyInterface

Throws:

org.lsst.ccs.HardwareException

checkStarted

public void checkStarted()
                  throws org.lsst.ccs.HardwareException

Specified by:

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

Throws:

org.lsst.ccs.HardwareException

checkStopped

public void checkStopped()
                  throws org.lsst.ccs.HardwareException

Specified by:

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

Throws:

org.lsst.ccs.HardwareException

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

Specified by:

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

getNodeName

public String getNodeName(String 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:

isBooted

@Command(type=QUERY,
         level=3,
         description="Return true if the device, with nodeID given as argument, is booted.")
public boolean isBooted(String aNodeID)

Check if the String nodeID already exists in the bootedNodes table. If it is booted it is on the bootedNodes table. It means that this node ID is on the can open bus.

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.

sendCanOpenCommand

@Command(type=ACTION,
         level=3,
         description="Send a CanOpen command to the Can Bus.")
public String sendCanOpenCommand(String command)

For end users, in engineering mode, this method can be used to send Can Open commands to the Wrapper. Test if the command is valid before sending it to the CAN bus.

Parameters:

command - A Can Open command that the Wrapper should understand.

Returns:

the response from the Wrapper

Throws:

FcsHardwareException

checkCanOpenCommand

protected void checkCanOpenCommand(String command)

Tests that a CANOpen command is valid. If the command is not valid it throws a IllegalArgumentException. This is used in the sendCanOpen command method which can be entered by an end user in a console.

Parameters:

command - CANOpen command to be tested

checkNodeID

public void checkNodeID(String 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

public String writeSDO(String nodeID,
                       String index,
                       String subindex,
                       String size,
                       String value)

Write a SDO request and send it to the can open stack, then analyses the response or throws an exception if the request failed. The parameters are given in HEXA. For internal usage.

Parameters:

nodeID - FORMAT=HEXA

index - FORMAT=HEXA

subindex - FORMAT=HEXA

size - FORMAT=HEXA

value - FORMAT=HEXA

Returns:

"OK" if OK

Throws:

SDORequestException

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(String nodeID,
                                                                                                                                                                                                                                                                                                                                                                          String index,
                                                                                                                                                                                                                                                                                                                                                                          String 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

value - FORMAT=decimal

Returns:

Throws:

FcsHardwareException

readSDO

public String readSDO(String nodeID,
                      String index,
                      String subindex)
               throws ShortResponseToSDORequestException,
                      FcsHardwareException

Read a SDO with the given index and subindex RETURNS the value read in hexa (String) if no error occured or returns the error code if a error was detected.

Parameters:

nodeID - FORMAT=hexa

index - FORMAT=hexa

subindex - FORMAT=hexa

Returns:

Throws:

SDORequestException

ShortResponseToSDORequestException

FcsHardwareException

processResponseToReadSDO

public String processResponseToReadSDO(String response,
                                       String nodeID,
                                       String request)
                                throws ShortResponseToSDORequestException,
                                       SDORequestException

Check a response to a readSDO command. Return the data requested if the response is a valid response otherwise throw an Exception of type SDORequestException or ShortResponseToSDORequestException.

Parameters:

response -

nodeID -

request -

Returns:

Throws:

ShortResponseToSDORequestException

SDORequestException

readSDOCommand

@Command(type=QUERY,
         level=3,
         description="Send a CANOpen readSDO command to the Can Bus.")
public String readSDOCommand(String nodeID,
                                                                                                                                           String index,
                                                                                                                                           String 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 - FORMAT=hexa

index - FORMAT=hexa

subindex - FORMAT=hexa

Returns:

Throws:

FcsHardwareException

processSDORequestError

public String processSDORequestError(String request,
                                     String response,
                                     String nodeID,
                                     String errorCode,
                                     org.lsst.ccs.bus.states.AlertState alertState)

When we receive a response with an error to a SDO request, this methods retreives the errorName in the CANOpen tables, create an error message and raise an Alert.

Parameters:

request -

response -

errorCode -

nodeID -

alertState -

Returns:

msg a message to be added to an exception if needed.

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

Returns:

Throws:

FcsHardwareException

identifyHardware

@Command(type=QUERY,
         level=0,
         description="Identification of the hardware : we want to retrieve the information \n     * stored in the hardware of the booted nodes and update the array of nodes\n     * with this information.")
public void identifyHardware()
                                                                                                                                                                                                                                                                           throws org.lsst.ccs.HardwareException

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.

Throws:

org.lsst.ccs.HardwareException

updateDeviceInfo

@Command(type=QUERY,
         level=1,
         description="Update device information in sending to the CANbus a CANopen command : info,nodeID")
public void updateDeviceInfo(String bootedNodeID)
                                                                                                                                                                        throws org.lsst.ccs.HardwareException

This method sends a message info,nodeID to the CANbus and update the CANopen device information from data received from the device.

Parameters:

bootedNodeID -

Throws:

org.lsst.ccs.HardwareException

isCANDevicesReady

@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 isCANDevicesReady()

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.

Returns:

a boolean

processEmcyMessage

public void processEmcyMessage(String message)

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 (CANopen devices are CanOpenProxy Observers).

Parameters:

message -

checkBootedCanOpenNodes

public void checkBootedCanOpenNodes()
                             throws org.lsst.ccs.HardwareException

Check if the list of the booted CANopen devices on the CANbus is identical to the hardware list we have in the description.

Throws:

org.lsst.ccs.HardwareException

checkNumberOfBootedNodes

@Command(type=QUERY,
         level=0,
         description="Checks if the number of booted nodes is correct : it has to be equal to the number of CANopen devices that this subsystem manages.")
public void checkNumberOfBootedNodes()
                                                                                                                                                                                                                                throws org.lsst.ccs.HardwareException

This methods checks if the number of booted nodes is correct : it has to be equal to the number of hardware that this tcpProxy manages.

Throws:

org.lsst.ccs.HardwareException

checkHardwareID

public void checkHardwareID(PieceOfHardware pieceOfHardware)
                     throws org.lsst.ccs.HardwareException

When the hardware is booted and we have retrieve the information (serial number), we want to check for each piece of hardware that we have the good node ID and the good serial number: so we compare the serial number found on the CANopen bus (in Map bootedNodes) with the serial number in the configuration file.

Parameters:

pieceOfHardware -

Throws:

org.lsst.ccs.HardwareException

getBootedNodeBySerialNumber

public CanOpenNode getBootedNodeBySerialNumber(String sn)

Find a node by its serial number in the list of booted bootedNodes. Returns null if this serial number is not on the CAN bus.

Parameters:

sn -

Returns:

CANopen node which serial number is sn or null.

printBootedNodeBySerialNumber

@Command(type=QUERY,
         level=0,
         description="Returns a String representation of a CANopen node booted on the CANbus for the device which serial number is given as a parameter.")
public String printBootedNodeBySerialNumber(String sn)

Returns a String representation of a CANopen node booted on the CANbus for the device which serial number is given as a parameter. This is for the end users.

Parameters:

sn -

Returns:

a String

printHardwareList

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

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

Specified by:

printHardwareList in interface TcpProxyInterface

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 TcpProxyInterface

Returns:

listHardwareNames

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

Return an Array containing hardware names handled by this component.

Specified by:

listHardwareNames in interface TcpProxyInterface

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 TcpProxyInterface

publishHardwareData

public void publishHardwareData(PieceOfHardware device)

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

Parameters:

device -

publishHardwareData

@Command(type=QUERY,
         level=1,
         description="Publish booting information for a CANopen device given by its CANopen nodeID.")
public void publishHardwareData(String nodeID)

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

Parameters:

nodeID -

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()

isTcpServerStarted

public boolean isTcpServerStarted()

returns true if this server is started.

Returns:

getPortNumber

public int getPortNumber()

getClientName

public String getClientName()

For simulation ONLY.

Returns:

start

public void start()

Specified by:

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

Specified by:

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

startServer

@Command(type=ACTION,
         level=1,
         description="Starts the tcp server.")
public void startServer()

Starts the server tcp on the port portNumber. And waits for a client connection.

startThreadReader

@Command(type=ACTION,
         level=1,
         description="Starts to listen to the tcp client.")
public void startThreadReader()

Starts a thread which read on the tcp socket, waiting for messages coming from tcp proxy. If the message has a known token (already registred in commandDispenser) it is a response to a can open command that we had sent to the proxy. If the token of the message is null, that means that is's an unsynchronous message coming from the can open stack and transmitted directly from the tcp proxy. That can be : - a boot message : "boot,nodeID" - an emergency message : "emcy,80+NodeID"

stopServer

public void stopServer()

Stops the tcp server.

isReady

public boolean isReady(String clientName)

call

public Object call(String clientName,
                   String command)

This methods send a command to the tcp client. The command is a String and can be understood by the client. Example for a Can Open command : rsdo,1,1018,0 The command is stored in the command dispenser with a token and command corelation. When the response comes back from the proxy we can retrieve it from the dispenser with the call token.

Parameters:

clientName -

command -

Returns:

result of the call or null if the call failed