roborock-controller-api

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #golang #docker #java #windows #awesome #kubernetes #vue #security #pytorch #openai

roborock-controller-api

(★ 12)

Roborock controller API

roborock-controller-api Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Roborock Controller API

![buiild](https://github.com/atheius/roborock-controller-api/actions/workflows/main.yml/badge.svg) ![docker](https://img.shields.io/docker/v/atheius/roborock-controller-api) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

</div>

An API interface for a Roborock vacuum cleaner.

This project was designed as a very simple interface to provide some basic controls without having to use the Roborock mobile app. It allows me to run HTTP requests from other smart devices (e.g. buttons etc.) to control the device.

This project was created using the [fastify-cli](https://github.com/fastify/fastify-cli).

## Install

```sh
pnpm install
```

## Setup

Create a `.env` file in the root directory of the project e.g.

```
DEVICE_ADDRESS=0.0.0.0
DEVICE_TOKEN=11111111111111111111111111111111
```

The device token can be obtained using [this tool](https://github.com/Maxmudjon/Get_MiHome_devices_token).

## Auth

You can enable basic auth with the following env vars:

```
AUTH_ENABLED=true
AUTH_USERNAME=username
AUTH_PASSWORD=password
```

## Bin Schedule

I added the option of a bin schedule to allow me to easily empty the device after cleaning has run.

You can enable a bin schedule with a cron e.g.

```
BIN_SCHEDULE_ENABLED=true
# The location of the bin (requires some trial an error to find grid coordinates!)
BIN_TARGET=10000,10000
# Go to the bin target at 7am every day...
BIN_SCHEDULE_CRON=0 7 * * *
```

## Run

Run the API:

```
pnpm run dev
```

## Docker

To build and run the Docker container:

```sh
# Build the container
docker build -t roborock-controller-api .

# Run the container
docker run \
--env DEVICE_TOKEN="token" \
--env DEVICE_ADDRESS="0.0.0.0" \
-p 3000:3000 \
roborock-controller-api:latest
```

## Examples

Some examples of using the API...

```sh
# Go to dock
curl --request GET 'localhost:3000/go/dock'
```

```sh
# Go to bin
curl --request GET 'localhost:3000/go/bin'
```

roborock-controller-api

roborock-controller-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

roborock-controller-api

roborock-controller-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README