public abstract class ISYInsteonClient extends ISYClient
UD_BATCH_MODE_CHANGED_ACTION, UD_BATTERY_DEVICE_WRITE_MODE_CHANGED_ACTION, UD_CLIENT_HEART_BEAT_EVENT, UD_DEVICE_SPECIFIC_EVENT, UD_DISCOVERING_NODES_ACTION, UD_DISCOVERING_NODES_COMPLETE_ACTION, UD_FOLDER_ADDED_ACTION, UD_FOLDER_REMOVED_ACTION, UD_FOLDER_RENAMED_ACTION, UD_GROUP_ADDED_ACTION, UD_GROUP_REMOVED_ACTION, UD_GROUP_RENAMED_ACTION, UD_INTERNET_ACCESS_DISABLED_ACTION, UD_INTERNET_ACCESS_ENABLED_ACTION, UD_INTERNET_ACCESS_EVENT, UD_INTERNET_ACCESS_FAILED_ACTION, UD_LINKER_EVENT, UD_LINKER_EVENT_CLEAR, UD_LINKER_EVENT_DEVICE_STATUS, UD_NETWORK_RENAMED_ACTION, UD_NODE_ADDED_ACTION, UD_NODE_CHANGE_LINK_ACTION, UD_NODE_CLEAR_ERROR_ACTION, UD_NODE_DEVICE_ID_CHANGED, UD_NODE_DEVICE_PROPERTY_CHANGED, UD_NODE_ENABLED_ACTION, UD_NODE_HAS_PENDING_DEVICE_WRITES_ACTION, UD_NODE_IN_ERROR_ACTION, UD_NODE_MOVED_ACTION, UD_NODE_PARENT_CHANGED_ACTION, UD_NODE_POWER_INFO_CHANGED_ACTION, UD_NODE_REMOVED_ACTION, UD_NODE_REMOVED_FROM_GROUP_ACTION, UD_NODE_RENAMED_ACTION, UD_NODE_REVISED_ACTION, UD_NODE_SUPPORTED_TYPE_INFO_CHANGED, UD_NODE_WRITING_TO_DEVICE_ACTION, UD_NODES_UPDATED_EVENT, UD_NOTIFICATION_SETTINGS_UPDATED_ACTION, UD_NTP_COMM_FAILED_ACTION, UD_NTP_SETTINGS_UPDATED_ACTION, UD_PROGRESS_EVENT_UPDATE, UD_PROGRESS_UPDATED_EVENT, UD_SYS_CONFIG_UPDATED_EVENT, UD_SYSTEM_BUSY_EVENT, UD_SYSTEM_IS_BUSY_ACTION, UD_SYSTEM_IS_IDLE_ACTION, UD_SYSTEM_IS_IN_SAFE_MODE_ACTION, UD_SYSTEM_IS_NOT_BUSY_ACTION, UD_TIME_CHANGED_ACTION, UD_TIME_CONFIG_CHANGED_ACTION, UD_TRIGGER_EVENT_GET_STATUS, UD_TRIGGER_EVENT_INFO_STRING, UD_TRIGGER_EVENT_KEY_CHANGED, UD_TRIGGER_EVENT_LEARN_IR, UD_TRIGGER_EVENT_SCHEDULE, UD_TRIGGER_EVENT_STATUS, UD_TRIGGER_EVENT_VAR_INIT, UD_TRIGGER_EVENT_VAR_STATUS, UD_TRIGGER_UPDATED_EVENT
Constructor and Description |
---|
ISYInsteonClient() |
Modifier and Type | Method and Description |
---|---|
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.
|
addFolder, addGroup, addNode, cancelNodesDiscovery, changeGroupState, changeNodeState, disableInternetAccess, discoverNodes, enableInternetAccess, getCurrValue, getLog, getNumPendingNotifications, getSystemDateTime, getSystemOptions, getSystemStatus, isISYReady, moveNode, onDeviceOffLine, onDeviceOffLine, onDeviceOnLine, onDeviceOnLine, onDeviceSpecific, onDeviceSpecific, onDiscoveringNodes, onDiscoveringNodes, onFolderRemoved, onFolderRemoved, onFolderRenamed, onFolderRenamed, onGroupRemoved, onGroupRemoved, onGroupRenamed, onGroupRenamed, onInternetAccessDisabled, onInternetAccessEnabled, onInternetAccessUpdated, onModelChanged, onModelChanged, onNetworkRenamed, onNetworkRenamed, onNewFolder, onNewFolder, onNewGroup, onNewGroup, onNewNode, onNewNode, onNodeDiscoveryStopped, onNodeDiscoveryStopped, onNodeEnabled, onNodeEnabled, onNodeError, onNodeError, onNodeHasPendingDeviceWrites, onNodeHasPendingDeviceWrites, onNodeIsWritingToDevice, onNodeIsWritingToDevice, onNodeMoved, onNodeMovedAsMaster, onNodeMovedAsSlave, onNodeParentChanged, onNodeParentChanged, onNodePowerInfoChanged, onNodePowerInfoChanged, onNodeRemoved, onNodeRemoved, onNodeRemovedFromGroup, onNodeRemovedFromGroup, onNodeRenamed, onNodeRenamed, onNodeToGroupRoleChanged, onNodeToGroupRoleChanged, onProgress, onProgress, onSystemConfigChanged, onSystemConfigChanged, onSystemStatus, onSystemStatus, onTriggerStatus, onTriggerStatus, queryGroup, queryNode, reboot, removeeFolder, removeFromGroup, removeGroup, removeNode, renameFolder, renameGroup, renameNetwork, renameNode, resetAllNotifications, resetLog, saveSystemDateTime, saveSystemOptions, setParent, start, updateUserCredentials
addUDErrorListener, addUDModelChangeListener, authenticate, cleanUp, getControls, getDevice, getGroups, getNodes, isStarted, onNewDevice, onNewDeviceAnnounced, removeUDErrorListener, removeUDModelChangeListener, setStarted, start, stop
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
onLinkerEvent, onNodeDeviceIdChanged, onNodeDevicePropertiesRefreshed, onNodeDevicePropertiesRefreshedComplete, onNodeDevicePropertyChanged, onNodeErrorCleared, onNodeRevised, onNodeSupportedTypeInfoChanged
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/masternode
- - the node to be movedscene
- - the scene the node is being moved topublic boolean moveNodeToSceneAsSlave(UDNode node, UDGroup scene)
UDNode
to the specified
scene (UDGroup
as a responder/slavenode
- - the node to be movedscene
- - the scene the node is being moved topublic boolean addNewScene(java.lang.String name)
UDGroup
to ISY. This method guarantees
unique address for each created scenename
- - the name for the newly created scenepublic 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 dimpublic boolean brightenDevice(java.lang.String address)
address
- - the address of the UDNode
to brightenpublic 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 setpublic 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 brightenpublic boolean startDeviceManualChangeDown(java.lang.String address)
address
- - the address of the UDNode
to dimpublic boolean stopDeviceManualChange(java.lang.String address)
address
- - the address of the UDNode
to stop manual changepublic boolean turnSceneOn(java.lang.String address)
address
- - the address of the scene (UDGroup
)
to be turned onpublic boolean turnSceneOff(java.lang.String address)
address
- - the address of the device (UDNode
)
to be turned offpublic boolean turnSceneFastOn(java.lang.String address)
address
- - the address of the scene (UDGroup
)
to be turned onpublic boolean turnSceneFastOff(java.lang.String address)
address
- - the address of the device (UDGroup
)
to be turned offpublic boolean dimScene(java.lang.String address)
address
- - the address of the UDGroup
to dimpublic boolean brightenScene(java.lang.String address)
address
- - the address of the UDGroup
to brightenpublic boolean startSceneManualChangeUp(java.lang.String address)
address
- - the address of the UDGroup
to brightenpublic boolean startSceneManualChangeDown(java.lang.String address)
address
- - the address of the UDGroup
to dimpublic boolean stopSceneManualChange(java.lang.String address)
address
- - the address of the UDGroup
to stop manual changepublic 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 attributesHashtable
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 1Hashtable
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 setUDGroup
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 setUDNode
,
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