org.osgi.service.enocean

Interface EnOceanMessage

public interface EnOceanMessage

Holds the necessary methods to interact with an EnOcean message.

Method Summary

Modifier and Type	Method and Description
byte[]	getBytes() Gets the bytes corresponding to the whole message, including the CRC.
int	getDbm() Returns the average RSSI on all the received subtelegrams, including redundant ones.
int	getDestinationId()
int	getFunc()
byte[]	getPayloadBytes() Returns the payload bytes of this message.
int	getRorg()
int	getSecurityLevelFormat() Returns the security level of this message, as specified in the 'Security of EnOcean Radio Networks' draft, section 4.2.1.3.
int	getSenderId()
int	getStatus() Gets the current EnOcean status of the Message.
int	getSubTelNum() Returns the number of subtelegrams (usually 1) this Message carries.
int	getType()

Method Detail

getRorg

int getRorg()

Returns:

the message's RORG

getFunc

int getFunc()

Returns:

the message's FUNC

getType

int getType()

Returns:

the message's TYPE

getSenderId

int getSenderId()

Returns:

the message's Sender ID

getDestinationId

int getDestinationId()

Returns:

the message's destination ID, or -1

getBytes

byte[] getBytes()

Gets the bytes corresponding to the whole message, including the CRC. The generated byte[] array may be sent to an EnOcean gateway and is conform to EnOcean Radio Protocol.

Returns:

The serialized byte list corresponding to the binary message.

getPayloadBytes

byte[] getPayloadBytes()

Returns the payload bytes of this message.

Returns:

corresponding value.

getStatus

int getStatus()

Gets the current EnOcean status of the Message. The 'status' byte is actually a bitfield that mainly holds repeater information, teach-in status, and more or less information depending on the radiotelegram type.

Returns:

the current EnOcean status of this message.

getSubTelNum

int getSubTelNum()

Returns the number of subtelegrams (usually 1) this Message carries.

Returns:

The number of subtelegrams in the case of multiframe messages.

getDbm

int getDbm()

Returns the average RSSI on all the received subtelegrams, including redundant ones.

Returns:

The average RSSI perceived.

getSecurityLevelFormat

int getSecurityLevelFormat()

Returns the security level of this message, as specified in the 'Security of EnOcean Radio Networks' draft, section 4.2.1.3.

Returns:

The security level format.