Merge release v1.2.0

Author: github-actions[bot]

.github/workflows/docker-publish.yml

@@ -2,10 +2,10 @@ name: Build and Deploy Hame Relay
 
 on:
   push:
-    branches: [ "main" ]
+    branches: [ "main", "develop" ]
     tags: [ "*.*.*" ]
   pull_request:
-    branches: [ "main" ]
+    branches: [ "main", "develop" ]
 
 env:
   REGISTRY: ghcr.io
@@ -34,8 +34,13 @@ jobs:
       - name: Write certificates to files
         run: |
           echo "${{ secrets.CA_CERTIFICATE }}" > certs/ca.crt
-          echo "${{ secrets.CLIENT_CERTIFICATE }}" > certs/client.crt
-          echo "${{ secrets.CLIENT_KEY }}" > certs/client.key
+          echo "${{ secrets.CLIENT_CERTIFICATE_2024 }}" > certs/hame-2024.crt
+          echo "${{ secrets.CLIENT_KEY_2024 }}" > certs/hame-2024.key
+          echo "${{ secrets.HAME_2024_URL }}" > certs/hame-2024-url
+          echo "${{ secrets.CLIENT_CERTIFICATE_2025 }}" > certs/hame-2025.crt
+          echo "${{ secrets.CLIENT_KEY_2025 }}" > certs/hame-2025.key
+          echo "${{ secrets.HAME_2025_URL }}" > certs/hame-2025-url
+          echo "${{ secrets.TOPIC_ENCRYPTION_KEY_2025 }}" > certs/hame-2025-topic-encryption-key
         shell: bash
 
       - name: Set up QEMU
@@ -53,8 +58,14 @@ jobs:
         uses: docker/metadata-action@v5
         with:
           images: ${{ env.REGISTRY }}/${{ steps.lower-repo.outputs.IMAGE_NAME }}
+          tags: |
+            type=raw,value=next,enable=${{ github.ref == 'refs/heads/develop' }}
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
 
       - name: Log in to Container registry
+        if: github.event_name != 'pull_request'
         uses: docker/login-action@v3
         with:
           registry: ${{ env.REGISTRY }}
@@ -67,8 +78,8 @@ jobs:
         with:
           context: .
           platforms: ${{ matrix.platform }}
-          push: true
-          outputs: type=image,name=${{ env.REGISTRY }}/${{ steps.lower-repo.outputs.IMAGE_NAME }},push-by-digest=true,name-canonical=true,push=true
+          push: ${{ github.event_name != 'pull_request' }}
+          outputs: type=image,name=${{ env.REGISTRY }}/${{ steps.lower-repo.outputs.IMAGE_NAME }},push-by-digest=true,name-canonical=true,push=${{ github.event_name != 'pull_request' }}
           labels: ${{ steps.meta.outputs.labels }}
           cache-from: type=gha
           cache-to: type=gha,mode=max
@@ -94,6 +105,7 @@ jobs:
           retention-days: 1
 
   merge-artifacts:
+    if: github.event_name != 'pull_request'
     runs-on: ubuntu-latest
     needs: [build]
     steps:
@@ -104,6 +116,7 @@ jobs:
           pattern: digests-*
 
   merge:
+    if: github.event_name != 'pull_request'
     runs-on: ubuntu-latest
     needs: [merge-artifacts]
     permissions:
@@ -128,6 +141,11 @@ jobs:
         uses: docker/metadata-action@v5
         with:
           images: ${{ env.REGISTRY }}/${{ steps.lower-repo.outputs.IMAGE_NAME }}
+          tags: |
+            type=raw,value=next,enable=${{ github.ref == 'refs/heads/develop' }}
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
 
       - name: Log in to Container registry
         uses: docker/login-action@v3
@@ -169,8 +187,13 @@ jobs:
       - name: Write certificates to files
         run: |
           echo "${{ secrets.CA_CERTIFICATE }}" > certs/ca.crt
-          echo "${{ secrets.CLIENT_CERTIFICATE }}" > certs/client.crt
-          echo "${{ secrets.CLIENT_KEY }}" > certs/client.key
+          echo "${{ secrets.CLIENT_CERTIFICATE_2024 }}" > certs/hame-2024.crt
+          echo "${{ secrets.CLIENT_KEY_2024 }}" > certs/hame-2024.key
+          echo "${{ secrets.HAME_2024_URL }}" > certs/hame-2024-url
+          echo "${{ secrets.CLIENT_CERTIFICATE_2025 }}" > certs/hame-2025.crt
+          echo "${{ secrets.CLIENT_KEY_2025 }}" > certs/hame-2025.key
+          echo "${{ secrets.HAME_2025_URL }}" > certs/hame-2025-url
+          echo "${{ secrets.TOPIC_ENCRYPTION_KEY_2025 }}" > certs/hame-2025-topic-encryption-key
         shell: bash
 
       - name: Set up QEMU
@@ -188,8 +211,14 @@ jobs:
         uses: docker/metadata-action@v5
         with:
           images: ${{ env.REGISTRY }}/${{ steps.lower-repo.outputs.ADDON_IMAGE_NAME }}
