create-oi

KO | EN

gitlite — search

#javascript #python #typescript #llm #go #machine-learning #rust #linux #docker #macos #awesome #kubernetes #security #mcp

(★ 13)

A node.js API for interacting with an iRobot Create/Create2 or Roomba 600 Series. Because robots are fun.

create-oi Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

create-oi: iRobot Create&#174; driver for node
========================================

An API for interacting with an iRobot Create. Because robots are fun.

---
The iRobot Create provides a low-level serial protocol called the "Open Interface" (OI) documented [here](https://cdn-shop.adafruit.com/datasheets/create_2_Open_Interface_Spec.pdf).
What this library attempts to do is implement a simple and intuitive API on top of OI in [node.js](http://nodejs.org/) using the great [serialport](https://github.com/voodootikigod/node-serialport) library.

Prerequisites
-------------
 * iRobot Create (version 1 or 2)
 * Installed usb-serial drivers and connected laptop, Raspberry Pi, Gumstix or similarly node-capable machine to your Create
   * see: [Windows installation instructions](https://www.ftdichip.com/Support/Documents/InstallGuides/AN_396%20FTDI%20Drivers%20Installation%20Guide%20for%20Windows%2010.pdf) if using a windows laptop (linux comes with drivers, macs will need [FTDI drivers](http://www.ftdichip.com/Drivers/D2XX.htm))
 * node and npm are installed (on above machine)

Installation
------------
```sh
npm install --save create-oi
```

Getting Started
-----
After plugging in your Create USB cable you'll need to find 
out what serial port your operating system has assigned your Create.

On linux:
```sh
$ dmesg | grep tty
```
On a mac:
```sh
$ ls /dev/tty.*
```
On a windows box, open device manager and look under "Ports":
```bat
C:\> mmc devmgmt.msc
```

In your code you'll probably want to start with these two lines:
```javascript
var robot = require("create-oi");

robot.init({ serialport: "/dev/tty.usbserial-A2001nf6", version: 1 }); // use version: 2 if using a Create2
```
Make sure to set your `serialport` to the device name you found earlier. 
On my mac for me this is `"/dev/tty.usbserial-A2001nf6"`. Yours _will_ be different.

The API is event-based, meaning all the important stuff happens in event callbacks.
The first event you'll need to deal with is the `ready` event which gets fired when
the module sucessfully connects to the Create over the serial port. Note that the 
`this` context for all your callback handlers will be set to the `create-oi` module 
itself, so you can easily call `drive`, `rotate` or any other module method within a 
callback. Several events such as `bump` or `wheeldrop` will contain information about 
which specific sensor was triggered inside the event parameter passed into your 
callback function.

```javascript
robot.on('ready', function() {
    // twirl towards freedom
    this.rotate(100);
});

robot.on('bump', function(bumpEvent) {
    console.log(bumpEvent.direction);
    ...
});
```

Examples
--------
Working examples (provided you change the serial port) can be found in the examples directory.

API Docs
--------
See the [API Reference](https://github.com/drzaiusx11/create-oi/wiki/API-Reference) on the wiki.

create-oi

create-oi Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

create-oi

create-oi Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README