Package de.sg_o.app.miio.vacuum

Class VacuumStatus

java.lang.Object

de.sg_o.app.miio.vacuum.VacuumStatus

All Implemented Interfaces:

java.io.Serializable

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VacuumStatus.Error
static class	VacuumStatus.State

Constructor Summary

Constructors

Constructor	Description
VacuumStatus(boolean dndEnabled, boolean mapPresent, int cleanArea, int fanPower, int msgVersion, boolean inCleaning, VacuumStatus.Error errorCode, VacuumStatus.State state, int battery, int msgSeq, int cleanTime)	Create a new vacuum status object.
VacuumStatus(org.json.JSONObject status)	Generate a new vacuum status object from the response of a device.

Method Summary

Modifier and Type	Method	Description
org.json.JSONObject	construct()	Construct the message the vacuum sends to the controlling device.
boolean	equals(java.lang.Object o)
int	getBattery()
int	getCleanArea()
int	getCleanTime()
VacuumStatus.Error	getErrorCode()
int	getFanPower()
int	getMsgSeq()
int	getMsgVersion()
VacuumStatus.State	getState()
int	hashCode()
boolean	isDndEnabled()
boolean	isInCleaning()
boolean	isMapPresent()
void	setBattery(int battery)
void	setCleanArea(int cleanArea)
void	setCleanTime(int cleanTime)
void	setDndEnabled(boolean dndEnabled)
void	setErrorCode(VacuumStatus.Error errorCode)
void	setFanPower(int fanPower)
void	setInCleaning(boolean inCleaning)
void	setMapPresent(boolean mapPresent)
void	setMsgSeq(int msgSeq)
void	setMsgVersion(int msgVersion)
void	setState(VacuumStatus.State state)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VacuumStatus

public VacuumStatus(boolean dndEnabled,
                    boolean mapPresent,
                    int cleanArea,
                    int fanPower,
                    int msgVersion,
                    boolean inCleaning,
                    VacuumStatus.Error errorCode,
                    VacuumStatus.State state,
                    int battery,
                    int msgSeq,
                    int cleanTime)

Create a new vacuum status object.

Parameters:

dndEnabled - Whether the do not disturb period is active.

mapPresent - Whether a valid map is present.

cleanArea - The total cleaned area.

fanPower - The current fan power.

msgVersion - The message version.

inCleaning - Whether the vacuum is currently cleaning.

errorCode - The current error.

state - The current status.

battery - The current battery level.

msgSeq - The message sequence.

cleanTime - The total time spent cleaning.

VacuumStatus

public VacuumStatus(org.json.JSONObject status)

Generate a new vacuum status object from the response of a device.

Parameters:

status - The response to parse.

Method Detail

construct

public org.json.JSONObject construct()

Construct the message the vacuum sends to the controlling device.

Returns:

The constructed message.

isDndEnabled

public boolean isDndEnabled()

Returns:

Whether the do not disturb period is active.

setDndEnabled

public void setDndEnabled(boolean dndEnabled)

Parameters:

dndEnabled - Whether the do not disturb period is active.

isMapPresent

public boolean isMapPresent()

Returns:

Whether a valid map is present.

setMapPresent

public void setMapPresent(boolean mapPresent)

Parameters:

mapPresent - Whether a valid map is present.

getCleanArea

public int getCleanArea()

Returns:

The total cleaned area.

setCleanArea

public void setCleanArea(int cleanArea)

Parameters:

cleanArea - The total cleaned area.

getFanPower

public int getFanPower()

Returns:

The current fan power.

setFanPower

public void setFanPower(int fanPower)

Parameters:

fanPower - The current fan power.

getMsgVersion

public int getMsgVersion()

Returns:

The message version.

setMsgVersion

public void setMsgVersion(int msgVersion)

Parameters:

msgVersion - The message version.

isInCleaning

public boolean isInCleaning()

Returns:

Whether the vacuum is currently cleaning.

setInCleaning

public void setInCleaning(boolean inCleaning)

Parameters:

inCleaning - Whether the vacuum is currently cleaning.

getErrorCode

public VacuumStatus.Error getErrorCode()

Returns:

The current error.

setErrorCode

public void setErrorCode(VacuumStatus.Error errorCode)

Parameters:

errorCode - The current error.

getState

public VacuumStatus.State getState()

Returns:

The current status.

setState

public void setState(VacuumStatus.State state)

Parameters:

state - The current status.

getBattery

public int getBattery()

Returns:

The current battery level.

setBattery

public void setBattery(int battery)

Parameters:

battery - The current battery level.

getMsgSeq

public int getMsgSeq()

Returns:

The message sequence.

setMsgSeq

public void setMsgSeq(int msgSeq)

Parameters:

msgSeq - The message sequence.

getCleanTime

public int getCleanTime()

Returns:

The total time spent cleaning.

setCleanTime

public void setCleanTime(int cleanTime)

Parameters:

cleanTime - The total time spent cleaning.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object