Package de.sg_o.app.miio.base

Class Device

java.lang.Object

de.sg_o.app.miio.base.Device

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Light, Vacuum

public class Device
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Device(java.net.InetAddress ip, Token token, java.lang.String[] acceptableModels, int timeout, int retries)	Baseclass for all miIO devices.

Method Summary

Modifier and Type	Method	Description
boolean	configureRouter(java.lang.String ssid, java.lang.String password)	Set the deviced network connection up.
boolean	configureRouter(java.lang.String ssid, java.lang.String password, int uid)
boolean	discover()	Connect to a device and send a Hello message.
java.lang.String	firmware()	Get the devices firmware version.
java.lang.String[]	getAcceptableModels()
java.net.InetAddress	getIp()
int	getRetries()
int	getTimeout()
Token	getToken()
org.json.JSONObject	info()	Get the device info from the device
java.lang.String	model()	Get the devices model id.
java.lang.String	send(java.lang.String payload)	Send an arbitrary string as payload to the device.
Response	send(java.lang.String method, java.lang.Object params)	Send a command to a device.
boolean	sendOk(java.lang.String method)	Send a command to a device without parameters.
boolean	sendOk(java.lang.String method, java.lang.Object params)	Send a command to a device.
org.json.JSONArray	sendToArray(java.lang.String method)	Send a command to a device without parameters.
org.json.JSONArray	sendToArray(java.lang.String method, java.lang.Object params)	Send a command to a device.
org.json.JSONObject	sendToObject(java.lang.String method)	Send a command to a device without parameters.
org.json.JSONObject	sendToObject(java.lang.String method, java.lang.Object params)	Send a command to a device.
boolean	update(java.lang.String url, java.lang.String md5)	Command the device to update
int	updateProgress()	Request the update progress as a percentage value from 0 to 100
java.lang.String	updateStatus()	Request the update status.

Methods inherited from class java.lang.Object

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

Constructor Detail

Device

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

Baseclass for all miIO devices.

Parameters:

ip - The IP address of the device to connect to. If the address is null the first device that is an acceptableModel 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

getIp

public java.net.InetAddress getIp()

Returns:

The IP address of the device.

getToken

public Token getToken()

Returns:

The token of the device.

getRetries

public int getRetries()

Returns:

The number of retries when discovering a device or sending a command.

getAcceptableModels

public java.lang.String[] getAcceptableModels()

Returns:

The model strings this device must have.

getTimeout

public int getTimeout()

Returns:

The timeout for the communication to fail.

discover

public boolean discover()

Connect to a device and send a Hello message. If no IP has been specified, this will try do discover a device on the network.

Returns:

True if the device has been successfully acquired.

send

public Response send(java.lang.String method,
                     java.lang.Object params)
              throws CommandExecutionException

Send a command to a device. If no IP has been specified, this will try do discover a device on the network.

Parameters:

method - The method to execute on the device.

params - The command to execute on the device. Must be a JSONArray or JSONObject.

Returns:

The response from the device.

Throws:

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

send

public java.lang.String send(java.lang.String payload)
                      throws CommandExecutionException

Send an arbitrary string as payload to the device.

Parameters:

payload - The string to send.

Returns:

The response of the device as an unparsed string.

Throws:

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

sendToObject

public org.json.JSONObject sendToObject(java.lang.String method,
                                        java.lang.Object params)
                                 throws CommandExecutionException

Send a command to a device. If no IP has been specified, this will try do discover a device on the network.

Parameters:

method - The method to execute on the device.

params - The command to execute on the device. Must be a JSONArray or JSONObject.

Returns:

The response from the device as a JSONObject.

Throws:

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

sendToObject

public org.json.JSONObject sendToObject(java.lang.String method)
                                 throws CommandExecutionException

Send a command to a device without parameters. If no IP has been specified, this will try do discover a device on the network.

Parameters:

method - The method to execute on the device.

Returns:

The response from the device as a JSONObject.

Throws:

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

sendToArray

public org.json.JSONArray sendToArray(java.lang.String method,
                                      java.lang.Object params)
                               throws CommandExecutionException

Send a command to a device. If no IP has been specified, this will try do discover a device on the network.

Parameters:

method - The method to execute on the device.

params - The command to execute on the device. Must be a JSONArray or JSONObject.

Returns:

The response from the device as a JSONArray.

Throws:

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

sendToArray

public org.json.JSONArray sendToArray(java.lang.String method)
                               throws CommandExecutionException

Send a command to a device without parameters. If no IP has been specified, this will try do discover a device on the network.

Parameters:

method - The method to execute on the device.

Returns:

The response from the device as a JSONArray.

Throws:

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

sendOk

public boolean sendOk(java.lang.String method,
                      java.lang.Object params)
               throws CommandExecutionException

Send a command to a device. If no IP has been specified, this will try do discover a device on the network.

Parameters:

method - The method to execute on the device.

params - The command to execute on the device. Must be a JSONArray or JSONObject.

Returns:

True if a ok was received from the device.

Throws:

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

sendOk

public boolean sendOk(java.lang.String method)
               throws CommandExecutionException

Send a command to a device without parameters. If no IP has been specified, this will try do discover a device on the network.

Parameters:

method - The method to execute on the device.

Returns:

True if a ok was received from the device.

Throws:

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

info

public org.json.JSONObject info()
                         throws CommandExecutionException

Get the device info from the device

Returns:

The device info as a JSONObject

Throws:

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

update

public boolean update(java.lang.String url,
                      java.lang.String md5)
               throws CommandExecutionException

Command the device to update

Parameters:

url - The URL to update from

md5 - The MD5 Checksum for the update

Returns:

True if the command has been received. This does not mean that the update was successful.

Throws:

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

updateProgress

public int updateProgress()
                   throws CommandExecutionException

Request the update progress as a percentage value from 0 to 100

Returns:

The current progress.

Throws:

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

updateStatus

public java.lang.String updateStatus()
                              throws CommandExecutionException

Request the update status.

Returns:

The update status.

Throws:

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

configureRouter

public boolean configureRouter(java.lang.String ssid,
                               java.lang.String password)
                        throws CommandExecutionException

Set the deviced network connection up.

Parameters:

ssid - The SSID to device should connect to

password - The password for that connection

Returns:

True if the command was received successfully. This does not mean that the connection has been correctly established.

Throws:

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

configureRouter

public boolean configureRouter(java.lang.String ssid,
                               java.lang.String password,
                               int uid)
                        throws CommandExecutionException

Throws:

CommandExecutionException

model

public java.lang.String model()
                       throws CommandExecutionException

Get the devices model id.

Returns:

The devices model id.

Throws:

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

firmware

public java.lang.String firmware()
                          throws CommandExecutionException

Get the devices firmware version.

Returns:

The devices current firmware version.

Throws:

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