com.tibbo.aggregate.common.device

Class AbstractDeviceDriver

java.lang.Object

org.java.plugin.Plugin

com.tibbo.aggregate.common.plugin.BasePlugin

com.tibbo.aggregate.common.device.AbstractDeviceDriver

All Implemented Interfaces:

DeviceDriver, AggreGatePlugin, java.lang.Comparable<AggreGatePlugin>

Direct Known Subclasses:

DemoDeviceDriver

public abstract class AbstractDeviceDriver
extends BasePlugin
implements DeviceDriver

Field Summary

Fields inherited from class com.tibbo.aggregate.common.plugin.BasePlugin

INDEX_HIGH, INDEX_HIGHER, INDEX_HIGHEST, INDEX_LOW, INDEX_LOWER, INDEX_LOWEST, INDEX_NORMAL, INDEX_VERY_HIGH, INDEX_VERY_LOW

Fields inherited from class org.java.plugin.Plugin

log

Constructor Summary

Constructors

Constructor and Description
AbstractDeviceDriver(java.lang.String description, java.lang.String protocol, TableFormat connectionProperties)
AbstractDeviceDriver(java.lang.String description, TableFormat connectionPropertiesFormat)

Method Summary

Modifier and Type	Method and Description
void	accessSettingUpdated(java.lang.String name) This method is called when any variable belonging to ContextUtils.GROUP_ACCESS variable group is changed.
void	acklowledgeEvent(Event ev, Acknowledgement acknowledgement) Can be used to register an event acknowledgement in a device.
void	configureDeviceAccount(DeviceContext deviceContext, CallerController caller) In contrast to DeviceDriver.setupDeviceContext(DeviceContext), this method is called only once in the end of initial device account creation.
void	connect() This method is called if isConnected() method returned false or DeviceContext.setReconnectionRequired(true) was called by the driver during previous synchronization.
TableFormat	createConnectionPropertiesFormat() Should return device connection properties as a single-record TableFormat.
DiscoveryProvider	createDiscoveryProvider() Should return implementation of a DiscoveryProvider is driver supports device discovery or null otherwise.
java.util.List<DeviceEntityDescriptor>	definitionsToDescriptors(java.util.List<? extends EntityDefinition> definitions, boolean activeByDefault)
void	deviceDestroyed(boolean moving) This method is called when the device is removed.
void	deviceMoved(Context newParent, java.lang.String newName) This method is called when the device is moved.
void	disconnect() This method is called when device account is being deleted, server is being stopped, or DeviceContext.setReconnectionRequired(true) was called by the driver during previous synchronization.
EventDefinition	discoverEvent(java.lang.String name, java.lang.Object helper) Tries to discover device event that was not found during automatic metadata reading.
FunctionDefinition	discoverFunction(java.lang.String name, java.lang.Object helper) Tries to discover device variable that was not found during automatic metadata reading.
VariableDefinition	discoverVariable(java.lang.String name, java.lang.Object helper) Tries to discover device variable that was not found during automatic metadata reading.
DataTable	executeFunction(FunctionDefinition fd, CallerController caller, DataTable parameters) This method should implement the call of the device-side operation (function).
void	finishSynchronization() This method is called in the end of every synchronization.
java.util.Set<java.lang.String>	getAddresses() Returns the list of device addresses.
TableFormat	getConnectionPropertiesFormat()
VariableStatus	getCustomVariableStatus(java.lang.String name) This method allows the driver to report custom variable status to the system core.
DeviceContext	getDeviceContext()
java.lang.String	getPrimaryAddress() This method should return string representation of device address or null if device has no address.
java.lang.String	getProtocol() Returns device protocol description.
java.lang.String	getStatus() Returns current status of device and/or driver or null if detailed status is not available.
java.util.List<Expression>	getStatusExpressions(CallerController aCallerController) Implementations of this method should provide list of expression that will be used to show device status on dynamic maps.
java.util.Date	getVariableModificationTime(java.lang.String name) This method should return timestamp of device setting last modification time as reported by the hardware.
boolean	isConnected() This method should return true driver has successfully established a link with the hardware.
boolean	isUseDeviceSideValuesCache() Should return true if server should cache device-side values and pass them to DeviceDriver.writeVariableValue(VariableDefinition, CallerController, DataTable, DataTable) along with new values.
boolean	isUsesAssets() Should return true if device driver has support for assets.
boolean	isUsesConnections() This method should return true if device uses normal connection model.
java.util.List<DeviceAssetDefinition>	readAssets() This method returns the hierarchical list of assets provided by the device.
void	readBufferedData() This method should handle reading variable values and device events buffered by remote side during a disconnection period.
java.util.List<EventDefinition>	readEventDefinitions(DeviceEntities entities) This method should return definitions of events that may be generated by the device.
java.util.List<EventDefinition>	readEventDefinitions(java.util.List<DeviceAssetDefinition> groups, DeviceEntities entities) This method is similar to the DeviceDriver.readEventDefinitions(DeviceEntities).
java.util.List<DeviceEntityDescriptor>	readEventDescriptors(java.util.List<DeviceAssetDefinition> assets) This method should return a list of potentially available device events.
java.util.List<FunctionDefinition>	readFunctionDefinitions(DeviceEntities entities) This method should return definitions of device operations (functions).
java.util.List<FunctionDefinition>	readFunctionDefinitions(java.util.List<DeviceAssetDefinition> groups, DeviceEntities entities) This method is similar to the DeviceDriver.readFunctionDefinitions(DeviceEntities).
java.util.List<DeviceEntityDescriptor>	readFunctionDescriptors(java.util.List<DeviceAssetDefinition> assets) This method should return a list of potentially available device functions.
java.util.List<VariableDefinition>	readVariableDefinitions(DeviceEntities entities) This method should return definitions of device settings (variables).
java.util.List<VariableDefinition>	readVariableDefinitions(java.util.List<DeviceAssetDefinition> groups, DeviceEntities entities) This method is similar to the DeviceDriver.readVariableDefinitions(DeviceEntities).
java.util.List<DeviceEntityDescriptor>	readVariableDescriptors(java.util.List<DeviceAssetDefinition> assets) This method should return a list of potentially available device variables.
DataTable	readVariableValue(VariableDefinition vd, CallerController caller) Implementation of this method should read value of device setting pointed by the argument, convert it to the form of Data Table and return it.
boolean	runFullSynchronizationOnStartup() Defines whether full synchronization of the device should occur on every server restart.
void	setConnected(boolean connected)
void	setupDeviceContext(DeviceContext deviceContext) This method is called once during creation of the device context (after device creation and on server startup).
boolean	shouldSynchronize(SynchronizationParameters parameters) This method is called once before every synchronization.
void	startSynchronization() Called in the beginning of every synchronization cycle.
void	updateVariableModificationTime(java.lang.String name, java.util.Date value) This method should update device-side modification time of a setting pointed by name argument or do nothing if modification-time-based synchronization is not supported.
void	writeVariableValue(VariableDefinition vd, CallerController caller, DataTable value, DataTable deviceValue) Implementation of this method should write server-side value of device setting into a hardware.

