|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.universaldevices.client.UDClient
com.udi.isy.jsdk.ISYClient
com.udi.isy.jsdk.insteon.ISYInsteonClient
public abstract class ISYInsteonClient
This class extends ISYClient to support all Insteon related communications and functionality
Field Summary |
---|
Constructor Summary | |
---|---|
ISYInsteonClient()
|
Method Summary | |
---|---|
boolean |
addNewScene(java.lang.String name)
Adds a new Scene ( UDGroup to ISY. |
boolean |
brightenDevice(java.lang.String address)
Brightens a light device one notch |
boolean |
brightenScene(java.lang.String address)
Brightens all the devices, within the scene, one notch |
boolean |
dimDevice(java.lang.String address)
Dims a light device one notch |
boolean |
dimScene(java.lang.String address)
Dims all the devices, within a scene, one notch |
java.util.Hashtable<java.lang.String,SceneProfileAttributes> |
getDevicesSceneAttributesForAController(java.lang.String scene_address,
java.lang.String controller_address)
Returns a Hashtable of SceneProfileAttributes for a Controller |
java.util.Hashtable<java.lang.String,SceneProfileAttributes> |
getDevicesSceneAttributesForAScene(java.lang.String scene_address)
Returns a Hashtable of SceneProfileAttributes . |
boolean |
isLinking()
|
boolean |
moveNodeToSceneAsMaster(UDNode node,
UDGroup scene)
Moves the specified UDNode to the specified
scene (UDGroup as a controller/master |
boolean |
moveNodeToSceneAsSlave(UDNode node,
UDGroup scene)
Moves the specified UDNode to the specified
scene (UDGroup as a responder/slave |
boolean |
setDeviceOnLevel(java.lang.String address,
int percent)
Sets a light device's on level to the given percentage |
boolean |
setDeviceOnLevelForAScene(java.lang.String scene_address,
java.lang.String node_address,
int on_level_percent)
Sets the onlevel for a given Insteon device within a scene. |
boolean |
setDeviceOnLevelForASceneController(java.lang.String controller_address,
java.lang.String node_address,
int on_level_percent)
Sets the on-level for a given Insteon device within a scene which is controlled by another Insteon controller |
boolean |
setDeviceRampRate(java.lang.String address,
int ramprate)
Sets a light device's ramp-rate to the value |
boolean |
setDeviceRampRateForAScene(java.lang.String scene_address,
java.lang.String node_address,
int ramprate)
Sets the ramp-rate for a given Insteon device within a scene. |
boolean |
setDeviceRampRateForASceneController(java.lang.String controller_address,
java.lang.String node_address,
int ramprate)
Sets the ramp-rate for a given Insteon device within a scene which is controlled by another Insteon controller |
boolean |
setMasterLinkingMode()
Puts the PLM in linking mode as master so, when the StartLinking method is called, PLM will act as a controller and not a responder |
boolean |
setSlaveLinkingMode()
Puts the PLM in linking mode as slave so, when the StartLinking method is called, PLM will act as a responder and not a controller |
void |
start()
Starts the client, looks for an ISY, and when found notifies the client by invoking onNewDeviceAnnounced |
boolean |
startDeviceManualChangeDown(java.lang.String address)
Starts dimming a ligth device till stopManualChange is invoked |
boolean |
startDeviceManualChangeUp(java.lang.String address)
Starts brightening a ligth device till stopManualChange is invoked |
boolean |
startLinking()
Puts the PLM in the linking mode. |
boolean |
startSceneManualChangeDown(java.lang.String address)
Starts dimming all devices, within a scene, till stopManualChange is invoked |
boolean |
startSceneManualChangeUp(java.lang.String address)
Starts brightening all devices, within a scene, till stopManualChange is invoked |
boolean |
stopDeviceManualChange(java.lang.String address)
Stops any previous invocation of startManualChangeUp/Down |
boolean |
stopLinking()
Stops the linking session |
boolean |
stopSceneManualChange(java.lang.String address)
Stops any previous invocation of startManualChangeUp/Down for a scene |
boolean |
turnDeviceFastOff(java.lang.String address)
Turns off the device immediately |
boolean |
turnDeviceFastOn(java.lang.String address)
Turns on the device to 100% immediately |
boolean |
turnDeviceOff(java.lang.String address)
Turns off the device; if this device is a light device, then the device will turn off the stored ramp-rate |
boolean |
turnDeviceOn(java.lang.String address)
Turns on the device; if this device is a light device, then the device will turn on to the stored on-level and at the stored ramp-rate |
boolean |
turnSceneFastOff(java.lang.String address)
Turns off all the devices with in a scene immediately |
boolean |
turnSceneFastOn(java.lang.String address)
Turns on all the devices within the scene to 100% immediately |
boolean |
turnSceneOff(java.lang.String address)
Turns off the scene. |
boolean |
turnSceneOn(java.lang.String address)
Turns on the scene. |
Methods inherited from class com.universaldevices.client.UDClient |
---|
addUDErrorListener, addUDModelChangeListener, authenticate, cleanUp, getControls, getDevice, getGroups, getNodes, isStarted, onNewDevice, onNewDeviceAnnounced, removeUDErrorListener, removeUDModelChangeListener, setStarted, start, stop |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.universaldevices.device.model.IModelChangeListener |
---|
onNodeDeviceIdChanged, onNodeDevicePropertiesRefreshed, onNodeDevicePropertiesRefreshedComplete, onNodeDevicePropertyChanged, onNodeErrorCleared, onNodeRevised |
Constructor Detail |
---|
public ISYInsteonClient()
Method Detail |
---|
public void start()
ISYClient
,
UDProxyDevice
public boolean setMasterLinkingMode()
public boolean setSlaveLinkingMode()
public boolean startLinking()
Note: ISY will revert back to the default linking mode as soon as the first link is made.
public boolean stopLinking()
public boolean isLinking()
public boolean moveNodeToSceneAsMaster(UDNode node, UDGroup scene)
UDNode
to the specified
scene (UDGroup
as a controller/master
node
- - the node to be movedscene
- - the scene the node is being moved to
public boolean moveNodeToSceneAsSlave(UDNode node, UDGroup scene)
UDNode
to the specified
scene (UDGroup
as a responder/slave
node
- - the node to be movedscene
- - the scene the node is being moved to
public boolean addNewScene(java.lang.String name)
UDGroup
to ISY. This method guarantees
unique address for each created scene
name
- - the name for the newly created scene
public boolean turnDeviceOn(java.lang.String address)
address
- - the address of the device (UDNode
)
to be turned onpublic boolean turnDeviceOff(java.lang.String address)
address
- - the address of the device (UDNode
)
to be turned offpublic boolean turnDeviceFastOn(java.lang.String address)
address
- - the address of the device (UDNode
)
to be turned onpublic boolean turnDeviceFastOff(java.lang.String address)
address
- - the address of the device (UDNode
)
to be turned offpublic boolean dimDevice(java.lang.String address)
address
- - the address of the UDNode
to dim
public boolean brightenDevice(java.lang.String address)
address
- - the address of the UDNode
to brighten
public boolean setDeviceOnLevel(java.lang.String address, int percent)
address
- - the address of the UDNode
for which
the on level is being setpercent
- - the percentage to which the light device's on level
should be set
public boolean setDeviceRampRate(java.lang.String address, int ramprate)
address
- - the address of the UDNode
for which
the ramp-rate is being setramprate
- - the value to which the light device's ramp-rate
should be set the possible values of which are between 0 and 31
inclusive. The relationship between these values and the corresponding amount of
time it takes to "ramp", is given in InsteonOps.rampRates
public boolean startDeviceManualChangeUp(java.lang.String address)
address
- - the address of the UDNode
to brighten
public boolean startDeviceManualChangeDown(java.lang.String address)
address
- - the address of the UDNode
to dim
public boolean stopDeviceManualChange(java.lang.String address)
address
- - the address of the UDNode
to stop manual change
public boolean turnSceneOn(java.lang.String address)
address
- - the address of the scene (UDGroup
)
to be turned on
public boolean turnSceneOff(java.lang.String address)
address
- - the address of the device (UDNode
)
to be turned off
public boolean turnSceneFastOn(java.lang.String address)
address
- - the address of the scene (UDGroup
)
to be turned on
public boolean turnSceneFastOff(java.lang.String address)
address
- - the address of the device (UDGroup
)
to be turned off
public boolean dimScene(java.lang.String address)
address
- - the address of the UDGroup
to dim
public boolean brightenScene(java.lang.String address)
address
- - the address of the UDGroup
to brighten
public boolean startSceneManualChangeUp(java.lang.String address)
address
- - the address of the UDGroup
to brighten
public boolean startSceneManualChangeDown(java.lang.String address)
address
- - the address of the UDGroup
to dim
public boolean stopSceneManualChange(java.lang.String address)
address
- - the address of the UDGroup
to stop manual change
public java.util.Hashtable<java.lang.String,SceneProfileAttributes> getDevicesSceneAttributesForAScene(java.lang.String scene_address)
Hashtable
of SceneProfileAttributes
.
i.e the on-level and ramp-rate for all the devices within a scene: UDGroup
.
The result is indexed by the device's address
scene_address
- - the address of the scene for which we are going to get all the devices'
scene attributes
Hashtable
of SceneProfileAttributes
for the
given scene. Otherwise, nullUDNode
,
UDGroup
,
SceneProfileAttributes
public java.util.Hashtable<java.lang.String,SceneProfileAttributes> getDevicesSceneAttributesForAController(java.lang.String scene_address, java.lang.String controller_address)
Hashtable
of SceneProfileAttributes
for a Controller
i.e the on-level and ramp-rate for all the devices within a scene UDGroup
and associated
to a controller/master.
The result is indexed by the device's address
scene_address
- - the address of the scene for which we are going to get all the devices'
scene attributescontroller_address
- - the address of the master/controller Insteon device beloning to the
scene in param 1
Hashtable
of SceneProfileAttributes
for the given sceneUDNode
,
UDGroup
,
SceneProfileAttributes
public boolean setDeviceOnLevelForAScene(java.lang.String scene_address, java.lang.String node_address, int on_level_percent)
scene_address
- - the address of the scene to which the Insteon device belongsnode_address
- - the address of the Insteon device for which we are setting scene attributeson_level_percent
- - the on-level to be set
UDGroup
public boolean setDeviceRampRateForAScene(java.lang.String scene_address, java.lang.String node_address, int ramprate)
scene_address
- - the address of the scene to which the Insteon device belongsnode_address
- - the address of the Insteon device for which we are setting scene attributesramprate
- - the value to which the device's ramp-rate, for the given scene,
should be set the possible values of which are between 0 and 31
inclusive. The relationship between these values and the corresponding amount of
time it takes to "ramp", is given in InsteonOps.rampRates
UDNode
,
UDGroup
public boolean setDeviceOnLevelForASceneController(java.lang.String controller_address, java.lang.String node_address, int on_level_percent)
controller_address
- - the address of the controller to which the Insteon device is linked (slave)node_address
- - the address of the Insteon device for which we are setting scene attributeson_level_percent
- - the on-level to be set
UDNode
,
UDGroup
public boolean setDeviceRampRateForASceneController(java.lang.String controller_address, java.lang.String node_address, int ramprate)
controller_address
- - the address of the controller to which the Insteon device is linked (slave)node_address
- - the address of the Insteon device for which we are setting scene attributesramprate
- - the value to which the device's ramp-rate, for the given controller,
should be set the possible values of which are between 0 and 31
inclusive. The relationship between these values and the corresponding amount of
time it takes to "ramp", is given in InsteonOps.rampRates
UDNode
,
UDGroup
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |