public abstract class ISYClient extends UDClient
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 |
---|
ISYClient() |
Modifier and Type | Method and Description |
---|---|
boolean |
addFolder(java.lang.String address,
java.lang.String name)
Adds a
UDFolder to ISY |
boolean |
addGroup(java.lang.String address,
java.lang.String name)
Adds a
UDGroup to ISY |
boolean |
addNode(java.lang.String newAddress,
java.lang.String newName,
java.lang.String type,
char flag)
Adds a
UDNode to ISY |
boolean |
cancelNodesDiscovery()
Cancels
UDNode discovery. |
boolean |
changeGroupState(java.lang.String control,
java.lang.String action,
java.lang.String group_address)
Changes the state of a group based on the given parameters
|
boolean |
changeNodeState(java.lang.String control,
java.lang.String action,
java.lang.String node_address)
Changes the state of a node based on the given parameters
|
boolean |
disableInternetAccess()
Disables internet access
|
boolean |
discoverNodes(java.lang.String type)
Starts
UDNode discovery. |
boolean |
enableInternetAccess()
Enables internet access
|
java.lang.Object |
getCurrValue(UDNode node,
java.lang.String control)
Returns the current value of a
UDControl for a UDNode |
java.lang.String |
getLog() |
boolean |
getNumPendingNotifications()
Gets the number of pending notifications (which are queued to be sent out) and
stores it in this object.
|
com.universaldevices.common.datetime.DateTime |
getSystemDateTime()
Returns ISY's system date/time related attributes
|
SystemOptions |
getSystemOptions()
Retrieves the currently set
SystemOptions in
ISY (such things as email addresses, number pending, etc.). |
SystemStatus |
getSystemStatus()
Returns ISY's system status
|
boolean |
isISYReady() |
boolean |
moveNode(java.lang.String id,
java.lang.String gid,
char flag)
Moves a
UDNode to a UDGroup |
abstract void |
onDeviceOffLine()
This method is invoked when an ISY is no longer reachable (for any reason)
|
void |
onDeviceOffLine(UDProxyDevice device)
This method is invoked when an ISY is no longer reachable (for any reason)
|
abstract void |
onDeviceOnLine()
This method is invoked when an ISY is on line (possibly again)
|
void |
onDeviceOnLine(UDProxyDevice device)
This method is invoked when an ISY is on line (possibly again)
|
abstract void |
onDeviceSpecific(java.lang.String action,
java.lang.String node,
XMLElement ei)
Notifies the client of any device specific changes.
|
void |
onDeviceSpecific(UDProxyDevice device,
java.lang.String action,
java.lang.String node,
XMLElement ei)
Notifies the client of any device specific changes.
|
abstract void |
onDiscoveringNodes()
This method is invoked when ISY goes into Linking/Discovery
mode
|
void |
onDiscoveringNodes(UDProxyDevice device)
This method is invoked when ISY goes into Linking/Discovery
mode
|
abstract void |
onFolderRemoved(java.lang.String folderAddress)
This method is called when a Folder is removed
|
void |
onFolderRemoved(UDProxyDevice device,
java.lang.String folderAddress)
This method is called when a Folder is removed
|
abstract void |
onFolderRenamed(UDFolder folder)
This method is called when a Folder is renamed
|
void |
onFolderRenamed(UDProxyDevice device,
UDFolder folder)
This method is called when a Folder is renamed
|
abstract void |
onGroupRemoved(java.lang.String groupAddress)
This method is invoked when a group/scene is permanently removed
from ISY
|
void |
onGroupRemoved(UDProxyDevice device,
java.lang.String groupAddress)
This method is invoked when a group/scene is permanently removed
from ISY
|
abstract void |
onGroupRenamed(UDGroup group)
This method is invoked when a group/scene is renamed
|
void |
onGroupRenamed(UDProxyDevice device,
UDGroup group)
This method is invoked when a group/scene is renamed
|
abstract void |
onInternetAccessDisabled()
This method is invoked when Internet access is disabled
|
abstract void |
onInternetAccessEnabled(java.lang.String url)
This method is invoked when Internet access has been enabled
|
void |
onInternetAccessUpdated(UDProxyDevice device,
java.lang.String url,
java.lang.String action)
This method is called when the state of internet access has
changed
|
abstract void |
onModelChanged(UDControl control,
java.lang.Object value,
UDNode node)
This method is invoked when ISY senses a change in the value of
any
UDControl for any UDNode |
void |
onModelChanged(UDProxyDevice device,
UDControl control,
java.lang.Object value,
UDNode node)
This method is invoked when ISY senses a change in the value of
any
UDControl for any UDNode |
abstract void |
onNetworkRenamed(java.lang.String newName)
This method is invoked when the network has been renamed
|
void |
onNetworkRenamed(UDProxyDevice device,
java.lang.String newName)
This method is invoked when the network has been renamed
|
abstract void |
onNewFolder(UDFolder folder)
This method is called when a new folder is created
|
void |
onNewFolder(UDProxyDevice device,
UDFolder newFolder)
This method is called when a new folder is created
|
abstract void |
onNewGroup(UDGroup new_group)
This method is invoked when a new group/scene has been created in ISY
|
void |
onNewGroup(UDProxyDevice device,
UDGroup new_group)
This method is invoked when a new group/scene has been created in ISY
|
abstract void |
onNewNode(UDNode node)
This method is invoked when a new node (representation of a physical
device) is added to ISY
|
void |
onNewNode(UDProxyDevice device,
UDNode newNode)
This method is invoked when a new node (representation of a physical
device) is added to ISY
|
abstract void |
onNodeDiscoveryStopped()
This method is invoked when ISY is no longer in Linking/
Discovery mode
|
void |
onNodeDiscoveryStopped(UDProxyDevice device)
This method is invoked when ISY is no longer in Linking/
Discovery mode
|
abstract void |
onNodeEnabled(UDNode node,
boolean b)
This method is invoked when a node is enabled or disabled
|
void |
onNodeEnabled(UDProxyDevice device,
UDNode node,
boolean b)
This method is invoked when a node is enabled or disabled
|
abstract void |
onNodeError(UDNode node)
This method is invoked when there's an error communicating with the
node (or, better said, the physical device which is represented by this
node)
|
void |
onNodeError(UDProxyDevice device,
UDNode node)
This method is invoked when there's an error communicating with the
node (or, better said, the physical device which is represented by this
node)
|
abstract void |
onNodeHasPendingDeviceWrites(UDNode node,
boolean hasPending)
This method is called when the node has pending device writes
|
void |
onNodeHasPendingDeviceWrites(UDProxyDevice device,
UDNode node,
boolean hasPending)
This method is called when the node has pending device writes
|
abstract void |
onNodeIsWritingToDevice(UDNode node,
boolean isWriting)
This method is called when the device associated with the node
is being programmed (written to)
|
void |
onNodeIsWritingToDevice(UDProxyDevice device,
UDNode node,
boolean isWriting)
This method is called when the device associated with the node
is being programmed (written to)
|
void |
onNodeMoved(UDProxyDevice device,
UDNode node,
UDGroup group,
char role)
This method is invoked when a node has been moved to a scene/group
|
abstract void |
onNodeMovedAsMaster(UDNode node,
UDGroup group)
This method is invoked when a node has been moved to a scene/group
as a controller/master
|
abstract void |
onNodeMovedAsSlave(UDNode node,
UDGroup group)
This method is invoked when a node has been moved to a scene/group
as a responder/slave
|
abstract void |
onNodeParentChanged(UDNode node,
UDNode newParent)
This method is called when the parent of a node has changed
|
void |
onNodeParentChanged(UDProxyDevice device,
UDNode node,
UDNode newParent)
This method is called when the parent of a node has changed
|
abstract void |
onNodePowerInfoChanged(UDNode node)
This method is called when the power information has changed for a node
|
void |
onNodePowerInfoChanged(UDProxyDevice device,
UDNode node)
This method is called when the power information has changed for a node
|
abstract void |
onNodeRemoved(java.lang.String nodeAddress)
This method is invoked when a
UDNode (and any associated physical
device thereof) has been permanently removed from ISY |
void |
onNodeRemoved(UDProxyDevice device,
java.lang.String nodeAddress)
This method is invoked when a
UDNode (and any associated physical
device thereof) has been permanently removed from ISY |
abstract void |
onNodeRemovedFromGroup(UDNode node,
UDGroup group)
This method is invoked when
UDNode has been removed from
a group/scene (UDGroup |
void |
onNodeRemovedFromGroup(UDProxyDevice device,
UDNode node,
UDGroup group)
This method is invoked when
UDNode has been removed from
a group/scene (UDGroup |
abstract void |
onNodeRenamed(UDNode node)
This method is invoked when a
UDNode has been renamed |
void |
onNodeRenamed(UDProxyDevice device,
UDNode node)
This method is invoked when a
UDNode has been renamed |
abstract void |
onNodeToGroupRoleChanged(UDNode node,
UDGroup group,
char new_role)
Notifies the client that the node's role for a group changed
|
void |
onNodeToGroupRoleChanged(UDProxyDevice device,
UDNode node,
UDGroup group,
char new_role)
Notifies the client that the node's role for a group changed
|
abstract void |
onProgress(java.lang.String action,
XMLElement ei)
Notifies the client of the progress of actions currently being taken.
|
void |
onProgress(UDProxyDevice device,
java.lang.String action,
XMLElement ei)
Notifies the client of the progress of actions currently being taken.
|
abstract void |
onSystemConfigChanged(java.lang.String event,
XMLElement eventInfo)
Notifies the client that system configurations have change
|
void |
onSystemConfigChanged(UDProxyDevice device,
java.lang.String event,
XMLElement eventInfo)
Notifies the client that system configurations have changed
|
abstract void |
onSystemStatus(boolean busy)
This method is invoked when the state of ISY changes
|
void |
onSystemStatus(UDProxyDevice device,
java.lang.String event)
This method is invoked when the state of ISY changes
|
abstract void |
onTriggerStatus(java.lang.String arg1,
XMLElement arg2)
This method is invoked when the trigger status changes
|
void |
onTriggerStatus(UDProxyDevice device,
java.lang.String arg1,
XMLElement arg2)
This method is invoked when the trigger status changes
|
boolean |
queryGroup(java.lang.String address)
Queries a
UDGroup within ISY |
boolean |
queryNode(java.lang.String address)
Queries a
UDNode within ISY |
boolean |
reboot()
Reboots ISY; this method is fully encrypted on the wire for security purposes
|
boolean |
removeeFolder(java.lang.String id)
Permanently removes a
UDFolder from ISY |
boolean |
removeFromGroup(java.lang.String id,
java.lang.String gid)
Removes a
UDNode from a UDGroup |
boolean |
removeGroup(java.lang.String id)
Permanently removes a
UDGroup from ISY |
boolean |
removeNode(java.lang.String address)
Permanently removes a
UDNode from ISY |
boolean |
renameFolder(java.lang.String address,
java.lang.String newName)
Renames a
UDFloder in ISY |
boolean |
renameGroup(java.lang.String address,
java.lang.String newName)
Renames a
UDGroup in ISY |
boolean |
renameNetwork(java.lang.String name)
Renames the network
|
boolean |
renameNode(java.lang.String address,
java.lang.String newName)
Renames a
UDNode in ISY |
boolean |
resetAllNotifications()
Resets any pending notifications which are queued to be sent based
on the configured interval
|
boolean |
resetLog()
Completely resets and removes all the ISY's log entries
|
boolean |
saveSystemDateTime(com.universaldevices.common.datetime.DateTime dt)
Sets ISY's system date/time/latitude/longitude
|
boolean |
saveSystemOptions(SystemOptions conf)
Sets the
SystemOptions in
ISY (such things as email addresses, number pending, etc.). |
boolean |
setParent(java.lang.String node,
int nodeType,
java.lang.String parent,
int parentType)
Sets a parent for a node
|
void |
start(java.lang.String uuid,
java.lang.String url)
Starts the client given the uuid of the device and its
url (protocol, host, and port only: http://1.2.3.4:5).
|
boolean |
updateUserCredentials(java.lang.String userid,
java.lang.String pwd)
Updates the main userid/pwd pair for ISY
|
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(java.lang.String uuid, java.lang.String url) throws java.lang.Exception
This method is especially useful when there are firewall issues which stop the UPnP traffic to reach the system. This method may fail if ISY is using DHCP address
uuid
- - the uuid of ISYurl
- - the protocol://host:port for ISYjava.lang.Exception
- - Bad URLpublic boolean isISYReady()
public java.lang.Object getCurrValue(UDNode node, java.lang.String control)
UDControl
for a UDNode
node
- - the UDNode
for which we seek the current valuecontrol
- - the UDControl
for which we want the current valueUDControl
for a UDNode
public boolean changeGroupState(java.lang.String control, java.lang.String action, java.lang.String group_address)
control
- - the UDControl
being affectedaction
- - the UDAction
applied to the controlgroup_address
- - the address of the UDGroup
public boolean changeNodeState(java.lang.String control, java.lang.String action, java.lang.String node_address)
control
- - the UDControl
being affectedaction
- - the UDAction
applied to the controlnode_address
- - the address of the UDNode
public boolean addNode(java.lang.String newAddress, java.lang.String newName, java.lang.String type, char flag)
UDNode
to ISYpublic boolean removeNode(java.lang.String address)
UDNode
from ISYaddress
- - the address of the UDNode
to be removedUDNode
public boolean renameNode(java.lang.String address, java.lang.String newName)
UDNode
in ISYaddress
- - the address of the UDNode
to be renamednewName
- - the new name for the UDNode
UDNode
public boolean addGroup(java.lang.String address, java.lang.String name)
UDGroup
to ISYaddress
- - the address of the new UDGroup
name
- - the name of the new UDGroup
UDGroup
public boolean addFolder(java.lang.String address, java.lang.String name)
UDFolder
to ISYaddress
- - the address of the new UDFolder
name
- - the name of the new UDFolder
UDFolder
public boolean removeGroup(java.lang.String id)
UDGroup
from ISYid
- - the address of the UDGroup
to be removedUDGroup
public boolean removeeFolder(java.lang.String id)
UDFolder
from ISYid
- - the address of the UDFolder
to be removedUDFolder
public boolean renameGroup(java.lang.String address, java.lang.String newName)
UDGroup
in ISYaddress
- - the address of the UDGroup
to be renamednewName
- - the new name for the UDGroup
UDGroup
public boolean renameFolder(java.lang.String address, java.lang.String newName)
UDFloder
in ISYaddress
- - the address of the UDFolder
to be renamednewName
- - the new name for the UDFolder
UDFolder
public boolean setParent(java.lang.String node, int nodeType, java.lang.String parent, int parentType)
node
- - The address of the node to have parent setnodeType
- - The type of the nodeparent
- - The address of the parentparentType
- - The type of the parentpublic boolean moveNode(java.lang.String id, java.lang.String gid, char flag)
UDNode
to a UDGroup
id
- - the address of the UDNode
to be movedgid
- - the address of the UDGroup
being moved toflag
- - the relationship flag between the node and the group. Possible
values:
Constants.NODE_IS_MASTER: the node plays the master relationship in the group
~Constants.NODE_IS_MASTER: the node plays a slave relationship in the groupUDNode
,
UDGroup
public boolean removeFromGroup(java.lang.String id, java.lang.String gid)
UDNode
from a UDGroup
public boolean renameNetwork(java.lang.String name)
name
- - the new name for the networkpublic boolean queryNode(java.lang.String address)
UDNode
within ISYaddress
- - the address of the UDNode
UDNode
public boolean queryGroup(java.lang.String address)
UDGroup
within ISYaddress
- - the address of the UDGroup
UDGroup
public boolean discoverNodes(java.lang.String type)
UDNode
discovery. In case of Insteon, this means starting
a Linking sessiontype
- - the type of device being added (optional)public boolean cancelNodesDiscovery()
UDNode
discovery. In case of Insteon, this means stopping
the Linking sessionpublic boolean enableInternetAccess()
public boolean disableInternetAccess()
public SystemStatus getSystemStatus()
SystemStatus
retrieved from ISY, null if failedSystemStatus
public boolean saveSystemDateTime(com.universaldevices.common.datetime.DateTime dt)
dt
- - the DateTime object according to which the ISY's system
date/time is setpublic com.universaldevices.common.datetime.DateTime getSystemDateTime()
DateTime
object holding ISY's data/time attributes; null if failedDateTime
public SystemOptions getSystemOptions()
SystemOptions
in
ISY (such things as email addresses, number pending, etc.).SystemOptions
; null if failedSystemOptions
public boolean saveSystemOptions(SystemOptions conf)
SystemOptions
in
ISY (such things as email addresses, number pending, etc.).conf
- - @see SystemOptionsSystemOptions
public boolean resetAllNotifications()
SystemOptions
public boolean getNumPendingNotifications()
UDProxyDevice
.getNumNotifications() method.SystemOptions
,
UDProxyDevice
public java.lang.String getLog()
public boolean resetLog()
public boolean reboot()
public boolean updateUserCredentials(java.lang.String userid, java.lang.String pwd)
userid
- - the useridpwd
- - the passwordpublic abstract void onDiscoveringNodes()
public final void onDiscoveringNodes(UDProxyDevice device)
device
- - the UDProxyDevice
originating this eventpublic abstract void onNodeDiscoveryStopped()
public final void onNodeDiscoveryStopped(UDProxyDevice device)
device
- - the UDProxyDevice
originating this eventpublic abstract void onGroupRemoved(java.lang.String groupAddress)
groupAddress
- - the group's addresspublic final void onGroupRemoved(UDProxyDevice device, java.lang.String groupAddress)
groupAddress
- - the group's addressdevice
- - the UDProxyDevice
UDProxyDevice
public abstract void onGroupRenamed(UDGroup group)
group
- - the UDGroup
UDGroup
public final void onGroupRenamed(UDProxyDevice device, UDGroup group)
group
- - the UDGroup
device
- - the UDProxyDevice
UDGroup
,
UDProxyDevice
public abstract void onModelChanged(UDControl control, java.lang.Object value, UDNode node)
UDControl
for any UDNode
public final void onModelChanged(UDProxyDevice device, UDControl control, java.lang.Object value, UDNode node)
UDControl
for any UDNode
device
- - the UDProxyDevice
initiating the changecontrol
- - the UDControl
's namevalue
- - the UDAction
value for the UDControl
node
- - the UDNode
to which the change appliesUDProxyDevice
,
UDNode
,
UDControl
,
UDAction
public abstract void onNetworkRenamed(java.lang.String newName)
newName
- - the new name for the networkpublic final void onNetworkRenamed(UDProxyDevice device, java.lang.String newName)
newName
- - the new name for the networkdevice
- - the UDProxyDevice
originating this eventpublic abstract void onNewGroup(UDGroup new_group)
new_group
- - the new groupUDGroup
public final void onNewGroup(UDProxyDevice device, UDGroup new_group)
device
- - the UDProxyDevice initiating this eventnew_group
- - the new UDGroupUDGroup
,
UDProxyDevice
public abstract void onNewNode(UDNode node)
node
- - the new nodeUDNode
public final void onNewNode(UDProxyDevice device, UDNode newNode)
device
- - the UDProxyDevice initiating this eventnewNode
- - the new UDNodeUDProxyDevice
,
UDNode
public abstract void onNodeError(UDNode node)
node
- - the UDNode
in errorUDNode
public final void onNodeError(UDProxyDevice device, UDNode node)
device
- - the UDProxyDevice
initiating this eventnode
- - the UDNode
in errorUDProxyDevice
,
UDNode
public abstract void onNodeEnabled(UDNode node, boolean b)
node
- - the UDNode
in errorb
- - whether or not enabledUDProxyDevice
,
UDNode
public void onNodeEnabled(UDProxyDevice device, UDNode node, boolean b)
device
- - the UDProxyDevice
initiating this eventnode
- - the UDNode
in errorb
- - whether or not enabledUDProxyDevice
,
UDNode
public abstract void onNodeMovedAsMaster(UDNode node, UDGroup group)
public abstract void onNodeMovedAsSlave(UDNode node, UDGroup group)
public final void onNodeMoved(UDProxyDevice device, UDNode node, UDGroup group, char role)
device
- - the UDProxyDevice
initiating this eventnode
- - the UDNode
which has just movedgroup
- - the UDGroup
to which the node moved torole
- - whether or not the node has moved as a controller or a responder.
Possible values are UDConstants.NODE_IS_MASTER and ~UDConstants.NODE_IS_MASTERUDProxyDevice
,
UDNode
,
UDGroup
public abstract void onNodeRemoved(java.lang.String nodeAddress)
UDNode
(and any associated physical
device thereof) has been permanently removed from ISYnodeAddress
- - the address of the UDNode
removedUDNode
public final void onNodeRemoved(UDProxyDevice device, java.lang.String nodeAddress)
UDNode
(and any associated physical
device thereof) has been permanently removed from ISYdevice
- - the UDDevice
initiating this eventnodeAddress
- - the address of the UDNode
removedUDNode
public abstract void onNodeRemovedFromGroup(UDNode node, UDGroup group)
UDNode
has been removed from
a group/scene (UDGroup
public final void onNodeRemovedFromGroup(UDProxyDevice device, UDNode node, UDGroup group)
UDNode
has been removed from
a group/scene (UDGroup
device
- - the UDProxyDevice
initiating this eventnode
- - the UDNode
removedgroup
- - the UDGroup
from which the node was removedUDProxyDevice
,
UDNode
,
UDGroup
public abstract void onNodeToGroupRoleChanged(UDNode node, UDGroup group, char new_role)
node
- - the UDNode
whose role changedgroup
- - the UDGroup
whose role to the node changednew_role
- - the new role which the node plays in the group; currently this value
is restricted to Constants.NODE_IS_MASTER
i.e. this node is either
a master/controller of this group or a slave/responderpublic void onNodeToGroupRoleChanged(UDProxyDevice device, UDNode node, UDGroup group, char new_role)
device
- - the UDProxyDevice
originating this eventnode
- - the UDNode
whose role changedgroup
- - the UDGroup
whose role to the node changednew_role
- - the new role which the node plays in the group; currently this value
is restricted to Constants.NODE_IS_MASTER
i.e. this node is either
a master/controller of this group or a slave/responderpublic abstract void onNodeRenamed(UDNode node)
UDNode
has been renamednode
- - the UDNode
which was renamedUDNode
public final void onNodeRenamed(UDProxyDevice device, UDNode node)
UDNode
has been renamednode
- - the UDNode
which was renameddevice
- - the UDProxyDevice
originating this eventUDProxyDevice
,
UDNode
public abstract void onDeviceOffLine()
UDProxyDevice
public final void onDeviceOffLine(UDProxyDevice device)
device
- - the UDProxyDevice
which is no longer on lineUDProxyDevice
public abstract void onDeviceOnLine()
UDProxyDevice
public final void onDeviceOnLine(UDProxyDevice device)
device
- - the UDProxyDevice
which is now on lineUDProxyDevice
public abstract void onInternetAccessEnabled(java.lang.String url)
url
- - the external URL for ISYpublic abstract void onInternetAccessDisabled()
public final void onInternetAccessUpdated(UDProxyDevice device, java.lang.String url, java.lang.String action)
device
- - the UDProxyDevice
initiating this eventurl
- - the external URL for ISYaction
- - whether or not Internet access is enabled or disabled:
IModelChangeListener.UD_INTERNET_ACCESS_DISABLED_ACTION
IModelChangeListener.UD_INTERNET_ACCESS_ENABLED_ACTIONpublic abstract void onSystemStatus(boolean busy)
busy
- - whether or not ISY is busy and that it cannot process
other requests (it may try to queue them if possible)public final void onSystemStatus(UDProxyDevice device, java.lang.String event)
device
- - the UDProxyDevice
initiating this eventevent
- - what type of system status we haveIModelChangeListener
public abstract void onTriggerStatus(java.lang.String arg1, XMLElement arg2)
arg1
- - Please consult WSDKarg2
- - Please consult WSDKpublic void onTriggerStatus(UDProxyDevice device, java.lang.String arg1, XMLElement arg2)
arg1
- - Please consult WSDKarg2
- - Please consult WSDKdevice
- The UDProxyDevice
originating this eventpublic abstract void onProgress(java.lang.String action, XMLElement ei)
action
- The action to perform based on this eventei
- Detailed status informationpublic void onProgress(UDProxyDevice device, java.lang.String action, XMLElement ei)
device
- The UDProxyDevice
originating this eventaction
- The action to perform based on this eventei
- Detailed status informationpublic abstract void onDeviceSpecific(java.lang.String action, java.lang.String node, XMLElement ei)
action
- The action to perform based on this eventnode
- The node to which this action is appliedei
- Detailed status informationpublic void onDeviceSpecific(UDProxyDevice device, java.lang.String action, java.lang.String node, XMLElement ei)
device
- The UDProxyDevice
originating this eventaction
- The action to perform based on this eventei
- Detailed status informationnode
- (if any) to which this action was performedpublic void onSystemConfigChanged(UDProxyDevice device, java.lang.String event, XMLElement eventInfo)
device
- - the UDProxyDevice
originating this eventevent
- - can be any of IModelChangeListener.UD_TIME_CHANGED_ACTION
IModelChangeListener.UD_TIME_CONFIG_CHANGED_ACTION
IModelChangeListener.UD_NTP_SETTINGS_UPDATED_ACTION
IModelChangeListener.UD_NOTIFICATION_SETTINGS_UPDATED_ACTION
IModelChangeListener.UD_NTP_COMM_FAILED_ACTION
eventInfo
- - any additional information sent by ISYpublic abstract void onSystemConfigChanged(java.lang.String event, XMLElement eventInfo)
event
- - can be any of eventInfo
- - the extra event information XMLElement
IModelChangeListener.UD_TIME_CHANGED_ACTION
IModelChangeListener.UD_TIME_CONFIG_CHANGED_ACTION
IModelChangeListener.UD_NTP_SETTINGS_UPDATED_ACTION
IModelChangeListener.UD_NOTIFICATION_SETTINGS_UPDATED_ACTION
IModelChangeListener.UD_NTP_COMM_FAILED_ACTION
public void onFolderRemoved(UDProxyDevice device, java.lang.String folderAddress)
device
- - the UDProxyDevice
originating this eventfolderAddress
- - the address for the folderUDFolder
public abstract void onFolderRemoved(java.lang.String folderAddress)
folderAddress
- - the address for the folderUDFolder
public void onFolderRenamed(UDProxyDevice device, UDFolder folder)
device
- - the UDProxyDevice
originating this eventfolder
- - the UDFolder
which has been renamedUDFolder
,
UDProxyDevice
public abstract void onFolderRenamed(UDFolder folder)
public void onNewFolder(UDProxyDevice device, UDFolder newFolder)
device
- - the UDProxyDevice
originating this eventnewFolder
- - the UDFolder
which has been renamedUDFolder
,
UDProxyDevice
public abstract void onNewFolder(UDFolder folder)
public void onNodeParentChanged(UDProxyDevice device, UDNode node, UDNode newParent)
device
- - the UDProxyDevice
originating this eventnode
- - the UDNode
for which the parent has changednewParent
- - the UDNode
which is the parent for the nodeUDNode
,
UDProxyDevice
public abstract void onNodeParentChanged(UDNode node, UDNode newParent)
public void onNodeHasPendingDeviceWrites(UDProxyDevice device, UDNode node, boolean hasPending)
device
- - the UDProxyDevice
originating this eventnode
- - the UDNode
which has pending device writeshasPending
- - whether or not there's pending device writesUDNode
,
UDProxyDevice
public abstract void onNodeHasPendingDeviceWrites(UDNode node, boolean hasPending)
public void onNodeIsWritingToDevice(UDProxyDevice device, UDNode node, boolean isWriting)
device
- - the UDProxyDevice
originating this eventnode
- - the UDNode
which might be programmedisWriting
- - whether or not the node is being programmedUDNode
,
UDProxyDevice
public abstract void onNodeIsWritingToDevice(UDNode node, boolean isWriting)
public void onNodePowerInfoChanged(UDProxyDevice device, UDNode node)
device
- - the UDProxyDevice
originating this eventnode
- - the UDNode
which might be programmedUDNode
,
UDProxyDevice