dorita980

Unofficial iRobot Roomba (i7/i7+, 980, 960, e5, 690, 675, etc) node.js library (SDK).

With this library you can send commands to your wifi enabled Roomba through the iRobot cloud API or directly from your LAN and integrate your roboot with your own Home Automation or IoT project.

See rest980 if you need a HTTP REST API interface.

Advice

If you enjoy dorita980 and it works nice for you, I recommend blocking the internet access to your robot to avoid the OTA firmware updates. New firmware changes can cause dorita980 to stop working. Blocking firmware updates can be performed using the parental control options on your router.

When a new firmware is published, you can come here to verify if dorita980 is still compatible. Once dorita980 is compatible you can temporarily enable internet access for your robot to get the firmware upgrade.

If you have firmware version 1.6.x click here to see the old documentation.

Check your robot version!

Features

Compatible robots: all 600, 800, 900, e5 and i7/i7+ series with HOME app and Braava m6.
Get your username/password easily.
Auto discovery robot IP (optional).
Local API control (from your LAN).
Simplified Cleaning Preferences settings.
Firmware 1.6.x compatible.
Firmware 2.x.x compatible (latest serie 900 uses firmware v2, not v3).
Firmware 3.2.x compatible (latest serie 800 uses firmware v3).
See rest980 if you need a HTTP REST API interface to use dorita980 through it.

Latest firmware tested and working: v2.4.16-126

Video: Realtime cleaning map using dorita980 lib in rest980.

Supported Features by Firmware Version

	1.6.x Local	1.6.x Cloud	2.x.x Local	2.x.x Cloud	3.x.x Local
Clean/Start/Stop/Pause/Dock/Resume/CleanRoom/Find	yes	yes	yes	pending	yes
Get Preferences	yes	yes	yes	pending	yes
Set Preferences	yes	yes	yes	pending	yes
Get x,y,d Position	yes	yes	yes	pending	-
Get Mission	yes	yes	yes	pending	yes
Get Mission number	no	no	yes	pending	yes
Get General Info	yes	yes	yes	pending	yes
Get Schedule	yes	yes	yes	pending	yes
Set Schedule	yes	yes	yes	pending	yes
Set CarpetBoost (performance, eco, auto)	yes	yes	yes	pending	-
Set Edge Clean	yes	yes	yes	pending	-
Set Cleaning Passes (auto, on, two)	yes	yes	yes	pending	-
set Always Finish	yes	yes	yes	pending	-
MQTT Custom events	-	-	yes	pending	yes
HTTP API	yes	yes	-	-	-
Discovery Robot IP	yes	-	yes	-	yes
Get BLID and Password	yes	-	yes	-	yes
Support multiples clients at the same time	yes	yes	no	pending	no

Note: some new firmwares are not reporting robot position ('pose' property) to local env.

Install

First you need node.js installed and then:

$ npm install dorita980 --save

Quick start via Local request on your LAN

You can control the robot from your local network.

Create myapp.js file with this content:

var dorita980 = require('dorita980');

var myRobotViaLocal = new dorita980.Local('MyUsernameBlid', 'MyPassword', '192.168.1.104'); // robot IP address

myRobotViaLocal.on('connect', init);

function init () {
  myRobotViaLocal.clean()
  .then(() => myRobotViaLocal.end()) // disconnect to leave free the channel for the mobile app.
  .catch(console.log);
}

Then install dorita980 using npm and run your program:

$ npm install dorita980 --save
$ node myapp.js

Examples

Pause the robot via Local request:

var dorita980 = require('dorita980');

var myRobotViaLocal = new dorita980.Local('MyUsernameBlid', 'MyPassword', '192.168.1.104'); // robot IP address 

myRobotViaLocal.on('connect', init);

function init () {
  myRobotViaLocal.pause()
  .then(() => myRobotViaLocal.end()) // disconnect to leave free the channel for the mobile app.
  .catch(console.log);
}

Get robot week schedule

var dorita980 = require('dorita980');

var myRobotViaLocal = new dorita980.Local('MyUsernameBlid', 'MyPassword', '192.168.1.104'); // robot IP address 

myRobotViaLocal.on('connect', init);

function init () {
  myRobotViaLocal.getWeek()
  .then((weekConfig) => {
    console.log(weekConfig)
    myRobotViaLocal.end()
  })
  .catch(console.log);
}

