dev addon

enedisgateway2mqtt_test/CHANGELOG.md

@@ -0,0 +1,2 @@
+- Allows setting options through 3 ways, see addon readme
+- Data validation

enedisgateway2mqtt_test/Dockerfile

@@ -0,0 +1,63 @@
+ARG BUILD_UPSTREAM="0.7.1-dev"
+FROM m4dm4rtig4n/enedisgateway2mqtt:$BUILD_UPSTREAM
+
+# Base system
+ARG BASHIO_VERSION=0.13.1
+
+# Copy root filesystem
+COPY rootfs /
+VOLUME [ "/config" ]
+
+RUN \
+    ################
+    # Install apps #
+    ################
+    apt-get clean \
+    && apt-get update \
+    && apt-get install -y \
+    jq \
+    curl \
+    yamllint \
+    && apt-get clean \
+    \    
+    ##################
+    # Install bashio #
+    ##################
+    && mkdir -p /tmp/bashio \
+    && curl -L -f -s "https://github.com/hassio-addons/bashio/archive/v${BASHIO_VERSION}.tar.gz" \
+    | tar -xzf - --strip 1 -C /tmp/bashio \
+    && mv /tmp/bashio/lib /usr/lib/bashio \
+    && ln -s /usr/lib/bashio/bashio /usr/bin/bashio \
+    && rm -rf /tmp/bashio || true
+
+RUN chmod 777 /entrypoint.sh
+ENTRYPOINT [ "/usr/bin/env" ]
+CMD ["/entrypoint.sh"]
+VOLUME [ "/data" ]
+
+### LABELS
+ARG BUILD_ARCH
+ARG BUILD_DATE
+ARG BUILD_DESCRIPTION
+ARG BUILD_NAME
+ARG BUILD_REF
+ARG BUILD_REPOSITORY
+ARG BUILD_VERSION
+LABEL \
+    io.hass.name="${BUILD_NAME}" \
+    io.hass.description="${BUILD_DESCRIPTION}" \
+    io.hass.arch="${BUILD_ARCH}" \
+    io.hass.type="addon" \
+    io.hass.version=${BUILD_VERSION} \
+    maintainer="alexbelgium (https://github.com/alexbelgium)" \
+    org.opencontainers.image.title="${BUILD_NAME}" \
+    org.opencontainers.image.description="${BUILD_DESCRIPTION}" \
+    org.opencontainers.image.vendor="Home Assistant Add-ons" \
+    org.opencontainers.image.authors="alexbelgium (https://github.com/alexbelgium)" \
+    org.opencontainers.image.licenses="MIT" \
+    org.opencontainers.image.url="https://github.com/alexbelgium" \
+    org.opencontainers.image.source="https://github.com/${BUILD_REPOSITORY}" \
+    org.opencontainers.image.documentation="https://github.com/${BUILD_REPOSITORY}/blob/main/README.md" \
+    org.opencontainers.image.created=${BUILD_DATE} \
+    org.opencontainers.image.revision=${BUILD_REF} \
+    org.opencontainers.image.version=${BUILD_VERSION}

enedisgateway2mqtt_test/README.md

