MiLightRGBW Plugin V1.0 Page 1 of 5

Transcription

1 MiLightRGBW Plugin V1.0 Page 1 of 5 Setup You can change the plugin device s IP address and port to match the settings of your MiLight WiFi Bridge by editing the attribute ip in the Advanced tab. The format is ipaddress:port. Set the group (1-4) that this device is to control by editing the variable Group in the device's Advanced tab. You can also set Group to 0 in which case the plugin will control all four groups simultaneously. After changing any of these settings, click SAVE/Reload and then reload/refresh the browser page. Operation This plugin should give you a device on the dashboard UI that behaves like a normal dimmable light but with several additional features. On the device tile, there are Min and Max buttons for the dimmer level and separate On and Off buttons. The last set dimmer level will be retained if the lamps are switched off and on with the Off and On buttons. Setting the dimmer level to 0 will turn the lamps off. Setting any non-zero dimmer level will turn the lamps on if they were off. A dimmer value of 5 is the minimum light level of the lamps. Under the Control tab, there is a White button that sets the lamps into whitelight mode. There are also input fields and Set buttons for Color Hue Value (0-255), Disco Mode (1-9) and Disco Rate (1-8). Clicking the SetHue or SetMode buttons without entering a value in the input fields will set the lamp to the last used values. There are six buttons for setting the lamp hue to basic colours. The Enroll button may be used, immediately after switching on lamp power, to enroll the lamp into the WiFi Bridge. The Sync button will re-assert the current plugin settings to synchronize a lamp that has been adjusted by a remote control or Smartphone App. Lamp hue may also be set on the Color tab by clicking on the required colour. Whenever the mode is changed to White or SetHue, the plugin will restore the dimming level of the lamps to the value set on the UI dimmer control. The dimming level will not be restored for Disco modes unless the option RDL is set. When set to Disco mode, the lamp's effect speed will be reset to the last used Disco Rate value unless the NRR option is set. Actions urn:upnp-org:serviceid:dimming1 SetLoadLevelTarget newloadleveltarget = <0-100> urn:upnp-org:serviceid:switchpower1 SetTarget newtargetvalue= <0 or 1> urn:dcineco-com:serviceid:milightrgbw1 SetHue newhue = <0-255> urn:dcineco-com:serviceid:milightrgbw1 SetDiscoMode newdiscomode=<1-9> urn:dcineco-com:serviceid:milightrgbw1 SetDiscoRate newdiscorate = <1-8> urn:dcineco-com:serviceid:milightrgbw1 SetWhiteMode urn:dcineco-com:serviceid:milightrgbw1 Sync urn:dcineco-com:serviceid:milightrgbw1 SetColor newcolor = <"red" or "green" or "blue" or "cyan" or "yellow" or "magenta">

2 MiLightRGBW Plugin V1.0 Page 2 of 5 Configuration Options MiLightRGBW has some configurable options to allow the operation to be adjusted to suit hardware and preferences. The options are set in one of the following ways: Enter the options string on the device's Advanced tab in the variable Options. The new options will take effect following a Save/Reload. Initiate the SetOptions action with newoptions=<your options>. This may be done in a scene or, conveniently, by pasting the Lua code into APPS,Develop Apps,Test Luup code (Lua). The new options will take effect immediately. The Lua for this is: luup.call_action("urn:dcineco-com:serviceid:milightrgbw1","setoptions",{newoptions="<your-optio ns>"},<id>) Where <your-options> is the new options string and <ID> is the device ID of your MiLightRGBW device. Options The options string is a comma-separated list of any of the following in any order. They may be entered in either upper or lower-case. Any spaces will be ignored. Absence of an option means that the default value or processing will be used. All options can be removed by entering an empty options string. NKA Disable KeepAlive function. SKA Send short KeepAlive (0x55). Default 0x30,0x00,0x55. NRR Disable DiscoRate reset when switching to Disco mode. RDL Restore dimmer level when switching to Disco mode. TDM Traditional Dimmer Mode. Dim level is shown as zero when off. DDR=nnn Set DiscoRate to nnn when switching to Disco mode. Default is 6. ICT=nnn Set inter-command delay to nnn ms. Default is 50. ODT=nnn Set fade/off delay time to nnn ms. Default is MDL=nnn Set minimum dim-level to nnn%. Default is 5. CLT=2 Use colour lookup table for RGBW LED strip controller. Examples luup.call_action("urn:dcineco-com:serviceid:milightrgbw1","setoptions",{newoptions="nka,mdl=1 0,odt=1500"},142) This will disable the KeepAlive heartbeat, set the minimum dim-level to 10% and allow 1.5 seconds for the lamp to fade down before turning it off. luup.call_action("urn:dcineco-com:serviceid:milightrgbw1","setoptions",{newoptions=""},142) This will remove all options and return to default values. Notes If the KeepAlive function is disabled using the SetOptions action, it will stop after the next cycle which may be up to 60 seconds later.

