fr.liglab.adele.icasa.device.light

Interface BinaryLight

All Superinterfaces:

GenericDevice

All Known Implementing Classes:

ZigbeeBinaryLight

public interface BinaryLight
extends GenericDevice

Service definition of a simple binary light device.

Author:

Gabriel Pedraza Ferreira

Field Summary

Fields

Modifier and Type	Field and Description
static String	BINARY_LIGHT_MAX_POWER_LEVEL Device property indicating the maximum power level of the binary light.
static String	BINARY_LIGHT_POWER_STATUS Service property indicating whether the binary light is is turned on or off.

Fields inherited from interface fr.liglab.adele.icasa.device.GenericDevice

DEFAULT_HEIGHT, DEFAULT_WIDTH, DEVICE_SERIAL_NUMBER, FAULT_NO, FAULT_PROPERTY_NAME, FAULT_UNKNOWN, FAULT_YES, LOCATION_PROPERTY_NAME, LOCATION_UNKNOWN, STATE_ACTIVATED, STATE_DEACTIVATED, STATE_PROPERTY_NAME, STATE_UNKNOWN

Method Summary

Methods

Modifier and Type	Method and Description
double	getMaxPowerLevel() Return the current power level of this binary light
boolean	getPowerStatus() Return the current power state of this binary light.
boolean	setPowerStatus(boolean state) Change the power status of this binary light.
void	turnOff() Change the power status to false
void	turnOn() Change the power status to true

Methods inherited from interface fr.liglab.adele.icasa.device.GenericDevice

addListener, constainsProperty, enterInZones, getFault, getProperties, getPropertyValue, getSerialNumber, getState, hasPropertyValue, leavingZones, removeListener, removeProperty, setFault, setPropertyValue, setState

Field Detail

BINARY_LIGHT_POWER_STATUS

static final String BINARY_LIGHT_POWER_STATUS

Service property indicating whether the binary light is is turned on or off.

• This property is mandatory
• Type of values : java.lang.Boolean
• Description : value is true when the light is turned on, false otherwise.

See Also:

getPowerStatus(), setPowerStatus(boolean), Constant Field Values

BINARY_LIGHT_MAX_POWER_LEVEL

static final String BINARY_LIGHT_MAX_POWER_LEVEL

Device property indicating the maximum power level of the binary light.

• This property is mandatory
• Type of values : java.lang.Double, is 100 Watts
• Description : value is the wattage of the light. 100 watts for a normal lamp.

See Also:

getMaxPowerLevel(), Constant Field Values

Method Detail

getPowerStatus

boolean getPowerStatus()

Return the current power state of this binary light.

Returns:

the current power state of this binary light.

See Also:

setPowerStatus(boolean), BINARY_LIGHT_POWER_STATUS

setPowerStatus

boolean setPowerStatus(boolean state)

Change the power status of this binary light.

Parameters:

state - the new power state of this binary light.

Returns:

the previous power state of this binary light.

See Also:

getPowerStatus(), BINARY_LIGHT_POWER_STATUS

turnOn

void turnOn()

Change the power status to true

turnOff

void turnOff()

Change the power status to false

getMaxPowerLevel

double getMaxPowerLevel()

Return the current power level of this binary light

Returns:

the power level of this binary light

See Also:

BINARY_LIGHT_MAX_POWER_LEVEL