Package de.sg_o.app.miio.vacuum

Class Vacuum

java.lang.Object

de.sg_o.app.miio.base.Device

de.sg_o.app.miio.vacuum.Vacuum

All Implemented Interfaces:

java.io.Serializable

public class Vacuum
extends Device
implements java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Vacuum(java.net.InetAddress ip, Token token, int timeout, int retries)	Create an object for communicating with the Mi Robot an the Roborock.

Method Summary

Modifier and Type	Method	Description
boolean	addTimer(VacuumTimer timer)	Add a new scheduled cleanup.
boolean	cleanArea(float x0, float y0, float x1, float y1, int passes)	Clean the specified area on the map.
boolean	cleanArea(int[] bottomLeft, int[] topRight, int passes)	Clean the specified area on the map.
boolean	cleanAreaFromMap(int x0, int y0, int x1, int y1, int passes)	Clean the specified area on the map.
VacuumConsumableStatus	consumableStatus()	Get the vacuums consumables status.
boolean	disableDoNotDisturb()	Disable the do not disturb timer.
boolean	findMe()	Make the vacuum make a sound to find it
VacuumCleanup[]	getAllCleanups()	Get an array with the details of all cleanups.
org.json.JSONObject	getCarpetModeState()	Get the current carpet cleaning settings.
VacuumDoNotDisturb	getDoNotDisturb()	Get the current do not disturb settings from the device
int	getFanSpeed()	Get the vacuums current fan speed setting.
java.lang.String	getSerialnumber()	Get the vacuums serial number.
int	getSoundVolume()	Get the current volume.
VacuumTimer[]	getTimers()	Get all stored scheduled cleanups.
java.util.TimeZone	getTimezone()	Get the vacuums current timezone.
long	getTotalCleanedArea()	Get the vacuums total cleaned area.
long	getTotalCleaningTime()	Get the total time the vacuum has been cleaning.
long	getTotalCleans()	Get the total number of cleanups the vacuum has performed.
boolean	goTo(float x, float y)	Go to the specified position on the map.
boolean	goTo(int[] p)	Go to the specified position on the map.
boolean	goToMapPosition(int x, int y)	Go to the specified position on the map.
boolean	home()	Send the vacuum to its docking station.
VacuumSounpackInstallState	installSoundpack(java.lang.String url, java.lang.String md5, int soundId)	Install a new soundpack to the device.
boolean	manualControlMove(float rotationSpeed, float speed, int runDuration)	Manually control the robot
boolean	manualControlStart()	Enable manual remote controls.
boolean	manualControlStop()	Disable manual remote controls.
boolean	pause()	Pause the cleanup.
boolean	removeTimer(VacuumTimer timer)	Delete a scheduled cleanup.
boolean	resetConsumable(VacuumConsumableStatus.Names consumable)	Reset a vacuums consumable.
boolean	setCarpetMode(boolean enabled, int high, int low, int integral, int stallTime)	Change the carped cleaning settings.
boolean	setDoNotDisturb(VacuumDoNotDisturb dnd)	Set the do not disturb timer.
boolean	setFanSpeed(int speed)	Set the vacuums fan speed setting.
boolean	setSoundVolume(int volume)	Set the vacuums volume.
boolean	setTimerEnabled(VacuumTimer timer)	Enable or disable a scheduled cleanup.
boolean	setTimezone(java.util.TimeZone zone)	Set the vacuums timezone
VacuumSounpackInstallState	soundpackInstallStatus()	Get the current soundpack installation status.
boolean	spotCleaning()	Clean the area around the vacuums current position
boolean	start()	Start the cleanup.
VacuumStatus	status()	Get the vacuums status.
boolean	stop()	Stop the cleanup.
boolean	testSoundVolume()	Make the vacuum produce a test sound.

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

Vacuum

public Vacuum(java.net.InetAddress ip,
              Token token,
              int timeout,
              int retries)

Create an object for communicating with the Mi Robot an the Roborock.

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.

timeout - The timeout for the communication

retries - The number of retries after a failed communication

Method Detail

status

public VacuumStatus status()
                    throws CommandExecutionException

Get the vacuums status.

Returns:

The vacuums status.

Throws:

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

getTimezone

public java.util.TimeZone getTimezone()
                               throws CommandExecutionException

Get the vacuums current timezone.

Returns:

The current timezone.

Throws:

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

setTimezone

public boolean setTimezone(java.util.TimeZone zone)
                    throws CommandExecutionException

Set the vacuums timezone

Parameters:

zone - The new timezone to set.

Returns:

True if the command has been received successfully.

Throws:

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

consumableStatus

public VacuumConsumableStatus consumableStatus()
                                        throws CommandExecutionException

Get the vacuums consumables status.

Returns:

The consumables status.

Throws:

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

resetConsumable

public boolean resetConsumable(VacuumConsumableStatus.Names consumable)
                        throws CommandExecutionException

