Ultra1wire3 HSPI User's Guide
Total Page:16
File Type:pdf, Size:1020Kb
Ultra1Wire3 HSPI User’s Guide A HomeSeer HS3 plug-in to monitor temperature and humidity in your home Copyright © 2015 [email protected] Revised 09/27/2015 This document contains proprietary and copyrighted information and may not be copied, reproduced, translated, or reduced to any electronic medium without prior consent, in writing, from [email protected]. Table of Contents Introduction .................................................................................................................................................. 4 Intended Audience .................................................................................................................................... 4 Ultra1Wire3 HSPI Overview .......................................................................................................................... 4 How It Works ............................................................................................................................................ 4 Features .................................................................................................................................................... 4 Example Usage .......................................................................................................................................... 5 Requirements ............................................................................................................................................ 5 Ultra1Wire3 HSPI Installation ....................................................................................................................... 5 Downloading and Installing the HomeSeer Plug-in .................................................................................. 5 Ultra1Wire3 HSPI Configuration ................................................................................................................... 5 Web Page Layout ...................................................................................................................................... 5 Ultra1Wire3 HSPI Setup ............................................................................................................................ 6 Initial Setup Checklist ................................................................................................................................ 6 Midon Design TEMP08 .......................................................................................................................... 7 EDS HA7E ............................................................................................................................................... 7 EDS HA7Net ........................................................................................................................................... 7 EDS OWServer ....................................................................................................................................... 7 MeshNet Controller .............................................................................................................................. 7 Ultra1Wire3 HSPI Options......................................................................................................................... 8 Ultra1Wire3 HSPI Devices ......................................................................................................................... 9 Manually Adding a New 1-Wire Adapter .............................................................................................. 9 Modifying a 1-Wire Adapter ................................................................................................................. 9 Deleting a 1-Wire Adapter .................................................................................................................... 9 Adding 1-Wire Environmental Sensors ....................................................................................................... 10 HA7E, HA7Net, OW-Server, MeshNet Controller Host Adapters ........................................................... 10 TEMP08 Host Adapter ............................................................................................................................. 10 Adding Other 1-Wire Devices to the TEMP08......................................................................................... 10 Modifying a 1-Wire Environmental Sensors ............................................................................................... 10 Deleting a 1-Wire Environmental Sensors .................................................................................................. 11 2 Ultra1Wire3 HSPI Charting.......................................................................................................................... 11 Ultra1Wire3 HSPI Triggers .......................................................................................................................... 12 Device Value Trigger ............................................................................................................................... 12 Ultra1Wire3 HSPI Trigger Actions ............................................................................................................... 12 Ultra1Wire3 HSPI Trigger Conditions .......................................................................................................... 13 1-Wire Network Description ....................................................................................................................... 13 Linear 1-Wire Network Topology ............................................................................................................ 13 Example 1-Wire Linear Network ......................................................................................................... 14 Star 1-Wire Network Topology ............................................................................................................... 14 Example 1-Wire Star Network ............................................................................................................ 15 Supported 1-Wire Host Adapters ........................................................................................................... 15 Supported 1-Wire Devices ...................................................................................................................... 16 Temperature Sensors .......................................................................................................................... 16 Temperature/Humidity Sensors ......................................................................................................... 16 Counters .............................................................................................................................................. 16 Switches/Light Sensors ....................................................................................................................... 16 Embedded Data Systems Environmental Sensors .............................................................................. 16 Embedded Data Systems Wireless Environmental Sensors................................................................ 16 Ultra1Wire3 HSPI API Reference................................................................................................................. 17 3 Introduction Ultra1Wire3 is the next generation HomeSeer plug-in that makes tracking temperature and humidity in your home easy. By using the Embedded Data Systems Intelligent 1-Wire Interface Adapters and/or the Midon Design TEMP08 Serial One Wire Interface, this plug-in automatically creates and maintains a HomeSeer device for each 1-Wire environmental sensor detected. In addition, the temperature, humidity, barometric pressure and counter values for each 1-Wire sensor are inserted into an underlying database for graphing purposes. Intended Audience This document is intended for the HomeSeer user that has chosen to install and configure the Ultra1Wire3 HomeSeer Plug-in. Ultra1Wire3 HSPI Overview How It Works The plug-in connects to any of the supported 1-Wire Host Adapters and obtains a list of supported 1-wire devices. When using the HA7Net or OW-Server 1-Wire host adapters, the plug-in checks the value of each connected digital environmental sensor then updates the HomeSeer device and inserts temperature, humidity, barometric pressure and counter readings into the database. When using the HA7E 1-Wire host adapter, the plug-in checks the value of each connected digital environmental temperature sensor then updates the HomeSeer device and inserts temperature readings into the database. When using the TEMP08 host adapter, the plug-in reads the output of all connected devices then updates the HomeSeer device and inserts temperature, humidity, barometric pressure and counter readings into the database. Features Multiple threading allows 1-Wire readings to take place without disrupting the performance of HomeSeer. Automatically discovers and builds HomeSeer devices for each supported 1-Wire environmental sensor. Logs all temperature, humidity, counter and barometric pressure readings to an underlying database. Temperature, humidity, counter and barometric pressure charts are created using AMCharts http://www.amcharts.com/. Ability to trigger HomeSeer3 events based on 1-Wire device sensor readings. 4 Error Try/Catch logic to ensure plug-in doesn't fail with an unhandled exception. Example Usage Use Ultra1Wire3 to generate an e-mail notification