Methods inherited from class com.tibbo.aggregate.common.plugin.BasePlugin

compareTo, createGlobalConfigContext, createGlobalConfigContext, createUserConfigContext, doStart, doStop, getDescription, getGlobalConfigContext, getId, getPluginDirector, getShortId, getSortIndex, getUserConfigContext, globalDeinit, globalInit, globalStart, globalStop, setDescription, setId, setIndex, setPluginDirector, userDeinit, userInit

Methods inherited from class org.java.plugin.Plugin

getDescriptor, getManager, isActive, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tibbo.aggregate.common.device.DeviceDriver

createDeviceContext

Methods inherited from interface com.tibbo.aggregate.common.plugin.AggreGatePlugin

createGlobalConfigContext, createUserConfigContext, getDescription, getGlobalConfigContext, getId, getShortId, getSortIndex, getUserConfigContext, globalDeinit, globalInit, globalStart, globalStop, userDeinit, userInit

Constructor Detail

AbstractDeviceDriver

public AbstractDeviceDriver(java.lang.String description,
                            TableFormat connectionPropertiesFormat)

AbstractDeviceDriver

public AbstractDeviceDriver(java.lang.String description,
                            java.lang.String protocol,
                            TableFormat connectionProperties)

Method Detail

getPrimaryAddress

