GithubHelp home page GithubHelp logo

aimproxy / libroomba Goto Github PK

View Code? Open in Web Editor NEW
16.0 1.0 1.0 46 KB

Unofficial Roomba C Library for V2 and V3 firmware to control your robot (on LAN)

License: GNU General Public License v3.0

C 96.14% Meson 3.86%
c roomba irobot dorita980 roomba980 socket-programming wolfssl wolfmqtt sdk iot

libroomba's Introduction

roomba_gif

LibRoomba

GitHub GitHub last commit

The intention of this project is making an implementation of dorita980 in C.

This project has been implemented in C for firmwares V2 and V3. With this library you can send commands to your wifi enabled Roomba through the iRobot directly from your LAN.

I recommend blocking the internet access to your robot to avoid the OTA firmware updates, new OTA can cause libroomba to stop working.

If you enjoy libroomba and it works nice for you, please give me a star.

How to contribute

If you wanna contribute to the project, please make a fork, write your code and then submit a PR.

Features

  • Get username/password easily from Roomba
  • Auto discovery roomba IP
  • Control your robot with the local API
  • Firmware 2.x.x/3.x.x compatible

Commands

Commands 2.x.x Local 3.x.x Local
Clean yes yes
Start yes yes
Stop yes yes
Pause yes yes
Dock yes yes
Resume yes yes
Discovery Robot IP yes yes
Get BLID and Password yes yes

Dependencies

  • wolfSSL with oldTLS support which contains AES128-SHA256 cipher suite
  • wolfMQTT with TLS support
  • Json-C

Building

git clone https://github.com/roombavacuum/libroomba.git && cd home
meson build && cd build
ninja

How to Use it

Discovery

Discover your Roomba through the network. This function sends a probe to the broadcast until find a roomba!

cd build/examples
./discovery

Get Robot Info

This function gives you the basic information about the robot, such as firmaware version, hostname, the ip, and the blid.

cd build/examples
./getRobotInfo

Get Password

This method will only work correctly if you have triggered wifi mode by holding the HOME button for several seconds until the roomba beeps.

cd build/examples
./getPassword

Exec a command

Pass the desired command in argv[1]

./startRoomba "clean"

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.