dorita980

The dorita980 library provides two primary ways to interact with your Roomba 980 (Firmware 1.6.6):

1. Local Connection (dorita980.Local): Sends commands directly over WiFi to your robot on your LAN. This does not require an internet connection. You must provide the robot's IP address and the firmware major version.
2. Cloud Connection (dorita980.Cloud): Controls the robot via the iRobot cloud API. This allows control from inside or outside your home without needing the robot's local IP address.

Both methods require your robot's username/blid and password.

var dorita980 = require('dorita980');

// Local connection example
var myRobotViaLocal = new dorita980.Local('MyUsernameBlid', 'MyPassword', '192.168.1.104', 1);

// Cloud connection example
var myRobotViaCloud = new dorita980.Cloud('MyUsernameBlid', 'MyPassword', 1);

To use the library, you need your robot's credentials. You can retrieve them by running the getpassword script from the repository clone:

1. Clone the repo: git clone https://github.com/koalazak/dorita980.git
2. Install dependencies: npm install
3. Run the script: npm run getpassword <robotIP> <firmwareversion>

Physical Robot Steps:

• Ensure the robot is on the Home Base and powered on.
• Press and hold the HOME button for about 2 seconds until it plays a series of tones.
• Release the button; the WIFI light will flash.
• The script will then output your Password and Username/blid.

$ npm run getpassword 192.168.1.103 1

The dorita980 library is compatible with Node.js versions greater than 4.0. If you are using Node.js v0.10, you must use the --harmony flag to use the getpassword feature.

$ node --harmony ./bin/getpassword.js "192.168.1.104"

To control your robot from anywhere (inside or outside your home), use dorita980.Cloud. You do not need to provide a robot IP address, only the credentials and the firmware major version.

var dorita980 = require('dorita980');

var myRobotViaCloud = new dorita980.Cloud('MyUsernameBlid', 'MyPassword', 1);

// start to clean!
myRobotViaCloud.start().then((response) => {
  console.log(response);
}).catch((err) => {
  console.log(err);
});

Install the unofficial iRobot Roomba 980 Node.js SDK via npm to control your robot through the iRobot cloud API or directly via your local LAN.

$ npm install dorita980 --save

To control your robot from your local network, instantiate dorita980.Local with your credentials, the robot's IP address, and the firmware major version (e.g., 1 for firmware 1.6.6).

var dorita980 = require('dorita980');

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

// start to clean!
myRobotViaLocal.start().then((response) => {
  console.log(response);
}).catch((err) => {
  console.log(err);
});

If you do not know your robot's IP address, you can use the dorita980.getRobotIP() method to find it on your network. This process typically takes 1-2 seconds.

var dorita980 = require('dorita980');

dorita980.getRobotIP(function (ierr, ip) {
  if (!ierr) {
    var myRobotViaLocal = new dorita980.Local('MyUsernameBlid', 'MyPassword', ip);
    // Use the discovered IP to perform actions
  } else {
    console.log('error looking for robot IP');
  }
});

Instead of manually constructing a setPreferences object, you can use these helper methods to toggle specific cleaning settings:

• setCarpetBoostAuto() / setCarpetBoostPerformance() / setCarpetBoostEco()
• setEdgeCleanOn() / setEdgeCleanOff()
• setCleaningPassesAuto() / setCleaningPassesOne() / setCleaningPassesTwo()
• setAlwaysFinishOn() / setAlwaysFinishOff()

When using the getpassword tool for newer firmware (V2), you can control the TLS connection behavior using environment variables:

• ROBOT_CIPHERS: Specifies the allowed ciphers. Defaults to AES128-SHA256,TLS_AES_256_GCM_SHA384.
• ROBOT_TLS_LEGACY: If set to anything other than '0', the tool will attempt to use SSL_OP_LEGACY_SERVER_CONNECT to support older TLS implementations.

# Example setting a custom cipher
ROBOT_CIPHERS='YOUR_CIPHER_STRING' npm run getpassword <robot_ip_address>

# Example enabling legacy TLS support
ROBOT_TLS_LEGACY='1' npm run getpassword <robot_ip_address>