@@ -0,0 +1,47 @@
+# Home assistant add-on: Enedisgateway2mqtt
+
+[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
+
+[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
+
+![Supports 
+ Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ![Supports armhf Architecture][armhf-shield] ![Supports armv7 Architecture][armv7-shield]
+
+_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
+
+[![Stargazers repo roster for @alexbelgium/hassio-addons](https://reporoster.com/stars/alexbelgium/hassio-addons)](https://github.com/alexbelgium/hassio-addons/stargazers)
+
+## About
+
+Enedisgateway2mqtt use Enedis Gateway API to send data in your MQTT Broker.
+See its github for all informations : https://github.com/m4dm4rtig4n/enedisgateway2mqtt/blob/master/README.md
+
+## Configuration
+
+There are 3 ways to configure this addon :
+- Using the addon options
+- Using the custom_var field, where variables not already defined in the addon options can be described using the format : var1=text1,var2=text2
+- Manually editing the file /config/enedisgateway2mqtt/enedisgateway2mqtt.conf and adding options with the format var1=text1
+
+All variables defined the in the addon options and custom_var fields are automatically copied in the /config/enedisgateway2mqtt/enedisgateway2mqtt.conf file.
+
+The complete list of options can be seen here : https://github.com/m4dm4rtig4n/enedisgateway2mqtt#environment-variable
+
+## Installation
+
+The installation of this add-on is pretty straightforward and not different in
+comparison to installing any other Hass.io add-on.
+
+1. [Add my Hass.io add-ons repository][repository] to your Hass.io instance.
+1. Install this add-on.
+1. Click the `Save` button to store your configuration.
+1. Start the add-on.
+1. Check the logs of the add-on to see if everything went well.
+1. Carefully configure the add-on to your preferences, see the official documentation for for that.
+
+[smb-shield]: https://img.shields.io/badge/SMB--green?style=plastic.svg
+[repository]: https://github.com/alexbelgium/hassio-addons
+[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
+[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
+[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
+[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg

enedisgateway2mqtt_test/apparmor.txt

@@ -0,0 +1,38 @@
+#include <tunables/global>
+
+profile inadyn_addon flags=(attach_disconnected,mediate_deleted) {
+  #include <abstractions/base>
+  
+  capability,
+  file,
+  mount,
+  umount,
+  remount,
+  capability setgid,
+  capability setuid,
+
+
+# S6-Overlay
+  /bin/** ix,
+  /usr/bin/** ix,
+  /usr/lib/bashio/** ix,
+  /etc/s6/** rix,
+  /run/s6/** rix,
+  /etc/services.d/** rwix,
+  /etc/cont-init.d/** rwix,
+  /etc/cont-finish.d/** rwix,
+  /init rix,
+  /var/run/** mrwkl,
+  /var/run/ mrwkl,
+  /dev/i2c-1 mrwkl, 
+  
+  # Data access
+  /data/** rw, 
+
+  # suppress ptrace denials when using 'docker ps' or using 'ps' inside a container
+  ptrace (trace,read) peer=docker-default,
+ 
+  # docker daemon confinement requires explict allow rule for signal
+  signal (receive) set=(kill,term) peer=/usr/bin/docker,
+
+}

enedisgateway2mqtt_test/config.json

@@ -0,0 +1,16 @@
+{
+  "arch": ["aarch64", "amd64", "armv7", "armhf"],
+  "description": "use Enedis Gateway API to send data in your MQTT Broker",
+  "map": ["config:rw"],
+  "name": "Enedisgateway2mqtt_test",
+  "options": {
+    "CONFIG_LOCATION": "/config/enedisgateway2mqtt/config.yaml"
+  },
+  "schema": {
+    "CONFIG_LOCATION": "str"
+  },
+  "slug": "enedisgateway2mqtt_test",
+  "upstream": "0.7.1",
+  "url": "https://github.com/alexbelgium/hassio-addons",
+  "version": "0.7.1"
+}

enedisgateway2mqtt_test/rootfs/entrypoint.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+#!/bin/bash
+
+echo "Starting scripts :"
+for SCRIPTS in scripts/*; do
+  [ -e "$SCRIPTS" ] || continue
+  echo "$SCRIPTS: executing"
+  chown $(id -u):$(id -g) $SCRIPTS
+  chmod a+x $SCRIPTS
+  sed -i 's|/usr/bin/with-contenv bashio|/usr/bin/env bashio|g' $SCRIPTS || true
+  ./$SCRIPTS || echo "$SCRIPTS: exiting $?"
+done

enedisgateway2mqtt_test/rootfs/scripts/00-aaa.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+if [ ! -f "/usr/bin/bashio" ]; then
+    echo "Bashio does not exist, executing script"
+
+    ################
+    # Install apps #
+    ################
+    apt-get clean &&
+        apt-get update &&
+        apt-get install -y --no-install-recommends \
+            jq \
+            curl \
+            yamllint
+
+    ###################
+    # Install bashio #
+    ##################
+    BASHIO_VERSION=0.13.1
+    mkdir -p /tmp/bashio
+    curl -L -f -s "https://github.com/hassio-addons/bashio/archive/v${BASHIO_VERSION}.tar.gz" |
+        tar -xzf - --strip 1 -C /tmp/bashio
+    mv /tmp/bashio/lib /usr/lib/bashio
+    ln -s /usr/lib/bashio/bashio /usr/bin/bashio
+    rm -rf /tmp/bashio
+
+    echo "Bashio installed"
+fi

enedisgateway2mqtt_test/rootfs/scripts/00-banner.sh

@@ -0,0 +1,39 @@
+#!/usr/bin/with-contenv bashio
+# ==============================================================================
+# Home Assistant Community Add-on: Base Images
+# Displays a simple add-on banner on startup
+# ==============================================================================
+if bashio::supervisor.ping; then
+    bashio::log.blue \
+        '-----------------------------------------------------------'
+    bashio::log.blue " Add-on: $(bashio::addon.name)"
+    bashio::log.blue " $(bashio::addon.description)"
+    bashio::log.blue \
+        '-----------------------------------------------------------'
+
+    bashio::log.blue " Add-on version: $(bashio::addon.version)"
+    if bashio::var.true "$(bashio::addon.update_available)"; then
+        bashio::log.magenta ' There is an update available for this add-on!'
+        bashio::log.magenta \
+            " Latest add-on version: $(bashio::addon.version_latest)"
+        bashio::log.magenta ' Please consider upgrading as soon as possible.'
+    else
+        bashio::log.green ' You are running the latest version of this add-on.'
+    fi
+
+    bashio::log.blue " System: $(bashio::info.operating_system)" \
+        " ($(bashio::info.arch) / $(bashio::info.machine))"
+    bashio::log.blue " Home Assistant Core: $(bashio::info.homeassistant)"
+    bashio::log.blue " Home Assistant Supervisor: $(bashio::info.supervisor)"
+
+    bashio::log.blue \
+        '-----------------------------------------------------------'
+    bashio::log.blue \
+        ' Please, share the above information when looking for help'
+    bashio::log.blue \
+        ' or support in, e.g., GitHub, forums or the Discord chat.'
+    bashio::log.green \
+        ' https://github.com/alexbelgium/hassio-addons'
+    bashio::log.blue \
+        '-----------------------------------------------------------'
+fi

enedisgateway2mqtt_test/rootfs/scripts/99-run.sh

@@ -0,0 +1,43 @@
+#!/usr/bin/env bashio
+
+# Where is the config
+CONFIGSOURCE=$(bashio::config "CONFIG_LOCATION")
+
+# Check if config file is there, or create one from template
+if [ -f $CONFIGSOURCE ]; then
+    echo "Using config file found in $CONFIGSOURCE"
+else
+    echo "No config file, creating one from template"
+    # Create folder
+    mkdir -p "$(dirname "${CONFIGSOURCE}")"
+    # Downloading template
+    TEMPLATESOURCE=/data/config.yaml
+    # Placing template in config
+    cp $TEMPLATESOURCE "$(dirname "${CONFIGSOURCE}")"
+    # Need to restart
+    bashio::log.fatal "Config file not found, creating a new one. Please customize the file in $CONFIGSOURCE before restarting."
+    bashio::exit.nok
+fi
+
+# Check if yaml is valid
+yamllint -d relaxed --no-warnings $CONFIGSOURCE &>ERROR
+if [ $? = 0 ]; then
+    echo "Config file is a valid yaml"
+else
+    bashio::log.fatal "Config file has an invalid yaml format. Please check the file in $CONFIGSOURCE. Errors list :"
+    cat ERROR
+fi
+
+# Create symlink
+[ -f /data/config.yaml ] && rm /data/config.yaml
+ln -s $CONFIGSOURCE /data
+echo "Symlink created"
+
+##############
+# Launch App #
+##############
+echo " "
+bashio::log.info "Starting the app"
+echo " "
+
+python -u /app/main.py || bashio::log.fatal "The app has crashed. Are you sure you entered the correct config options?"

enedisgateway2mqtt_test/rootfs/templates/config.yaml

@@ -0,0 +1,11 @@
+---
+ doe: "a deer, a female deer"
+ ray: "a drop of golden sun"
+ pi: 3.14159
+ xmas: true
+ french-hens: 3
+ calling-birds:
+   - huey
+   - dewey
+   - louie
+   - fred