+          tags: |
+            type=raw,value=next,enable=${{ github.ref == 'refs/heads/develop' }}
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
 
       - name: Log in to Container registry
+        if: github.event_name != 'pull_request'
         uses: docker/login-action@v3
         with:
           registry: ${{ env.REGISTRY }}
@@ -203,8 +232,8 @@ jobs:
           context: .
           platforms: ${{ matrix.platform }}
           file: hassio-addon/Dockerfile
-          push: true
-          outputs: type=image,name=${{ env.REGISTRY }}/${{ steps.lower-repo.outputs.ADDON_IMAGE_NAME }},push-by-digest=true,name-canonical=true,push=true
+          push: ${{ github.event_name != 'pull_request' }}
+          outputs: type=image,name=${{ env.REGISTRY }}/${{ steps.lower-repo.outputs.ADDON_IMAGE_NAME }},push-by-digest=true,name-canonical=true,push=${{ github.event_name != 'pull_request' }}
           build-args: BUILD_FROM=ghcr.io/hassio-addons/base:14.2.2
           cache-from: type=gha
           cache-to: type=gha,mode=max
@@ -231,6 +260,7 @@ jobs:
           retention-days: 1
 
   merge-addon-artifacts:
+    if: github.event_name != 'pull_request'
     runs-on: ubuntu-latest
     needs: [build-addon]
     steps:
@@ -241,6 +271,7 @@ jobs:
           pattern: addon-digests-*
 
   merge-addon:
+    if: github.event_name != 'pull_request'
     runs-on: ubuntu-latest
     needs: [merge-addon-artifacts]
     permissions:
@@ -265,6 +296,11 @@ jobs:
         uses: docker/metadata-action@v5
         with:
           images: ${{ env.REGISTRY }}/${{ steps.lower-repo.outputs.ADDON_IMAGE_NAME }}
+          tags: |
+            type=raw,value=next,enable=${{ github.ref == 'refs/heads/develop' }}
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
 
       - name: Log in to Container registry
         uses: docker/login-action@v3

.gitignore

@@ -19,7 +19,7 @@ certs/
 *.pem
 
 # Configuration files
-config.json
+config/config.json
 
 # IDE
 .idea/

CHANGELOG.md

@@ -1,4 +1,10 @@
 # Changelog
+## [1.2.0] - 2025-07-19
+- Support multiple remote brokers via new `brokers.json`
+- Added broker configuration for the new 2025 Hame cloud
+- Added device types `JPLS-8H` and `HMG-25`
+- Log level can now be adjusted via the `LOG_LEVEL` environment variable
+- Automatically select the appropriate broker based on device firmware
 
 ## [1.1.11]
 - Add support for HMM-1 (Jupiter)

Dockerfile

@@ -12,9 +12,6 @@ RUN npm ci
 # Copy source code
 COPY src/ ./src/
 
-# Copy certificates during build
-COPY certs/ca.crt certs/client.crt certs/client.key ./src/certs/
-
 # Build the application
 RUN npm run build
 
@@ -35,8 +32,11 @@ COPY package.json ./
 COPY --from=builder /build/node_modules ./node_modules
 COPY --from=builder /build/dist/ ./dist/
 
+# Copy brokers configuration
+COPY brokers.json ./brokers.json
+
 # Copy embedded certificates
-COPY --from=builder /build/src/certs/ ./certs/
+COPY certs/ ./certs/
 
 # Create config directory
 RUN mkdir -p /app/config

README.md

@@ -88,10 +88,11 @@ mkdir config
 {
   "broker_url": "mqtt://username:password@your-broker-url",
   "inverse_forwarding": false,
+  "default_broker_id": "hame-2024",
   "username": "your_hame_email@example.com",
   "password": "your_hame_password",
   "devices": [
-    { "device_id": "24-digit-device-id", "mac": "maccaddresswithoutcolons", "type": "HMA-1" }
+    { "device_id": "24-digit-device-id", "mac": "maccaddresswithoutcolons", "type": "HMA-1", "version": 0 }
   ]
 }
 ```
@@ -101,7 +102,13 @@ mkdir config
   - `false` (default): Storage uses local broker, maintain app functionality (**Only available for Saturn/B2500**)
   - `true`: Storage uses Hame broker, enable local control (**Required for Venus/Jupiter, optional for Saturn/B2500**)
 - `username` and `password`: Your Hame account credentials for automatic device information retrieval
+- `default_broker_id`: Identifier of the remote broker to use (defaults to `hame-2024`)
 - `devices`: Your storage systems' details (can use dummy values initially if using automatic retrieval)
+- Remote broker settings are loaded from `brokers.json`. Each broker can specify
+  `topic_prefix`, `client_id_prefix` (defaults to `hm_`), and an optional
+  `topic_encryption_key` used to generate remote device identifiers.
+  `use_remote_topic_id_versions` can specify firmware versions that require
+  using the remote topic ID structure.
 
 **Getting Device Information:**
 - **Recommended**: If you provide `username` and `password`, the relay can fetch your device information automatically from the Hame API. Check the container logs to see the retrieved device details, then update your configuration with the actual values.
@@ -115,6 +122,7 @@ docker run -d \
   -v "$(pwd)/config:/app/config" \
   ghcr.io/tomquist/hame-relay:main
 ```
