Code Monkey home page Code Monkey logo

roomba-exporter's Introduction

Roomba exporter

Prometheus exporter for iRobot Roomba robot vacuum cleaners

Configuration

  1. Connect to the same network as the Roomba ๐Ÿ“ถ
  2. Find the Roomba IP, e.g. by running an arp scan arp -a
  3. Obtain the Roomba details
# Get required dependency
npm install

# Follow in-terminal instructions
npx get-roomba-password

Running

  1. Start the Roomba exporter, setting the following environment variables
# Required environment variables
ROOMBA_IP_ADDRESS=<ip from configuration step 2>
USERNAME=<blid from configuration step 3>
PASSWORD=<password from configuration step 3>

# Optional environment variables
PORT=<Port for endpoint exposing metrics> # Defaults to 7000
  1. Run as a standalone container or a sidecar in Kubernetes
docker run \
    -p 7000:7000 \
    --env=ROOMBA_IP_ADDRESS=192.168.87.120 \
    --env=USERNAME=3192801C39119775 \
    --env=PASSWORD=foobarbaz123 \
    quay.io/whirlwin/roomba-exporter:latest

Compatability

Tested with:

  • iRobot Roomba 980 โœ…
  • iRobot Roomba 895 โœ…

roomba-exporter's People

Contributors

whirlwin avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

roomba-exporter's Issues

docker image is private?

The docker image appears to be private:

% docker pull quay.io/whirlwin/roomba-exporter:latest
Error response from daemon: unauthorized: access to the requested resource is not authorized

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.