Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

homebridge-nodemcu-roomba876

Package Overview
Dependencies
Maintainers
1
Versions
15
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

homebridge-nodemcu-roomba876

Roomba876 for Homebridge via nodemcu microcontroller

  • 0.1.23
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
3
Maintainers
1
Weekly downloads
 
Created
Source

This project is to add iRobot roomba 876 (or others without smart/WiFi capabilities) controlls over Apple Home.

npm version

homebridge-nodemcu-roomba876

This Homebridge plugin adds switch, battery level and charge status intrefaces via REAT API calls underneath.

API calls go to nodemcu (esp8266) WiFi microcontroller connected to iRobot roomba to read its status and control it.

See Hardware requirements to make it work for you and your roomba.

Credits

This code was built upon the work in the following projects:

Prerequisities

  • iRobot romba without WiFi capabilities (otherwise, you don't need nodemcu and extra code), my model is 876 but most of robots are having the same open interface (OI) spec so should work well
  • Raspberry Pi or any other Mac/PC to host homebridge software
  • Nodemcu microcontroller to run HTTP REST API server and proxy homebrdge commands to roomba

Features

  • Start/stop Roomba `Hey Siri, start Roomba*
  • Check on/off status Hey Siri, is the Roomba on?
  • Check charging status Hey Siri, is the Roomba charging?
  • Check battery status Hey Siri, is the Roomba charged?

Installation

npm install -g homebridge-nodemcu-roomba876

Homebridge configuration

Add to your config.json's accessory section (add only accessories entry, don't copy whole code shippet):

{
    "bridge": {
		"name": "Homebridge",
		"username": "CD:22:3D:E3:CE:30",
		"port": 51826,
		"pin": "123-45-678"
    },
    "description": "My Homebridge",
    "platforms": [],
    "accessories": [
		{
			"accessory": "Roomba876",
			"model":"876",
			"name": "Roomba",
			"hostname": "http://mdns-host-or-ip-address-of-your-roomba-nodemcu",
		}
    ]
}

The Model and Name options can be set to whatever you'd like. Hostname is an IP address of nodemcu's microcontroller or its mDNS host name used

Nodemcu

This is separate hardware to listen on host/IP with REST interface accepting API calls from this homebridge plugin.

It should be developed and flashed separately from this plugin. You can use Arduino IDE to develop and flash it.

It passes commands from homebridge/Siri to roomba over open interface port (OI).

Source

Source is located in nodemcu folder of this project. But rest of the routine is up to you.

Wiring

TBD

Keywords

FAQs

Package last updated on 13 Nov 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc