Eufy-Clean REST Wrapper

Overview

This project is a REST API wrapper around the work done by @martijnpoppen in the eufy-clean repository. It provides an interface to interact with Eufy cleaning devices through REST endpoints.

Disclaimer / Security

This project is not guaranteed to work properly and should be secured properly by the user. Do not expose this app publicly. This was hacked together fairly quickly, does not use any TLS encryption (http only) and is generally not production ready.

Use at your own risk

Installation

Using Docker Compose

1. Clone the repository:

   git clone https://github.com/J2-Tech/eufy-clean-rest-wrapper.git
   cd eufy-clean-rest-wrapper

2. Create a .env file:

   PORT=8081
   HOST=0.0.0.0

3. Build and run the application using Docker Compose:

   docker-compose up --build

Using Node.js

1. Clone the repository:

   git clone https://github.com/J2-Tech/eufy-clean-rest-wrapper.git
   cd eufy-clean-rest-wrapper

2. Install dependencies:

   npm install
   npm run install:eufy-clean

3. Run the application:

   node index.js

Usage

A Postman collection is included in postman-collection.json This collection contains a list of all the endpoints currently supported

Contribution

Feel free to fork or create a PR if you have improvements to suggest

Credits

This project is built on top of the work done by @martijnpoppen in the eufy-clean repository. This program is simply a wrapper around their work, go check it out