2009-01-09 1.2.0

org.eclipse.soda.dk.base.device.service
Interface BaseDeviceService

All Superinterfaces:
ControlService, DeviceService
All Known Implementing Classes:
BaseDevice

public interface BaseDeviceService
extends DeviceService

Base Device. The device service interface defines the service to be registered for the BaseDevice device.

The following measurements are supported:

Status
Configuration
Capabilities

The list of exported services:

Since:
1.0
Version:
1.2.0
See Also:
BaseDeviceService, DeviceService

Field Summary
static java.lang.String[] ALL_COMMANDS
          Comprehensive list of all the command identifiers.
static java.lang.String[] ALL_MEASUREMENTS
          Comprehensive list of all the measurement identifiers.
static java.lang.String[] ALL_SIGNALS
          Comprehensive list of all the signal identifiers.
static java.lang.String BaseDevice
          Define the BaseDevice key.
static java.lang.String Capabilities
          Defines the Capabilities measurement.
static java.lang.String CAPABILITIES_ERROR_EXTERNAL_KEY
          Defines the Capabilities measurement.
static java.lang.String CAPABILITIES_EXTERNAL_KEY
          Defines the Capabilities measurement.
static java.lang.String CAPABILITIES_GET_EXTERNAL_KEY
          Defines the Capabilities measurement.
static java.lang.String CAPABILITIES_READ_EXTERNAL_KEY
          Defines the Capabilities measurement.
static java.lang.String CAPABILITIES_WRITE_EXTERNAL_KEY
          Defines the Capabilities measurement.
static java.lang.String Configuration
          Defines the Configuration measurement.
static java.lang.String CONFIGURATION_ERROR_EXTERNAL_KEY
          Defines the Configuration measurement.
static java.lang.String CONFIGURATION_EXTERNAL_KEY
          Defines the Configuration measurement.
static java.lang.String CONFIGURATION_GET_EXTERNAL_KEY
          Defines the Configuration measurement.
static java.lang.String CONFIGURATION_READ_EXTERNAL_KEY
          Defines the Configuration measurement.
static java.lang.String CONFIGURATION_WRITE_EXTERNAL_KEY
          Defines the Configuration measurement.
static java.lang.String SERVICE_DESCRIPTION
          Description of the test.
static java.lang.String SERVICE_NAME
          Define the OSGi service name.
static java.lang.String Status
          Defines the Status measurement.
static java.lang.String STATUS_ERROR_EXTERNAL_KEY
          Defines the Status measurement.
static java.lang.String STATUS_EXTERNAL_KEY
          Defines the Status measurement.
static java.lang.String STATUS_GET_EXTERNAL_KEY
          Defines the Status measurement.
static java.lang.String STATUS_READ_EXTERNAL_KEY
          Defines the Status measurement.
static java.lang.String STATUS_WRITE_EXTERNAL_KEY
          Defines the Status measurement.
 
Fields inherited from interface org.eclipse.soda.dk.device.service.DeviceService
ACTIVE, ALIVE, AUTOSTART, BLOCKPROCESSING, BROADCAST_COMMAND_COUNT_DATA_KEY, BROADCAST_MEASUREMENT_COUNT_DATA_KEY, BROADCAST_SIGNAL_COUNT_DATA_KEY, CHANNEL_CHANGED_EXTERNAL_KEY, CHANNEL_EXTERNAL_ID_DATA_KEY, CHANNEL_ID_DATA_KEY, ChannelChanged, Channels, CHANNELS_EXTERNAL_KEY, CHANNELS_GET_EXTERNAL_KEY, CHANNELS_READ_EXTERNAL_KEY, CHANNELS_WRITE_EXTERNAL_KEY, CLOSE_CHANNEL_EXTERNAL_KEY, CloseChannel, CONFIGURATION_DATA_KEY, CONNECTED, CREATED, DEAD, ERROR_EXTERNAL_KEY, EVENPROCESSING, EXECUTE_EXTERNAL_KEY, GET_EXTERNAL_KEY, INITIALIZEMEASUREMENTS, KEYS_DATA_KEY, Metrics, METRICS_EXTERNAL_KEY, METRICS_GET_EXTERNAL_KEY, NULL, OPEN_CHANNEL_EXTERNAL_KEY, OpenChannel, READ_EXTERNAL_KEY, RECEIVED_KEY_DATA_KEY, SET_EXTERNAL_KEY, SOURCE_DATA_KEY, STARTED, STATE_DATA_KEY, STATE_OLD_DATA_KEY, TIMESTAMP_DATA_KEY, TRIGGER_EXTERNAL_KEY, VALUE_DATA_KEY, VALUE_OLD_DATA_KEY, WRITE_EXTERNAL_KEY
 
