fr.liglab.adele.icasa.device.sprinkler

Interface Sprinkler

All Superinterfaces:

GenericDevice

public interface Sprinkler
extends GenericDevice

Service definition of a sprinkler device.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SPRINKLER_POWER_STATUS Service property indicating whether the sprinkler 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
boolean	getPowerStatus() Return the current power state of this sprinkler.
boolean	setPowerStatus(boolean state) Change the power status of this sprinkler.
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

SPRINKLER_POWER_STATUS

static final String SPRINKLER_POWER_STATUS

Service property indicating whether the sprinkler is is turned on or off.

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

See Also:

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

Method Detail

getPowerStatus

boolean getPowerStatus()

Return the current power state of this sprinkler.

Returns:

the current power state of this sprinkler.

See Also:

setPowerStatus(boolean), SPRINKLER_POWER_STATUS

setPowerStatus

boolean setPowerStatus(boolean state)

Change the power status of this sprinkler.

Parameters:

state - the new power state of this sprinkler.

Returns:

the previous power state of this sprinkler.

See Also:

getPowerStatus(), SPRINKLER_POWER_STATUS

turnOn

void turnOn()

Change the power status to true

turnOff

void turnOff()

Change the power status to false