diff --git a/README.md b/README.md index 46f12733..bb0d8603 100644 --- a/README.md +++ b/README.md @@ -11,16 +11,16 @@ This is a modified version of [Valetudo by Hypher](https://github.com/Hypfer/Val * Ability to select multiple saved zones at once; * Selected zones optionally shown at the map tab to see and edit what's actually going to be cleaned; -* Renaming zones and spots, since why not? * Configurable virtual walls and forbidden zones, finally! * Scheduled zoned cleaning - when you do not need to clean the whole house; -* Ability to specify in webGUI the number of iterations to clean the same zone multiple times; +* Ability to specify the number of iterations to clean the same zone multiple times; * Showing status of the device on the map; * Set of dynamically appearing buttons on the map to better control device from there; * Experimental ability to save/restore maps; -* Random visual changes: using different colors and icons here and there, some behavioral changes when working with maps and so on. +* A telegram bot software for remote control from the outside world; +* A number of visual changes and under-the-hood optimizations. -**Also webUI localization is supported since 0.4.0-RE7!** +**Also localization is supported since 0.4.0-RE7!** Currently available for en/de/ru/bg. Add your own native language support by editing ./client/locales/en.json template and sending a PR. ---- @@ -51,5 +51,6 @@ Check [deployment section](/deployment) or [this wiki page](https://github.com/r ### Join the Discussion * [Valetudo Telegram group](https://t.me/joinchat/AR1z8xOGJQwkApTulyBx1w) -### Resources -* [valetudo-mapper](https://github.com/rand256/valetudo-mapper) - A companion service for PNG Maps +### Getting map picture for integrations +* [valetudo-mapper](https://github.com/rand256/valetudo-mapper) - a companion service for generating PNG Maps +* You can also try to request a simple map from Valetudo RE itself via http at `/api/simple_map`, but it shouldn't be called too often since resources of the vacuum are limited. diff --git a/deployment/README.md b/deployment/README.md index 8f9ed71d..b399fefb 100644 --- a/deployment/README.md +++ b/deployment/README.md @@ -1,6 +1,36 @@ ### Downloading pre-built Valetudo -You can simply download pre-built binaries of Valetudo from the [releases](https://github.com/rand256/valetudo/releases) section of the repo. If downloaded binary is compressed to .tar.gz format, you need to unpack it first. +You can simply download pre-built binaries of Valetudo from the +[releases](https://github.com/rand256/valetudo/releases) section of the repo. +It is currently distrubuted in three different ways: + +* **valetudo.tar.gz** + + This is a single binary file packed with tar+gzip compression. To use it, + start with unpacking it typing `tar zxf valetudo.tar.gz` or via your favourite + GUI (de)compressing tool. Continue reading from *Installing and configuring* + section on what to do next. + +* **valetudo_**_**version**_**_armhf.deb** + + This is a package containing both valetudo binary and its configuration files. + You need to put it on the device to i.e. /mnt/data directory and then it can be + installed by issuing `deb -i valetudo_/version/_armhf.deb` on the console. + It will unpack itself and put all the files to the required places, so you won't + need to create them yourself. After installation you will only have to restart + the device using `reboot` command. + +* **v11_**_**version**_**.pkg** + + The last way to get prebuilt valetudo onto your device is to flash one of these firmware + images with valetudo preinstalled inside. It can be easily done using + [XVacuum](https://forum.xda-developers.com/android/apps-games/app-xvacuum-firmware-xiaomi-vacuum-t3896526) + app for your smartphone. Vacuum Gen.1 has firmware version numbers like **003xxx** and vacuum Gen.2 + (roborock S5) has firmware version numbers like **001xxx**. After flashing the firmware you will + immediately have working device with valetudo preinstalled. Next you should connect + to its access point and visit http://192.168.8.1 site to setup Wi-Fi settings. + +You can use any of these also for upgrading an older valetudo version to current one. ### Acquiring sources and building Valetudo diff --git a/develop/HOWTO.md b/develop/HOWTO.md index 265c0905..2cffd3ec 100644 --- a/develop/HOWTO.md +++ b/develop/HOWTO.md @@ -18,7 +18,7 @@ Install git and npm: ``` cd ~ -git clone https://github.com/Hypfer/Valetudo.git +git clone https://github.com/rand256/valetudo.git ``` ### 3. Install dependencies diff --git a/package.json b/package.json index 9f7f3da7..c66db7b4 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { - "name": "valetudo", - "version": "0.4.0-RE7", + "name": "valetudo-re", + "version": "0.8.0", "description": "Self-contained control webinterface for xiaomi vacuum robots", "main": "index.js", "bin": "index.js", @@ -12,7 +12,7 @@ }, "scripts": { "test": "echo \"Error: no test specified\" && exit 1", - "build": "pkg --targets node10-linux-armv7 --no-bytecode --options max-old-space-size=32,optimize_for_size --public-packages=prettycron ." + "build": "pkg --targets node10-linux-armv7 --no-bytecode --options max-old-space-size=32,optimize_for_size --public-packages=prettycron . --output valetudo" }, "author": "", "dependencies": {