Skip to content

Latest commit

 

History

History
109 lines (76 loc) · 2.68 KB

HOWTO.md

File metadata and controls

109 lines (76 loc) · 2.68 KB

Building and Modifying Valetudo

This file provides instructions for quickly setting up an environment where you can build and modify Valetudo according to your needs.

It shows a complete setup from scratch, on a freshly installed Ubuntu 18.04 system.

Your mileage may vary if you're using a different OS, or if you start from a different setup. However, it should be rather easy to understand the steps, and to adapt them to your situation.

1. Install prerequisites

Install git and npm:

sudo apt install git npm

2. Clone the repository

cd ~
git clone https://github.com/Hypfer/Valetudo.git

3. Install dependencies

cd Valetudo
npm install

4. Create configuration

./develop/run

On the first invocation, this script will create the files that you'll need for your local setup, and it will tell you to to edit them. It is expected behavior for the script to fail on first run, and you must provide the following configuration in develop/local/ directory:

  • env: Define the local port and the vacuum address

    export VAC_WEBPORT=8080
export VAC_ADDRESS=192.168.1.10

  • device.conf: copy it from the robot, e.g. scp root@vacuum:/mnt/default/device.conf develop/local/ You need to at least provide the model= line. Note that key refers to the cloud key, not the local one.

    did=
key=
vendor=
mac=
model=roborock.vacuum.s5

  • device.token: copy it from the robot, e.g. scp root@vacuum:/mnt/data/miio/device.token develop/local/ Or manually put in the token, e.g. 00000000000000000000000000000000

  • config.json: define map_upload_host if you need to test map uploading as well

Once you finished editing the files, you should be all set.

5. Verify configuration and run

./develop/run

If your configuration is correct, Valetudo should now be working on your development host.

6. Code!

Modify the source code according to your needs, and restart the server as needed -- you can always run it as:

./develop/run

7. Build and install on the device

When you're done with your modifications, here's how to build the executable for the robot:

npm run build

You can also create the build with the provider Dockerfile (e.g. when you're on a different OS than Linux). Create the build environment container with:

docker build .

Run the container with

docker run <image_id>

Copy the output file from the container with

docker cp <container_id>:valetudo valetudo

The output file valetudo is a binary file that you can copy to the device:

scp ./valetudo [email protected]:/usr/local/bin/

Once you're that far, you hopefully don't need any further advice.