Reset a vacuums consumable.

Parameters:

consumable - The consumable to reset

Returns:

True if the consumable has been reset.

Throws:

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

start

public boolean start()
              throws CommandExecutionException

Start the cleanup.

Returns:

True if the command has been received correctly.

Throws:

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

pause

public boolean pause()
              throws CommandExecutionException

Pause the cleanup.

Returns:

True if the command has been received correctly.

Throws:

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

stop

public boolean stop()
             throws CommandExecutionException

Stop the cleanup.

Returns:

True if the command has been received correctly.

Throws:

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

home

public boolean home()
             throws CommandExecutionException

Send the vacuum to its docking station.

Returns:

True if the command has been received correctly.

Throws:

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

spotCleaning

public boolean spotCleaning()
                     throws CommandExecutionException

Clean the area around the vacuums current position

Returns:

True if the command has been received correctly.

Throws:

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

findMe

public boolean findMe()
               throws CommandExecutionException

Make the vacuum make a sound to find it

Returns:

True if the command has been received correctly.

Throws:

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

getFanSpeed

public int getFanSpeed()
                throws CommandExecutionException

Get the vacuums current fan speed setting.

Returns:

The fan speed.

Throws:

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

setFanSpeed

public boolean setFanSpeed(int speed)
                    throws CommandExecutionException

Set the vacuums fan speed setting.

Parameters:

speed - The new speed to set.

Returns:

True if the command has been received correctly.

Throws:

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

getTimers

public VacuumTimer[] getTimers()
                        throws CommandExecutionException

Get all stored scheduled cleanups.

Returns:

An array with all timers. Is empty if no timer has been set on the device.

Throws:

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

addTimer

public boolean addTimer(VacuumTimer timer)
                 throws CommandExecutionException

Add a new scheduled cleanup.

Parameters:

timer - The new timer to set.

Returns:

True if the command was received successfully.

Throws:

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

setTimerEnabled

public boolean setTimerEnabled(VacuumTimer timer)
                        throws CommandExecutionException

Enable or disable a scheduled cleanup.

Parameters:

timer - The timer to update.

Returns:

True if the command was received successfully.

Throws:

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

removeTimer

public boolean removeTimer(VacuumTimer timer)
                    throws CommandExecutionException

Delete a scheduled cleanup.

Parameters:

timer - The timer to remove.

Returns:

True if the command was received successfully.

Throws:

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

getDoNotDisturb

public VacuumDoNotDisturb getDoNotDisturb()
                                   throws CommandExecutionException

Get the current do not disturb settings from the device

Returns:

The do not disturb settings.

Throws:

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

setDoNotDisturb

public boolean setDoNotDisturb(VacuumDoNotDisturb dnd)
                        throws CommandExecutionException

Set the do not disturb timer.

Parameters:

dnd - The new settings to set.

Returns:

True if the command was received successfully.

Throws:

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

disableDoNotDisturb

public boolean disableDoNotDisturb()
                            throws CommandExecutionException

Disable the do not disturb timer.

Returns:

True if the command was received successfully.

Throws:

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

goToMapPosition

public boolean goToMapPosition(int x,
                               int y)
                        throws CommandExecutionException

Go to the specified position on the map.

Parameters:

x - The x position to move to in pixel. 512 pixel is the center of the map.

y - The y position to move to in pixel. 512 pixel is the center of the map.

Returns:

True if the command has been received correctly.

Throws:

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

goTo

public boolean goTo(float x,
                    float y)
             throws CommandExecutionException

Go to the specified position on the map.

Parameters:

x - The x position to move to in meters. 25.6 meters is the center of the map.

y - The y position to move to in meters. 25.6 meters is the center of the map.

Returns:

True if the command has been received correctly.

Throws:

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

goTo

public boolean goTo(int[] p)
             throws CommandExecutionException

Go to the specified position on the map.

Parameters:

p - The position to move to in millimeters. 25600 millimeter both in x and y is the center of the map. The origin of the map is 0 millimeters in x and y.

Returns:

True if the command has been received correctly.

Throws:

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

cleanAreaFromMap

public boolean cleanAreaFromMap(int x0,
                                int y0,
                                int x1,
                                int y1,
                                int passes)
                         throws CommandExecutionException

Clean the specified area on the map.

Parameters:

x0 - The x position of the first point defining the area in pixel. 512 pixel is the center of the map.

y0 - The y position of the first point defining the area in pixel. 512 pixel is the center of the map.

x1 - The x position of the second point defining the area in pixel. 512 pixel is the center of the map.

y1 - The y position of the second point defining the area in pixel. 512 pixel is the center of the map.

passes - The number of times to clean this area.

Returns:

True if the command has been received correctly.

Throws:

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

cleanArea

public boolean cleanArea(float x0,
                         float y0,
                         float x1,
                         float y1,
                         int passes)
                  throws CommandExecutionException