How to get your username/blid and password

(Needed for Cloud and Local requests)

You need your iRobot account credentials (username and password).

** Option 1 **

Install dorita980 globally and then run the get-roomba-password-cloud command:

$ npm install -g dorita980
$ get-roomba-password-cloud <iRobot Username> <iRobot Password> [Optional API-Key]

** Option 2 **

Clone the repo and then run the npm script:

$ git clone https://github.com/koalazak/dorita980.git
$ cd dorita980
$ npm install
$ npm run get-password-cloud <iRobot Username> <iRobot Password> [Optional API-Key]

** Option 3 **

Docker run command:

docker run -it node sh -c "npm install -g dorita980 && get-roomba-password-cloud <iRobot Username> <iRobot Password> [Optional API-Key]"

** Example Output **

$ npm install -g dorita980
$ get-roomba-password-cloud myemail@example.com myeasypassword
Found 1 robot(s)!
Robot "Dorita" (sku: R98---- SoftwareVer: v2.4.16-126):
BLID=> xxxxxxxxxxxxx
Password=> :1:1486937829:gktkDoYpWaDxCfGh <= Yes, all this string.

Use this credentials in dorita980 lib :)

<details> <summary>Show old firmwares method (local call)</summary>

This method stop working for latest firmwares. If you have problems using this method please use the cloud method.

You need to know your robot IP address (look in your router or scan your LAN network with nmap to find it). Or use the dorita980.getRobotIP() method.

** Local Option 1 **

Install dorita980 globally and then run the get-roomba-password command:

$ npm install -g dorita980
$ get-roomba-password <robotIP>

** Local Option 2 **

Clone the repo and then run the npm script:

$ git clone https://github.com/koalazak/dorita980.git
$ cd dorita980
$ npm install
$ npm run getpassword <robotIP>

** Local Option 3 **

Docker run command:

docker run -it node sh -c "npm install -g dorita980 && get-roomba-password <robotIP>"

** Example Output in local method **

$ npm install -g dorita980
$ get-roomba-password 192.168.1.103

Make sure your robot is on the Home Base and powered on. Then press and hold the HOME button on your robot until it plays a series of tones (about 2 seconds). Release the button and your robot will flash WIFI light.
Then press any key...
{ ver: '2',
  hostname: 'Roomba-xxxxxxxxxxxxx',
  robotname: 'Dorita',
  ip: '192.168.1.103',
  mac: '12:12:12:12:12:12',
  sw: 'v2.0.0-34',
  sku: 'R98----',
  nc: 0,
  proto: 'mqtt',
  blid: 'xxxxxxxxxxxxx' <---- username/blid
}
Password=> :1:1486937829:gktkDoYpWaDxCfGh <= Yes, all this string.
Use this credentials in dorita980 lib :)

</details>

Troubleshoot - Getting the password

Most common issues getting your password are related with:

Mobile application is open: You must close iRobot mobile application on your phone. The robot only support ONE connection at time. You will get a connection error if this is the case.
Other applications are using your robot: Close all your applications or scripts using the robot. Same as frist bullet.
Network connectivity issues: Make sure your computer can reach your robot: nc -zv <robot_ip> 8883 if this command fails check your network.
Slow networks using local method: On some slow networks you need to run the get-roomba-password a couple of times until you get it. This is because UDP packages may be lost.
node.js version: Mostly tested on v10 but also works on v12, v14 and v16. Try using v10.
Wrong button: It is really common people touching CLEAN button on 980 robots instead of HOME button when prompted. Make sure you are pressing the correct button. Some model (like 675) do not have HOME button and you need to press DOCK+SPOT.
Make sure your robot is docked on the Home Base and powered on (short press Clean button once to turn it on. But do not start a cleaning session!)
Robot not configured: Did you configure the Robot for first time with the mobile app? If not, you need to do that first. This process set the actual password.
Sometimes the robot hangs: Reset the robot pressing Clean for 10 seconds aprox. Wait for restart and try again.

Auto discover IP address for local request:

If you don't known which IP address to use in dorita980.Local() you can use dorita980.getRobotIP() to find it. This process takes 1-2 seconds, so if you know the IP you can just use it explicity.

You need UDP brodcast enable in your network!

var dorita980 = require('dorita980');

