Merge pull request SensorsIot#774 from Paraphraser/20240721-esphome-old-menu

2024-07-21 Adds ESPHome - old-menu branch - PR 2 of 2

Author: Slyke

.templates/esphome/88-tty-iotstack-esphome.rules

@@ -0,0 +1,47 @@
+# Assumptions:
+#
+# 1. The ESPhome container is running with the container-name "esphome".
+#
+# 2. The service definition for the ESPhome container includes:
+#
+#        device_cgroup_rules:
+#          - 'c 188:* rw'
+#
+#    This clause permits the container to access any device with a major
+#    number 188, which captures most USB-to-serial adapters that are
+#    found on ESP32 dev boards or equivalent off-board adapters such as
+#    those made by Future Technology Devices International (FTDI) and
+#    Silicon Laboratories Incorporated. The major number 188 also shows
+#    up in the UDEV rules below. 
+#
+# 3. The ESP device to be managed is mounted and/or unmounted WHILE the
+#    container is running. In other words, all bets are off if the host
+#    system reboots or the container starts while the USB device is
+#    connected. You will likely need to unplug/replug the device to
+#    get the container back in sync.
+#
+# The rules do NOT check if the container is running and do NOT check
+# for errors. All that will happen is errors in the system log.
+#
+# Removing ESPhome from your stack does NOT remove this rules file. It
+# does not matter whether you accomplish removal by editing your compose
+# file or via the IOTstack menu, this rule will be left in place and it
+# will generate an error every time it fires in response to insertion
+# or removal of a matching USB device.
+#
+# It is perfectly safe to remove this rules file yourself:
+#
+#   sudo rm /etc/udev/rules.d/88-tty-iotstack-esphome.rules
+#
+# That's all you have to do. UDEV is dynamic and, despite what you read
+# on the web, does NOT have to be restarted or reloaded.
+
+# Upon insertion of a matching USB device, mount the same device inside the container
+ACTION=="add", \
+  SUBSYSTEM=="tty", ENV{MAJOR}=="188", \
+  RUN+="/usr/bin/docker exec esphome mknod %E{DEVNAME} c %M %m"
+
+# Upon removal of a matching USB device, remove the same device inside the container
+ACTION=="remove", \
+  SUBSYSTEM=="tty", ENV{MAJOR}=="188", \
+  RUN+="/usr/bin/docker exec esphome rm -f %E{DEVNAME}"

.templates/esphome/build.sh

@@ -0,0 +1,55 @@
+#!/usr/bin/env bash
+
+# should not run as root
+[ "$EUID" -eq 0 ] && echo "This script should NOT be run using sudo" && exit 1
+
+# assumes (like all build.sh scripts) that the working directory is
+# the docker-compose project directory (typically ~/IOTstack)
+PROJECT="$PWD"
+
+# sanity check
+[ ! -d "$PROJECT/.templates" ] && echo "This script should be run from ~/IOTstack" && exit 1
+
+# where is this script is running? The expected answer is:
+#   «projectDirectory»/.templates/esphome 
+WHERE="$(dirname "$(realpath "$0")")"
+
+# the service name is implied from the last part of the template path
+SERVICE=$(basename "$WHERE")
+
+# the rules file name is
+RULES_FILE="88-tty-iotstack-${SERVICE}.rules"
+
+# the original rules file is here
+SOURCE_PATH="$WHERE/$RULES_FILE"
+
+# the path to install the file is here
+TARGET_PATH="/etc/udev/rules.d/$RULES_FILE"
+
+if [ ! -f "$TARGET_PATH" ] ; then
+	if [ -f "$SOURCE_PATH" ] ; then
+		sudo cp "$SOURCE_PATH" "$TARGET_PATH"
+		sudo chmod 644 "$TARGET_PATH"
+	fi
+fi
+
+# define the path to the environment file
+ENV_FILE="$PROJECT/.env"
+
+# ensure the file exists
+touch "$ENV_FILE"
+
+# $1 = key
+# $2 = value
+setEnvironment() {
+	if [ $(grep -c "^$1=" "$ENV_FILE") -eq 0 ] ; then
+		echo "$1=$2" >>"$ENV_FILE"
+	fi
+}
+
+# generate random password
+PASSWORD=$(< /dev/urandom tr -dc A-Z-a-z-0-9 | head -c ${1:-16})
+
+# conditionally set variables
+setEnvironment "ESPHOME_USERNAME" "$SERVICE"
+setEnvironment "ESPHOME_PASSWORD" "$PASSWORD"

.templates/esphome/service.yml

@@ -0,0 +1,15 @@
+  esphome:
+    container_name: esphome
+    image: esphome/esphome
+    restart: unless-stopped
+    environment:
+      - TZ=${TZ:-Etc/UTC}
+      - USERNAME=${ESPHOME_USERNAME:-esphome}
+      - PASSWORD=${ESPHOME_PASSWORD:?eg echo ESPHOME_PASSWORD=ChangeMe >>~/IOTstack/.env}
+    network_mode: host
+    x-ports:
+      - "6052:6052"
+    volumes:
+      - ./volumes/esphome/config:/config
+    device_cgroup_rules:
+      - 'c 188:* rw'

menu.sh

@@ -68,6 +68,7 @@ declare -A cont_array=(
 	[mjpg-streamer]="MJPG Streamer"
 	[home_assistant]="Home Assistant Container"
 	[wordpress]="Web content management"
+	[esphome]="ESPHome device provisioning"
 	# add yours here
 )
 
@@ -120,6 +121,7 @@ declare -a keylist=(
 	"mjpg-streamer"
 	"home_assistant"
 	"wordpress"
+	"esphome"
 	# add yours here
 )