Package de.sg_o.app.miio.yeelight

Class Prop

java.lang.Object

de.sg_o.app.miio.yeelight.Prop

public class Prop
extends java.lang.Object

This class handles the properties of a light.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Prop.Names	The retrievable properties.

Constructor Summary

Constructors

Constructor	Description
Prop(Prop.Names[] props)	Create a new light properties object.

Method Summary

Modifier and Type	Method	Description
Prop.Names[]	getProps()
org.json.JSONArray	getRequestArray()
java.util.Map<Prop.Names,java.lang.String>	parseResponse(org.json.JSONArray response)	Parse the response from the device and return a map containing the property names and their values.

Methods inherited from class java.lang.Object

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

Constructor Detail

Prop

public Prop(Prop.Names[] props)

Create a new light properties object.

Parameters:

props - The properties to retrieve.

Method Detail

getProps

public Prop.Names[] getProps()

Returns:

The properties to retrieve.

getRequestArray

public org.json.JSONArray getRequestArray()
                                   throws CommandExecutionException

Returns:

A JSONArray that is sent to the device to retrieve the property values. * @throws CommandExecutionException When the properties array was invalid.

Throws:

CommandExecutionException

parseResponse

public java.util.Map<Prop.Names,java.lang.String> parseResponse(org.json.JSONArray response)
                                                         throws CommandExecutionException

Parse the response from the device and return a map containing the property names and their values.

Parameters:

response - The response from the device.

Returns:

A map containing the property names as the keys and their values.

Throws:

CommandExecutionException