Top Description Fields Methods
org.osgi.service.enocean

public Interface EnOceanDevice

Imports
java.util.Map
This interface represents a physical device that communicates over the EnOcean protocol.
Author
$Id: 93ab66783daf739ccd92210cd704eaea799ffc10 $

Field Summary

Modifier and TypeField and Description
public static final String
CHIP_ID

Property name for the mandatory CHIP_ID of the device

public static final String
DEVICE_CATEGORY

Property name for the mandatory DEVICE_CATEGORY of the device

public static final String
ENOCEAN_EXPORT

Property name that defines if the device is exported or not.

public static final String
FUNC

Property name for the radiotelegram functional type of the profile associated with this device.

public static final String
MANUFACTURER

Property name for the manufacturer ID that may be specified by some teach-in messages.

public static final String
RORG

Property name for the radiotelegram main type of the profile associated with this device.

public static final String
SECURITY_LEVEL_FORMAT

Property name for the security level mask for this device.

public static final String
TYPE

Property name for the radiotelegram subtype of the profile associated with this device.

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

The EnOcean device chip ID.
getChipId()

public byte[]

Returns:

The current encryption key, or null.
getEncryptionKey()

Returns the current encryption key used by this device.

public int

Returns:

The EnOcean profile FUNC, or -1 if unknown.
getFunc()

public int[]

Returns:

The list of currently learned device's CHIP_IDs.
getLearnedDevices()

Gets the list of devices the device already has learned.

public int

Returns:

The EnOcean manufacturer code, -1 if unknown.
getManufacturer()

public int

Returns:

The current rolling code in use with this device's communications.
getRollingCode()

Get the current rolling code of the device.

public int

Returns:

The EnOcean profile RORG.
getRorg()

public Map<Integer, Integer[]>

Returns:

A list of the available RPCs, in a Map<Integer, Integer[]> form.
getRPCs()

Retrieves the currently available RPCs to this device; those are stored using their manfufacturerId:commandId identifiers.

public int

Returns:

The EnOcean security level format, or 0 as default (no security)
getSecurityLevelFormat()

public int

Returns:

The EnOcean profile TYPE, or -1 if unknown.
getType()

public void
invoke(EnOceanRPC rpc, EnOceanHandler handler)

Sends an RPC to the remote device.

public void
remove()

Removes the device's OSGi service from OSGi service platform.

public void
setEncryptionKey(byte[]
the encryption key to be set.
key)

Sets the encryption key of the device.

public void
setFunc(int
the EEP func of the device;
func)

Manually sets the EEP FUNC of the device.

public void
setLearningMode(boolean
the desired state: true for learning mode, false to disable it.
learnMode)

Switches the device into learning mode.

public void
setRollingCode(int
the rolling code to be set or initiated.
rollingCode)

Sets the rolling code of this device.

public void
setType(int
the EEP type of the device;
type)

Manually sets the EEP TYPE of the device.

Field Detail

CHIP_IDback to summary
public static final String CHIP_ID

Property name for the mandatory CHIP_ID of the device

DEVICE_CATEGORYback to summary
public static final String DEVICE_CATEGORY

Property name for the mandatory DEVICE_CATEGORY of the device

ENOCEAN_EXPORTback to summary
public static final String ENOCEAN_EXPORT

Property name that defines if the device is exported or not. If present, the device is exported.

FUNCback to summary
public static final String FUNC

Property name for the radiotelegram functional type of the profile associated with this device.

MANUFACTURERback to summary
public static final String MANUFACTURER

Property name for the manufacturer ID that may be specified by some teach-in messages.

RORGback to summary
public static final String RORG

Property name for the radiotelegram main type of the profile associated with this device.

SECURITY_LEVEL_FORMATback to summary
public static final String SECURITY_LEVEL_FORMAT

Property name for the security level mask for this device. The format of that mask is specified in EnOcean Security Draft.

TYPEback to summary
public static final String TYPE

Property name for the radiotelegram subtype of the profile associated with this device.

Method Detail

getChipIdback to summary
public int getChipId()
Returns:int

The EnOcean device chip ID.

getEncryptionKeyback to summary
public byte[] getEncryptionKey()

Returns the current encryption key used by this device.

Returns:byte[]

The current encryption key, or null.

getFuncback to summary
public int getFunc()
Returns:int

The EnOcean profile FUNC, or -1 if unknown.

getLearnedDevicesback to summary
public int[] getLearnedDevices()

Gets the list of devices the device already has learned.

Returns:int[]

The list of currently learned device's CHIP_IDs.

getManufacturerback to summary
public int getManufacturer()
Returns:int

The EnOcean manufacturer code, -1 if unknown.

getRollingCodeback to summary
public int getRollingCode()

Get the current rolling code of the device.

Returns:int

The current rolling code in use with this device's communications.

getRorgback to summary
public int getRorg()
Returns:int

The EnOcean profile RORG.

getRPCsback to summary
public Map<Integer, Integer[]> getRPCs()

Retrieves the currently available RPCs to this device; those are stored using their manfufacturerId:commandId identifiers.

Returns:Map<Integer, Integer[]>

A list of the available RPCs, in a Map<Integer, Integer[]> form.

getSecurityLevelFormatback to summary
public int getSecurityLevelFormat()
Returns:int

The EnOcean security level format, or 0 as default (no security)

getTypeback to summary
public int getType()
Returns:int

The EnOcean profile TYPE, or -1 if unknown.

invokeback to summary
public void invoke(EnOceanRPC rpc, EnOceanHandler handler)

Sends an RPC to the remote device.

removeback to summary
public void remove()

Removes the device's OSGi service from OSGi service platform.

setEncryptionKeyback to summary
public void setEncryptionKey(byte[] key)

Sets the encryption key of the device.

Parameters
key:byte[]

the encryption key to be set.

setFuncback to summary
public void setFunc(int func)

Manually sets the EEP FUNC of the device.

Parameters
func:int

the EEP func of the device;

setLearningModeback to summary
public void setLearningMode(boolean learnMode)

Switches the device into learning mode.

Parameters
learnMode:boolean

the desired state: true for learning mode, false to disable it.

setRollingCodeback to summary
public void setRollingCode(int rollingCode)

Sets the rolling code of this device.

Parameters
rollingCode:int

the rolling code to be set or initiated.

setTypeback to summary
public void setType(int type)

Manually sets the EEP TYPE of the device.

Parameters
type:int

the EEP type of the device;