kirbownz/electrolux-to-mqtt repository overview

docker pull kirbownz/electrolux-to-mqtt:latest
docker run --rm \
  # Mandatory variables \
  -e MQTT_URL=mqtt://192.168.1.1:1883 \
  -e MQTT_USERNAME=mqtt-user \
  -e MQTT_PASSWORD=mqtt-password \
  -e ELECTROLUX_API_KEY=electrolux-api-key \
  -e [email protected] \
  -e ELECTROLUX_PASSWORD=electrolux-password \
  -e ELECTROLUX_COUNTRY_CODE=FI \
  # Optional variables \
  # -e MQTT_TOPIC_PREFIX=electrolux_ \
  # -e MQTT_CLIENT_ID=electrolux-comfort600 \
  # -e MQTT_RETAIN=false \
  # -e MQTT_QOS=2 \
  # -e ELECTROLUX_REFRESH_INTERVAL=30 \
  # -e ELECTROLUX_APPLIANCE_DISCOVERY_INTERVAL=300 \
  # -e ELECTROLUX_RENEW_TOKEN_BEFORE_EXPIRY=60 \
  # -e ELECTROLUX_COMMAND_STATE_DELAY_SECONDS=30 \
  # -e ELECTROLUX_APPLIANCE_REMOVAL_GRACE_PERIOD_MINUTES=30 \
  # -e ELECTROLUX_API_TIMEOUT_SECONDS=25 \
  # -e HOME_ASSISTANT_AUTO_DISCOVERY=true \
  # -e HOME_ASSISTANT_REVERT_STATE_ON_REJECTION=false \
  # -e HA_BIRTH_REPUBLISH=true \
  # -e HA_STATUS_TOPIC=homeassistant/status \
  # -e HA_BIRTH_PAYLOAD=online \
  # -e LOG_LEVEL=info \
  # -e LOGGING_SHOW_CHANGES=true \
  # -e LOGGING_IGNORED_KEYS=networkInterface,totalRuntime \
  # -e LOGGING_SHOW_VERSION_NUMBER=true \
  # -e LOGGING_SKIP_CACHE_LOGGING=true \
  # -e LOGGING_SHOW_TIMESTAMP=true \
  # -e VERSION_CHECK_INTERVAL=3600 \
  # -e VERSION_CHECK_NOTIFY_GRACE_PERIOD=3600 \
  # -e VERSION_CHECK_NTFY_WEBHOOK_URL=https://ntfy.sh/vB66ozQaRiqhTE9j \ # Register your own at https://ntfy.sh/
  # -e VERSION_CHECK_UPDATE_CHANNEL=stable \                                   # image default (omit unless pinning)
  # -e HEALTH_CHECK_ENABLED=true \
  # -e HEALTH_CHECK_FILE_PATH=/tmp/e2m-health \
  # -e HEALTH_CHECK_UNHEALTHY_RESTART_MINUTES=45 \
  # -e E2M_TELEMETRY_ENABLED=true \
  --name electrolux-to-mqtt kirbownz/electrolux-to-mqtt:latest

services:
  electrolux-to-mqtt:
    image: kirbownz/electrolux-to-mqtt:latest
    mem_limit: 128mb
    memswap_limit: 256mb
    restart: unless-stopped
    volumes:
      - "/etc/localtime:/etc/localtime:ro"
      - "/etc/timezone:/etc/timezone:ro"
    environment:
      # Mandatory variables
      - MQTT_URL=mqtt://192.168.1.1:1883
      - MQTT_USERNAME=mqtt-user
      - MQTT_PASSWORD=mqtt-password
      - ELECTROLUX_API_KEY=electrolux-api-key
      - [email protected]
      - ELECTROLUX_PASSWORD=electrolux-password
      - ELECTROLUX_COUNTRY_CODE=FI
      # Optional variables (uncomment as needed)
      # - MQTT_TOPIC_PREFIX=electrolux_
      # - MQTT_CLIENT_ID=electrolux-comfort600
      # - MQTT_RETAIN=false
      # - MQTT_QOS=2
      # - ELECTROLUX_REFRESH_INTERVAL=30
      # - ELECTROLUX_APPLIANCE_DISCOVERY_INTERVAL=300
      # - ELECTROLUX_RENEW_TOKEN_BEFORE_EXPIRY=60
      # - ELECTROLUX_COMMAND_STATE_DELAY_SECONDS=30
      # - ELECTROLUX_APPLIANCE_REMOVAL_GRACE_PERIOD_MINUTES=30
      # - ELECTROLUX_API_TIMEOUT_SECONDS=25
      # - HOME_ASSISTANT_AUTO_DISCOVERY=true
      # - HOME_ASSISTANT_REVERT_STATE_ON_REJECTION=false
      # - HA_BIRTH_REPUBLISH=true
      # - HA_STATUS_TOPIC=homeassistant/status
      # - HA_BIRTH_PAYLOAD=online
      # - LOG_LEVEL=info
      # - LOGGING_SHOW_CHANGES=true
      # - LOGGING_IGNORED_KEYS=networkInterface,totalRuntime
      # - LOGGING_SHOW_VERSION_NUMBER=true
      # - LOGGING_SKIP_CACHE_LOGGING=true
      # - LOGGING_SHOW_TIMESTAMP=true
      # - VERSION_CHECK_INTERVAL=3600
      # - VERSION_CHECK_NOTIFY_GRACE_PERIOD=3600
      # - VERSION_CHECK_NTFY_WEBHOOK_URL=https://ntfy.sh/vB66ozQaRiqhTE9j # Register your own at https://ntfy.sh/
      # - VERSION_CHECK_UPDATE_CHANNEL=stable                              # image default (omit unless pinning)
      # - HEALTH_CHECK_ENABLED=true
      # - HEALTH_CHECK_FILE_PATH=/tmp/e2m-health
      # - HEALTH_CHECK_UNHEALTHY_RESTART_MINUTES=45
      # - E2M_TELEMETRY_ENABLED=true

docker pull kirbownz/electrolux-to-mqtt:next
docker run --rm -v ./config.yml:/app/config.yml:ro --name electrolux-to-mqtt kirbownz/electrolux-to-mqtt:next

image: kirbownz/electrolux-to-mqtt:next

# Copy config.example.yml
cp config.example.yml config.yml

# Modify as needed
code config.yml

# Make sure you have the correct toolchain (Node.js etc. — pinned in mise.toml)
# If you don't have mise installed, follow https://mise.jdx.dev/getting-started.html
mise install

# Install correct pnpm version if not installed already
corepack enable
corepack install

# Install the dependencies
pnpm install

# Run the app in development mode
pnpm dev

# Make a copy of the docker-compose.local.example.yml
cp docker/docker-compose.local.example.yml docker/docker-compose.local.yml

# Modify as needed
code docker/docker-compose.local.yml

# Run the stack (automatically uses Node version from .nvmrc)
NODE_VERSION=$(cat .nvmrc) docker compose -f docker/docker-compose.local.yml down ; NODE_VERSION=$(cat .nvmrc) docker compose -f docker/docker-compose.local.yml up --build

# Or if you have pnpm installed:
pnpm dev:docker

# Run all tests
pnpm test

# To run E2E tests (including version-checker E2E):
pnpm test:e2e

# You can override the ntfy notification topic for E2E tests with:
E2M_NTFY_TOPIC=yourtopic pnpm test:e2e
# If not set, the default topic is `vB66ozQaRiqhTE9j`.

# Run tests in watch mode (auto-rerun on changes)
pnpm test:watch