{"id":13513643,"url":"https://github.com/Hypfer/ICantBelieveItsNotValetudo","last_synced_at":"2025-03-31T02:32:47.325Z","repository":{"id":39918113,"uuid":"181076923","full_name":"Hypfer/ICantBelieveItsNotValetudo","owner":"Hypfer","description":"A Valetudo companion service which renders maps to pngs","archived":true,"fork":false,"pushed_at":"2023-10-01T07:44:11.000Z","size":485,"stargazers_count":129,"open_issues_count":4,"forks_count":80,"subscribers_count":13,"default_branch":"master","last_synced_at":"2024-11-01T17:36:56.631Z","etag":null,"topics":["valetudo"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Hypfer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2019-04-12T20:10:46.000Z","updated_at":"2024-09-12T11:54:16.000Z","dependencies_parsed_at":"2022-07-15T17:00:39.524Z","dependency_job_id":"67e324cb-c5c5-4959-955a-0553de1b2908","html_url":"https://github.com/Hypfer/ICantBelieveItsNotValetudo","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hypfer%2FICantBelieveItsNotValetudo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hypfer%2FICantBelieveItsNotValetudo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hypfer%2FICantBelieveItsNotValetudo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hypfer%2FICantBelieveItsNotValetudo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Hypfer","download_url":"https://codeload.github.com/Hypfer/ICantBelieveItsNotValetudo/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246407369,"owners_count":20772118,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["valetudo"],"created_at":"2024-08-01T05:00:33.640Z","updated_at":"2025-03-31T02:32:46.929Z","avatar_url":"https://github.com/Hypfer.png","language":"JavaScript","funding_links":[],"categories":["Projects"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://github.com/Hypfer/Valetudo\"\u003e\n        \u003cimg src=\"https://github.com/Hypfer/Valetudo/blob/master/assets/logo/valetudo_logo_with_name.svg\" width=\"800\" alt=\"valetudo\"\u003e\n    \u003c/a\u003e\n    \u003cp align=\"center\"\u003e\u003ch2\u003eI can't believe it's not Valetudo\u003c/h2\u003e\u003c/p\u003e\n\u003c/div\u003e\n\n# This repository is archived\n\nHead over to [https://github.com/erkexzcx/valetudopng](https://github.com/erkexzcx/valetudopng) for its successor\n\n\n## Prior readme\n\nICBINV is a companion service for Valetudo that renders ValetudoMap map data to raster graphics.\n\nIncoming ValetudoMap Data is received via MQTT.\nRendered map images are published to MQTT and can optionally also be requested via HTTP (if enabled)\n\nPlease note that this service is only maintained on a very basic level.\n\n## Why would I need this?\n\nIf you're using Home Assistant, you probably don't as the custom valetudo lovelace map card does a much better job\nthan ICBINV while also being way easier to install, update and use.\n\nIf you however use FHEM, OpenHAB or similar, this might be the only way to view the map data using your home automation system.\n\n## Installation\n\nThe recommended install method for ICBINV is to clone the repo and then use the provided Dockerfile.\n\nWith docker-compose, it would look something like this:\n\n```\n  icantbelieveitsnotvaletudo:\n    build:\n      context: ./ICantBelieveItsNotValetudo/\n      dockerfile: Dockerfile\n    container_name: \"ICantBelieveItsNotValetudo\"\n    restart: always\n    volumes:\n      - /opt/docker_containers/ICantBelieveItsNotValetudo/config.json:/app/config.json\n```\n\nIf you have multiple robots, simply deploy multiple instances of ICBINV.\n\n\nIf you don't want to use docker, you will need to install a recent nodejs version + npm installed on your host.\n\nFirst, install the dependencies with `npm ci`. Then, you can start the application by running `npm run start`.\n\n## Configuration\n\nTo configure *I can't believe it's not Valetudo*, create a file called `config.json` in the working directory.\nYou can also run `npm start` to automatically create a default configuration file.\n\nIf you are running in docker, map the configuration file to `/app/config.json` .\n\n## Integration with FHEM, ioBroker, openHAB etc\n\nEnabling the webserver in the configuration file will allow you to fetch the latest rendered map image via `http://host:port/api/map/image`.\u003cbr/\u003e\nThe map will also be available as base64-encoded string at `http://host:port/api/map/base64`.\n\nBy default, the image data is published via MQTT to `mqtt.topicPrefix/mqtt.identifier/MapData/map` as a raw binary image.\u003cbr/\u003e\nIf `mqtt.publishAsBase64` is set to `true`, the image data will instead be published as base64-encoded string, which can be useful for OpenHAB.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FHypfer%2FICantBelieveItsNotValetudo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FHypfer%2FICantBelieveItsNotValetudo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FHypfer%2FICantBelieveItsNotValetudo/lists"}