Method Summary
 
Methods inherited from interface org.eclipse.soda.dk.device.service.DeviceService
addDeviceListener, closeChannel, elements, exit, get, getChannel, getCommand, getConfigurationInformation, getMeasurement, getNotificationService, getSignal, getState, getTransport, isStarted, openChannel, put, remove, removeDeviceListener, send, send, send, send, setConfigurationInformation, setNotificationService, setTransport, start, stop
 
Methods inherited from interface org.eclipse.soda.dk.device.service.ControlService
getKey
 

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME
Define the OSGi service name.

Since:
1.0
See Also:
Constant Field Values

BaseDevice

static final java.lang.String BaseDevice
Define the BaseDevice key.

Since:
1.0
See Also:
Constant Field Values

Status

static final java.lang.String Status
Defines the Status measurement.

Since:
1.0
See Also:
Constant Field Values

STATUS_EXTERNAL_KEY

static final java.lang.String STATUS_EXTERNAL_KEY
Defines the Status measurement.

Since:
1.0
See Also:
The value of this field is "prefix/Device/Status", Constant Field Values

STATUS_GET_EXTERNAL_KEY

static final java.lang.String STATUS_GET_EXTERNAL_KEY
Defines the Status measurement.

Since:
1.0
See Also:
The value of this field is "prefix/Device/Status/get", Constant Field Values

STATUS_READ_EXTERNAL_KEY

static final java.lang.String STATUS_READ_EXTERNAL_KEY
Defines the Status measurement.

Since:
1.0
See Also:
Status, NotificationService.GET_EXTERNAL_KEY, The value of this field is "prefix/Device/Status/read", Constant Field Values

STATUS_WRITE_EXTERNAL_KEY

static final java.lang.String STATUS_WRITE_EXTERNAL_KEY
Defines the Status measurement.

Since:
1.0
See Also:
Status, NotificationService.GET_EXTERNAL_KEY, NotificationService.READ_EXTERNAL_KEY, The value of this field is "prefix/Device/Status/write", Constant Field Values

STATUS_ERROR_EXTERNAL_KEY

static final java.lang.String STATUS_ERROR_EXTERNAL_KEY
Defines the Status measurement.

Since:
1.0
See Also:
Status, NotificationService.GET_EXTERNAL_KEY, NotificationService.READ_EXTERNAL_KEY, NotificationService.WRITE_EXTERNAL_KEY, The value of this field is "prefix/Device/Status/error", Constant Field Values

Configuration

static final java.lang.String Configuration
Defines the Configuration measurement.

Since:
1.0
See Also:
Constant Field Values

CONFIGURATION_EXTERNAL_KEY

static final java.lang.String CONFIGURATION_EXTERNAL_KEY
Defines the Configuration measurement.

Since:
1.0
See Also:
The value of this field is "prefix/Device/Configuration", Constant Field Values

CONFIGURATION_GET_EXTERNAL_KEY

static final java.lang.String CONFIGURATION_GET_EXTERNAL_KEY
Defines the Configuration measurement.

Since:
1.0
See Also:
The value of this field is "prefix/Device/Configuration/get", Constant Field Values

