Top Description Fields Methods
org.osgi.service.enocean

public Interface EnOceanHost

This interface represents an EnOcean Host, a device that offers EnOcean networking features.
Author
$Id: 5cb1aa6ca0176904c533f012cc59342ecce3f05d $

Field Summary

Modifier and TypeField and Description
public static final Object
HOST_ID

The unique ID for this Host: this matches the CHIP_ID of the EnOcean Gateway Chip it embodies.

public static final int
REPEATER_LEVEL_OFF

repeater level to disable repeating; this is the default.

public static final int
REPEATER_LEVEL_ONE

repeater level to repeat every telegram at most once.

public static final int
REPEATER_LEVEL_TWO

repeater level to repeat every telegram at most twice.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

a String object containing the API version info.
apiVersion()

Returns the chip's API version info (cf. ESP3 command 0x03: CO_RD_VERSION)

public String

Returns:

a String object containing the application version info.
appVersion()

Returns the chip's application version info (cf. ESP3 command 0x03: CO_RD_VERSION)

public int

Returns:

the BASE_ID of the device as defined in EnOcean specification
getBaseID()

Gets the BASE_ID of the chip, if set (cf. ESP3 command 0x08: CO_RD_IDBASE)

public int

Returns:

the associated CHIP_ID of the exported device.
getChipId(String servicePID)

Retrieves the CHIP_ID associated with the given servicePID, if existing on this chip.

public int

Returns:

one of the Repeater Level constants as defined above.
getRepeaterLevel()

Gets the current repeater level of the host (cf. ESP3 command 0x0A: CO_RD_REPEATER)

public void
reset()

Reset the EnOcean Host (cf. ESP3 command 0x02: CO_WR_RESET)

public void
setBaseID(int
to be set.
baseID)

Sets the base ID of the device, may be used up to 10 times (cf. ESP3 command 0x07: CO_WR_IDBASE)

public void
setRepeaterLevel(int
one of the Repeater Level constants as defined above.
level)

Sets the repeater level on the host (cf. ESP3 command 0x09: CO_WR_REPEATER)

Field Detail

HOST_IDback to summary
public static final Object HOST_ID

The unique ID for this Host: this matches the CHIP_ID of the EnOcean Gateway Chip it embodies.

REPEATER_LEVEL_OFFback to summary
public static final int REPEATER_LEVEL_OFF

repeater level to disable repeating; this is the default.

REPEATER_LEVEL_ONEback to summary
public static final int REPEATER_LEVEL_ONE

repeater level to repeat every telegram at most once.

REPEATER_LEVEL_TWOback to summary
public static final int REPEATER_LEVEL_TWO

repeater level to repeat every telegram at most twice.

Method Detail

apiVersionback to summary
public String apiVersion() throws EnOceanException

Returns the chip's API version info (cf. ESP3 command 0x03: CO_RD_VERSION)

Returns:String

a String object containing the API version info.

Exceptions
EnOceanException:
if any problem occurs.
appVersionback to summary
public String appVersion() throws EnOceanException

Returns the chip's application version info (cf. ESP3 command 0x03: CO_RD_VERSION)

Returns:String

a String object containing the application version info.

Exceptions
EnOceanException:
if any problem occurs.
getBaseIDback to summary
public int getBaseID() throws EnOceanException

Gets the BASE_ID of the chip, if set (cf. ESP3 command 0x08: CO_RD_IDBASE)

Returns:int

the BASE_ID of the device as defined in EnOcean specification

Exceptions
EnOceanException:
if any problem occurs.
getChipIdback to summary
public int getChipId(String servicePID) throws EnOceanException

Retrieves the CHIP_ID associated with the given servicePID, if existing on this chip.

Returns:int

the associated CHIP_ID of the exported device.

Exceptions
EnOceanException:
if any problem occurs.
getRepeaterLevelback to summary
public int getRepeaterLevel() throws EnOceanException

Gets the current repeater level of the host (cf. ESP3 command 0x0A: CO_RD_REPEATER)

Returns:int

one of the Repeater Level constants as defined above.

Exceptions
EnOceanException:
if any problem occurs.
resetback to summary
public void reset() throws EnOceanException

Reset the EnOcean Host (cf. ESP3 command 0x02: CO_WR_RESET)

Exceptions
EnOceanException:
if any problem occurs.
setBaseIDback to summary
public void setBaseID(int baseID) throws EnOceanException

Sets the base ID of the device, may be used up to 10 times (cf. ESP3 command 0x07: CO_WR_IDBASE)

Parameters
baseID:int

to be set.

Exceptions
EnOceanException:
if any problem occurs.
setRepeaterLevelback to summary
public void setRepeaterLevel(int level) throws EnOceanException

Sets the repeater level on the host (cf. ESP3 command 0x09: CO_WR_REPEATER)

Parameters
level:int

one of the Repeater Level constants as defined above.

Exceptions
EnOceanException:
if any problem occurs.