diff --git a/bundles/org.openhab.binding.milight/README.md b/bundles/org.openhab.binding.milight/README.md index b7e879388dd..6c2b6615e19 100644 --- a/bundles/org.openhab.binding.milight/README.md +++ b/bundles/org.openhab.binding.milight/README.md @@ -39,15 +39,15 @@ iBox and iBox2 have the version 6, older milight bridges have the version 3. The ID is the MAC address of the bridge in hexadecimal digits. Bridge milight:bridgeV3:mybridge [ host="192.168.0.70", bridgeid="ACCF23A6C0B4", passwordByte1=0, passwordByte2=0, repeat=2, delayTime=75 ] { - Thing whiteLed myWhite [ zone="0" ] - Thing rgbwwLed myRGB [ zone="4" ] - Thing rgbLed myOldRGB [ zone="1" ] + Thing whiteLed myWhite [ zone="0" ] + Thing rgbwwLed myRGB [ zone="4" ] + Thing rgbLed myOldRGB [ zone="1" ] } The Thing configuration for the bridge uses the following syntax -* Bridge milight:bridgeV3: &lsqb host="", bridgeid="" &rsqb -* Bridge milight:bridgeV6: &lsqb host="", bridgeid="", passwordByte1="<0-255>", passwordByte2="<0-255>" &rsqb +* Bridge milight:bridgeV3: host="", bridgeid="" +* Bridge milight:bridgeV6: host="", bridgeid="", passwordByte1="<0-255>", passwordByte2="<0-255>" Optionally, the following parameters can be added @@ -58,16 +58,16 @@ Optionally, the following parameters can be added The Thing configuration for the bulbs uses the following syntax: -&lsqbThing&rsqb &lsqb zone="<0-4>" &rsqb +Thing zone="<0-4>" The following bulb types are valid for configuration: -* rgbv2Led: The very first available bulb. Not very common anymore. -* whiteLed: The dual white bulbs (with cold/warm white) used with v3-v5 bridges. -* rgbLed: The rgb+white bulbs (with cold/warm white) used with v3-v5 bridges. About 4080 colors (255 colors * 16 brightness steps). +* rgbv2Led: The very first available bulb. Not very common anymore. +* whiteLed: The dual white bulbs (with cold/warm white) used with v3-v5 bridges. +* rgbLed: The rgb+white bulbs (with cold/warm white) used with v3-v5 bridges. About 4080 colors (255 colors x 16 brightness steps). * rgbiboxLed: The iBox bridge integrated color bulb without a dedicated white channel. -* rgbwLed: The 2016/2017 color bulb without saturation support. About 6630 (255*26) colors. -* rgbwwLed: The 2016/2017 color bulb with saturation support. About 1.044.480 (255*64*64) different color shades. Use this also for the newer generation of the dual white bulbs. +* rgbwLed: The 2016/2017 color bulb without saturation support. About 6630 (255x26) colors. +* rgbwwLed: The 2016/2017 color bulb with saturation support. About 1.044.480 (255x64x64) different color shades. Use this also for the newer generation of the dual white bulbs. The zone number is either 0 for meaning all bulbs of the same type or a valid zone number (1-4). Future bridges may support more zones. @@ -76,44 +76,43 @@ Future bridges may support more zones. For dual white bulbs these channels are supported: - ledbrightness Controls the brightness of your bulbs - ledtemperature Changes from cold white to warm white and vice versa - lednightmode Dims your bulbs to a very low level to use them as a night light - animation_mode_relative Changes the animation mode. Use an IncreaseDecrease type of widget. + ledbrightness Controls the brightness of your bulbs + ledtemperature Changes from cold white to warm white and vice versa + lednightmode Dims your bulbs to a very low level to use them as a night light + animation_mode_relative Changes the animation mode. Use an IncreaseDecrease type of widget For rgbv2Led bulbs these channels are supported: - ledbrightness Controls the brightness of your bulbs - ledcolor Changes the color and brightness of your rgb bulbs when bound to a colorpicker - or just the brightness if bound to a Dimmer or controls On/Off if bound to a switch. - animation_mode_relative Changes the animation mode. Use an IncreaseDecrease type of widget. + ledbrightness Controls the brightness of your bulbs + ledcolor Changes the color and brightness of your rgb bulbs when bound to a colorpicker + or just the brightness if bound to a Dimmer or controls On/Off if bound to a switch. + animation_mode_relative Changes the animation mode. Use an IncreaseDecrease type of widget For rgbLed bulbs these channels are supported: - lednightmode Dims your bulbs to a very low level to use them as a night light - ledwhitemode Disable all color (saturation is 0) - ledbrightness Controls the brightness of your bulbs - ledcolor Changes the color and brightness of your rgb bulbs when bound to a colorpicker - or just the brightness if bound to a Dimmer or controls On/Off if bound to a switch. - animation_mode_relative Changes the animation mode. Use an IncreaseDecrease type of widget. + lednightmode Dims your bulbs to a very low level to use them as a night light + ledwhitemode Disable all color (saturation is 0) + ledbrightness Controls the brightness of your bulbs + ledcolor Changes the color and brightness of your rgb bulbs when bound to a colorpicker + or just the brightness if bound to a Dimmer or controls On/Off if bound to a switch + animation_mode_relative Changes the animation mode. Use an IncreaseDecrease type of widget animation_speed_relative Changes the speed of your chosen animation mode For rgbwLed/rgbwwLed bulbs these channels are supported: - lednightmode Dims your bulbs to a very low level to use them as a night light - ledwhitemode Disable all color (saturation is 0) - ledbrightness Controls the brightness of your bulbs - ledsaturation Controls the saturation of your bulbs (not for rgbwLed!) - ledtemperature Changes from cold white to warm white and vice versa (not for rgbwLed!) - ledcolor Changes the color and brightness of your rgb bulbs when bound to a colorpicker - or just the brightness if bound to a Dimmer or controls On/Off if bound to a switch. - animation_mode Changes the animation mode. Chose between animation mode 1 to 9. - animation_mode_relative Changes the animation mode. Use an IncreaseDecrease type of widget. + lednightmode Dims your bulbs to a very low level to use them as a night light + ledwhitemode Disable all color (saturation is 0) + ledbrightness Controls the brightness of your bulbs + ledsaturation Controls the saturation of your bulbs (not for rgbwLed!) + ledtemperature Changes from cold white to warm white and vice versa (not for rgbwLed!) + ledcolor Changes the color and brightness of your rgb bulbs when bound to a colorpicker + or just the brightness if bound to a Dimmer or controls On/Off if bound to a switch + animation_mode Changes the animation mode. Chose between animation mode 1 to 9 + animation_mode_relative Changes the animation mode. Use an IncreaseDecrease type of widget animation_speed_relative Changes the speed of your chosen animation mode - ledlink Sync bulb to this zone within 3 seconds of light bulb socket power on - ledunlink Clear bulb from this zone within 3 seconds of light bulb socket power on + ledlink Sync bulb to this zone within 3 seconds of light bulb socket power on + ledunlink Clear bulb from this zone within 3 seconds of light bulb socket power on -[(See the API)](http://www.limitlessled.com/dev/). Limitations: @@ -124,24 +123,23 @@ Limitations: .items ``` -Switch Light_Groundfloor {channel="milight:whiteLed:ACCF23A6C0B4:0:ledbrightness"} # Switch for all white bulbs -Dimmer Light_LivingroomB {channel="milight:whiteLed:ACCF23A6C0B4:1:ledbrightness"} # Dimmer changing brightness for bulb in zone 1 -Dimmer Light_LivingroomC {channel="milight:whiteLed:ACCF23A6C0B4:1:ledtemperature"} # Dimmer changing colorTemperature for bulb in zone 1 -Dimmer RGBW_LivingroomB {channel="milight:rgbwLed:ACCF23A6C0B4:2:ledbrightness"} # Dimmer changing brightness for RGBW bulb in zone 2 -Color Light_Party {channel="milight:rgbwLed:ACCF23A6C0B4:1:ledcolor"}# Colorpicker for rgb bulbs +Switch Light_Groundfloor {channel="milight:whiteLed:ACCF23A6C0B4:0:ledbrightness"} //Switch for all white bulbs +Dimmer Light_LivingroomB {channel="milight:whiteLed:ACCF23A6C0B4:1:ledbrightness"} //Dimmer changing brightness for bulb in zone 1 +Dimmer Light_LivingroomC {channel="milight:whiteLed:ACCF23A6C0B4:1:ledtemperature"} //Dimmer changing colorTemperature for bulb in zone 1 +Dimmer RGBW_LivingroomB {channel="milight:rgbwLed:ACCF23A6C0B4:2:ledbrightness"} //Dimmer changing brightness for RGBW bulb in zone 2 +Color Light_Party {channel="milight:rgbwLed:ACCF23A6C0B4:1:ledcolor"} //Colorpicker for rgb bulbs -# You have to link the items to the channels of your prefered group e.g. in Paper UI after you have saved -# your items file. +//You have to link the items to the channels of your prefered group e.g. in Paper UI after you have saved your items file. -# The command types nightMode and whiteMode are stateless and should be configured as pushbuttons as they only support a trigger action: -Switch Light_GroundfloorN {channel="milight:whiteLed:ACCF23A6C0B4:0:lednightmode", autoupdate="false"} # Activate the NightMode for all bulbs +//The command types nightMode and whiteMode are stateless and should be configured as pushbuttons as they only support a trigger action: +Switch Light_GroundfloorN {channel="milight:whiteLed:ACCF23A6C0B4:0:lednightmode", autoupdate="false"} //Activate the NightMode for all bulbs -# The command types animation_mode_relative and animation_speed are stateless and should be configured as pushbuttons as they only support INCREASE and DECREASE commands: +//The command types animation_mode_relative and animation_speed are stateless and should be configured as pushbuttons as they only support INCREASE and DECREASE commands: Dimmer AnimationMode {channel="milight:rgbLed:ACCF23A6C0B4:5:animation_mode_relative", autoupdate="false"} Dimmer AnimationSpeed {channel="milight:rgbLed:ACCF23A6C0B4:5:animation_speed", autoupdate="false"} -# Animation Mode for RGBWW bulbs is different, it allows to pick a mode directly. +//Animation Mode for RGBWW bulbs is different, it allows to pick a mode directly. Switch AnimationModeRgbWW {channel="milight:rgbwwLed:ACCF23A6C0B4:5:animation_mode"} ``` @@ -149,7 +147,7 @@ Switch AnimationModeRgbWW {channel="milight:rgbwwLed:ACCF23A6C0B4:5:animation_mo .sitemap ``` -Switch item=AnimationMode mappings=[DECREASE='-', INCREASE='+'] -Switch item=AnimationSpeed mappings=[DECREASE='-', INCREASE='+'] +Switch item=AnimationMode mappings=[DECREASE='-', INCREASE='+'] +Switch item=AnimationSpeed mappings=[DECREASE='-', INCREASE='+'] Switch item=Light_GroundfloorN mappings=[ON='Night Mode'] ```