public java.lang.String getPrimaryAddress()

Description copied from interface: DeviceDriver

This method should return string representation of device address or null if device has no address. The address will be used by device discovery module to find existing devices.

Specified by:

getPrimaryAddress in interface DeviceDriver

Returns:

Device address

getAddresses

public java.util.Set<java.lang.String> getAddresses()

Description copied from interface: DeviceDriver

Returns the list of device addresses. For example, for a network device this list can contain device host name and IPv4/IPv6 addresses of devices' network interfaces.

Specified by:

getAddresses in interface DeviceDriver

Returns:

Set of device addresses

getStatus

public java.lang.String getStatus()

Description copied from interface: DeviceDriver

Returns current status of device and/or driver or null if detailed status is not available.

Specified by:

getStatus in interface DeviceDriver

Returns:

Textual description of device/driver status

getStatusExpressions

public java.util.List<Expression> getStatusExpressions(CallerController aCallerController)

Description copied from interface: DeviceDriver

Implementations of this method should provide list of expression that will be used to show device status on dynamic maps. The expressions may include relative references to variables/functions of device context.

Specified by:

getStatusExpressions in interface DeviceDriver

Returns:

The list of device status expressions

setupDeviceContext

public void setupDeviceContext(DeviceContext deviceContext)
                        throws ContextException

Description copied from interface: DeviceDriver

This method is called once during creation of the device context (after device creation and on server startup). Driver implementation usually override it to add definitions of device communication settings (e.g. IP address and port number) to the device context. Setup of synchronization settings for the whole device and individual settings is also performed at this point.

Variable definitions representing device communication settings should belong to ContextUtils.GROUP_ACCESS variable group.

Specified by:

setupDeviceContext in interface DeviceDriver

Throws:

ContextException

configureDeviceAccount

public void configureDeviceAccount(DeviceContext deviceContext,
                                   CallerController caller)
                            throws ContextException

Description copied from interface: DeviceDriver

In contrast to DeviceDriver.setupDeviceContext(DeviceContext), this method is called only once in the end of initial device account creation. Its implementation can correct necessary default values of device context variables, such as metadata reading mode or device settings caching mode. Overriding this method is not necessary for most drivers.

Specified by:

configureDeviceAccount in interface DeviceDriver

Throws:

ContextException

accessSettingUpdated

public void accessSettingUpdated(java.lang.String name)

Description copied from interface: DeviceDriver

This method is called when any variable belonging to ContextUtils.GROUP_ACCESS variable group is changed. Driver implementations may override it to respond to device communication settings changes by resetting driver internal state.

Note, that in most cases overriding this method is not necessary as driver implementations should re-read device communication settings from device context in the beginning of every synchronization, e.g. from startSynchronization() method.

Specified by:

accessSettingUpdated in interface DeviceDriver

shouldSynchronize

public boolean shouldSynchronize(SynchronizationParameters parameters)
                          throws ContextException

Description copied from interface: DeviceDriver

This method is called once before every synchronization. The synchronization is silently skipped if it returns null. Certain drivers may override this method to skip synchronization if device communication settings were not yet filled in.

Specified by:

shouldSynchronize in interface DeviceDriver

Throws:

ContextException - Should be thrown by the driver to force generating Info event in addition to skipping the synchronization. This Info event contains exception message that is supposed to describe the reason of synchronization skip, e.g. "device address not specified". In order to avoid event flooding, driver should throw an exception only if full synchronization is performed.

startSynchronization

public void startSynchronization()
                          throws DeviceException

Description copied from interface: DeviceDriver

Called in the beginning of every synchronization cycle. Driver implementations may read communication settings from device context at this point.

Specified by:

startSynchronization in interface DeviceDriver

Throws:

DeviceException - If some device communications were performed and error occurred

isUsesConnections

public boolean isUsesConnections()

Description copied from interface: DeviceDriver

This method should return true if device uses normal connection model.

Specified by:

