fr.liglab.adele.icasa.device.power

Interface PowerSwitch

All Superinterfaces:

GenericDevice

All Known Subinterfaces:

PowerSwitchmeter

All Known Implementing Classes:

ZigbeePowerSwitch

public interface PowerSwitch
extends GenericDevice

Service definition for a simple powerswitch device

Author:

gunalp

Field Summary

Fields

Modifier and Type	Field and Description
static String	POWER_SWITCH_CURRENT_STATUS Service Property indicating the current Status of the power switch This property is mandatory Type of values : java.lang.Boolean Description : value is expressed in boolean so it is true or false.

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	getStatus() Return the current status of the powerswitch returns 'true' if switch is on, 'false' if switch is off
boolean	switchOff() Switches the power off
boolean	switchOn() Switches the power on

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

POWER_SWITCH_CURRENT_STATUS

static final String POWER_SWITCH_CURRENT_STATUS

Service Property indicating the current Status of the power switch

• This property is mandatory
• Type of values : java.lang.Boolean
• Description : value is expressed in boolean so it is true or false.

See Also:

getStatus(), Constant Field Values

Method Detail

getStatus

boolean getStatus()

Return the current status of the powerswitch returns 'true' if switch is on, 'false' if switch is off

Returns:

the current status of the powerswitch

See Also:

POWER_SWITCH_CURRENT_STATUS

switchOn

boolean switchOn()

Switches the power on

Returns:

'true' if the switch was off and now on, 'false' if the switch was already on

See Also:

switchOff()

switchOff

boolean switchOff()

Switches the power off

Returns:

'true' if the switch was on and now off, 'false' if the switch was already off

See Also:

switchOn()