public Interface Device

Constant for the value of the Constants#DEVICE_CATEGORY service property. That category is used by all device services.

See Also

Constants#DEVICE_CATEGORY

The service property value contains the device description. It's an optional property. The value type is java.lang.String.

The service property value contains the device driver name. For example, EnOcean, Z-Wave, Bluetooth, etc. It's a mandatory property. The value type is java.lang.String.

The service property value contains the device firmware vendor. It's an optional property. The value type is java.lang.String.

The service property value contains the device firmware version. It's an optional property. The value type is java.lang.String.

The service property value contains the device hardware vendor. It's an optional property. The value type is java.lang.String.

The service property value contains the device hardware version. It's an optional property. The value type is java.lang.String.

The service property value contains the device model. It's an optional property. The value type is java.lang.String.

The service property value contains the device name. It's an optional property. The value type is java.lang.String.

The service property value contains the reference device unique identifiers. It's an optional property. The value type is java.lang.String[]. It can be used to represent different relationships between the devices. For example, the EnOcean controller can have a reference to the USB dongle.

The service property value contains the device serial number. It's an optional property. The value type is java.lang.String.

The service property value contains the device status. It's a mandatory property. The value type is java.lang.Integer. The possible values are:

• STATUS_ONLINE
• STATUS_OFFLINE
• STATUS_REMOVED
• STATUS_PROCESSING
• STATUS_NOT_INITIALIZED
• STATUS_NOT_CONFIGURED

The service property value contains the device status detail. It holds the reason for the current device status. It's an optional property. The value type is java.lang.Integer. There are two value categories:

• positive values - those values contain details related to the current status. Examples: STATUS_DETAIL_CONNECTING and STATUS_DETAIL_INITIALIZING.
• negative values - those values contain errors related to the current status. Examples: STATUS_DETAIL_CONFIGURATION_UNAPPLIED, STATUS_DETAIL_BROKEN and STATUS_DETAIL_COMMUNICATION_ERROR.

The service property value contains the device types like DVD, TV, etc. It's an optional property. The value type is java.lang.String[].

The service property value contains the device unique identifier. It's a mandatory property. The value type is java.lang.String. To simplify the unique identifier generation, the property value must follow the rule:

UID ::= driver-name ':' device-id

UID - device unique identifier

driver-name - the value of the SERVICE_DRIVER service property

device-id - device unique identifier in the scope of the driver

Device status detail indicates that the device is broken. It can be used as a value of SERVICE_STATUS_DETAIL service property. The device status must be STATUS_OFFLINE.

Device status detail indicates that the device communication is problematic. It can be used as a value of SERVICE_STATUS_DETAIL service property. The device status must be STATUS_ONLINE or STATUS_NOT_INITIALIZED.

Device status detail indicates that the device cannot be configured. It can be used as a value of SERVICE_STATUS_DETAIL service property. The device status must be STATUS_NOT_CONFIGURED.

Device status detail indicates that the device configuration is not applied. It can be used as a value of SERVICE_STATUS_DETAIL service property. The device status must be STATUS_NOT_CONFIGURED.

Device status detail indicates that the device is currently connecting to the network. It can be used as a value of SERVICE_STATUS_DETAIL service property. The device status must be STATUS_PROCESSING.

Device status detail indicates that the device doesn't provide enough information and cannot be determined. It can be used as a value of SERVICE_STATUS_DETAIL service property. The device status must be STATUS_NOT_INITIALIZED.

Device status detail indicates that the device is in duty cycle. It can be used as a value of SERVICE_STATUS_DETAIL service property. The device status must be STATUS_OFFLINE.

Device status detail indicates that the device firmware is updating. It can be used as a value of SERVICE_STATUS_DETAIL service property. The device status must be STATUS_PROCESSING.

Device status detail indicates that the device is not accessible and further communication is not possible. It can be used as a value of SERVICE_STATUS_DETAIL service property. The device status must be STATUS_OFFLINE.

Device status detail indicates that the device is currently in process of initialization. It can be used as a value of SERVICE_STATUS_DETAIL service property. The device status must be STATUS_PROCESSING.

Device status detail indicates that the device is leaving the network. It can be used as a value of SERVICE_STATUS_DETAIL service property. The device status must be STATUS_PROCESSING.

Device status indicates that the device is currently not configured. The device can require additional actions to become completely connected to the network. It can be used as a value of SERVICE_STATUS service property.

Device status indicates that the device is currently not initialized. Some protocols don't provide device information right after the device is connected. The device can be initialized later when it's awakened. It can be used as a value of SERVICE_STATUS service property.

Device status indicates that the device is currently not available for operations. It can be used as a value of SERVICE_STATUS service property.

Device status indicates that the device is currently available for operations. The recent communication with the device has been passed through. It can be used as a value of SERVICE_STATUS service property.

Device status indicates that the device is currently busy with an operation. It can be used as a value of SERVICE_STATUS service property.

Device status indicates that the device has been removed from the network. That status must be set as the last device status. After that the device service can be unregistered from the service registry. It can be used as a value of SERVICE_STATUS service property.

Returns the current value of the specified property. The method will return the same value as ServiceReference.getProperty(String) for the service reference of this device.

This method must continue to return property values after the device service has been unregistered.

Parameters

propKey:String

The property key.

Returns:Object

The property value or null if the property key cannot be mapped to a value.

Returns an array with all device service property keys. The method will return the same value as ServiceReference.getPropertyKeys() for the service reference of this device. The result cannot be null.

Returns:String[]

An array with all device service property keys, cannot be null.

Removes this device.

The method must synchronously:

• Remove the device from the device network.
• Set the device status to STATUS_REMOVED.
• Unregister the device service from the OSGi service registry.

Exceptions

DeviceException:

If an operation error is available.

UnsupportedOperationException:

If the operation is not supported over this device.

SecurityException:

If the caller does not have the appropriate DevicePermission(this device, DevicePermission#REMOVE) and the Java Runtime Environment supports permissions.

IllegalStateException:

If this device service object has already been unregistered.