CONFIGURATION_READ_EXTERNAL_KEY

static final java.lang.String CONFIGURATION_READ_EXTERNAL_KEY
Defines the Configuration measurement.

Since:
1.0
See Also:
Configuration, NotificationService.GET_EXTERNAL_KEY, The value of this field is "prefix/Device/Configuration/read", Constant Field Values

CONFIGURATION_WRITE_EXTERNAL_KEY

static final java.lang.String CONFIGURATION_WRITE_EXTERNAL_KEY
Defines the Configuration measurement.

Since:
1.0
See Also:
Configuration, NotificationService.GET_EXTERNAL_KEY, NotificationService.READ_EXTERNAL_KEY, The value of this field is "prefix/Device/Configuration/write", Constant Field Values

CONFIGURATION_ERROR_EXTERNAL_KEY

static final java.lang.String CONFIGURATION_ERROR_EXTERNAL_KEY
Defines the Configuration measurement.

Since:
1.0
See Also:
Configuration, NotificationService.GET_EXTERNAL_KEY, NotificationService.READ_EXTERNAL_KEY, NotificationService.WRITE_EXTERNAL_KEY, The value of this field is "prefix/Device/Configuration/error", Constant Field Values

Capabilities

static final java.lang.String Capabilities
Defines the Capabilities measurement.

Since:
1.0
See Also:
Constant Field Values

CAPABILITIES_EXTERNAL_KEY

static final java.lang.String CAPABILITIES_EXTERNAL_KEY
Defines the Capabilities measurement.

Since:
1.0
See Also:
The value of this field is "prefix/Device/Capabilities", Constant Field Values

CAPABILITIES_GET_EXTERNAL_KEY

static final java.lang.String CAPABILITIES_GET_EXTERNAL_KEY
Defines the Capabilities measurement.

Since:
1.0
See Also:
The value of this field is "prefix/Device/Capabilities/get", Constant Field Values

CAPABILITIES_READ_EXTERNAL_KEY

static final java.lang.String CAPABILITIES_READ_EXTERNAL_KEY
Defines the Capabilities measurement.

Since:
1.0
See Also:
Capabilities, NotificationService.GET_EXTERNAL_KEY, The value of this field is "prefix/Device/Capabilities/read", Constant Field Values

CAPABILITIES_WRITE_EXTERNAL_KEY

static final java.lang.String CAPABILITIES_WRITE_EXTERNAL_KEY
Defines the Capabilities measurement.

Since:
1.0
See Also:
Capabilities, NotificationService.GET_EXTERNAL_KEY, NotificationService.READ_EXTERNAL_KEY, The value of this field is "prefix/Device/Capabilities/write", Constant Field Values

CAPABILITIES_ERROR_EXTERNAL_KEY

static final java.lang.String CAPABILITIES_ERROR_EXTERNAL_KEY
Defines the Capabilities measurement.

Since:
1.0
See Also:
Capabilities, NotificationService.GET_EXTERNAL_KEY, NotificationService.READ_EXTERNAL_KEY, NotificationService.WRITE_EXTERNAL_KEY, The value of this field is "prefix/Device/Capabilities/error", Constant Field Values

ALL_COMMANDS

static final java.lang.String[] ALL_COMMANDS
Comprehensive list of all the command identifiers.

Since:
1.0

ALL_SIGNALS

static final java.lang.String[] ALL_SIGNALS
Comprehensive list of all the signal identifiers.

Since:
1.0

ALL_MEASUREMENTS

static final java.lang.String[] ALL_MEASUREMENTS
Comprehensive list of all the measurement identifiers.

Since:
1.0

SERVICE_DESCRIPTION

static final java.lang.String SERVICE_DESCRIPTION
Description of the test.

Since:
1.1
See Also:
Constant Field Values

2009-01-09 1.2.0

Copyright (c) 2009 IBM. See license in Legal section.