Clean the specified area on the map.

Parameters:

x0 - The x position of the first point defining the area in meters. 25.6 meters is the center of the map.

y0 - The y position of the first point defining the area in meters. 25.6 meters is the center of the map.

x1 - The x position of the second point defining the area in meters. 25.6 meters is the center of the map.

y1 - The y position of the second point defining the area in meters. 25.6 meters is the center of the map.

passes - The number of times to clean this area.

Returns:

True if the command has been received correctly.

Throws:

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

cleanArea

public boolean cleanArea(int[] bottomLeft,
                         int[] topRight,
                         int passes)
                  throws CommandExecutionException

Clean the specified area on the map.

Parameters:

bottomLeft - The bottom left position of the area in millimeters. 25600 millimeter both in x and y is the center of the map. The origin of the map is 0 millimeters in x and y.

topRight - The top right position of the area in millimeters. 25600 millimeter both in x and y is the center of the map. The origin of the map is 0 millimeters in x and y.

passes - The number of times to clean this area.

Returns:

True if the command has been received correctly.

Throws:

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

getTotalCleaningTime

public long getTotalCleaningTime()
                          throws CommandExecutionException

Get the total time the vacuum has been cleaning.

Returns:

The time the device spent cleaning.

Throws:

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

getTotalCleanedArea

public long getTotalCleanedArea()
                         throws CommandExecutionException

Get the vacuums total cleaned area.

Returns:

The total area the device has cleaned.

Throws:

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

getTotalCleans

public long getTotalCleans()
                    throws CommandExecutionException

Get the total number of cleanups the vacuum has performed.

Returns:

The number of cleanups the device has performed.

Throws:

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

getAllCleanups

public VacuumCleanup[] getAllCleanups()
                               throws CommandExecutionException

Get an array with the details of all cleanups.

Returns:

An array with the details of all cleanups. Empty if no cleanups were performed.

Throws:

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

getSoundVolume

public int getSoundVolume()
                   throws CommandExecutionException

Get the current volume.

Returns:

The current set volume of the device between 0 and 100.

Throws:

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

setSoundVolume

public boolean setSoundVolume(int volume)
                       throws CommandExecutionException

Set the vacuums volume.

Parameters:

volume - The volume between 0 and 100.

Returns:

True if the command was received successfully.

Throws:

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

testSoundVolume

public boolean testSoundVolume()
                        throws CommandExecutionException

Make the vacuum produce a test sound.

Returns:

True if the command was received successfully.

Throws:

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

manualControlStart

public boolean manualControlStart()
                           throws CommandExecutionException

Enable manual remote controls.

Returns:

True if the command has been received correctly.

Throws:

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

manualControlStop

public boolean manualControlStop()
                          throws CommandExecutionException

Disable manual remote controls.

Returns:

True if the command has been received correctly.

Throws:

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

manualControlMove

public boolean manualControlMove(float rotationSpeed,
                                 float speed,
                                 int runDuration)
                          throws CommandExecutionException

Manually control the robot

Parameters:

rotationSpeed - The speed of rotation in deg/s.

speed - The speed of the robot in m/s. Must be greater then -0.3 and less then 0.3.

runDuration - The time to run the command in ms. Values less than 0 will be replaced by a default value of 1000ms.

Returns:

True if the command has been received correctly.

Throws:

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

installSoundpack

public VacuumSounpackInstallState installSoundpack(java.lang.String url,
                                                   java.lang.String md5,
                                                   int soundId)
                                            throws CommandExecutionException

Install a new soundpack to the device.

Parameters:

url - The url the soundpack should be downloaded from.

md5 - The md5 checksum of the new soundpack.

soundId - The ID of the soundpacks language.

Returns:

The current installation status.

Throws:

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

soundpackInstallStatus

public VacuumSounpackInstallState soundpackInstallStatus()
                                                  throws CommandExecutionException

Get the current soundpack installation status.

Returns:

The current soundpack installation status.

Throws:

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

getCarpetModeState

public org.json.JSONObject getCarpetModeState()
                                       throws CommandExecutionException

Get the current carpet cleaning settings.

Returns:

The current carpet cleaning settings.

Throws:

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

setCarpetMode

public boolean setCarpetMode(boolean enabled,
                             int high,
                             int low,
                             int integral,
                             int stallTime)
                      throws CommandExecutionException

Change the carped cleaning settings.

Parameters:

enabled - Weather the carped cleanup mode should be enabled.

high - The high parameter of the carped cleanup.

low - The low parameter of the carped cleanup.

integral - The integral parameter of the carped cleanup.

stallTime - The stall time parameter of the carped cleanup.

Returns:

True if the command has been received successfully.

Throws:

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

getSerialnumber

public java.lang.String getSerialnumber()
                                 throws CommandExecutionException

Get the vacuums serial number.

Returns:

The vacuums serial number.

Throws:

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