isUsesConnections in interface DeviceDriver

isConnected

public boolean isConnected()

Description copied from interface: DeviceDriver

This method should return true driver has successfully established a link with the hardware.

Specified by:

isConnected in interface DeviceDriver

connect

public void connect()
             throws DeviceException

Description copied from interface: DeviceDriver

This method is called if isConnected() method returned false or DeviceContext.setReconnectionRequired(true) was called by the driver during previous synchronization. It should establish connection with the hardware.

Specified by:

connect in interface DeviceDriver

Throws:

DeviceException - If connection has failed

isUsesAssets

public boolean isUsesAssets()

Description copied from interface: DeviceDriver

Should return true if device driver has support for assets.

Specified by:

isUsesAssets in interface DeviceDriver

readAssets

public java.util.List<DeviceAssetDefinition> readAssets()
                                                 throws ContextException,
                                                        DeviceException,
                                                        DisconnectionException

Description copied from interface: DeviceDriver

This method returns the hierarchical list of assets provided by the device.

Specified by:

readAssets in interface DeviceDriver

Throws:

ContextException - If some server-side error occurred

DeviceException - If device assets reading failed (e.g. hardware error occurred)

DisconnectionException - If device connection was interrupted during metadata reading

readVariableDescriptors

public java.util.List<DeviceEntityDescriptor> readVariableDescriptors(java.util.List<DeviceAssetDefinition> assets)
                                                               throws ContextException,
                                                                      DeviceException,
                                                                      DisconnectionException

Description copied from interface: DeviceDriver

This method should return a list of potentially available device variables.

Specified by:

readVariableDescriptors in interface DeviceDriver

Throws:

ContextException - If some server-side error occurred

DeviceException - If device assets reading failed (e.g. hardware error occurred)

DisconnectionException - If device connection was interrupted during metadata reading

readFunctionDescriptors

public java.util.List<DeviceEntityDescriptor> readFunctionDescriptors(java.util.List<DeviceAssetDefinition> assets)
                                                               throws ContextException,
                                                                      DeviceException,
                                                                      DisconnectionException

Description copied from interface: DeviceDriver

This method should return a list of potentially available device functions.

Specified by:

readFunctionDescriptors in interface DeviceDriver

Throws:

ContextException - If some server-side error occurred

DeviceException - If device assets reading failed (e.g. hardware error occurred)

DisconnectionException - If device connection was interrupted during metadata reading

readEventDescriptors

public java.util.List<DeviceEntityDescriptor> readEventDescriptors(java.util.List<DeviceAssetDefinition> assets)
                                                            throws ContextException,
                                                                   DeviceException,
                                                                   DisconnectionException

Description copied from interface: DeviceDriver

This method should return a list of potentially available device events.

Specified by:

readEventDescriptors in interface DeviceDriver

Throws:

ContextException - If some server-side error occurred

DeviceException - If device assets reading failed (e.g. hardware error occurred)

DisconnectionException - If device connection was interrupted during metadata reading

isUseDeviceSideValuesCache

public boolean isUseDeviceSideValuesCache()

Description copied from interface: DeviceDriver

Should return true if server should cache device-side values and pass them to DeviceDriver.writeVariableValue(VariableDefinition, CallerController, DataTable, DataTable) along with new values.

Specified by:

isUseDeviceSideValuesCache in interface DeviceDriver

readVariableDefinitions

public java.util.List<VariableDefinition> readVariableDefinitions(DeviceEntities entities)
                                                           throws ContextException,
                                                                  DeviceException,
                                                                  DisconnectionException

Description copied from interface: DeviceDriver

This method should return definitions of device settings (variables). Its implementations may read device metadata or construct the definitions based on server-side device configuration.

The method is called only if DeviceDriver.isUsesAssets() method returns false.

Specified by:

readVariableDefinitions in interface DeviceDriver

Parameters:

entities - Interface allowing to check what variables are active and those definitions should be returned by this method.

Throws:

ContextException - If some server-side error occurred

DeviceException - If device metadata reading failed (e.g. hardware error occurred)

DisconnectionException - If device connection was interrupted during metadata reading

readVariableDefinitions

