UltraLighting3 HSPI User s Guide A HomeSeer HS3 plug-in used to control your LIFX Wi-Fi enabled, multi-colored LED lights.

Transcription

1 UltraLighting3 HSPI User s Guide A HomeSeer HS3 plug-in used to control your LIFX Wi-Fi enabled, multi-colored LED lights. Copyright 2016 ultrajones@hotmail.com Revised 09/10/2016 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 ultrajones@hotmail.com.

2 Table of Contents Introduction... 4 Intended Audience... 4 UltraLighting3 HSPI Overview... 4 How It Works... 4 Features... 4 Requirements... 4 UltraLighting3 HSPI Installation... 5 Downloading the HomeSeer Plug-in... 5 UltraLighting3 HSPI Configuration... 5 Web Page Layout... 5 Screenshot... 5 Options... 6 LIFX Options... 6 Web Page Access... 6 Application Options... 6 Screenshot... 6 UltraLighting3 HomeSeer Devices... 6 LIFX Device Types... 6 UltraLighting3 State... 7 Screenshot... 8 UltraLighting3 HSPI Triggers... 8 UltraLighting3 HSPI Trigger Actions... 9 UltraLighting3 Set Color... 9 Screenshot... 9 UltraLighting3 Set White Shade... 9 Screenshot... 9 UltraLighting3 Set Power... 9 Screenshot UltraLighting3 Set Brightness

3 Screenshot UltraLighting3 Set Waveform Screenshot UltraLighting3 HSPI Trigger Conditions UltraLighting3 HSPI API Reference

4 Introduction UltraLighting3 is a HomeSeer3 plug-in (HSPI) that allows you to use HomeSeer to set your LIFX LED lights to suit your mood or life style. The UltraLighting3 HSPI uses the LAN protocol which allows the fastest control of your lights. With LIFX there are no cables or hub; all you need is Wi-Fi, your ios/android device and a LIFX Light. Once your lights are configured, the UltraLighting3 HSPI will automatically discover and configure them for use with HomeSeer. Intended Audience This document is intended for the HomeSeer user that has chosen to install and configure the UltraLighting3 HomeSeer Plug-in. UltraLighting3 HSPI Overview How It Works UltraLighting3 HSPI uses the LIFX LAN Protocol to discover and control all your LIFX LED lights connected to your home Wi-Fi network. The plug-in continues to listen for LIFX network packets to detect a change in a lights state. The plug-in will automatically create a HomeSeer device for each LED light allowing direct control of on/off/dim. HomeSeer events allow you to control a single light or a group of lights. Features Create HomeSeer events to control on/off/dim, set colors, whites for one light or a group of lights. Direct control of LIFX lights by interacting with the HomeSeer device or controlling them using HomeSeer event actions. Command retry technology is built into the plug-in which provides for reliable control of your lights. Error Try/Catch logic to ensure plug-in doesn't fail with an unhandled exception. Multiple threading allows UltraLighting3 to manage and control your LIFX lights without disrupting the performance of HomeSeer. Requirements Homeseer 3.0 or greater One or more LIFX Wi-Fi-enabled LED lights available at 4

5 UltraLighting3 HSPI Installation Downloading the HomeSeer Plug-in 1. From your HomeSeer web page, select PLUG-INS > Manage. 2. Click the + icon next to Additional Interfaces to expand the list of available HomSeer3 plug-ins. 3. Click the + icon next to the Lighting & Primary Technology category, then click the checkbox next to the UltraLighting3 (LIFX LED Wi-Fi Bulbs) package to mark the plug-in for installation. 4. Under Pending Updates/Installs, click the Download and Install button. 5. Once the installer finishes, find the UltraLighting3 plug-in under Installed Plug-Ins, then enable it. UltraLighting3 HSPI Configuration Web Page Layout The UltraLighting3 plug-in has 6 web pages that provide access to the available features of the plug-in. Screenshot The available web pages are as follows: 1. Status Displays the plug-in and the Sighthound Video System status. 2. Options Displays and allows you to change the options associated with the plug-in. 5

6 Options All options are set from the Options web page. The following options are supported: LIFX Options Command Timeout Specifies the number of seconds to wait for the LIFX Light to respond to a command before giving up. Attempts Per Command Specifies the number of times you want to try sending a LIFX command before giving up. IP Address The IP address you want to bind the plug-in to. The default is an empty string which allows the plug-in to bind to the default interface. Note: Leave this field blank if you only have one active interface on your HomeSeer system. Web Page Access Authorized User Roles Specify the HomeSeer users authorized to access the UltraLighting3 web page. Application Options Logging Level Select the level of application logging. Note: This option may produce a lot of output and should only be used when debugging. Screenshot UltraLighting3 HomeSeer Devices The UltraLighting3 plug-in automatically creates a HomeSeer device for each LIFX Wi-Fi enabled LED light configured on your network. LIFX Device Types A device is automatically created for each LIFX Wi-Fi enabled LED light connected to your network. The HomeSeer device created allows you to control on/off/brightness. The following device types will be created depending on the LIFX Wi-Fi enabled bulb installed on your home network: 6

7 1. LIFX Original LIFX Color LIFX Color 900 BR30 4. LIFX Color LIFX White 800 (Low Voltage) 6. LIFX White 800 (High Voltage) 7. LIFX White 900 BR30 (Low Voltage) UltraLighting3 State This device allows you to enable or disable the LIFX network packet processing without having to disable the plug-in. 7

8 Screenshot UltraLighting3 HSPI Triggers This plug-in does not have any HomeSeer triggers defined. However, you can still create an event trigger using the HomeSeer device. As an example, you can trigger a HomeSeer event whenever the LIFX WiFi enabled LED light loses connection to your Wi-Fi network or whenever the light is turned on or off. 8

9 UltraLighting3 HSPI Trigger Actions You can create HomeSeer events using any of the supported triggers below. UltraLighting3 Set Color This trigger action allows you to set the color to your LIFX Wi-Fi enabled LED lights. Simply select the lights you want to apply a new color to, then select the color, then select the timespan which to apply the color change. Screenshot UltraLighting3 Set White Shade This trigger action allows you to set the white shade to your LIFX Wi-Fi enabled LED lights. Simply select the lights you want to apply a new shade to, then select the white shade, then select the timespan which to apply the change. Screenshot UltraLighting3 Set Power This trigger action allows you to set the power to your LIFX Wi-Fi enabled LED lights. Simply select the lights you want to turn on or off, then select the power state, then select the timespan which to apply the change. 9

10 Screenshot UltraLighting3 Set Brightness This trigger action allows you to set the brightness to your LIFX Wi-Fi enabled LED lights. Simply select the lights you want to change the brightness, then select the brightness percent, then select the timespan which to apply the change. Screenshot UltraLighting3 Set Waveform This trigger action allows you to apply a lighting effect to your LIFX Wi-Fi enabled LED lights. Simply select the lights you want to apply the new effect to, then select the effect options. 10

11 Screenshot UltraLighting3 HSPI Trigger Conditions This plug-in does not have any HomeSeer trigger conditions defined. UltraLighting3 HSPI API Reference To be determined. 11