Skip to content

Latest commit

 

History

History
184 lines (143 loc) · 5.96 KB

README.md

File metadata and controls

184 lines (143 loc) · 5.96 KB
Raw

This is CI for automatically build docker images of ICantBelieveItsNotValetudo

Images can be found at Docker Hub: ptmn/icantbelieveitsnotvaletudo

docker run ptmn/icantbelieveitsnotvaletudo
valetudo

I can't believe it's not Valetudo

This is a simple map generation companion service for Valetudo which does all the heavy lifting. Since both CPU and memory are limited on the robot, PNG generation for third-party components has been moved here. The service receives raw map data from the robot via MQTT, renders a map and publishes the resulting PNG image via MQTT.

Feel free to open PRs with improvements.

Important note

ICBINV sucks. I am aware of that. You should be too.
It is hard to use, it performs badly and it is also not required in many setups.

If you're using Home Assistant, you only need something like this if you want to send the map image somewhere. (e.g. a Telegram Bot)
For that, however, it would be a cleaner solution to have a custom component, which renders the map data to a camera entity, as that would eliminate the mqtt detour, the need for a docker container etc., while being much easier to use with multiple robots.

For non-homeassistant-users something like ICBINV is probably still required.
A rewrite won't hurt though. Especially since it currently depends on a native dependency which is always just painful.

Installation

I can't believe it's not Valetudo is built with JavaScript and requires Node.js and npm to run.

Installation is easy: Clone this repository and run npm install to install dependencies. Then run npm start to start the service. If you prefer running services in containers, this repository includes a dockerfile for you.

Configuration

To configure I can't believe it's not Valetudo, create a file called config.json in the working directory. You can also run npm start to automatically create a default configuration file. If you are running in docker, map the configuration file to /app/config.json .

A basic example configuration would look like this:

{
    "mapSettings": {
        "drawPath": true,
        "drawCharger": true,
        "drawRobot": true,
        "scale": 2
    },
    "mqtt" : {
        "identifier": "rockrobo",
        "topicPrefix": "valetudo",
        "autoconfPrefix": "homeassistant",
        "broker_url": "mqtt://user:pass@foobar.example",
        "caPath": "",
        "mapDataTopic": "valetudo/robot/MapData/map-data",
        "minMillisecondsBetweenMapUpdates": 10000,
        "publishMapImage": true,
        "publishAsBase64": false
    },
    "webserver": {
        "enabled": false,
        "port": 3000
    }
}

Integration with FHEM, ioBroker, openHAB etc

If you set webserver.enabled to true, the map PNG will be available at http://host:port/api/map/image so you can display a map with any home automation software that allows fetching images from a URL. The map will also be available as base64-encoded string at http://host:port/api/map/base64. By default, the image data is published via MQTT to mqtt.topicPrefix/mqtt.identifier/MapData/map, if mqtt.publishAsBase64 is set to true, the image data is published as base64-encoded string (a.e. for openHAB).

Advanced Map Configuration

The appearance of the map is configured by the mapSettings

object. The default settings already produce a nice map, but you can use these advanced settings to further customize the map for better integration into your home automation.

Scaling

Since the map data has a resolution of approximately 5 cm per pixel, the resulting images have a relatively low resolution. The map is therefore scaled up by a factor of 2 by default. The scaling factor can be configured by setting mapSettings.scale to the desired value.

To avoid blurred edges, the scaling is done with nearest-neighbor interpolation.

Rotating

Rotating the map can be achieved by setting the mapSettings.rotate to the desired value.

Colors

The map is rendered using a blueish color map by default. The colors of the floor, hard and weak obstacles as well as the robot's path can be set via the mapSettings.colors object, e.g. (other settings omitted for brevity):

{
    "mapSettings": {
        "colors": {
            "floor": "transparent",
            "obstacle": "hsl(120, 20%, 50%)",
            "path": "#333333"
        }
    },
    "mqtt" : {
    }
}

All valid CSS color values are accepted.

New Map Colors

You can now set colors for the new Valetudo Maps too - however - only hex values are supported. If you need to set the opacity you can do so using 8 digit hex code. Since new Valetudo maps are using segments, new field in config has been added (other settings omitted for brevity):

{

    "mapSettings": {
        "colors": {
            "floor": "#0000FF",
            "obstacle": "#33333380",
            "segments": ["#000000", "FF0000", "00FF00", "0000FF"],
            "path": "#FFFFFF"
        }
    },
    "mqtt" : {
    }

}

Cropping and padding

You can crop the image or add padding to better fit your use case. the cropping is applied first so you can also remove artefacts that can appear with windows or other reflective surfaces.

{

    "mapSettings": {
        "crop_top": 695,
        "crop_bottom": 0,
        "crop_left": 150,
        "crop_right": 200,
        "padding_top": 150,
        "padding_bottom": 150,
        "padding_right": 50,
        "padding_left": 50
    },
    "mqtt" : {
    }

}