Shortcut functions

There are shortcut functions available to run actions on your bot.

Cleaning

vacbot.run("Clean", mode, action);
vacbot.run("SpotArea", "start", areas);
vacbot.run("CustomArea", "start", boundaryCoordinates, numberOfCleanings);
vacbot.run("Edge");
vacbot.run("Spot");

Various control commands

vacbot.run("Charge");
vacbot.run("Stop");
vacbot.run("Pause");
vacbot.run("Resume");
vacbot.run("MoveBackward");
vacbot.run("MoveForward");
vacbot.run("MoveLeft");
vacbot.run("MoveRight");

Retrieve states

vacbot.run("GetCleanState");
vacbot.run("GetChargeState");
vacbot.run("GetBatteryState");
vacbot.run("GetSleepStatus");

Cleaning log and consumable

vacbot.run("GetCleanLogs");
vacbot.run("GetCleanSum");
vacbot.run("GetLifeSpan", "main_brush");
vacbot.run("GetLifeSpan", "side_brush");
vacbot.run("GetLifeSpan", "filter");
vacbot.run("ResetLifeSpan", "main_brush");
vacbot.run("ResetLifeSpan", "side_brush");
vacbot.run("ResetLifeSpan", "filter");

Voice and sound

You can find a list of soundIDs here.

vacbot.run("PlaySound"); // soundID = 0 "startup music chime"
vacbot.run("PlaySound", soundID);
vacbot.run("GetVolume");
vacbot.run("SetVolume", volume);

Position, map data and boundaries

vacbot.run("GetMaps");
vacbot.run("GetSpotAreas", mapID);
vacbot.run("GetSpotAreaInfo", mapID, spotAreaID);
vacbot.run("GetVirtualBoundaries", mapID);
vacbot.run("GetVirtualBoundaryInfo", mapID, virtualBoundaryID);
vacbot.run("DeleteVirtualBoundary", mapID, virtualBoundaryID, boundaryType);
vacbot.run("AddVirtualBoundary", mapID, boundaryCoordinates, boundaryType);
vacbot.run("GetPosition");
vacbot.run("GetChargerPos");
vacbot.run("Relocate");

Vacuum power

vacbot.run("GetCleanSpeed");
vacbot.run("SetCleanSpeed", level);

Mopping and waterbox

vacbot.run("GetWaterLevel");
vacbot.run("SetWaterLevel", level);
vacbot.run("GetWaterBoxInfo");

Various other commands

vacbot.run("GetNetInfo");
vacbot.run("GetOnOff", "do_not_disturb");
vacbot.run("GetOnOff", "continuous_cleaning");
vacbot.run("GetOnOff", "silence_voice_report");
vacbot.run("SetOnOff", "do_not_disturb", value);
vacbot.run("SetOnOff", "continuous_cleaning", value);
vacbot.run("SetOnOff", "silence_voice_report", value);
vacbot.run("GetAutoEmpty");
vacbot.run("SetAutoEmpty", value);