diff --git a/.github/workflows/build_image.yml b/.github/workflows/build_image.yml index d7153fc..d17566a 100644 --- a/.github/workflows/build_image.yml +++ b/.github/workflows/build_image.yml @@ -10,37 +10,40 @@ name: Create and publish a Docker image on: - push: - branches: ['main'] - + release: + types: [created] + env: REGISTRY: ghcr.io IMAGE_NAME: ${{ github.repository }} jobs: build-and-push-image: - runs-on: ubuntu-latest + runs-on: ubuntu-latest permissions: contents: read packages: write steps: - name: Checkout repository - uses: actions/checkout@v3 - + uses: actions/checkout@v3 + - name: Set up QEMU + uses: docker/setup-qemu-action@v2 + with: + platforms: 'arm64,arm' + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v2 - name: Log in to the Container registry uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1 with: registry: ${{ env.REGISTRY }} username: ${{ github.actor }} password: ${{ secrets.GITHUB_TOKEN }} - - name: Extract metadata (tags, labels) for Docker id: meta uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7 with: images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} - - name: Build and push Docker image uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4 with: diff --git a/README.md b/README.md index f3461ab..45e2a62 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ -# volvo2mqtt -Home Assistant addon for connecting AAOS Volvos +# Volvo2Mqtt + +This component establishes a connection between the newer AAOS Volvo cars and Home Assistant via MQTT.
+Maybe this component works also with other Volvo cars. Please try out the native Volvo [integration](https://www.home-assistant.io/integrations/volvooncall/) before using this component! If the native component doesn't work for your car, try this mqtt bridge. + +## Setup + +Just install this addon with the following command. +Please note to fill in your settings inside the environment variables. + +`docker run -e CONF_updateInterval=300 -e CONF_babelLocale='de' -e CONF_mqtt='@json {"broker": "", "username": "", "password": ""}' -e CONF_volvoData='@json {"username": "", "password": "", "vin": ""}' -e TZ='Europe/Berlin' --name volvo2mqtt ghcr.io/dielee/volvo2mqtt:main` + +Here is what every option means: + +| Name | Type | Default | Description | +| -------------------- | :-------: | :----------: | --------------------------------------------------------------- | +| `updateInterval` | `int` | **required** | Updateintervall in seconds. | +| `babelLocale` | `string` | **required** | Locale for date Format | +| `mqtt` | `json` | **required** | Broker = Mqtt Broker IP / Username and Passwort are optional! | +| `volvoData` | `json` | **required** | Username and password are required. Car vin is optional. If no vin is provided, the system will always use the first vehicle in API. | +| `TZ` | `string` | | Container timezone eg "Europe/Berlin" |