org.lsst.ccs.drivers.canopenjni

Class CanOpenCommands

java.lang.Object

org.lsst.ccs.drivers.canopenjni.CanOpenCommands

All Implemented Interfaces:

CanOpenInterface

Deprecated.

This class is no longer needed since the methods of CanOpenInterface have been annotated with the @Command interface.

@Deprecated
public class CanOpenCommands
extends Object
implements CanOpenInterface

Annotate the methods of CanOpenInterface with @Command annotation.

Author:

emarin

Constructor Summary

Constructors

Constructor and Description
CanOpenCommands(CanOpenInterface coi) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addReceivedPDO(int cobId) Deprecated. Configures the pdo with the given cob_id for reception on the master node.
void	clearReceivedPDOs() Deprecated.
String	info(int nodeID) Deprecated. Returns the information for the given nodeID.
void	init() Deprecated.
void	init(int master, String baud, String busName, int nodeID) Deprecated. Initialization of the master node.
boolean	isReady() Deprecated.
void	quit() Deprecated. Shuts down the master node.
void	reset(int nodeId) Deprecated.
long	rsdo(int nodeId, int index, int subindex) Deprecated. Send a read sdo command.
int	scan() Deprecated. Sends a scan on the can bus.
void	setBootMessageListener(BootMessageListener bml) Deprecated.
void	setEmergencyMessageListener(EmergencyMessageListener eml) Deprecated.
void	setNMTStateOperational(int nodeId) Deprecated.
void	setPdoTimeout(long to) Deprecated.
void	setSdoTimeout(long to) Deprecated.
void	ssta(int nodeId) Deprecated. Slave start
void	ssto(int nodeId) Deprecated. Slave stop
void	start() Deprecated.
void	stop() Deprecated.
PDOData	sync() Deprecated. Sends a sync message on the canbus and synchronously waits for the received pdo configured in the master to be received.
void	wsdo(int nodeId, int index, int subindex, int size, long data) Deprecated. Send a write sdo command.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CanOpenCommands

public CanOpenCommands(CanOpenInterface coi)

Deprecated.

Method Detail

init

@Command
public void init(int master,
                          String baud,
                          String busName,
                          int nodeID)
                   throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Description copied from interface: CanOpenInterface

Initialization of the master node. This command has to be issued first for the subsequent one to be successful.

Specified by:

init in interface CanOpenInterface

Parameters:

master - 1 for master, 0 for slave.

baud - "125K","1M",...

busName - the bus name (0 for can0, 1 for can1)

nodeID - the nodeID

Throws:

org.lsst.ccs.drivers.commons.DriverException

addReceivedPDO

@Command
public void addReceivedPDO(int cobId)
                             throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Description copied from interface: CanOpenInterface

Configures the pdo with the given cob_id for reception on the master node.

Specified by:

addReceivedPDO in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

clearReceivedPDOs

@Command
public void clearReceivedPDOs()
                                throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Specified by:

clearReceivedPDOs in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

sync

@Command
public PDOData sync()
                      throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Description copied from interface: CanOpenInterface

Sends a sync message on the canbus and synchronously waits for the received pdo configured in the master to be received. For it to work, all received pdos configured on the master node must have a transmission type equal to Ox1, otherwise the behaviour is undefined.

Specified by:

sync in interface CanOpenInterface

Returns:

The PDOs

Throws:

org.lsst.ccs.drivers.commons.DriverException - in case of a failure accessing the hardware, or if the hardware returns an error

org.lsst.ccs.drivers.commons.DriverTimeoutException - if the hardware doesn't respond within the specified timeout

ConcurrentCallException - if a sync command is running and hasn't completed yet

scan

@Command
public int scan()
                  throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Description copied from interface: CanOpenInterface

Sends a scan on the can bus.

Specified by:

scan in interface CanOpenInterface

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

info

@Command
public String info(int nodeID)
                     throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Description copied from interface: CanOpenInterface

Returns the information for the given nodeID.

Specified by:

info in interface CanOpenInterface

Parameters:

nodeID - the node id

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

wsdo

@Command
public void wsdo(int nodeId,
                          int index,
                          int subindex,
                          int size,
                          long data)
                   throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Description copied from interface: CanOpenInterface

Send a write sdo command.

Specified by:

wsdo in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException - in case of a failure accessing the hardware, or if the hardware returns an error

org.lsst.ccs.drivers.commons.DriverTimeoutException - if the hardware doesn't respond within the specified timeout

ConcurrentCallException - if a write sdo / read sdo command was sent on the same node and hasn't completed yet

rsdo

@Command
public long rsdo(int nodeId,
                          int index,
                          int subindex)
                   throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Description copied from interface: CanOpenInterface

Send a read sdo command.

Specified by:

rsdo in interface CanOpenInterface

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException - in case of a failure accessing the hardware, or if the hardware returns an error

org.lsst.ccs.drivers.commons.DriverTimeoutException - if the hardware doesn't respond within the specified timeout

ConcurrentCallException - if a write sdo / read sdo command was sent on the same node and hasn't completed yet

ssta

@Command
public void ssta(int nodeId)
                   throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Description copied from interface: CanOpenInterface

Slave start

Specified by:

ssta in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

ssto

@Command
public void ssto(int nodeId)
                   throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Description copied from interface: CanOpenInterface

Slave stop

Specified by:

ssto in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

reset

@Command
public void reset(int nodeId)
                    throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Specified by:

reset in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

quit

@Command
public void quit()
                   throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Description copied from interface: CanOpenInterface

Shuts down the master node.

Specified by:

quit in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

init

@Command
public void init()
                   throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Specified by:

init in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

start

@Command
public void start()
                    throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Specified by:

start in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

stop

@Command
public void stop()
                   throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Specified by:

stop in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

isReady

@Command
public boolean isReady()
                         throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Specified by:

isReady in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

setEmergencyMessageListener

@Command
public void setEmergencyMessageListener(EmergencyMessageListener eml)
                                          throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Specified by:

setEmergencyMessageListener in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

setBootMessageListener

@Command
public void setBootMessageListener(BootMessageListener bml)
                                     throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Specified by:

setBootMessageListener in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

setSdoTimeout

@Command
public void setSdoTimeout(long to)
                            throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Specified by:

setSdoTimeout in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

setPdoTimeout

@Command
public void setPdoTimeout(long to)
                            throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Specified by:

setPdoTimeout in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

setNMTStateOperational

@Command
public void setNMTStateOperational(int nodeId)
                                     throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Specified by:

setNMTStateOperational in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException