Package de.sg_o.app.miio.yeelight

Class Light

java.lang.Object

de.sg_o.app.miio.base.Device

de.sg_o.app.miio.yeelight.Light

Direct Known Subclasses:

ColorLight

public abstract class Light
extends Device

Baseclass for all yeelight devices.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Light(java.net.InetAddress ip, Token token, java.lang.String[] acceptableModels, int timeout, int retries)

Method Summary

Modifier and Type	Method	Description
int	getBrightness()
int	getColorTemperature()
int	getDeviceMode()
int	getHue()
int	getIntProp(Prop.Names prop)	Get a single property value and try to convert it to an int.
java.lang.String	getName()
java.util.Map<Prop.Names,java.lang.String>	getProps(Prop.Names[] props)	Get several property values at once from the device.
int	getRGB()
int	getSaturation()
java.lang.String	getSingleProp(Prop.Names prop)	Get a single property value from the device.
int	getTimeUntilPowerOff()
boolean	isOn()
boolean	powerOffAfterTime(int minutes)	Power the device off after some time.
boolean	setAsDefault()	Set the current settings as the default value that will be restored after a power loss.
boolean	setBrightness(int brightness, boolean smoothChange, int duration)
boolean	setColorTemperature(int temperature, boolean smoothChange, int duration)
boolean	setHSV(int hue, int saturation, boolean smoothChange, int duration)
boolean	setName(java.lang.String name)
boolean	setPower(boolean on, boolean smoothChange, int duration)
boolean	setRGB(int c, boolean smoothChange, int duration)
boolean	stopPowerOffAfterTime()	Prevent the device from powering off after some time.
boolean	togglePower()

Methods inherited from class de.sg_o.app.miio.base.Device

configureRouter, configureRouter, discover, firmware, getAcceptableModels, getIp, getRetries, getTimeout, getToken, info, model, send, send, sendOk, sendOk, sendToArray, sendToArray, sendToObject, sendToObject, update, updateProgress, updateStatus

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Light

public Light(java.net.InetAddress ip,
             Token token,
             java.lang.String[] acceptableModels,
             int timeout,
             int retries)

Parameters:

ip - The IP address of the light to connect to. If the address is null the first light that was found will be chosen.

token - The token for that device. If the token is null the token will be extracted from unprovisioned devices.

acceptableModels - An array of acceptable devices to connect to.

timeout - The timeout for the communication

retries - The number of retries after a failed communication

Method Detail

getProps

public java.util.Map<Prop.Names,java.lang.String> getProps(Prop.Names[] props)
                                                    throws CommandExecutionException

Get several property values at once from the device.

Parameters:

props - The properties to get.

Returns:

The property names and values.

Throws:

CommandExecutionException - When there has been a error during the communication or the response was invalid.

getSingleProp

public java.lang.String getSingleProp(Prop.Names prop)
                               throws CommandExecutionException

Get a single property value from the device.

Parameters:

prop - The property to get.

Returns:

The value of the specified property name.

Throws:

CommandExecutionException - When there has been a error during the communication or the response was invalid.

getIntProp

public int getIntProp(Prop.Names prop)
               throws CommandExecutionException

Get a single property value and try to convert it to an int.

Parameters:

prop - The property to get.

Returns:

The value of the specified property name.

Throws:

CommandExecutionException - When there has been a error during the communication or the response was invalid.

getDeviceMode

public int getDeviceMode()
                  throws CommandExecutionException

Returns:

1: rgb mode; 2: color temperature mode; 3: Hue Saturation mode

Throws:

CommandExecutionException - When there has been a error during the communication or the response was invalid.

setColorTemperature

public boolean setColorTemperature(int temperature,
                                   boolean smoothChange,
                                   int duration)
                            throws CommandExecutionException

Parameters:

temperature - Color temperature to set. 1700 to 6500(k) inclusive

smoothChange - Whether to change instantly or smoothly.

duration - The duration of the smooth change.

Returns:

True if the command was received successfully.

Throws:

CommandExecutionException - When there has been a error during the communication or the response was invalid.

getColorTemperature

public int getColorTemperature()
                        throws CommandExecutionException

Returns:

The color temperature the device is set to.

Throws:

CommandExecutionException - When there has been a error during the communication or the response was invalid.

setRGB

public boolean setRGB(int c,
                      boolean smoothChange,
                      int duration)
               throws CommandExecutionException

Parameters:

c - The color to change to.

smoothChange - Whether to change instantly or smoothly.

duration - The duration of the smooth change.

Returns:

True if the command was received successfully.

Throws:

CommandExecutionException - When there has been a error during the communication or the response was invalid.

getRGB

public int getRGB()
           throws CommandExecutionException

Returns:

The current color the device is set to.

Throws:

CommandExecutionException - When there has been a error during the communication or the response was invalid.

setHSV

public boolean setHSV(int hue,
                      int saturation,
                      boolean smoothChange,
                      int duration)
               throws CommandExecutionException

Parameters:

hue - The hue to change to.

saturation - The saturation to change to.

smoothChange - Whether to change instantly or smoothly.

duration - The duration of the smooth change.

Returns:

True if the command was received successfully.

Throws:

CommandExecutionException - When there has been a error during the communication or the response was invalid.

getHue

public int getHue()
           throws CommandExecutionException

Returns:

The hue the device is currently set to.

Throws:

CommandExecutionException - When there has been a error during the communication or the response was invalid.

getSaturation

public int getSaturation()
                  throws CommandExecutionException

Returns:

The saturation the device is currently set to.

Throws:

CommandExecutionException - When there has been a error during the communication or the response was invalid.

setBrightness

public boolean setBrightness(int brightness,
                             boolean smoothChange,
                             int duration)
                      throws CommandExecutionException

Parameters:

brightness - The brightness to change to.

smoothChange - Whether to change instantly or smoothly.

duration - The duration of the smooth change.

Returns:

True if the command was received successfully.

Throws:

CommandExecutionException - When there has been a error during the communication or the response was invalid.

getBrightness

public int getBrightness()
                  throws CommandExecutionException

Returns:

The brightness the device is currently set to.

Throws:

CommandExecutionException - When there has been a error during the communication or the response was invalid.

setPower

public boolean setPower(boolean on,
                        boolean smoothChange,
                        int duration)
                 throws CommandExecutionException

Parameters:

on - True: turn the device on; False: turn the device off.

smoothChange - Whether to change instantly or smoothly.

duration - The duration of the smooth change.

Returns:

True if the command was received successfully.

Throws:

CommandExecutionException - When there has been a error during the communication or the response was invalid.

togglePower

public boolean togglePower()
                    throws CommandExecutionException

Returns:

Thoggle the devices power

Throws:

CommandExecutionException - When there has been a error during the communication or the response was invalid.

isOn

public boolean isOn()
             throws CommandExecutionException

Returns:

The hue the device is currently set to.

Throws:

CommandExecutionException - When there has been a error during the communication or the response was invalid.

setAsDefault

public boolean setAsDefault()
                     throws CommandExecutionException

Set the current settings as the default value that will be restored after a power loss.

Returns:

True if the command was received successfully

Throws:

CommandExecutionException - When there has been a error during the communication or the response was invalid.

powerOffAfterTime

public boolean powerOffAfterTime(int minutes)
                          throws CommandExecutionException

Power the device off after some time.

Parameters:

minutes - The time until the device is turned off in minutes.

Returns:

True if the command was received successfully.

Throws:

CommandExecutionException - When there has been a error during the communication or the response was invalid.

stopPowerOffAfterTime

public boolean stopPowerOffAfterTime()
                              throws CommandExecutionException

Prevent the device from powering off after some time.

Returns:

True if the command was received successfully.

Throws:

CommandExecutionException - When there has been a error during the communication or the response was invalid.

getTimeUntilPowerOff

public int getTimeUntilPowerOff()
                         throws CommandExecutionException

Returns:

The brightness the device is currently set to.

Throws:

CommandExecutionException - When there has been a error during the communication or the response was invalid.

setName

public boolean setName(java.lang.String name)
                throws CommandExecutionException

Parameters:

name - The name to set the device to.

Returns:

True if the command was received successfully.

Throws:

CommandExecutionException - When there has been a error during the communication or the response was invalid.

getName

public java.lang.String getName()
                         throws CommandExecutionException

Returns:

The devices name.

Throws:

CommandExecutionException - When there has been a error during the communication or the response was invalid.