Copyright 2007/2008 Universal Devices, Inc. All Rights Reserved Web Services Flag, Objects, Parameters, Messages, and Bindings for ISY The status of ISY 0 = Initializing: in the process of initializing device(s) 1 = Querying: in the process of querying a device 2 = Discovery: in discovery/linking mode 3 = Busy: it's busy may ignore requests 10 = Ready: idle or low impact activities All possible options for the node type: 1 = node 4 = group/scene All possible options for when a new node is either created or discovered using the underlying protocol 1 = add the node and reset all previous setting if any 2 = unused 3 = add the node, find all the associated nodes, and create all the linkages thereto 4 = add the node, find all the associated nodes, but do not create any linkages Possible flags for when a node is linked or the type of mode for the modem in discovery mode 0x10 (16 decimal) = Controller; The node is going to be a controller for the scene 0x20 (32 decimal) = Responder ; The node is going to be a responder in the scene 0x18 (24 decimal) = Enable Internet Access 0x26 (38 decimal) = Disable Internet Access 0 = All shall be restored from the configuration files in ISY 1 = Does not regenerate groups/scenes - good for testing 0 = The node shall be disabled 1 = The node shall be enabled 0 = The node type is not set 1 = The node type is of type node 2 = The node type is of type group/scene 3 = The node type is of type folder/location 1 = Read only 2 = Basic 3 = Advanced 4 = Admin Default:Basic All possible values for control All possible values for communications with ELK The hierarchy type for the parent The unique address for a node. This address is the one to be used in subsequent calls to ISY to impact a node/group/scene change The user defined name for a device. The address of the parent if any ELK unique identifier for each node/scene/group A bit mask: 0x01 -- Node is initialized (internal) 0x02 -- Node is going to be crawled (internal) 0x04 -- This is a group node 0x08 -- This is the root node for ISY, i.e. My Lighting 0x10 -- Device Communications Error 0x20 -- Brand new node 0x40 -- Node shall be deleted 0x80 -- Node is device root 0x00 -- Node is neither a controller or responder for the enclosing scene. i.e. devices under the My Lighting node 0x10 -- Node is a controller for the enclosing scene 0x20 -- Node is a responder for the enclosing scene The type of device. For INSTEON: device-cat.device-subcat.version.reserved (4 bytes) Whether or not the node is enabled (plugged in). Note: this feature only works on 99 Series The underlying group/scene number associated with this scene. Normally, not used except for programs made for debugging The address and the type (controller vs. responder) of devices participating in a group/scene Signifies a folder. Note that folders do not have ELK-IDs The configuration of all the nodes already set in ISY The name of ISY network. If blank, then it may be construed as the Network node. Describes the characteristics of the ISY hardware/firmware and some info about the underlying protocol Whether or not ISY queries all devices upon reboot Whether or not nodes are queried one at a time Provides pertinent information about how ISY will interact with the UPnP subsystem The UPnP device/service type which is advertised and responded to default is true default is false Applies to ISY as a whole It has no correspomding value on the device side " Whether or not Triggers are activated Whether or not we are using the default SSL certificate which was shipped originally with ISY The remote/extenal/internet URL by which one can access this system Describes the type of ISY for which this is the configuration An ISY feature or service. A list of ISY installed features/services Defines the root Group for ISY. ISY's System Status: NumRemainingOps = an estimate of how many operations are left to complete DelayBetweenOps (in miliseconds) = an estimate of any delay between each operation Note: you may assume 1 second per each operation ISY's DateTime Structure: NTP = time in NTP format TMZOffset = Time zone Offset from GMT (in seconds) DST = Daylight Saving Time (true/false) Lat = Latitude (in degrees) Long = Longitude (in degrees) Sunrise = Sunrise time in NTP format (response only) Sunset = Sunset time in NTP format (response only) MailTo = Comma delimited list of notification recipients CompactEmail = Whether or not to send short notifications PCacthUp = Whether or not programs should catch up upon startup PGracePeriod = The amount of time (in seconds) after which a schedule is still considered met HTMLRole = The role for HTML user NTPHost = NTP host name NTPEnabled = Whether or not NTP checking is enabled NTPInterval = The amount of time (in seconds) between each NTP check ISY's System Options (configuration of how ISY works) MailTo = Comma delimited list of notification recipients CompactEmail = Whether or not to send short notifications QueryOnInit = Whether or not to query all devices at Restart PCacthUp = Whether or not programs should catch up upon startup PGracePeriod = The amount of time (in seconds) after which a schedule is still considered met NTPHost = NTP host name NTPActive = Whether or not ISY has been able to communicate with the NTP host NTPEnabled = Whether or not NTP checking is enabled NTPInterval = The amount of time (in seconds) between each NTP check WaitBusyReading = Whether or not ISY has to wait for "silence" before sending the next packet HTMLRole = The role of the HTML user SMTP Configuration UseDefaultSMTP = Whether or not we should use UDI's default SMTP Server SMTPServer = SMTP Server SMTPPort = SMTP Port SMTPUID = SMTP User ID SMTPPWD = SMTP Password SMTPFrom = SMTP From email address SMTPTimeout = SMTP Timeout to wait for each operation UseTLS = Whether or not we should use TLS Driver error definitions A list of DriverError(s) The possible debug levels that can be chosen Debug structure The structure which represents the profile of responders for a scene OL = on level RR = ramp rate Climate will be added in release 3 The structure which represents the profiles of responders for a scene In the case of X10: 1. User "X10" as the control 2. action may be null 3. use house code and unit code in node. The format is: HouseCodeUnitCode (UnitCode may be null) Optionally, provide the type of node to be discovered Provide the command to be processed in the SecAction tag for example, see ELKActionCodes Provide the security code in the code tag Shall contain the max age in seconds before the next heartbeat is sent Shall contain the specific value per each Control Type Shall contain specific actions relating to Triggers Very much dependent on the underlying protocol (INSTEON, ZWave, etc.) Shall contain the possible Actions for when nodes are updated Shall contain the possible Actions when system configuration is updated Shall contain System Status Shall contain information about the state of Internet Access Shall contain system progress information Shall contain information the state of the security system A programmable alert sent to clients to do as they wish: i.e. beep, change colors, do something else, etc. The EventInfo holds: bPrice = base price cPrice = current price Open Auto Demand/Response Actions. The EventInfo structure holds: bPrice = base price cPrice = current price Electricity meter information. The EventInfo structure holds: total = total utilization in watts watts = instantaneous utilization in watts voltage = instantaneous voltage in Volts current = instantaneous current in Amps active = the actual status of FYP Climate Information The EventInfo structure holds: value = the value, usually, in double unit = the unit of measure for the value An XML structure with specific information for each event type Unique message sequence number incremented with each message for this subscription Subscription ID Returns the current configuration of ISY Returns the configuration of nodes, groups, scenes, and any relationship thereto Adds a scene/group Removes a group (permanently) from configuration Renames a group in configuration Adds a folder Removes a folder (permanently) from configuration Renames a folder in configuration Adds a predefined node for a device with a given address Removes a node (permanently) from configuration Renames a node in configuration Moves a node into a group/scene Removes a Node from a Group Renames the Network name Queries a node, a scene, or even the whole network Changes the way ISY discovers nodes/devices ISY as a controller or ISY as a responder Puts ISY in discovery (linking) mode Optionally, provide the type of device to look for The flag decides the operations (reset, crawl, spider) to be performed after device(s) are discovered Enables/Disables port forwarding to ISY on UPnP enabled routers. This process might take a long time and, as such, one must take caution with TCP connect timeouts Returns the current state of ISY Returns the current state of ISY Returns the current state of ISY Returns the options by which ISY is configured Returns the SMTP Options configured in ISY Sets SMTP Configuration Parameters Sets Notifications Options Sets Program Options Sets NTP Options Adjusts the clock to NTS Reboots the system Changes the userid and password for a user Restores devices from the configuration in ISY Restores a specific device from the configuration in ISY Replaces the modem attached to ISY and reconfigures devices if necessary Replaces the modem attached to ISY and reconfigures devices if necessary Replaces one device with another (swap) Arm/disarm a security system Gets the debug options and current level Gets the debug options and current level Gets the profile attributes for responders. Set the controller element to scene's address and: In case this is an ISY scene, set the node element to "none." In case this is a controller for a scene, set the node element to the controller's address Sets the profile attribute for responders. Set the controller element to scene's address and: In case this is an ISY scene, set the node element to "none" In case this is a controller for a scene, set the node element to the responder's address reportURL: To reuse the socket, use REUSE_SOCKET as the value duration: use infinite Unsubscribe from ISY Whether or not the client still holds a subscription to ISY Sends a test email. This is used to check SMTP settings. Clears the list of recent errors in ISY Gets the list of recent errors in ISY Enables or disables a node Sets a parent for a node UDI Binding binds the concrete Port (UDI Services) to the Abstract Port Type (UDIServices_PortType