https://github.com/albinmedoc/cleanmate

Easily control your Cleanmate robot
https://github.com/albinmedoc/cleanmate

Last synced: 24 days ago
JSON representation

Easily control your Cleanmate robot

• Host: GitHub
• URL: https://github.com/albinmedoc/cleanmate
• Owner: albinmedoc
• License: apache-2.0
• Created: 2022-10-18T18:10:52.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-11-05T22:26:37.000Z (over 2 years ago)
• Last Synced: 2024-12-15T11:37:22.937Z (about 2 months ago)
• Language: TypeScript
• Size: 319 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![GitHub last commit](https://img.shields.io/github/last-commit/albinmedoc/cleanmate.svg)](https://github.com/albinmedoc/cleanmate)

[![npm](https://img.shields.io/npm/v/cleanmate?label=npm%20package)](https://github.com/albinmedoc/cleanmate)

[![npm](https://img.shields.io/npm/dt/cleanmate)](https://www.npmjs.com/package/cleanmate)

# Cleanmate

Cleanmate is a popular robot vacuum cleaner in Sweden. This plugin allows you to control it from CLI or node.

Right now there is no official documentation or API over how to control the robot. To develop this library the tcp request to and from the robot has been analyzed. 


**Note:** The code has only been tested for the Cleanmate S995. Please make a Pull Request if you get it working with another model.

## How to get the authentication code

Currenly there is no easy way to get the authentication code (please let me know if there is).

The way to obtain a authentication code is to listen to a tcp packet when your phone sends a command to the robot. [Wireshark](https://www.wireshark.org/) is a great program to use for listening to network traffic.