Merge pull request #51 from pmagyar/ha_addon

add HA Addon

.github/workflows/docker-publish.yml

@@ -0,0 +1,106 @@
+---
+name: Docker
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+on:
+  push:
+    branches: ["main"]
+    # Publish semver tags as releases.
+    tags: ['v*.*.*']
+  pull_request:
+    branches: ["main"]
+
+env:
+  # Use docker.io for Docker Hub if empty
+  REGISTRY: ghcr.io
+  # github.repository as <account>/<repo>
+  IMAGE_NAME: ${{ github.repository }}
+
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+      # This is used to complete the identity challenge
+      # with sigstore/fulcio when running outside of PRs.
+      id-token: write
+    strategy:
+      fail-fast: false
+
+    steps:
+      -
+        name: Prepare
+        run: |
+          platform=${{ matrix.platform }}
+          echo "PLATFORM_PAIR=${platform//\//-}" >> $GITHUB_ENV
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Install the cosign tool except on PR
+      # https://github.com/sigstore/cosign-installer
+      - name: Install cosign
+        if: github.event_name != 'pull_request'
+        uses: sigstore/cosign-installer@v3.3.0
+        with:
+          cosign-release: 'v2.2.2'
+
+      # Set up BuildKit Docker container builder to be able to build
+      # multi-platform images and export cache
+      # https://github.com/docker/setup-buildx-action
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@f95db51fddba0c2d1ec667646a06c2ce06100226  # v3.0.0
+
+      # Login against a Docker registry except on PR
+      # https://github.com/docker/login-action
+      - name: Log into registry ${{ env.REGISTRY }}
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d  # v3.0.0
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      # Extract metadata (tags, labels) for Docker
+      # https://github.com/docker/metadata-action
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/metadata-action@96383f45573cb7f253c731d3b3ab81c87ef81934  # v5.0.0
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      # Build and push Docker image with Buildx (don't push on PR)
+      # https://github.com/docker/build-push-action
+      - name: Build and push Docker image
+        id: build-and-push
+        uses: docker/build-push-action@0565240e2d4ab88bba5387d719585280857ece09  # v5.0.0
+        with:
+          context: .
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+          platforms: linux/amd64, linux/arm/v7, linux/armhf, linux/aarch64, linux/i386
+
+      # Sign the resulting Docker image digest except on PRs.
+      # This will only write to the public Rekor transparency log when the Docker
+      # repository is public to avoid leaking data.  If you would like to publish
+      # transparency data even for private images, pass --force to cosign below.
+      # https://github.com/sigstore/cosign
+      - name: Sign the published Docker image
+        if: ${{ github.event_name != 'pull_request' }}
+        env:
+          # https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions#using-an-intermediate-environment-variable
+          TAGS: ${{ steps.meta.outputs.tags }}
+          DIGEST: ${{ steps.build-and-push.outputs.digest }}
+        # This step uses the identity token to provision an ephemeral certificate
+        # against the sigstore community Fulcio instance.
+        run: echo "${TAGS}" | xargs -I {} cosign sign --yes {}@${DIGEST}

.gitignore

@@ -9,5 +9,4 @@ __*
 *.txt
 *.json
 *.zip
-*.sh
 *.ini

.yamllint

@@ -0,0 +1,3 @@
+---
+rules:
+  line-length: disable

Dockerfile

@@ -5,12 +5,13 @@ WORKDIR /app
 COPY requirements.txt ./
 
 RUN apt-get update && \
-  apt-get install -y --no-install-recommends gcc python3-dev libssl-dev && \
+  apt-get install -y --no-install-recommends gcc python3-dev libssl-dev libxml2-dev libxslt-dev python3-dev jq && \
   pip3 install -r requirements.txt && \
   apt-get remove -y gcc python3-dev libssl-dev && \
   apt-get autoremove -y
 
-COPY hc2mqtt.py  hc-login.py HCDevice.py HCSocket.py HCxml2json.py ./
+COPY hc2mqtt.py hc-login.py HCDevice.py HCSocket.py HCxml2json.py run.sh ./
 
-ENTRYPOINT ["python3"]
+RUN chmod a+x ./run.sh
-CMD ["hc2mqtt.py", "--config", "./config/config.ini"]
+
+CMD ["./run.sh"]

README.md

@@ -453,10 +453,6 @@ To start a dishwasher on eco mode in 10 miuntes (`BSH.Common.Option.StartInRelat
 {"program":8196,"options":[{"uid":558,"value":600}]}
 ```
 
-## FRIDA tools
-
-Moved to [`README-frida.md`](README-frida.md)
-
 ## Notes
 - Sometimes when the device is off, there is the error `ERROR [ip] [Errno 113] No route to host`
 - There is a lot more information available, like the status of a program that is currently active. This needs to be integrated if possible. For now only the values that relate to the `config.json` are published

home-assistant-addon/config.yaml

@@ -0,0 +1,42 @@
+---
+name: "HomeConnect2MQTT"
+description: "Run HCPY as addon"
+version: "v0.1.0"
+slug: "hcpy"
+image: ghcr.io/hcpy2-0/hcpy
+init: false
+arch:
+  - armhf
+  - aarch64
+  - amd64
+  - armv7
+  - i386
+map:
+  - share
+url: https://github.com/hcpy2-0/hcpy
+panel_title: HCPY
+options:
+  HCPY_DEVICES_FILE: "config/devices.json"
+  HCPY_MQTT_HOST: localhost
+  HCPY_MQTT_PORT: 1883
+  HCPY_MQTT_PREFIX: "homeconnect/"
+  HCPY_MQTT_USERNAME: ""
+  HCPY_MQTT_PASSWORD: ""
+  HCPY_MQTT_SSL: false
+  HCPY_MQTT_CAFILE: ""
+  HCPY_MQTT_CERTFILE: ""
+  HCPY_MQTT_KEYFILE: ""
+  HCPY_MQTT_CLIENTNAME: "hcpy1"
+schema:
+  HCPY_DEVICES_FILE: str
+  HCPY_MQTT_HOST: str
+  HCPY_MQTT_PORT: int
+  HCPY_MQTT_PREFIX: str
+  HCPY_MQTT_USERNAME: str
+  HCPY_MQTT_PASSWORD: password
+  HCPY_MQTT_SSL: bool?
+  HCPY_MQTT_CAFILE: str
+  HCPY_MQTT_CERTFILE: str
+  HCPY_MQTT_KEYFILE: str
+  HCPY_MQTT_CLIENTNAME: str
+startup: services

repository.yaml

@@ -0,0 +1,4 @@
+---
+name: HCPY
+url: https://github.com/hcpy2-0/hcpy
+maintainer: pmagyar, Meatballs1

run.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+if [ -f /data/options.json ]; then
+    set -o allexport
+    eval "$(jq -r 'to_entries[]|"\(.key)=\"\(.value)\""' /data/options.json)"
+    set +o allexport
+    exec python3 hc2mqtt.py
+fi
+exec python3 hc2mqtt.py --config ./config/config.ini