Skip to content

Commit

Permalink
🚚 Move addon contents to own folder
Browse files Browse the repository at this point in the history
  • Loading branch information
Poeschl committed Sep 18, 2024
1 parent ca202dd commit 91bef8a
Show file tree
Hide file tree
Showing 20 changed files with 63 additions and 22 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/addon-ci.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Check addon with linters
name: Addon CI

# yamllint disable-line rule:truthy
on:
Expand Down
5 changes: 5 additions & 0 deletions .github/workflows/addon-deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ on:
release:
types:
- published
workflow_run:
workflows: ["Addon CI"]
branches: [main]
types:
- completed

jobs:
workflows:
Expand Down
31 changes: 11 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,28 +13,19 @@ This is the adaption of [ICantBelieveItsNotValetudo](https://github.com/Hypfer/I
[![Install on my Home Assistant][install-badge]][install-url]
[![Donate][donation-badge]][donation-url]

## Config

The configuration keys are identical to the [configuration of ICantBelieveItsNotValetudo](https://github.com/Hypfer/ICantBelieveItsNotValetudo/blob/main/README.md).
Please get the meaning for them from there.
It's normal that the structure of the addon differs from the official config file, this is nessesary because of the Supervisor Addon config structure.

If you use the Mosquitto Addon in Home Assistant `core-mosquitto` can be used as broker address like this: `mqtt://<user>:<password>@core-mosquitto`. Keep in mind to set proper `mapDataTopic` value. As of Valetudo 2021.04.0, it's `${topicPrefix}/${identifier}/MapData/map-data`, which with default values is equal to `valetudo/rockrobo/MapData/map-data`.

## PNG image
[stage-badge]: https://img.shields.io/badge/Addon%20stage-stable-green.svg
[aarch64-badge]: https://img.shields.io/badge/aarch64-yes-green.svg
[amd64-badge]: https://img.shields.io/badge/amd64-yes-green.svg
[armhf-badge]: https://img.shields.io/badge/armhf-no-red.svg
[armv7-badge]: https://img.shields.io/badge/armv7-yes-green.svg
[i386-badge]: https://img.shields.io/badge/i386-yes-green.svg

[repository-badge]: https://img.shields.io/badge/Add-repository-41BDF5?logo=home-assistant&style=for-the-badge
[repository-url]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2FPoeschl%2FHassio-Addons

The generated image will be served over the Supervisor Ingress feature. So the floor plan can be accessed via the build-in side panel and the auto-configured mqtt camera.
[install-badge]: https://img.shields.io/badge/Install%20on-Home%20Assistant-41BDF5?logo=home-assistant&style=for-the-badge
[install-url]: https://my.home-assistant.io/redirect/supervisor_addon?addon=243ffc37_icantbelieveitsnotvaletudo

[aarch64-badge]: https://img.shields.io/badge/aarch64-yes-green.svg?style=for-the-badge
[amd64-badge]: https://img.shields.io/badge/amd64-yes-green.svg?style=for-the-badge
[armhf-badge]: https://img.shields.io/badge/armhf-no-red.svg?style=for-the-badge
[armv7-badge]: https://img.shields.io/badge/armv7-yes-green.svg?style=for-the-badge
[i386-badge]: https://img.shields.io/badge/i386-yes-green.svg?style=for-the-badge
[stage-badge]: https://img.shields.io/badge/Addon%20stage-stable-green.svg?style=for-the-badge
[install-badge]: https://img.shields.io/badge/Install%20on%20my-Home%20Assistant-41BDF5?logo=home-assistant&style=for-the-badge
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=for-the-badge&logoColor=white
[donation-url]: https://www.buymeacoffee.com/Poeschl
[repository-badge]: https://img.shields.io/badge/Add%20repository%20to%20my-Home%20Assistant-41BDF5?logo=home-assistant&style=for-the-badge

[install-url]: https://my.home-assistant.io/redirect/supervisor_addon?addon=243ffc37_icantbelieveitsnotvaletudo
[repository-url]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2FPoeschl%2FHassio-Addons
45 changes: 45 additions & 0 deletions icantbelieveitsnotvaletudo/.README.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# ICantBelieveItsNotValetudo Addon

This is the adaption of [ICantBelieveItsNotValetudo](https://github.com/Hypfer/ICantBelieveItsNotValetudo) as a Supervisor addon.

[![Release][release-badge]][release]
![Addon Stage][stage-badge]

[![Donate][donation-badge]][donation-url]

## Config

The configuration keys are identical to the [configuration of ICantBelieveItsNotValetudo](https://github.com/Hypfer/ICantBelieveItsNotValetudo/blob/main/README.md).
Please get the meaning for them from there.
It's normal that the structure of the addon differs from the official config file, this is nessesary because of the Supervisor Addon config structure.

If you use the Mosquitto Addon in Home Assistant `core-mosquitto` can be used as broker address like this: `mqtt://<user>:<password>@core-mosquitto`. Keep in mind to set proper `mapDataTopic` value. As of Valetudo 2021.04.0, it's `${topicPrefix}/${identifier}/MapData/map-data`, which with default values is equal to `valetudo/rockrobo/MapData/map-data`.

## PNG image

The generated image will be served over the Supervisor Ingress feature. So the floor plan can be accessed via the build-in side panel and the auto-configured mqtt camera.

{% if channel == "edge" %}
## ⚠ WARNING! THIS IS AN EDGE VERSION!

This Home Assistant Add-on is and bloody edge build.
Edge builds add-ons are based upon the latest development version.

- They may not work at all.
- They might stop working at any time.
- They could have a negative impact on your system.

If you are more interested in stable releases of our add-ons:

For the stable version of the add-ons: [Stable-Repository]
{% endif %}

[stage-badge]: https://img.shields.io/badge/Addon%20stage-stable-green.svg

[release-badge]: https://img.shields.io/badge/version-{{ version }}-blue.svg
[release]: {{ repo }}/tree/{{ version }}

[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=for-the-badge&logoColor=white
[donation-url]: https://www.buymeacoffee.com/Poeschl

[Stable-Repository]: https://github.com/Poeschl-HomeAssistant-Addons/repository
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion config.yaml → icantbelieveitsnotvaletudo/config.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: ICantBelieveItsNotValetudo
version: 4.0.0
version: dev
slug: icantbelieveitsnotvaletudo
description: This is a simple companion service for valetudo which generates the map pngs.
url: https://github.com/Poeschl/Hassio-Addons/tree/main/ICantBelieveItsNotValetudo
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 91bef8a

Please sign in to comment.