public java.util.List<VariableDefinition> readVariableDefinitions(java.util.List<DeviceAssetDefinition> groups,
                                                                  DeviceEntities entities)
                                                           throws ContextException,
                                                                  DeviceException,
                                                                  DisconnectionException

Description copied from interface: DeviceDriver

This method is similar to the DeviceDriver.readVariableDefinitions(DeviceEntities). If should return only definitions of variables that belong to enabled assets and their children.

The method is called only if DeviceDriver.isUsesAssets() returns true.

Specified by:

readVariableDefinitions in interface DeviceDriver

entities - Interface allowing to check what variables are active and those definitions should be returned by this method.

Throws:

ContextException - If some server-side error occurred

DeviceException - If device metadata reading failed (e.g. hardware error occurred)

DisconnectionException - If device connection was interrupted during metadata reading

readFunctionDefinitions

public java.util.List<FunctionDefinition> readFunctionDefinitions(DeviceEntities entities)
                                                           throws ContextException,
                                                                  DeviceException,
                                                                  DisconnectionException

Description copied from interface: DeviceDriver

This method should return definitions of device operations (functions). Its implementations may read device metadata or construct the definitions based on server-side device configuration.

The method is called only if DeviceDriver.isUsesAssets() method returns false.

Specified by:

readFunctionDefinitions in interface DeviceDriver

Parameters:

entities - Interface allowing to check what functions are active and those definitions should be returned by this method.

Throws:

ContextException - If some server-side error occurred

DeviceException - If device metadata reading failed (e.g. hardware error occurred)

DisconnectionException - If device connection was interrupted during metadata reading

readFunctionDefinitions

public java.util.List<FunctionDefinition> readFunctionDefinitions(java.util.List<DeviceAssetDefinition> groups,
                                                                  DeviceEntities entities)
                                                           throws ContextException,
                                                                  DeviceException,
                                                                  DisconnectionException

Description copied from interface: DeviceDriver

This method is similar to the DeviceDriver.readFunctionDefinitions(DeviceEntities). If should return only definitions of functions that belong to enabled assets and their children.

The method is called only if DeviceDriver.isUsesAssets() returns true.

Specified by:

readFunctionDefinitions in interface DeviceDriver

entities - Interface allowing to check what functions are active and those definitions should be returned by this method.

Throws:

ContextException - If some server-side error occurred

DeviceException - If device metadata reading failed (e.g. hardware error occurred)

DisconnectionException - If device connection was interrupted during metadata reading

readEventDefinitions

public java.util.List<EventDefinition> readEventDefinitions(DeviceEntities entities)
                                                     throws ContextException,
                                                            DeviceException,
                                                            DisconnectionException

Description copied from interface: DeviceDriver

This method should return definitions of events that may be generated by the device. Its implementations may read device metadata or construct the definitions based on server-side device configuration.

Note, that instances of these events may be generated by the driver asynchronously at any time after at least one device synchronization has finished. This is performed by calling DeviceContext.fireEvent().

The method is called only if DeviceDriver.isUsesAssets() method returns false.

Specified by:

readEventDefinitions in interface DeviceDriver

Parameters:

entities - Interface allowing to check what events are active and those definitions should be returned by this method.

Throws:

ContextException - If some server-side error occurred

DeviceException - If device metadata reading failed (e.g. hardware error occurred)

DisconnectionException - If device connection was interrupted during metadata reading

readEventDefinitions

public java.util.List<EventDefinition> readEventDefinitions(java.util.List<DeviceAssetDefinition> groups,
                                                            DeviceEntities entities)
                                                     throws ContextException,
                                                            DeviceException,
                                                            DisconnectionException

Description copied from interface: DeviceDriver

This method is similar to the DeviceDriver.readEventDefinitions(DeviceEntities). If should return only definitions of events that belong to enabled assets and their children.

The method is called only if DeviceDriver.isUsesAssets() returns true.

Specified by:

readEventDefinitions in interface DeviceDriver

entities - Interface allowing to check what events are active and those definitions should be returned by this method.

Throws:

ContextException - If some server-side error occurred

DeviceException - If device metadata reading failed (e.g. hardware error occurred)

DisconnectionException - If device connection was interrupted during metadata reading

readVariableValue

public DataTable readVariableValue(VariableDefinition vd,
                                   CallerController caller)
                            throws ContextException,
                                   DeviceException,
                                   DisconnectionException

Description copied from interface: DeviceDriver

Implementation of this method should read value of device setting pointed by the argument, convert it to the form of Data Table and return it.

Specified by:

readVariableValue in interface DeviceDriver

Throws:

ContextException - If conversion of device value to the Data Table has occurred

DeviceException - If reading of device setting has failed (e.g. hardware error occurred)

DisconnectionException - If device connection was lost during operation

writeVariableValue

public void writeVariableValue(VariableDefinition vd,
                               CallerController caller,
                               DataTable value,
                               DataTable deviceValue)
                        throws ContextException,
                               DeviceException,
                               DisconnectionException

Description copied from interface: DeviceDriver

Implementation of this method should write server-side value of device setting into a hardware. This method will be called only if device setting definition is writable (e.g server-side changes are allowed.

Specified by:

writeVariableValue in interface DeviceDriver

deviceValue - Previous value of setting received from device by calling DeviceDriver.readVariableValue(VariableDefinition, CallerController). Will be NULL if server was restarted since previous read operation or DeviceDriver.isUseDeviceSideValuesCache() returns false;

Throws:

ContextException - If conversion of the Data Table to a device value has occurred

DeviceException - If writing of device setting has failed (e.g. hardware error occurred)

DisconnectionException - If device connection was lost during operation

executeFunction

public DataTable executeFunction(FunctionDefinition fd,
                                 CallerController caller,
                                 DataTable parameters)
                          throws ContextException,
                                 DeviceException,
                                 DisconnectionException

Description copied from interface: DeviceDriver

This method should implement the call of the device-side operation (function). It should decode parameters Data Table to a device native format, pass this input to the device and call requested operation. Opeartion output should be encoded in the form of Data Table and returned by this method

Specified by:

executeFunction in interface DeviceDriver

Throws:

ContextException - If server-side error occurred (e.g. conversion of input/output between Data Tables and device native format)

DeviceException - If device-side error occurred

DisconnectionException - If device connection was lost during operation

getVariableModificationTime

public java.util.Date getVariableModificationTime(java.lang.String name)
                                           throws DeviceException,
                                                  DisconnectionException

Description copied from interface: DeviceDriver

This method should return timestamp of device setting last modification time as reported by the hardware. If modification-time-based synchronization is not supported, the method should return null.

Specified by:

getVariableModificationTime in interface DeviceDriver

Throws:

DeviceException - If device-side error occurred

DisconnectionException - If device connection was lost during operation

updateVariableModificationTime

public void updateVariableModificationTime(java.lang.String name,
                                           java.util.Date value)
                                    throws DeviceException,
                                           DisconnectionException

Description copied from interface: DeviceDriver

This method should update device-side modification time of a setting pointed by name argument or do nothing if modification-time-based synchronization is not supported.

Specified by:

updateVariableModificationTime in interface DeviceDriver

Throws:

DeviceException - If device-side error occurred

DisconnectionException - If device connection was lost during operation

getCustomVariableStatus

public VariableStatus getCustomVariableStatus(java.lang.String name)
                                       throws DeviceException,
                                              DisconnectionException

Description copied from interface: DeviceDriver

This method allows the driver to report custom variable status to the system core. It should return null if no custom status should be used.

Specified by:

getCustomVariableStatus in interface DeviceDriver

Throws:

DeviceException

DisconnectionException

disconnect

public void disconnect()
                throws DeviceException

Description copied from interface: DeviceDriver

This method is called when device account is being deleted, server is being stopped, or DeviceContext.setReconnectionRequired(true) was called by the driver during previous synchronization. The method should break a link with the hardware and clean up any internal data related to the connection.

Specified by:

disconnect in interface DeviceDriver

Throws:

DeviceException - If proper disconnection has failed

finishSynchronization

public void finishSynchronization()
                           throws DeviceException,
                                  DisconnectionException

Description copied from interface: DeviceDriver

This method is called in the end of every synchronization. Its implementations may perform some cleanup.

Specified by:

finishSynchronization in interface DeviceDriver

Throws:

DeviceException - If some device communications were performed and error occurred

DisconnectionException

setConnected

public void setConnected(boolean connected)

getDeviceContext

public DeviceContext getDeviceContext()

createDiscoveryProvider

public DiscoveryProvider createDiscoveryProvider()

Description copied from interface: DeviceDriver

Should return implementation of a DiscoveryProvider is driver supports device discovery or null otherwise.

Specified by:

createDiscoveryProvider in interface DeviceDriver

getProtocol

public java.lang.String getProtocol()

Description copied from interface: DeviceDriver

Returns device protocol description. This method should return null, if device protocol name matches driver description.

Specified by:

getProtocol in interface DeviceDriver

Returns:

Device protocol description

getConnectionPropertiesFormat

public TableFormat getConnectionPropertiesFormat()

createConnectionPropertiesFormat

public TableFormat createConnectionPropertiesFormat()

Description copied from interface: DeviceDriver

Should return device connection properties as a single-record TableFormat. The format must include at least "name" field.

This method is defined in AtestbstractDeviceDriver and should not be overridden in most cases.

Specified by:

createConnectionPropertiesFormat in interface DeviceDriver

definitionsToDescriptors

public java.util.List<DeviceEntityDescriptor> definitionsToDescriptors(java.util.List<? extends EntityDefinition> definitions,
                                                                       boolean activeByDefault)

discoverVariable

public VariableDefinition discoverVariable(java.lang.String name,
                                           java.lang.Object helper)

Description copied from interface: DeviceDriver

Tries to discover device variable that was not found during automatic metadata reading.

Specified by:

discoverVariable in interface DeviceDriver

Returns:

Variable definition or null if nothing was found

discoverFunction

public FunctionDefinition discoverFunction(java.lang.String name,
                                           java.lang.Object helper)

Description copied from interface: DeviceDriver

Tries to discover device variable that was not found during automatic metadata reading.

Specified by:

discoverFunction in interface DeviceDriver

Returns:

Variable definition or null if nothing was found

discoverEvent

public EventDefinition discoverEvent(java.lang.String name,
                                     java.lang.Object helper)

Description copied from interface: DeviceDriver

Tries to discover device event that was not found during automatic metadata reading.

Specified by:

discoverEvent in interface DeviceDriver

Returns:

Event definition or null if nothing was found

acklowledgeEvent

public void acklowledgeEvent(Event ev,
                             Acknowledgement acknowledgement)
                      throws ContextException,
                             DeviceException

Description copied from interface: DeviceDriver

Can be used to register an event acknowledgement in a device.

Specified by:

acklowledgeEvent in interface DeviceDriver

Throws:

ContextException

DeviceException

runFullSynchronizationOnStartup

public boolean runFullSynchronizationOnStartup()

Description copied from interface: DeviceDriver

Defines whether full synchronization of the device should occur on every server restart. Returns false by default. In this case, full synchronization is only performed if full synchronization period elapsed since the previous full synchronization, in other cases connect-only synchronization takes place.

Specified by:

runFullSynchronizationOnStartup in interface DeviceDriver

deviceDestroyed

public void deviceDestroyed(boolean moving)

Description copied from interface: DeviceDriver

This method is called when the device is removed.

Specified by:

deviceDestroyed in interface DeviceDriver

deviceMoved

public void deviceMoved(Context newParent,
                        java.lang.String newName)
                 throws ContextException

Description copied from interface: DeviceDriver

This method is called when the device is moved.

Specified by:

deviceMoved in interface DeviceDriver

Throws:

ContextException

readBufferedData

public void readBufferedData()
                      throws ContextException,
                             DeviceException,
                             DisconnectionException

Description copied from interface: DeviceDriver

This method should handle reading variable values and device events buffered by remote side during a disconnection period.

Specified by:

readBufferedData in interface DeviceDriver

Throws:

ContextException - If some server-side error occurred

DeviceException - If device assets reading failed (e.g. hardware error occurred)

DisconnectionException - If device connection was interrupted during metadata reading