Align folders with updated upstream name

2026-01-19 19:18:10 +01:00 · 2022-12-06 16:28:12 +01:00
parent eb5bb6d078
commit 9fab19ae2d
47 changed files with 3 additions and 3 deletions
--- a/myelectricaldata/CHANGELOG.md
+++ b/myelectricaldata/CHANGELOG.md
@@ -0,0 +1,51 @@
+
+## 0.8.7 (03-12-2022)
+- Update to latest version from m4dm4rtig4n/myelectricaldata
+
+## 0.8.8-dev (03-12-2022)
+- Update to latest version from m4dm4rtig4n/myelectricaldata
+
+## 0.8.6-dev (02-12-2022)
+- Update to latest version from m4dm4rtig4n/myelectricaldata
+
+## 0.8.3-dev (01-12-2022)
+- Update to latest version from m4dm4rtig4n/myelectricaldata
+- Migration to MyElectricalData
+- WARNING : update to supervisor 2022.11 before installing
+- Add codenotary sign
+- New standardized logic for Dockerfile build and packages installation
+
+## 0.7.7 (25-11-2021)
+
+- Update to latest version from m4dm4rtig4n/enedisgateway2mqtt
+
+## 0.7.8-dev (23-11-2021)
+
+- Update to latest version from m4dm4rtig4n/enedisgateway2mqtt
+
+## 0.7.7-dev (23-11-2021)
+
+- Update to latest version from m4dm4rtig4n/enedisgateway2mqtt
+
+## 0.7.7-dev (21-11-2021)
+
+- Update to latest version from m4dm4rtig4n/enedisgateway2mqtt
+
+## 0.7.5 (18-11-2021)
+
+- Update to latest version from m4dm4rtig4n/enedisgateway2mqtt
+- Allows setting TZ
+
+## 0.7.4 (18-11-2021)
+
+- Update to latest version from m4dm4rtig4n/enedisgateway2mqtt
+
+## 0.7.3 (18-11-2021)
+
+- Improve code
+
+## 0.7.1 (17-11-2021)
+
+- Logic change for configuration, from addon options to an external config yaml
+- Allows setting options through 3 ways, see addon readme
+- Data validation
--- a/myelectricaldata/Dockerfile
+++ b/myelectricaldata/Dockerfile
@@ -0,0 +1,104 @@
+#============================#
+#  ALEXBELGIUM'S DOCKERFILE  #
+#============================#
+#           _.------.
+#       _.-`    ('>.-`"0.8.7""-.
+# '.--'`       _'`   _ .--.)
+#    -'         '-.-';`   `
+#    ' -      _.'  ``'--.
+#        '---`    .-'"0.8.7"`
+#               /`
+#=== Home Assistant Addon ===#
+
+#################
+# 1 Build Image #
+#################
+
+ARG BUILD_UPSTREAM="0.8.7"
+FROM m4dm4rtig4n/myelectricaldata:latest
+
+
+##################
+# 2 Modify Image #
+##################
+
+# Set S6 wait time
+ENV S6_CMD_WAIT_FOR_SERVICES=1 \
+    S6_CMD_WAIT_FOR_SERVICES_MAXTIME=0 \
+    S6_SERVICES_GRACETIME=0
+
+##################
+# 3 Install apps #
+##################
+
+# Add rootfs
+COPY rootfs/ /
+
+# Corrects permissions for s6 v3
+RUN if [ -d /etc/cont-init.d ]; then chmod -R 755 /etc/cont-init.d; fi && \
+    if [ -d /etc/services.d ]; then chmod -R 755 /etc/services.d; fi && \
+    if [ -f /entrypoint.sh ]; then chmod 755 /entrypoint.sh; fi
+
+# Modules
+ARG MODULES="00-banner.sh 01-custom_script.sh 00-global_var.sh"
+
+# Automatic modules download
+RUN if ! command -v bash >/dev/null 2>/dev/null; then (apt-get update && apt-get install -yqq --no-install-recommends bash || apk add --no-cache bash) >/dev/null; fi \
+    && if ! command -v curl >/dev/null 2>/dev/null; then (apt-get update && apt-get install -yqq --no-install-recommends curl || apk add --no-cache curl) >/dev/null; fi \
+    && apt-get update && apt-get install -yqq --no-install-recommends ca-certificates || apk add --no-cache ca-certificates >/dev/null || true \
+    && mkdir -p /etc/cont-init.d \
+    && for scripts in $MODULES; do echo "$scripts" && curl -f -L -s -S "https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.templates/$scripts" -o /etc/cont-init.d/"$scripts" && [ "$(sed -n '/\/bin/p;q' /etc/cont-init.d/"$scripts")" != "0.8.7" ] || (echo "script failed to install $scripts" && exit 1); done \
+    && chmod -R 755 /etc/cont-init.d
+
+# Manual apps
+ENV PACKAGES="jq \
+    curl \
+    yamllint"
+
+# Automatic apps & bashio
+# hadolint ignore=SC2015
+RUN if ! command -v bash >/dev/null 2>/dev/null; then (apt-get update && apt-get install -yqq --no-install-recommends bash || apk add --no-cache bash) >/dev/null; fi \
+    && if ! command -v curl >/dev/null 2>/dev/null; then (apt-get update && apt-get install -yqq --no-install-recommends curl || apk add --no-cache curl) >/dev/null; fi \
+    && curl -f -L -s -S "https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.templates/automatic_packages.sh" --output /automatic_packages.sh \
+    && chmod 777 /automatic_packages.sh \
+    && eval /./automatic_packages.sh "${PACKAGES:-}" \
+    && rm /automatic_packages.sh
+
+################
+# 4 Entrypoint #
+################
+
+RUN chmod 777 /entrypoint.sh
+ENTRYPOINT [ "/usr/bin/env" ]
+CMD ["/entrypoint.sh"]
+VOLUME [ "/data" ]
+
+############
+# 5 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}
--- a/myelectricaldata/README.md
+++ b/myelectricaldata/README.md
@@ -0,0 +1,56 @@
+# Home assistant add-on: MyElectricalData
+
+[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
+
+![Version](https://img.shields.io/badge/dynamic/json?label=Version&query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fenedisgateway2mqtt%2Fconfig.json)
+![Ingress](https://img.shields.io/badge/dynamic/json?label=Ingress&query=%24.ingress&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fenedisgateway2mqtt%2Fconfig.json)
+![Arch](https://img.shields.io/badge/dynamic/json?color=success&label=Arch&query=%24.arch&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fenedisgateway2mqtt%2Fconfig.json)
+
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9c6cf10bdbba45ecb202d7f579b5be0e)](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade)
+[![GitHub Super-Linter](https://github.com/alexbelgium/hassio-addons/workflows/Lint%20Code%20Base/badge.svg)](https://github.com/marketplace/actions/super-linter)
+[![Builder](https://github.com/alexbelgium/hassio-addons/workflows/Builder/badge.svg)](https://github.com/alexbelgium/hassio-addons/actions/workflows/builder.yaml)
+
+[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
+
+_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://git-lister.onrender.com/api/stars/alexbelgium/hassio-addons?limit=30)](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/myelectricaldata
+
+## Configuration
+
+Install, then start the addon a first time to initialize the templates.
+
+Options can be configured through two ways :
+
+- Addon options
+
+```yaml
+CONFIG_LOCATION: /config/enedisgateway2mqtt/enedisgateway2mqtt.conf # Sets the location of the config.yaml (see below)
+mqtt_autodiscover: true # Shows in the log the detail of the mqtt local server (if available). It can then be added to the config.yaml file.
+TZ: Europe/Paris # Sets a specific timezone
+```
+
+- Config.yaml
+  Everything is configured using the config.yaml file found in /config/enedisgateway2mqtt/enedisgateway2mqtt.conf.
+
+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.
+
+[repository]: https://github.com/alexbelgium/hassio-addons
--- a/myelectricaldata/apparmor.txt
+++ b/myelectricaldata/apparmor.txt
@@ -0,0 +1,58 @@
+#include <tunables/global>
+
+profile inadyn_addon flags=(attach_disconnected,mediate_deleted) {
+  #include <abstractions/base>
+
+  capability,
+  file,
+  signal,
+  mount,
+  umount,
+  remount,
+  network udp,
+  network tcp,
+  network dgram,
+  network stream,
+  network inet,
+  network inet6,
+  network netlink raw,
+  network unix dgram,
+  capability setgid,
+  capability setuid,
+
+
+# S6-Overlay
+  /init ix,
+  /run/{s6,s6-rc*,service}/** ix,
+  /package/** ix,
+  /command/** ix,
+  /run/{,**} rwk,
+  /dev/tty rw,
+  /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,
+  /dev/sda1 mrwkl,
+  /dev/sdb1 mrwkl,
+  /dev/nvme0 mrwkl,
+  /dev/nvme1 mrwkl,
+  /dev/mmcblk0p1 mrwkl,
+
+  # 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,
+
+}
--- a/myelectricaldata/config.json
+++ b/myelectricaldata/config.json
@@ -0,0 +1,32 @@
+{
+  "arch": [
+    "aarch64",
+    "amd64",
+    "armv7"
+  ],
+  "codenotary": "alexandrep.github@gmail.com",
+  "description": "use Enedis Gateway API to send data in your MQTT Broker (latest channel)",
+  "image": "ghcr.io/alexbelgium/enedisgateway2mqtt-{arch}",
+  "map": [
+    "config:rw"
+  ],
+  "name": "MyElectricalData",
+  "options": {
+    "CONFIG_LOCATION": "/config/enedisgateway2mqtt/config.yaml",
+    "TZ": "Europe/Paris",
+    "mqtt_autodiscover": true,
+    "verbose": true
+  },
+  "schema": {
+    "CONFIG_LOCATION": "str",
+    "TZ": "str?",
+    "mqtt_autodiscover": "bool",
+    "verbose": "bool"
+  },
+  "services": [
+    "mqtt:want"
+  ],
+  "slug": "enedisgateway2mqtt",
+  "url": "https://github.com/alexbelgium/hassio-addons",
+  "version": "0.8.7"
+}
--- a/myelectricaldata/icon.png
+++ b/myelectricaldata/icon.png
--- a/myelectricaldata/logo.png
+++ b/myelectricaldata/logo.png
--- a/myelectricaldata/rootfs/entrypoint.sh
+++ b/myelectricaldata/rootfs/entrypoint.sh
@@ -0,0 +1,27 @@
+#!/bin/bash
+echo "Starting..."
+
+############################
+# Backup Dockerfile Script #
+############################
+
+if [ -f /etc/cont-init.d/00-aaa_dockerfile_backup.sh ]; then
+    chown "$(id -u)":"$(id -g)" /etc/cont-init.d/00-aaa_dockerfile_backup.sh
+    chmod +x /etc/cont-init.d/00-aaa_dockerfile_backup.sh
+    /./etc/cont-init.d/00-aaa_dockerfile_backup.sh
+    rm /etc/cont-init.d/00-aaa_dockerfile_backup.sh
+fi
+
+####################
+# Starting scripts #
+####################
+
+for SCRIPTS in /etc/cont-init.d/*; do
+    [ -e "$SCRIPTS" ] || continue
+    echo "$SCRIPTS: executing"
+    chown "$(id -u)":"$(id -g)" "$SCRIPTS"
+    chmod a+x "$SCRIPTS"
+    # Change shebang if no s6 supervision
+    sed -i 's|/usr/bin/with-contenv bashio|/usr/bin/env bashio|g' "$SCRIPTS"
+    /."$SCRIPTS" || echo "$SCRIPTS: exiting $?"
+done
--- a/myelectricaldata/rootfs/etc/cont-init.d/91-mqtt_autodiscover.sh
+++ b/myelectricaldata/rootfs/etc/cont-init.d/91-mqtt_autodiscover.sh
@@ -0,0 +1,26 @@
+#!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
+# shellcheck disable=SC2155
+
+#####################
+# Autodiscover mqtt #
+#####################
+
+if bashio::config.true 'mqtt_autodiscover'; then
+    bashio::log.info "mqtt_autodiscover is defined in options, attempting autodiscovery..."
+    # Check if available
+    if ! bashio::services.available "mqtt"; then bashio::exit.nok "No internal MQTT service found. Please install Mosquitto broker"; fi
+    # Get variables
+    bashio::log.info "... MQTT service found, fetching server detail (you can enter those manually in your config file) ..."
+    export MQTT_HOST=$(bashio::services mqtt "host")
+    export MQTT_PORT=$(bashio::services mqtt "port")
+    export MQTT_SSL=$(bashio::services mqtt "ssl")
+    export MQTT_USERNAME=$(bashio::services mqtt "username")
+    export MQTT_PASSWORD=$(bashio::services mqtt "password")
+    # Export variables
+    for variables in "MQTT_HOST=$MQTT_HOST" "MQTT_PORT=$MQTT_PORT" "MQTT_SSL=$MQTT_SSL" "MQTT_USERNAME=$MQTT_USERNAME" "MQTT_PASSWORD=$MQTT_PASSWORD"; do
+        sed -i "1a export $variables" /etc/services.d/*/*run* 2>/dev/null
+        # Log
+        bashio::log.blue "$variables"
+    done
+fi
--- a/myelectricaldata/rootfs/etc/cont-init.d/99-run.sh
+++ b/myelectricaldata/rootfs/etc/cont-init.d/99-run.sh
@@ -0,0 +1,78 @@
+#!/usr/bin/env bashio
+# shellcheck shell=bash
+
+##################
+# INITIALIZATION #
+##################
+
+# Where is the config
+CONFIGSOURCE=$(bashio::config "CONFIG_LOCATION")
+DATABASESOURCE="$(dirname "${CONFIGSOURCE}")/enedisgateway.db"
+
+# Make sure folder exist
+mkdir -p "$(dirname "${CONFIGSOURCE}")"
+mkdir -p "$(dirname "${DATABASESOURCE}")"
+
+# Check absence of config file
+if [ -f /data/config.yaml ] && [ ! -L /data/config.yaml ]; then
+    bashio::log.warning "A current config was found in /data, it is backuped to ${CONFIGSOURCE}.bak"
+    mv /data/config.yaml "$CONFIGSOURCE".bak
+fi
+
+# Check if config file is there, or create one from template
+if [ -f "$CONFIGSOURCE" ]; then
+    # Create symlink if not existing yet
+    [ ! -L /data/config.yaml ] && ln -sf "$CONFIGSOURCE" /data
+    bashio::log.info "Using config file found in $CONFIGSOURCE"
+
+    # Check if yaml is valid
+    EXIT_CODE=0
+    yamllint -d relaxed "$CONFIGSOURCE" &>ERROR || EXIT_CODE=$?
+    if [ "$EXIT_CODE" = 0 ]; then
+        echo "Config file is a valid yaml"
+    else
+        cat ERROR
+        bashio::log.fatal "Config file has an invalid yaml format. Please check the file in $CONFIGSOURCE. Errors list above. You can check yaml validity with the online tool yamllint.com"
+        bashio::exit.nok
+    fi
+else
+    # Create symlink for addon to create config
+    touch "${CONFIGSOURCE}"
+    ln -sf "$CONFIGSOURCE" /data
+    rm "$CONFIGSOURCE"
+    # Need to restart
+    bashio::log.fatal "Config file not found. The addon will create a new one, then stop. Please customize the file in $CONFIGSOURCE before restarting."
+fi
+
+# Remove previous link or file
+[ -f /data/enedisgateway.db ] && rm /data/enedisgateway.db
+
+# Check if database is here or create symlink
+if [ -f "$DATABASESOURCE" ]; then
+    # Create symlink if not existing yet
+    ln -sf "${DATABASESOURCE}" /data && echo "creating symlink"
+    bashio::log.info "Using database file found in $DATABASESOURCE"
+else
+    # Create symlink for addon to create database
+    touch "${DATABASESOURCE}"
+    ln -sf "$DATABASESOURCE" /data
+    rm "$DATABASESOURCE"
+fi
+
+##############
+# Launch App #
+##############
+echo " "
+bashio::log.info "Starting the app"
+echo " "
+
+# Test mode
+TZ=$(bashio::config "TZ")
+if [ "$TZ" = "test" ]; then
+    echo "secret mode found, launching script in /config/test.sh"
+    cd /config || exit
+    chmod 777 test.sh
+    ./test.sh
+fi
+
+python -u /app/main.py || bashio::log.fatal "The app has crashed. Are you sure you entered the correct config options?"
--- a/myelectricaldata/rootfs/templates/config.yaml
+++ b/myelectricaldata/rootfs/templates/config.yaml
@@ -0,0 +1,63 @@
+##########
+# GLOBAL #
+##########
+debug: false
+
+####################
+##      MQTT      ##
+####################
+mqtt:
+  host: MOSQUITO_SERVER # MANDATORY
+  port: 1883
+  username: ""
+  password: ""
+  prefix: enedis_gateway
+  client_id: enedis_gateway
+  retain: true
+  qos: 0
+
+####################
+## Home assistant ##
+####################
+home_assistant:
+  discovery: false
+  discovery_prefix: homeassistant
+  card_myenedis: false
+
+###############
+## Influx DB ##
+###############
+#influxdb:
+#  host: MY_INFLUXDB_SERVER
+#  port: 8086
+#  token: MY_TOKEN
+#  org: MY_ORG
+#  bucket: MY_BUCKET
+
+####################
+## ENEDIS GATEWAY ##
+####################
+enedis_gateway:
+  PDL_1: # MANDATORY
+    token: PDL_1_TOKEN # MANDATORY
+    plan: BASE # BASE or HP/HC
+    consumption: true
+    consumption_detail: true
+    consumption_price_hc: 0
+    consumption_price_hp: 0
+    consumption_price_base: 0
+    production: false
+    production_detail: false
+    #    offpeak_hours: ""        # USE ONLY IF YOU WANT OVERLOAD DEFAULT VALUE, Format : 22h36-00h10;01h00-06h00
+    addresses: true
+#  PDL_2:
+#    token: PDL_2_TOKEN
+#    plan: HP/HC
+#    consumption: true
+#    consumption_detail: true
+#    consumption_price_hc: 0.1781
+#    consumption_price_hp: 0.1337
+#    consumption_price_base: 0.1781
+#    production: false
+#    production_detail: false
+#    addresses: true
--- a/myelectricaldata/updater.json
+++ b/myelectricaldata/updater.json
@@ -0,0 +1,9 @@
+{
+  "github_beta": "false",
+  "last_update": "03-12-2022",
+  "repository": "alexbelgium/hassio-addons",
+  "slug": "enedisgateway2mqtt",
+  "source": "dockerhub",
+  "upstream_repo": "m4dm4rtig4n/myelectricaldata",
+  "upstream_version": "0.8.7"
+}