dorita980.getRobotIP((ierr, ip) => {
  if (ierr) return console.log('error looking for robot IP');

  var myRobotViaLocal = new dorita980.Local('MyUsernameBlid', 'MyPassword', ip);

  myRobotViaLocal.getMission()
  .then((mission) => {
    console.log(mission);
  }).catch((err) => {
    console.log(err);
  });
});

You can also use .discovery method to get all the robots discovery data:

You need UDP brodcast enabled in your network!

var dorita980 = require('dorita980');

dorita980.discovery((ierr, data) => {
  console.log(data);
});

Will print:

{ ver: '2',
  hostname: 'Roomba-xxxxxxxxxxxxx',
  robotname: 'Dorita',
  ip: '192.168.1.103',
  mac: '12:12:12:12:12:12',
  sw: 'v2.0.0-34',
  sku: 'R98----',
  nc: 0,
  proto: 'mqtt' }

Local API

The library send commands directly over wifi to your robot. You dont need an internet connection.

<a href="#Local"><code>dorita980.Local(blid, password, ip, firmwareVersion)</code></a>
<a href="#end"><code>myRobot.end()</code></a>
<a href="#getRobotState"><code>myRobot.getRobotState(waitForFields)</code></a>
<a href="#getPreferences"><code>myRobot.getPreferences()</code></a>
<a href="#setPreferences"><code>myRobot.setPreferences(newPreferences)</code></a>
<a href="#getMission"><code>myRobot.getMission()</code></a>
<a href="#getBasicMission"><code>myRobot.getBasicMission()</code></a>
<a href="#getWirelessStatus"><code>myRobot.getWirelessStatus()</code></a>
<a href="#getTime"><code>myRobot.getTime()</code></a>
<a href="#getBbrun"><code>myRobot.getBbrun()</code></a>
<a href="#getLangs"><code>myRobot.getLangs()</code></a>
<a href="#getSys"><code>myRobot.getSys()</code></a>
<a href="#getWirelessLastStatus"><code>myRobot.getWirelessLastStatus()</code></a>
<a href="#getWeek"><code>myRobot.getWeek()</code></a>
<a href="#setWeek"><code>myRobot.setWeek(newWeek)</code></a>
<a href="#getCloudConfig"><code>myRobot.getCloudConfig()</code></a>
<a href="#start"><code>myRobot.start()</code></a>
<a href="#clean"><code>myRobot.clean()</code></a>
<a href="#cleanRoom"><code>myRobot.cleanRoom(args)</code></a>
<a href="#cleanRoomMultiple"><code>myRobot.cleanRoom(args) for multiple rooms</code></a>
<a href="#pause"><code>myRobot.pause()</code></a>
<a href="#stop"><code>myRobot.stop()</code></a>
<a href="#resume"><code>myRobot.resume()</code></a>
<a href="#dock"><code>myRobot.dock()</code></a>
<a href="#setCarpetBoostAuto"><code>myRobot.setCarpetBoostAuto()</code></a>
<a href="#setCarpetBoostPerformance"><code>myRobot.setCarpetBoostPerformance()</code></a>
<a href="#setCarpetBoostEco"><code>myRobot.setCarpetBoostEco()</code></a>
<a href="#setEdgeCleanOn"><code>myRobot.setEdgeCleanOn()</code></a>
<a href="#setEdgeCleanOff"><code>myRobot.setEdgeCleanOff()</code></a>
<a href="#setCleaningPassesAuto"><code>myRobot.setCleaningPassesAuto()</code></a>
<a href="#setCleaningPassesOne"><code>myRobot.setCleaningPassesOne()</code></a>
<a href="#setCleaningPassesTwo"><code>myRobot.setCleaningPassesTwo()</code></a>
<a href="#setAlwaysFinishOn"><code>myRobot.setAlwaysFinishOn()</code></a>
<a href="#setAlwaysFinishOff"><code>myRobot.setAlwaysFinishOff()</code></a>
<a href="#connect"><code>myRobot.on('connect', callback)</code></a>
<a href="#close"><code>myRobot.on('close', callback)</code></a>
<a href="#offline"><code>myRobot.on('offline', callback)</code></a>
<a href="#update"><code>myRobot.on('update', callback)</code></a>
<a href="#mission"><code>myRobot.on('mission', callback)</code></a>
<a href="#state"><code>myRobot.on('state', callback)</code></a>
<a href="#publish"><code>myRobot.publish('topic', rawJsonMessageAsString,