Related Manuals for HomeSeer A2Z-Link
Summary of Contents for HomeSeer A2Z-Link
- Page 1 A2Z‐Link User Manual Prepared by: Administrator Date: 5/11/2015 Copyright © HomeSeer Technologies LLC. All Rights Reserved.
- Page 2 The information contained in this document is subject to change without notice. This document contains proprietary information which is protected by copyright. All rights are reserved. No part of this document may be photocopied, reproduced, or translated to another language without the prior written consent of HomeSeer Technologies LLC.
-
Page 3: Table Of Contents
Table of Contents Chapter 1: Welcome Chapter 2: Getting Started System Overview Installation Managing ZWave Chapter 3: ASCII Control Interface Control Status Chapter 4: JSON Control Interface Controlling with JSON Chapter 5: Index ... -
Page 4: Chapter 1: Welcome
Getting Started ASCII Control system, try these alternative Interface resources: Our Website Knowledgebase or contact our team: Email: sales@homeseer.com JSON Control Phone: 603‐471‐2816 Interface Most popular pages Welcome Control Getting Started ASCII Control Interface Status... -
Page 5: Chapter 2: Getting Started
Why HomeSeer? HomeSeer was the first control system company to support Z‐Wave back in 2003. Today, our software is the culmination of more than a decade's worth of Z‐Wave engineering experience. We work very hard to support new Z‐Wave command classes and products, as they are released; this is a primary focus for us. -
Page 6: Installation
Z‐Wave devices. 5. For remote connections, myHomeSeer Remote can also be used. Create an account at http://myhs.homeseer.com. All you need is the license ID and password printed on the bottom of the unit. Once the account is created, you can log into the unit remotely at http://myhs.homeseer.com. - Page 7 4 . Getting Started Controller Management "Actions" Menu Adding A2Z‐Link to Existing Z‐Wave Installations If the site already has an existing Z‐Wave network a decision will need to be made. 1. If the devices were added using a simple handheld controller, or if the devices were added using a controller that will no longer be used, you should consider establishing a new network with the A2Z‐Link.
-
Page 8: Chapter 3: Ascii Control Interface
ASCII Control Interface . 5 Home > ASCII Control Interface ASCII Control Interface Articles in this section Control Status See also Welcome Getting Started JSON Control Interface Home > ASCII Control Interface > Control Control Connection Commands are sent over a TCP connection. The connection may remain open, or it may be opened and closed as needed. The default TCP port is port # 11000. - Page 9 6 . ASCII Control Interface Devices are controllable by setting their value or label. Each device holds a collection of name/value pairs that represent the available control points. Control points can be a single value, such as 0 for Off, or a value range such as 1‐98 for a dim level. In the web interface on the device management page you can click on the name of a device to bring up its properties.
-
Page 10: Status
ASCII Control Interface . 7 Command Format Description Example Returns control information for a given device, all all devices if the reference # is omitted. The return format is: ref,label=value,label=value,... If the device supports a control point that accepts a range of values, such as dimming light, the control For example, a dimming device pair will be returned as: with ref 3755 may have its PREFIX... - Page 11 8 . ASCII Control Interface Returns a comma list of devices. If the ref parameter is omitted, all devices are returned seperated with a "|", else just information for the requested ref number. Format of return is: ref,parent_ref,status,name,location2,location1 Where: Request the status of a light switch with ref ref = unique reference # of this device, will match request if a 3755, the return specific ref is entered in the request.
-
Page 12: Chapter 4: Json Control Interface
All GET requests are terminated with a CRLF. If no JSON data is expected from the request, the return may be either "ok", or "error". This response is for 2 devices, the first is a thermostat temperature, the second is a light switch: "Name":"HomeSeer Devices", A2ZLink... - Page 13 10 . JSON Control Interface "Version":"1.0", "Devices": "ref":3398, "name":"Temperature", "location":"ZWave", "location2":"Node 122", "value":82, "status":"82 F", "device_type_string":"ZWave Temperature" "last_change":"\/Date(1410193983884)\/" "relationship":4, "hide_from_view":false, "associated_devices": 3397 "device_type": "Device_API":16, "Device_API_Description":"Thermostat API" "Device_Type":2, "Device_Type_Description":"Thermostat Temperature", "Device_SubType":1, "Device_SubType_Description":"Temperature" "device_image":"" "ref":3570, "name":"Switch Binary", "location":"ZWave", /JSON? "location2":"Node 124", request=getstatus&ref=##&location1=LOC1&location2=LOC2 "value":255, "status":"On", "device_type_string":"ZWave Switch Binary" "last_change":"\/Date(1410196540597)\/" "relationship":4, "hide_from_view":false, "associated_devices": 3566 "device_type": "Device_API":4, "Device_API_Description":"PlugIn API"...
- Page 14 API's such as thermostat, energy, etc. See the Devices section in the Scripting section in the HomeSeer HS3 user documentation for information about the properties in this section. Returns control information for a device in the system, or all devices.
- Page 15 12 . JSON Control Interface "SingleRangeEntry":true, "ControlButtonType":0, "ControlButtonCustom":"", "CCIndex":1, "Range":null, "Ref":2256, "Label":"On", "ControlType":5, "ControlLocation": "Row":1, "Column":2, "ColumnSpan":0 "ControlLoc_Row":1, "ControlLoc_Column":2, "ControlLoc_ColumnSpan":0, "ControlUse":1, "ControlValue":99, "ControlString":"", "ControlStringList":null, "ControlStringSelected":null, "ControlFlag":false "Do_Update":true, "SingleRangeEntry":true, "ControlButtonType":0, "ControlButtonCustom":"", "CCIndex":2, "Range":null, "Ref":2256, "Label":"Off", "ControlType":5, "ControlLocation": "Row":1, "Column":1, "ColumnSpan":0 "ControlLoc_Row":1, "ControlLoc_Column":1, "ControlLoc_ColumnSpan":0, "ControlUse":2, "ControlValue":0, "ControlString":"", "ControlStringList":null, "ControlStringSelected":null,...
- Page 16 JSON Control Interface . 13 "RangeStatusSuffix":"%" "Ref":2256, "Label":"Dim (value)%", "ControlType":7, "ControlLocation": "Row":2, "Column":1, "ColumnSpan":3 "ControlLoc_Row":2, "ControlLoc_Column":1, "ControlLoc_ColumnSpan":3, "ControlUse":3, "ControlValue":1, "ControlString":"", "ControlStringList":null, "ControlStringSelected":null, "ControlFlag":false "ref":2256, "name":"light", "location":"Office", "location2":"First Floor" Where: L a b e l = The label to display on this control, if its a button, it would be the button label like "On"...
- Page 17 This command will execute the actions of an event. Pass the group /JSON? name and event name. The group and name are not case sensitive. request=runevent&group=GROUPNAME&name=EVENTNAME N o t e : Only available if A2Z-Link is enabled for automation. A2ZLink...
- Page 18 Many hosts can be added and are separated by a comma, IE: host=HomeTroller:Android,iPhone:bill N o t e : Only available if A2Z-Link is enabled for automation. /JSON?request=getlocations Returns all the location names for location 1 and location 2 /JSON?request=getcounter&counter=NAME...