Top Description Methods
org.osgi.service.enocean

public Interface EnOceanMessage


Holds the necessary methods to interact with an EnOcean message.
Author
$Id: edebb9eb99eb95b718b7e0c3a5685f720613639a $

Method Summary

Modifier and TypeMethod and Description
public byte[]

Returns:

The serialized byte list corresponding to the binary message.
getBytes
()

Gets the bytes corresponding to the whole message, including the CRC.

public int

Returns:

The average RSSI perceived.
getDbm
()

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

public int

Returns:

the message's destination ID, or -1
getDestinationId
()

public int

Returns:

the message's FUNC
getFunc
()

public byte[]

Returns:

corresponding value.
getPayloadBytes
()

Returns the payload bytes of this message.

public int

Returns:

the message's RORG
getRorg
()

public int

Returns:

The security level format.
getSecurityLevelFormat
()

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

public int

Returns:

the message's Sender ID
getSenderId
()

public int

Returns:

the current EnOcean status of this message.
getStatus
()

Gets the current EnOcean status of the Message.

public int

Returns:

The number of subtelegrams in the case of multiframe messages.
getSubTelNum
()

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

public int

Returns:

the message's TYPE
getType
()

Method Detail

getBytesback to summary
public 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:byte[]

The serialized byte list corresponding to the binary message.

getDbmback to summary
public int getDbm()

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

Returns:int

The average RSSI perceived.

getDestinationIdback to summary
public int getDestinationId()
Returns:int

the message's destination ID, or -1

getFuncback to summary
public int getFunc()
Returns:int

the message's FUNC

getPayloadBytesback to summary
public byte[] getPayloadBytes()

Returns the payload bytes of this message.

Returns:byte[]

corresponding value.

getRorgback to summary
public int getRorg()
Returns:int

the message's RORG

getSecurityLevelFormatback to summary
public 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:int

The security level format.

getSenderIdback to summary
public int getSenderId()
Returns:int

the message's Sender ID

getStatusback to summary
public 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:int

the current EnOcean status of this message.

getSubTelNumback to summary
public int getSubTelNum()

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

Returns:int

The number of subtelegrams in the case of multiframe messages.

getTypeback to summary
public int getType()
Returns:int

the message's TYPE