Package de.sg_o.app.miio.vacuum

Class VacuumTimer

java.lang.Object

de.sg_o.app.miio.vacuum.VacuumTimer

All Implemented Interfaces:

java.io.Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
VacuumTimer(java.lang.String ID, boolean enabled, int hour, int minute, java.util.HashSet<java.time.DayOfWeek> runDays)	Create a new vacuum timer object.
VacuumTimer(java.lang.String ID, boolean enabled, java.time.LocalTime time, java.util.HashSet<java.time.DayOfWeek> runDays, org.json.JSONArray job)	Create a new vacuum timer object.
VacuumTimer(org.json.JSONArray timer)	Generate a new vacuum timer object from the response of a device.

Method Summary

Modifier and Type	Method	Description
org.json.JSONArray	construct()	Construct the message the controlling device sends to the vacuum.
org.json.JSONArray	construct(boolean server)	Construct the message the vacuum sends to the controlling device or the device sends to the vacuum.
boolean	equals(java.lang.Object o)
java.lang.String	getID()
org.json.JSONArray	getJob()
java.lang.String	getOnOff()
java.util.Set<java.time.DayOfWeek>	getRunDays()
java.time.LocalTime	getTime()
int	hashCode()
boolean	isEnabled()
void	setEnabled(boolean enabled)
void	setJob(org.json.JSONArray job)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

VacuumTimer

public VacuumTimer(java.lang.String ID,
                   boolean enabled,
                   java.time.LocalTime time,
                   java.util.HashSet<java.time.DayOfWeek> runDays,
                   org.json.JSONArray job)

Create a new vacuum timer object.

Parameters:

ID - The timer ID. If null a new DI will be created from the current system time.

enabled - Whether the timer is enabled.

time - The time to start the job.

runDays - The days to run the job at. If null or an empty set, it will be run every day.

job - The job description.

VacuumTimer

public VacuumTimer(java.lang.String ID,
                   boolean enabled,
                   int hour,
                   int minute,
                   java.util.HashSet<java.time.DayOfWeek> runDays)

Create a new vacuum timer object.

Parameters:

ID - The timer ID. If null a new DI will be created from the current system time.

enabled - Whether the timer is enabled.

hour - The hour to start the job.

minute - The minute to start the job at.

runDays - The days to run the job at. If null or an empty set, it will be run every day.

VacuumTimer

public VacuumTimer(org.json.JSONArray timer)
            throws CommandExecutionException

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

Parameters:

timer - The response to parse.

Throws:

CommandExecutionException - WHen the response was invalid.

Method Detail

construct

public org.json.JSONArray construct()

Construct the message the controlling device sends to the vacuum.

Returns:

The constructed message.

construct

public org.json.JSONArray construct(boolean server)

Construct the message the vacuum sends to the controlling device or the device sends to the vacuum.

Parameters:

server - True if the constructed message is in the format from vacuum to controlling device.

Returns:

The constructed message.

getID

public java.lang.String getID()

Returns:

The timers ID.

isEnabled

public boolean isEnabled()

Returns:

Whether the timer is enabled.

getOnOff

public java.lang.String getOnOff()

Returns:

Whether the timer is enabled Either "on" or "fff".

setEnabled

public void setEnabled(boolean enabled)

Parameters:

enabled - Whether the timer is enabled.

getTime

public java.time.LocalTime getTime()

Returns:

The time to start the job.

getRunDays

public java.util.Set<java.time.DayOfWeek> getRunDays()

Returns:

The days to run the job at. If an empty set, it will be run every day.

getJob

public org.json.JSONArray getJob()

Returns:

The job description.

setJob

public void setJob(org.json.JSONArray job)

Parameters:

job - The job description.

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