org.lsst.ccs.drivers.canopenjni.rmi

Class CanOpenRMIClient

java.lang.Object

org.lsst.ccs.drivers.canopenjni.rmi.CanOpenRMIClient

All Implemented Interfaces:

CanOpenInterface

public class CanOpenRMIClient
extends Object
implements CanOpenInterface

Author:

emarin

Constructor Summary

Constructors

Constructor and Description
CanOpenRMIClient(String registryHostName)

Method Summary

Modifier and Type	Method and Description
void	addReceivedPDO(int cobId) Configures the pdo with the given cob_id for reception on the master node.
String	info(int nodeID) Returns the information for the given nodeID.
void	init()
void	init(int master, String baud, String busName, int nodeID) Initialization of the master node.
boolean	isReady()
void	quit()
void	reset(int nodeId)
long	rsdo(int nodeId, int index, int subindex) Read device entry
int	scan() Sends a scan on the can bus.
void	setBootMessageListener(BootMessageListener bml)
void	setEmergencyMessageListener(EmergencyMessageListener eml)
void	ssta(int nodeId) Slave start
void	ssto(int nodeId) Slave stop
void	start()
void	stop()
PDOData	sync() 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)

Methods inherited from class java.lang.Object

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

Constructor Detail

CanOpenRMIClient

public CanOpenRMIClient(String registryHostName)

Parameters:

registryHostName - the registry host name

Method Detail

init

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

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

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

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

sync

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

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 behavior is undefined.

Specified by:

sync in interface CanOpenInterface

Returns:

the PDOs.

Throws:

org.lsst.ccs.drivers.commons.DriverException

scan

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

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

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

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

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

Specified by:

wsdo in interface CanOpenInterface

Parameters:

nodeId - the node id

index - the index

subindex - the sub index

size - the size

data - the data

Throws:

org.lsst.ccs.drivers.commons.DriverException

rsdo

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

Description copied from interface: CanOpenInterface

Read device entry

Specified by:

rsdo in interface CanOpenInterface

Parameters:

nodeId - the node id

index - the index

subindex - the subindex

Returns:

an unsigned long. Cast to int to treat it as signed, leave to long to treat it as unsigned

Throws:

org.lsst.ccs.drivers.commons.DriverException

ssta

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

Description copied from interface: CanOpenInterface

Slave start

Specified by:

ssta in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

ssto

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

Description copied from interface: CanOpenInterface

Slave stop

Specified by:

ssto in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

reset

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

Specified by:

reset in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

quit

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

Specified by:

quit in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

init

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

Specified by:

init in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

start

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

Specified by:

start in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

stop

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

Specified by:

stop in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

isReady

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

Specified by:

isReady in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

setEmergencyMessageListener

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

Specified by:

setEmergencyMessageListener in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

setBootMessageListener

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

Specified by:

setBootMessageListener in interface CanOpenInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException