iobroker.volvo 0.1.2 → 1.0.0

package/.github/workflows/test-and-release.yml

@@ -40,7 +40,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        node-version: [18.x, 20.x, 22.x]
+        node-version: [20.x, 22.x]
         os: [ubuntu-latest, windows-latest, macos-latest]
 
     steps:
@@ -74,7 +74,7 @@ jobs:
     steps:
       - uses: ioBroker/testing-action-deploy@v1
         with:
-          node-version: '18.x'
+          node-version: '20.x'
           # Uncomment the following line if your adapter cannot be installed using 'npm ci'
           # install-command: 'npm install'
           npm-token: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -4,80 +4,193 @@
 
 [![NPM version](http://img.shields.io/npm/v/iobroker.volvo.svg)](https://www.npmjs.com/package/iobroker.volvo)
 [![Downloads](https://img.shields.io/npm/dm/iobroker.volvo.svg)](https://www.npmjs.com/package/iobroker.volvo)
-![Number of Installations (latest)](http://iobroker.live/badges/volvo-installed.svg)
-![Number of Installations (stable)](http://iobroker.live/badges/volvo-stable.svg)
 
-[![Known Vulnerabilities](https://snyk.io/test/github/TA2k/ioBroker.volvo/badge.svg)](https://snyk.io/test/github/TA2k/ioBroker.volvo)
+## Volvo Cars Adapter for ioBroker
 
-[![NPM](https://nodei.co/npm/iobroker.volvo.png?downloads=true)](https://nodei.co/npm/iobroker.volvo/)
+This adapter connects your Volvo car to ioBroker using the [Volvo Connected Vehicle API](https://developer.volvocars.com/apis/) and [Energy API v2](https://developer.volvocars.com/apis/energy/v2/overview/).
 
-**Tests:** ![Test and Release](https://github.com/TA2k/ioBroker.volvo/workflows/Test%20and%20Release/badge.svg)
+### Supported Features
 
-## volvo adapter for ioBroker
+- 🔋 Battery charge level, electric range, charging status (PHEV / BEV)
+- ⛽ Fuel level, odometer, trip statistics
+- 🚪 Door, window, and lock status
+- 📍 GPS location
+- 🔧 Diagnostics (service warnings, brake fluid, oil, tyres, lights)
+- 🔑 Remote commands (lock/unlock, honk, flash, climatization)
+- 🔄 Automatic data refresh at configurable intervals
+- 🔐 Token persistence — survives adapter restarts without re-login
 
-Volvo On Call and new Electric API for Android Automotive Cars Adapter
+---
 
-## Login for non electric cars
+## Setup Guide
 
-Non Eletric car can login via username and password.
+### 1. Get a VCC API Key
 
-## Eletric Android Automotive Cars need a VCC API Key
+1. Go to [developer.volvocars.com](https://developer.volvocars.com/account/) and sign in (Google or GitHub account).
+2. Create a new **Application**.
+3. Copy the **VCC API Key (Primary)**.
 
-Register/Login into
-<https://developer.volvocars.com/account/>
+![VCC ApiKey](./vccapikey.png)
 
-You need a Google or Github Account this is not related to you APP Credentials
+### 2. Configure the Adapter
 
-Create an Application
+1. Open the adapter settings in ioBroker.
+2. Enter your **Volvo ID email** and **password** (the same credentials you use in the Volvo Cars app).
+3. Paste the **VCC API Key**.
+4. Set the **update interval** (default: 5 minutes).
 
-Copy VCC API Key Primary
+### 3. Login with OTP
 
-![VCC ApiKey](./vccapikey.png)
+The Volvo API uses a two-factor authentication flow with a one-time password (OTP):
+
+1. Click **"Start Login (Send OTP)"** in the adapter settings.
+2. Check your email for the OTP code from Volvo.
+3. Enter the code and click **"Submit OTP"**.
+4. The adapter will store the refresh token so you won't need to repeat this unless the token expires (typically weeks/months).
+
+> **Note:** If the refresh token expires, the adapter will show a warning in the log. Simply repeat the OTP login from the adapter settings.
 
-Paste the API Key in the Instance settings
+---
 
-Enter Volvoe App Username and password.
+## Data Points
 
-## Controling Eletric Android
+The adapter creates the following data point structure under `volvo.0.<VIN>`:
 
-Controlling Eletric Android with the volvo.0.id.remote is not possible at the moment. The commands are send succeful to the API and are accepted but it looks like the API is not complete to control the car.
+| Path | Description |
+|---|---|
+| `energy.batteryChargeLevel.*` | Battery charge level (%), updated timestamp |
+| `energy.electricRange.*` | Electric driving range (km) |
+| `energy.chargingStatus.*` | Charging status (IDLE, CHARGING, etc.) |
+| `energy.chargerConnectionStatus.*` | Charger connection (CONNECTED, DISCONNECTED) |
+| `status.doors.*` | Door states (OPEN/CLOSED), central lock |
+| `status.windows.*` | Window states including sunroof |
+| `status.fuel.*` | Fuel amount (liters) |
+| `status.odometer.*` | Odometer reading (km) |
+| `status.diagnostics.*` | Service warnings, distance/time to service |
+| `status.statistics.*` | Fuel/energy consumption, trip meters |
+| `status.engine-status.*` | Engine running state |
+| `status.warnings.*` | Light warnings (brake lights, fog, indicators, etc.) |
+| `location.*` | GPS coordinates, heading, timestamp |
+| `remote.*` | Remote commands (buttons) |
 
-## Getting started
+## Remote Commands
 
-Use objects under remote to control the vehicle
+Use the buttons under `volvo.0.<VIN>.remote` to control your vehicle:
+
+- `lock` / `unlock` — Lock or unlock the car
+- `climatization-start` / `climatization-stop` — Start or stop pre-conditioning
+- `honk` / `flash` / `honk-flash` — Sound horn, flash lights, or both
+- `lock-reduced-guard` — Lock with reduced guard
+- `refresh` — Manually refresh all data
+
+---
 
 ## Changelog
+
+### 1.0.0 🎉
+
+First stable release — complete rewrite of the Volvo ioBroker adapter.
+
+**New Features:**
+- **Vehicle Details**: Model, year, color and images fetched from API
+- **Retry Logic**: Automatic retry with exponential backoff on API errors (429/5xx)
+- **Command Status Tracking**: Polls async command results (up to 5x) and stores status in `lastCommandStatus`
+- **Auto-Refresh after Commands**: Doors auto-refresh after lock/unlock, engine-status after climatization
+- **Last Update Timestamp**: `lastUpdate` state per vehicle shows last successful data fetch
+- **Admin UI: jsonConfig Migration**: Modern React-based settings UI (Admin5) with i18n support
+- **Admin UI: Connection Test**: Test API connection directly from adapter settings
+- **Admin UI: Vehicle Info**: Display vehicle details from settings page
+
+**Versioning Policy (SemVer):**
+- MAJOR: Breaking changes (config changes, removed states, new minimum Node.js)
+- MINOR: New features (new data points, commands, UI features)
+- PATCH: Bug fixes, dependency updates, cleanup
+
+### 0.2.7
+
+- Extracted inline JavaScript from `admin/index_m.html` into separate `admin/index_m.js`
+- Added ESLint config for admin browser JS (jQuery/browser globals)
+
+### 0.2.6
+
+- Removed obsolete files: `.create-adapter.json` (wrong adapter name), `lib/tools.js` (unused), `.prettierrc.js`/`.prettierignore` (Prettier not installed)
+- Updated `.npmignore` (removed references to deleted `.eslintrc.json`)
+- Updated CI workflow: dropped Node 18 (EOL), testing on Node 20 + 22
+
+### 0.2.5
+
+- Updated all dependencies to latest major versions
+- @alcalzone/release-script 3.7 → 5.1, eslint 9 → 10, @iobroker/testing 5.0 → 5.2
+
+### 0.2.4
+
+- Migrated from ESLint 8 to ESLint 9 (flat config) — fixes CVE-2025-50537
+- Removed deprecated `.eslintrc.json` and `.eslintignore`
+
+### 0.2.3
+
+- Fixed all npm audit vulnerabilities (0 remaining)
+- Added npm overrides for serialize-javascript, diff, esbuild
+
+### 0.2.2
+
+- Fixed ESLint lint error (single quotes)
+- Removed credentials and IPs from AGENTS.md, added discovery instructions
+- Updated devDependencies: @iobroker/testing 5.2, @types/node 25.5, eslint 8.57
+
+### 0.2.1
+
+- Fixed refresh token not being preserved across token refreshes (caused 401 errors after ~25 minutes)
+- Removed dead legacy code: old VOC API (`vocapi.wirelesscar.net`), `request` module, `uuid`, `json-bigint`
+- Updated dependencies: axios 1.14, qs 6.15, json2iob 2.6.22, @iobroker/adapter-core 3.3
+- Added update migration notice for users upgrading from pre-0.2.0 versions
+- Removed unused `newApi` config option from io-package.json
+
+### 0.2.0
+
+- **Complete rewrite of authentication**: Replaced dead `grant_type: password` OAuth flow with new multi-step OTP (one-time password) login via PingFederate
+- **All API endpoints updated to v2**: Vehicle list (`connected-vehicle/v2`), Energy (`energy/v2`), Commands (`connected-vehicle/v2/commands`)
+- **Fixed remote commands**: Changed `Content-Type` from deprecated vendor-specific format to `application/json` (was causing HTTP 415 errors)
+- **Fixed refresh button**: Now triggers a data re-fetch instead of sending an invalid API command (was causing HTTP 404)
+- **Buttons are now proper buttons**: Remote controls use `role: button` with auto-reset instead of toggle booleans
+- **Fixed Energy API parsing**: `batteryChargeLevel`, `electricRange`, `chargingStatus` etc. now update correctly (v2 response format differs from v1)
+- **Added OTP login UI** in adapter settings with step-by-step flow
+- **Added token persistence**: Refresh token stored in ioBroker state, survives adapter restarts
+- **Removed dead code**: Old VOC API (`vocapi.wirelesscar.net`), `extended-vehicle/v1`, `energy/v1`, `newApi` checkbox — all removed
+- **Admin UI localized**: English + German via `words.js`
+- **Updated README** with new setup guide
+
 ### 0.1.2 (2024-05-02)
 
-- added support for v2 api
+- Added support for v2 API
 
 ### 0.1.1
 
-- added location api information
+- Added location API information
 
 ### 0.1.0
 
-- (TA2k) add new api for electric cars
+- (TA2k) Add new API for electric cars
 
 ### 0.0.6
 
-- (TA2k) fix trip object naming
+- (TA2k) Fix trip object naming
 
 ### 0.0.5
 
-- (TA2k) fix receiving data
+- (TA2k) Fix receiving data
 
 ### 0.0.4
 
-- (TA2k) fix jscontroller
+- (TA2k) Fix jscontroller
 
 ### 0.0.3
 
-- (TA2k) fix preclimate
+- (TA2k) Fix preclimate
 
 ### 0.0.2
 
-- (TA2k) initial release
+- (TA2k) Initial release
 
 ## License
 

package/admin/i18n/de/translations.json

@@ -0,0 +1,14 @@
+{
+  "accountSettings": "Kontoeinstellungen",
+  "volvoIdEmail": "Volvo ID E-Mail",
+  "volvoIdPassword": "Volvo ID Passwort",
+  "vccApiKey": "VCC API-Schlüssel",
+  "vccApiKeyHelp": "API-Schlüssel unter developer.volvocars.com beziehen",
+  "updateInterval": "Aktualisierungsintervall (Minuten)",
+  "otpLogin": "Anmeldung mit Einmalpasswort",
+  "otpDescription": "Einstellungen zuerst speichern, dann 'Login starten' klicken um ein Einmalpasswort per E-Mail zu erhalten. Code eingeben und 'OTP bestätigen' klicken.",
+  "startLoginButton": "Login starten (OTP senden)",
+  "otpCode": "Einmalpasswort",
+  "submitOtpButton": "OTP bestätigen",
+  "testConnectionButton": "Verbindung testen"
+}

package/admin/i18n/en/translations.json

@@ -0,0 +1,14 @@
+{
+  "accountSettings": "Account Settings",
+  "volvoIdEmail": "Volvo ID Email",
+  "volvoIdPassword": "Volvo ID Password",
+  "vccApiKey": "VCC API Key",
+  "vccApiKeyHelp": "Get your API key at developer.volvocars.com",
+  "updateInterval": "Update interval (minutes)",
+  "otpLogin": "Login with OTP",
+  "otpDescription": "Save settings first, then click 'Start Login' to receive a one-time password via email. Enter the code and click 'Submit OTP' to complete authentication.",
+  "startLoginButton": "Start Login (Send OTP)",
+  "otpCode": "OTP Code",
+  "submitOtpButton": "Submit OTP",
+  "testConnectionButton": "Test Connection"
+}

package/admin/jsonConfig.json

@@ -0,0 +1,93 @@
+{
+  "i18n": true,
+  "type": "panel",
+  "items": {
+    "_settingsHeader": {
+      "type": "header",
+      "text": "accountSettings",
+      "size": 4
+    },
+    "user": {
+      "type": "text",
+      "label": "volvoIdEmail",
+      "sm": 12,
+      "md": 6
+    },
+    "password": {
+      "type": "password",
+      "label": "volvoIdPassword",
+      "sm": 12,
+      "md": 6
+    },
+    "vccapikey": {
+      "type": "text",
+      "label": "vccApiKey",
+      "help": "vccApiKeyHelp",
+      "sm": 12,
+      "md": 6
+    },
+    "interval": {
+      "type": "number",
+      "label": "updateInterval",
+      "min": 1,
+      "max": 1440,
+      "sm": 12,
+      "md": 6
+    },
+    "_divider1": {
+      "type": "divider"
+    },
+    "_otpHeader": {
+      "type": "header",
+      "text": "otpLogin",
+      "size": 4
+    },
+    "_otpDescription": {
+      "type": "staticText",
+      "text": "otpDescription",
+      "style": {
+        "marginBottom": 16
+      }
+    },
+    "_startLogin": {
+      "type": "sendTo",
+      "label": "startLoginButton",
+      "command": "startLogin",
+      "jsonData": "{\"user\": \"${data.user}\", \"password\": \"${data.password}\"}",
+      "variant": "contained",
+      "color": "primary",
+      "sm": 12,
+      "md": 4
+    },
+    "otp": {
+      "type": "text",
+      "label": "otpCode",
+      "doNotSave": true,
+      "noTranslation": true,
+      "sm": 12,
+      "md": 4
+    },
+    "_submitOtp": {
+      "type": "sendTo",
+      "label": "submitOtpButton",
+      "command": "submitOtp",
+      "jsonData": "{\"otp\": \"${data.otp}\"}",
+      "variant": "contained",
+      "color": "secondary",
+      "sm": 12,
+      "md": 4
+    },
+    "_divider2": {
+      "type": "divider"
+    },
+    "_testConnection": {
+      "type": "sendTo",
+      "label": "testConnectionButton",
+      "command": "testConnection",
+      "jsonData": "{\"vccapikey\": \"${data.vccapikey}\"}",
+      "variant": "outlined",
+      "sm": 12,
+      "md": 4
+    }
+  }
+}

package/io-package.json

@@ -1,8 +1,32 @@
 {
   "common": {
     "name": "volvo",
-    "version": "0.1.2",
+    "version": "1.0.0",
     "news": {
+      "1.0.0": {
+        "en": "First stable release! Vehicle details, retry logic, command status tracking, auto-refresh, jsonConfig Admin5 UI, connection test, vehicle info display",
+        "de": "Erstes stabiles Release! Fahrzeugdetails, Retry-Logik, Befehlsstatus-Tracking, Auto-Refresh, jsonConfig Admin5-UI, Verbindungstest, Fahrzeug-Info-Anzeige"
+      },
+      "0.2.7": {
+        "en": "Extracted inline JS from admin HTML into separate admin/index_m.js",
+        "de": "Inline-JS aus Admin-HTML in separate admin/index_m.js ausgelagert"
+      },
+      "0.2.6": {
+        "en": "Repository cleanup: removed obsolete files, updated CI to Node 20+",
+        "de": "Repository aufgeräumt: veraltete Dateien entfernt, CI auf Node 20+ aktualisiert"
+      },
+      "0.2.5": {
+        "en": "Updated all dependencies to latest major versions",
+        "de": "Alle Abhängigkeiten auf neueste Hauptversionen aktualisiert"
+      },
+      "0.2.4": {
+        "en": "Migrated to ESLint 9 (flat config), fixes CVE-2025-50537",
+        "de": "Migration auf ESLint 9 (Flat Config), behebt CVE-2025-50537"
+      },
+      "0.2.3": {
+        "en": "Fix all npm audit vulnerabilities via overrides",
+        "de": "Alle npm-Audit-Schwachstellen über Overrides behoben"
+      },
       "0.1.2": {
         "en": "added support for v2 api",
         "de": "Unterstützung für v2 api hinzugefügt",
@@ -26,33 +50,38 @@
         "en": "fix trip objects naming"
       }
     },
-    "title": "Volvo On Call",
+    "title": "Volvo Cars",
     "titleLang": {
-      "en": "Volvo On Call",
-      "de": "Volvo On Call",
-      "ru": "Volvo On Call",
-      "pt": "Volvo On Call",
-      "nl": "Volvo On Call",
-      "fr": "Volvo On Call",
-      "it": "Volvo On Call",
-      "es": "Volvo On Call",
-      "pl": "Volvo On Call",
-      "zh-cn": "沃尔沃待命"
+      "en": "Volvo Cars",
+      "de": "Volvo Cars",
+      "ru": "Volvo Cars",
+      "pt": "Volvo Cars",
+      "nl": "Volvo Cars",
+      "fr": "Volvo Cars",
+      "it": "Volvo Cars",
+      "es": "Volvo Cars",
+      "pl": "Volvo Cars",
+      "zh-cn": "沃尔沃汽车"
     },
     "desc": {
-      "en": "Volvo On Call Adapter",
-      "de": "Volvo On Call Adapter",
-      "ru": "Volvo On Call Адаптер",
-      "pt": "Adaptador Volvo On Call",
-      "nl": "Volvo On Call adapter",
-      "fr": "Adaptateur Volvo On Call",
-      "it": "Adattatore Volvo On Call",
-      "es": "Adaptador Volvo On Call",
-      "pl": "Adapter Volvo On Call",
-      "zh-cn": "沃尔沃随车转接器"
+      "en": "Volvo Cars Adapter (Connected Vehicle API v2)",
+      "de": "Volvo Cars Adapter (Connected Vehicle API v2)",
+      "ru": "Volvo Cars Адаптер (Connected Vehicle API v2)",
+      "pt": "Adaptador Volvo Cars (Connected Vehicle API v2)",
+      "nl": "Volvo Cars adapter (Connected Vehicle API v2)",
+      "fr": "Adaptateur Volvo Cars (Connected Vehicle API v2)",
+      "it": "Adattatore Volvo Cars (Connected Vehicle API v2)",
+      "es": "Adaptador Volvo Cars (Connected Vehicle API v2)",
+      "pl": "Adapter Volvo Cars (Connected Vehicle API v2)",
+      "zh-cn": "沃尔沃汽车适配器 (Connected Vehicle API v2)"
     },
-    "authors": ["TA2k <tombox2020@gmail.com>"],
-    "keywords": ["volvo", "volvo on call"],
+    "authors": [
+      "TA2k <tombox2020@gmail.com>"
+    ],
+    "keywords": [
+      "volvo",
+      "volvo cars"
+    ],
     "license": "MIT",
     "platform": "Javascript/Node.js",
     "main": "main.js",
@@ -64,6 +93,7 @@
     "mode": "daemon",
     "type": "vehicle",
     "compact": true,
+    "messagebox": true,
     "connectionType": "cloud",
     "dataSource": "poll",
     "materialize": true,
@@ -71,13 +101,15 @@
       {
         "js-controller": ">=1.4.2"
       }
-    ]
+    ],
+    "adminUI": {
+      "config": "json"
+    }
   },
   "native": {
     "user": "",
     "vccapikey": "",
     "password": "",
-    "newApi": false,
     "interval": 5
   },
   "objects": [],
@@ -103,5 +135,43 @@
       },
       "native": {}
     }
-  ]
+  ],
+  "messages": [
+    {
+      "condition": {
+        "operand": "and",
+        "rules": [
+          "oldVersion<0.2.0",
+          "newVersion>=0.2.0"
+        ]
+      },
+      "title": {
+        "en": "Important: Complete rewrite of authentication",
+        "de": "Wichtig: Authentifizierung komplett neu geschrieben"
+      },
+      "text": {
+        "en": "This update replaces the old Volvo On Call API with the new Volvo Cars Connected Vehicle API v2. After updating:\n\n1. Open the adapter settings\n2. Enter your VCC API Key (get one at developer.volvocars.com)\n3. Click \"Start Login\" and complete the OTP verification\n4. Recommended: Delete and recreate the adapter instance to remove stale data points from the old API",
+        "de": "Dieses Update ersetzt die alte Volvo On Call API durch die neue Volvo Cars Connected Vehicle API v2. Nach dem Update:\n\n1. Öffne die Adapter-Einstellungen\n2. Gib deinen VCC API-Schlüssel ein (erhältlich unter developer.volvocars.com)\n3. Klicke auf \"Login starten\" und schließe die OTP-Verifizierung ab\n4. Empfohlen: Lösche die Adapter-Instanz und erstelle sie neu, um veraltete Datenpunkte der alten API zu entfernen"
+      },
+      "level": "warn",
+      "buttons": [
+        "agree",
+        "cancel"
+      ]
+    }
+  ],
+  "news": {
+    "0.2.1": {
+      "en": "Fix refresh token persistence, remove dead VOC code, update dependencies",
+      "de": "Refresh-Token-Speicherung repariert, alten VOC-Code entfernt, Dependencies aktualisiert"
+    },
+    "0.2.0": {
+      "en": "Complete rewrite: OTP auth, Connected Vehicle API v2, Energy API v2, remote commands fixed, German localization",
+      "de": "Komplett-Umbau: OTP-Authentifizierung, Connected Vehicle API v2, Energy API v2, Fernbedienung repariert, deutsche Übersetzung"
+    },
+    "0.2.2": {
+      "en": "Fix ESLint, update devDependencies, clean AGENTS.md of credentials",
+      "de": "ESLint repariert, devDependencies aktualisiert, Zugangsdaten aus AGENTS.md entfernt"
+    }
+  }
 }

package/lib/extractKeys.js

@@ -161,7 +161,7 @@ function extractArray(adapter, element, key, path, write, preferedArrayName, for
 function isJsonString(str) {
   try {
     JSON.parse(str);
-  } catch (e) {
+  } catch (_e) {
     return false;
   }
   return true;