3 MiLightRGBW Plugin V1.0 Page 3 of 5 Bridge Configuration As delivered, the MiLight WiFi Bridge is an Access Point with its own SSID. You can set up the bridge as a client on an existing network as follows: V4 Bridge with black label Shipped from 1 st January 2014 This version of the bridge does not allow manual configuration. You must use the Mi-Light Smartphone app to connect the bridge to your network. It will use the IP address issued by your router s DHCP and default to port Most routers will allow you to specify a fixed/static IP address to be issued to the bridge. Some routers will also allow you to block internet access for the specified IP address. V3 Bridge with black label Shipped from September 2013 to December 2013 Connect a PC to the default SSID (milight), address the built-in server through your browser ( /home.html) and login as admin password admin. Change the following settings: STA Interface Setting AP's SSID: Set to your existing network SSID Security Mode: Set to existing network security mode Encryption Type: Set to existing network encryption type Pass Phrase: Set to your pre-shared key WAN Connection Type: Static IP Address: Set as required Subnet Mask: Set as required Default Gateway: Set to an unused IP address Application Setting Protocol: Select UDP Port: 8899 Mode Selection Check STA Mode Cycle the power to the bridge and you should be able to rejoin your normal network and connect to the bridge through its new IP address. If it doesn't work, press the reset button with a paperclip for five seconds and try again from the top.

4 MiLightRGBW Plugin V1.0 Page 4 of 5 V2 Bridge with blue/white label Connect a PC to the default SSID (wifi-socket), address the built-in server through your browser ( ) and login as admin password Change the following settings: Work Type: Set to Sta SSID: Set to your existing network SSID Encryption: Set to existing network encryption mode Key Format: Set as required for your key Encryption Key: Set to your pre-shared key Click Save for this block. DHCP Enable: Set unchecked Fixed IP Address: Set as required Subnet Mask: Set as required Gateway Address: Set as required or to unused IP address DNS Address: Set as required - often the same as the Gateway Click Save for this block. Cycle the power (or click System, System Restart) and you should be able to rejoin your normal network and connect to the bridge through its new IP address. If it doesn't work, press the reset button with a paperclip for five seconds and try again from the top. Device IP address and port Set the attribute ip on the plugin device's Advanced tab to match the bridge settings. The format is ipaddress:port where port is normally for the older bridge and 8899 for the V3 and V4 models. Close the device tile, click Save and then refresh your browser page. Registering Lamps Before you can control a lamp via the WiFi Bridge, it has to be registered on that bridge. This has to be done for each lamp in each zone/group. A lamp may be registered in up to four groups. A fifth registration will overwrite the first etc. Registration on the normal remote control also counts as one of the four. Lamps registered using the Mi-Light Smartphone app may be controlled by the MiLightXXX plugins without additional registration/enrolment. Turn off the power to the lamp with the wall-switch. Wait about ten seconds. Turn the power back on and, as soon as the lamp is on, click the Enroll button on the device's Control tab. If successful, the lamp will flash several times. If the lamp doesn't flash, try again. It may be necessary to click Enroll at the same time as you turn on the power.

5 MiLightRGBW Plugin V1.0 Page 5 of 5 De-Registering Lamps A lamp can be de-registered from all groups (including all bridges and remotes) using either the hand-held remote control or the Mi-Light Smartphone app. Hand-held Remote Turn off power to the lamp, wait five seconds, turn on power to the lamp and immediately press and hold the ON button for the Group/Zone on which it is registered. If successful, the lamp will flash several times. Mi-Light app Turn off power to the lamp, wait five seconds, turn on power to the lamp and immediately click the ON button for the Group/Zone on which it is registered five times in rapid succession. If successful, the lamp will flash several times.