+Set `LOG_LEVEL` to control verbosity, e.g. `-e LOG_LEVEL=debug`.
 
 ### Option 2: Using Docker Compose
 
@@ -138,7 +146,10 @@ services:
     restart: unless-stopped
     volumes:
       - ./config:/app/config
+    environment:
+      - LOG_LEVEL=debug
 ```
+Set `LOG_LEVEL` to control verbosity.
 
 4. Start the container:
 ```bash
@@ -177,6 +188,7 @@ devices:
   - device_id: "0123456789abcdef01234567"
     mac: "01234567890a"
     type: "HMA-1"
+    version: 151
   - device_id: "0123456789abcdef01234567"
     mac: "01234567890a"
     type: "HMA-1"
@@ -197,6 +209,7 @@ The add-on will automatically use your Home Assistant MQTT settings if configure
   - `device_id`: Your device's 22 to 24-digit ID
   - `mac`: Your device's MAC address without colons
   - `type`: Your device's type (e.g. HMA-1, HMA-2, HMA-3 etc.)
+  - `version`: (optional) Firmware version used for automatic broker selection. Enter the number without any decimal point (e.g. firmware `226.1` becomes `226`)
   - `inverse_forwarding`: (optional) Override the global setting for the operation mode of this device
 
 ### Optional Configuration
@@ -207,6 +220,7 @@ The add-on will automatically use your Home Assistant MQTT settings if configure
 - `username`: Your Hame account email address. When provided along with password, 
   the tool will automatically fetch device information from the Hame API and display it in the logs.
 - `password`: Your Hame account password. Required when using automatic device information retrieval.
+- `log_level`: Adjust log verbosity (`trace`, `debug`, `info`, `warn`, `error`, `fatal`).
 
 ## Development
 

brokers.json

@@ -0,0 +1,46 @@
+{
+  "hame-2024": {
+    "url": "@certs/hame-2024-url",
+    "ca": "@certs/ca.crt",
+    "cert": "@certs/hame-2024.crt",
+    "key": "@certs/hame-2024.key",
+    "topic_prefix": "hame_energy/",
+    "client_id_prefix": "hm_",
+    "min_versions": {
+      "HMA": 0,
+      "HMB": 0,
+      "HMF": 0,
+      "HMJ": 0,
+      "HMG": 0,
+      "HMM": 0,
+      "HMN": 0,
+      "JPLS": 0
+    }
+  },
+  "hame-2025": {
+    "url": "@certs/hame-2025-url",
+    "ca": "@certs/ca.crt",
+    "cert": "@certs/hame-2025.crt",
+    "key": "@certs/hame-2025.key",
+    "topic_prefix": "marstek_energy/",
+    "local_topic_prefix": "hame_energy/",
+    "client_id_prefix": "mst_",
+    "topic_encryption_key": "@certs/hame-2025-topic-encryption-key",
+    "use_remote_topic_id_versions": {
+      "HMA": [226],
+      "HMF": [226],
+      "HMK": [226],
+      "HMJ": [108]
+    },
+    "min_versions": {
+      "HMA": 226,
+      "HMF": 226,
+      "HMJ": 108,
+      "HMK": 226,
+      "HMG": 153,
+      "HMM": 135,
+      "HMN": 135,
+      "JPLS": 135
+    }
+  }
+}

hassio-addon/Dockerfile

@@ -36,6 +36,9 @@ COPY package.json ./
 COPY --from=builder /build/node_modules ./node_modules
 COPY --from=builder /build/dist/ ./dist/
 
+# Copy brokers configuration
+COPY brokers.json ./brokers.json
+
 # Copy certificates
 COPY certs/ ./certs/
 

hassio-addon/config.yaml

@@ -1,5 +1,5 @@
 name: "Hame Relay"
-version: "1.1.11"
+version: "1.2.0"
 slug: "hame_relay"
 description: "Connect B2500 storage to Home Assistant while keeping mobile app functionality"
 url: "https://github.com/tomquist/hame-relay"
@@ -16,17 +16,23 @@ services:
 watchdog: "http://[HOST]:[PORT:8080]/health"
 options:
   inverse_forwarding: false
+  default_broker_id: hame-2024
+  log_level: info
   devices:
     - device_id: "24-digit-device-id"
       mac: "maccaddresswithoutcolons"
       type: "HMA-1"
+      version: 0
 schema:
   mqtt_uri: str?
   inverse_forwarding: bool?
+  default_broker_id: list(hame-2024|hame-2025)?
+  log_level: list(trace|debug|info|warn|error|fatal)?
   username: str?
   password: password?
   devices:
     - device_id: str
       mac: str
       type: str
+      version: int?
       inverse_forwarding: bool?