|
||||||||||
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
example.MyISYInsteonClient
public class MyISYInsteonClient
This class implements a very simple ISY client which prints out events as they occur in ISY
Field Summary |
---|
Constructor Summary | |
---|---|
MyISYInsteonClient()
Constructor Registers this class as IModelChangeListener |
Method Summary | |
---|---|
void |
cleanUp()
Implement any cleanup Routines necessary here |
void |
onDeviceOffLine()
This method is invoked with the library does not receive announcements from ISY and considers it offline |
void |
onDeviceOnLine()
This method is invoked when a currently known ISY (UDProxyDevice) is back on line |
void |
onDeviceSpecific(java.lang.String arg1,
java.lang.String node,
XMLElement arg2)
Notifies the client of any device specific changes. |
void |
onDiscoveringNodes()
This method is invoked when ISY goes into Linking mode |
void |
onFolderRemoved(java.lang.String folderAddress)
This method is called when a Folder is removed |
void |
onFolderRenamed(UDFolder folder)
This method is called when a Folder is renamed |
void |
onGroupRemoved(java.lang.String groupAddress)
This method is invoked when a group/scene is removed |
void |
onGroupRenamed(UDGroup group)
This method is invoked when a group/scene is renamed |
void |
onInternetAccessDisabled()
This method is invoked when internet access is disabled on ISY |
void |
onInternetAccessEnabled(java.lang.String url)
This method is invoked with internet access is enabled on ISY |
void |
onModelChanged(UDControl control,
java.lang.Object value,
UDNode node)
This method is invoked everytime there's a change in the state of a control for a node (Insteon Device) |
void |
onNetworkRenamed(java.lang.String newName)
This method is invoked when the network is renamed. |
void |
onNewDeviceAnnounced(UDProxyDevice device)
This method is called when a new ISY is announced or discovered on the network. |
void |
onNewFolder(UDFolder folder)
This method is called when a new folder is created |
void |
onNewGroup(UDGroup newGroup)
This method is called when a new group/scene has been created |
void |
onNewNode(UDNode newNode)
This method is called when a new node (Insteon Device) has been added |
void |
onNodeDeviceIdChanged(UDProxyDevice device,
UDNode node)
Notifies the client that the address of the device represented by this node has changed. |
void |
onNodeDevicePropertiesRefreshed(UDProxyDevice device,
UDNode node)
Notifies the client that all the devices properties for a node were refreshed |
void |
onNodeDevicePropertiesRefreshedComplete(UDProxyDevice proxyDevice)
Called after the properties for one or more nodes has been refreshed. |
void |
onNodeDevicePropertyChanged(UDProxyDevice device,
UDNode node,
com.universaldevices.common.properties.UDProperty<?> property)
Notifies the client that a node property has changed |
void |
onNodeDiscoveryStopped()
This method is invoked when ISY is no longer in Linking mode |
void |
onNodeEnabled(UDNode node,
boolean b)
This method is called with a node is enabled or disabled |
void |
onNodeError(UDNode node)
This method is called when an Insteon Device does not correctly communicate with ISY |
void |
onNodeErrorCleared(UDProxyDevice arg0,
UDNode arg1)
Notifies the client that a node (device) in the system no longer has an error (communications or otherwise) |
void |
onNodeHasPendingDeviceWrites(UDNode node,
boolean hasPending)
This method is called when the node has pending device writes |
void |
onNodeIsWritingToDevice(UDNode node,
boolean isWriting)
This method is called when the device associated with the node is being programmed (written to) |
void |
onNodeMovedAsMaster(UDNode node,
UDGroup group)
This method is invoked when a node (Insteon Device) has been moved to a scene as controller/master |
void |
onNodeMovedAsSlave(UDNode node,
UDGroup group)
This method is invoked when a node (Insteon Device) has been moved to a scene as responder/slave |
void |
onNodeParentChanged(UDNode node,
UDNode newParent)
This method is called when the parent of a node has changed |
void |
onNodePowerInfoChanged(UDNode node)
This method is called when the power information has changed for a node |
void |
onNodeRemoved(java.lang.String nodeAddress)
This method is called when a node (Insteon Device) has been permanently removed from ISY |
void |
onNodeRemovedFromGroup(UDNode node,
UDGroup group)
This method is called when a node (Insteon Device) is removed from a scene |
void |
onNodeRenamed(UDNode node)
This method is invoked when a node (Insteon Device) is renamed |
void |
onNodeRevised(UDProxyDevice device,
UDNode node)
Notifies the client of the revision of a node (device) to the system. |
void |
onNodeToGroupRoleChanged(UDNode node,
UDGroup group,
char new_role)
This method is called when a node's role changes in the given group (master/slave role) |
void |
onProgress(java.lang.String arg1,
XMLElement arg2)
Notifies the client of the progress of actions currently being taken. |
void |
onSystemConfigChanged(java.lang.String event,
XMLElement eventInfo)
Notifies the client that system configurations have change |
void |
onSystemStatus(boolean busy)
This method is invoked when the state of the system (whether or not busy) is changed |
void |
onTriggerStatus(java.lang.String arg1,
XMLElement arg2)
This method is invoked when trigger status changes |
Methods inherited from class com.universaldevices.client.UDClient |
---|
addUDErrorListener, addUDModelChangeListener, authenticate, getControls, getDevice, getGroups, getNodes, isStarted, onNewDevice, removeUDErrorListener, removeUDModelChangeListener, setStarted, start, stop |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MyISYInsteonClient()
IModelChangeListener
Method Detail |
---|
public void onNewDeviceAnnounced(UDProxyDevice device)
onNewDeviceAnnounced
in class UDClient
UDClient.getDevice()
,
UDClient.onNewDevice(UDProxyDevice)
public void onDiscoveringNodes()
onDiscoveringNodes
in class ISYClient
public void onNodeDiscoveryStopped()
onNodeDiscoveryStopped
in class ISYClient
public void onGroupRemoved(java.lang.String groupAddress)
onGroupRemoved
in class ISYClient
groupAddress
- - the group's addresspublic void onGroupRenamed(UDGroup group)
onGroupRenamed
in class ISYClient
group
- - the UDGroup
UDGroup
public void onModelChanged(UDControl control, java.lang.Object value, UDNode node)
onModelChanged
in class ISYClient
control
- - the UDControl
's namevalue
- - the UDAction
value for the UDControl
node
- - the UDNode
to which the change appliesUDNode
,
UDControl
,
UDAction
public void onNetworkRenamed(java.lang.String newName)
onNetworkRenamed
in class ISYClient
newName
- - the new name for the networkpublic void onNewGroup(UDGroup newGroup)
onNewGroup
in class ISYClient
newGroup
- - the new UDGroup
UDGroup
public void onNewNode(UDNode newNode)
onNewNode
in class ISYClient
newNode
- - the new UDNode
UDNode
public void onNodeError(UDNode node)
onNodeError
in class ISYClient
node
- - the UDNode
in errorUDNode
public void onNodeEnabled(UDNode node, boolean b)
onNodeEnabled
in class ISYClient
node
- b
- UDProxyDevice
,
UDNode
public void onNodeRemoved(java.lang.String nodeAddress)
onNodeRemoved
in class ISYClient
nodeAddress
- - the address of the UDNode
removedUDNode
public void onNodeRemovedFromGroup(UDNode node, UDGroup group)
onNodeRemovedFromGroup
in class ISYClient
node
- - the UDNode
removedgroup
- - the UDGroup
from which the node was removedUDNode
,
UDGroup
public void onNodeToGroupRoleChanged(UDNode node, UDGroup group, char new_role)
onNodeToGroupRoleChanged
in class ISYClient
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 onNodeRenamed(UDNode node)
onNodeRenamed
in class ISYClient
node
- - the UDNode
which was renamedUDNode
public void onNodeMovedAsMaster(UDNode node, UDGroup group)
onNodeMovedAsMaster
in class ISYClient
node
- - the UDNode
which has just movedgroup
- - the UDGroup
to which the node moved toUDNode
,
UDGroup
public void onNodeMovedAsSlave(UDNode node, UDGroup group)
onNodeMovedAsSlave
in class ISYClient
node
- - the UDNode
which has just movedgroup
- - the UDGroup
to which the node moved toUDNode
,
UDGroup
public void onDeviceOffLine()
onDeviceOffLine
in class ISYClient
UDProxyDevice
public void onDeviceOnLine()
onDeviceOnLine
in class ISYClient
UDProxyDevice
public void onSystemStatus(boolean busy)
onSystemStatus
in class ISYClient
busy
- - whether or not ISY is busypublic void onInternetAccessDisabled()
onInternetAccessDisabled
in class ISYClient
public void onInternetAccessEnabled(java.lang.String url)
onInternetAccessEnabled
in class ISYClient
url
- - the external fully qualified url through which ISY can be accessedpublic void onTriggerStatus(java.lang.String arg1, XMLElement arg2)
onTriggerStatus
in class ISYClient
arg1
- - the statusarg2
- - extra informationpublic void onDeviceSpecific(java.lang.String arg1, java.lang.String node, XMLElement arg2)
ISYClient
onDeviceSpecific
in class ISYClient
arg1
- The action to perform based on this eventarg2
- Detailed status informationpublic void onProgress(java.lang.String arg1, XMLElement arg2)
ISYClient
onProgress
in class ISYClient
arg1
- The action to perform based on this eventarg2
- Detailed status informationpublic void cleanUp()
cleanUp
in class UDClient
public void onSystemConfigChanged(java.lang.String event, XMLElement eventInfo)
ISYClient
onSystemConfigChanged
in class ISYClient
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(java.lang.String folderAddress)
ISYClient
onFolderRemoved
in class ISYClient
folderAddress
- - the address for the folderUDFolder
public void onFolderRenamed(UDFolder folder)
ISYClient
onFolderRenamed
in class ISYClient
folder
- - the UDFolder
which has been renamedUDFolder
public void onNewFolder(UDFolder folder)
ISYClient
onNewFolder
in class ISYClient
folder
- - the UDFolder
which has been renamedUDFolder
public void onNodeHasPendingDeviceWrites(UDNode node, boolean hasPending)
ISYClient
onNodeHasPendingDeviceWrites
in class ISYClient
node
- - the UDNode
which has pending device writeshasPending
- - whether or not there's pending device writesUDNode
public void onNodeIsWritingToDevice(UDNode node, boolean isWriting)
ISYClient
onNodeIsWritingToDevice
in class ISYClient
node
- - the UDNode
which might be programmedisWriting
- - whether or not the node is being programmedUDNode
public void onNodeParentChanged(UDNode node, UDNode newParent)
ISYClient
onNodeParentChanged
in class ISYClient
node
- - the UDNode
for which the parent has changednewParent
- - the UDNode
which is the parent for the nodeUDNode
public void onNodePowerInfoChanged(UDNode node)
ISYClient
onNodePowerInfoChanged
in class ISYClient
node
- - the UDNode
which might be programmedUDNode
public void onNodeDeviceIdChanged(UDProxyDevice device, UDNode node)
IModelChangeListener
device
- - the UDProxyDevice
originating this eventnode
- - the UDNode
public void onNodeDevicePropertiesRefreshed(UDProxyDevice device, UDNode node)
IModelChangeListener
node
- The UDNode
that changedpublic void onNodeDevicePropertiesRefreshedComplete(UDProxyDevice proxyDevice)
IModelChangeListener
public void onNodeDevicePropertyChanged(UDProxyDevice device, UDNode node, com.universaldevices.common.properties.UDProperty<?> property)
IModelChangeListener
node
- The UDNode
that changedproperty
- The property that changed.public void onNodeRevised(UDProxyDevice device, UDNode node)
IModelChangeListener
device
- - the UDProxyDevice
originating this eventnode
- - the new UDNode
which was revisedpublic void onNodeErrorCleared(UDProxyDevice arg0, UDNode arg1)
IModelChangeListener
arg0
- - the UDProxyDevice
originating this eventarg1
- - the UDNode
that was in error
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |