com.fivecolibs.devices

Class FCOCIPI2CSubDevice

java.lang.Object

com.fivecolibs.devices.FCOCDevice

com.fivecolibs.devices.FCOCIPI2CSubDevice

All Implemented Interfaces:

java.lang.Runnable

public class FCOCIPI2CSubDevice
extends FCOCDevice

Standard FiveCo's I2C devices connected through IP device class

Version:

1.2

Author:

agardiol

Field Summary

Fields inherited from class com.fivecolibs.devices.FCOCDevice

m_aInterfacesInfo

Constructor Summary

Constructors

Constructor and Description
FCOCIPI2CSubDevice(int nNumberOfRegisters, byte cI2CAddress) Create a FiveCo device based on legacy TCP communication protocol with access through I2C bus
FCOCIPI2CSubDevice(int nNumberOfRegisters, byte cI2CAddress, int nBufferSize, long lThreadSleep) Create a FiveCo device based on legacy TCP communication protocol with access through I2C bus

Method Summary

Modifier and Type	Method and Description
FCOCDevice	addSubDevice(java.lang.String szSubDevName, int nAddress, int nNumberOfRegisters, int nInterface)
void	delete() Ask device object to stop its communication thread.
void	fireDataEvent(FCOCRegisterBase Register, java.lang.Object data, FCOEDataEventType eState, java.lang.Object CallbackParameter) Call this function to fire a Data Event.
byte	getAddress()
int	getInterface()
com.fivecolibs.devices.FCOCDevice.CQueueElement[]	getRequestQueue(boolean isAutoreadRegAdded) Return the elements of the ReadQueue in an array.
static java.lang.String	getStringAddress(int nAddress) Return a string of the address in parameter in this format : "0x55 (85)"
void	removeSubDevice(java.lang.String szSubDevName)
void	run() Main communication thread loop (threadLoop() in dot net lib)

Methods inherited from class com.fivecolibs.devices.FCOCDevice

addDeviceListener, addRegister, addRegister, askGetInterfaceInfo, call, getBufferSize, getDeviceListeners, getLastValueRead, getLastValueWritten, getRegisterAddress, getThisInterfaceInfo, getThreadLoopTime, getValue, getValue, receivedGetInterfacesInfo, removeDeviceListener, removeRegister, setAutoreadState, setAutoreadSupended, setBufferSize, setDebugLogEnabled, setInterfaceComSupendedState, setMaxParentBufferSize, setThreadLoopTime, setValue, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

FCOCIPI2CSubDevice

public FCOCIPI2CSubDevice(int nNumberOfRegisters,
                          byte cI2CAddress)

Create a FiveCo device based on legacy TCP communication protocol with access through I2C bus

Parameters:

nNumberOfRegisters - Max number of registers of this device

cI2CAddress - I2C address of the I2C sub device

FCOCIPI2CSubDevice

public FCOCIPI2CSubDevice(int nNumberOfRegisters,
                          byte cI2CAddress,
                          int nBufferSize,
                          long lThreadSleep)

Create a FiveCo device based on legacy TCP communication protocol with access through I2C bus

Parameters:

nNumberOfRegisters - Max number of registers of this device

cI2CAddress - I2C address of the I2C sub device

nBufferSize - Size of buffer for FiveCo packets (default is 180 bytes)

lThreadSleep - Sleep time in milliseconds (not used)

Method Detail

addSubDevice

public FCOCDevice addSubDevice(java.lang.String szSubDevName,
                               int nAddress,
                               int nNumberOfRegisters,
                               int nInterface)
                        throws java.io.IOException

Specified by:

addSubDevice in class FCOCDevice

Parameters:

szSubDevName - Name of the sub device to add

nAddress - New sub device address

nNumberOfRegisters - Maximum registers count of the sub device

nInterface - Interface number of the sub device

Returns:

Sub device object

Throws:

java.io.IOException - Exception thrown if a parameter is invalid

removeSubDevice

public void removeSubDevice(java.lang.String szSubDevName)

Specified by:

removeSubDevice in class FCOCDevice

Parameters:

szSubDevName - Name of the sub device to remove

delete

public void delete()

Description copied from class: FCOCDevice

Ask device object to stop its communication thread.

Specified by:

delete in class FCOCDevice

getRequestQueue

public com.fivecolibs.devices.FCOCDevice.CQueueElement[] getRequestQueue(boolean isAutoreadRegAdded)

Return the elements of the ReadQueue in an array. And clear the read queue.

Parameters:

isAutoreadRegAdded - Do autoread registers have to be added in array ?

Returns:

elements of the ReadQueue in an FCOCDevice.CQueueElement array

fireDataEvent

public void fireDataEvent(FCOCRegisterBase Register,
                          java.lang.Object data,
                          FCOEDataEventType eState,
                          java.lang.Object CallbackParameter)

Call this function to fire a Data Event.

Parameters:

Register - The FCOCRegisterBase associated with the event.

data - The data of the FCOCRegisterBase

eState - The FCOEDataEventType of the event.

CallbackParameter - The parameter to pass to the event.

getStringAddress

public static java.lang.String getStringAddress(int nAddress)

Return a string of the address in parameter in this format : "0x55 (85)"

Parameters:

nAddress - The address to return in string.

Returns:

A string of the address in parameter in this format : "0x55 (85)"

getAddress

public byte getAddress()

Returns:

Device I2C address

getInterface

public int getInterface()

Specified by:

getInterface in class FCOCDevice

Returns:

Device interface number

run

public void run()

Description copied from class: FCOCDevice

Main communication thread loop (threadLoop() in dot net lib)

Specified by:

run in interface java.lang.Runnable

Specified by:

run in class FCOCDevice