iobroker.bmw 2.8.3 → 2.8.4

package/README.md

@@ -25,6 +25,13 @@ bmw.0.VIN.properties
 bmw.0.VIN.remotev2
 
 ## Changelog
+
+### 2.8.4 (2024-11-21)
+
+- improved charging session parsing
+- added remote to fetch charging session from a specific month
+- added raw JSON of charging session for export
+
 ### 2.8.3 (2024-11-18)
 
 - login fixed

package/admin/index_m.html

@@ -126,7 +126,18 @@
           <label for="brand" class="translate">Brand</label>
         </div>
       </div>
-
+      <div class="row">
+        <div class="col s6 input-field">
+          <input type="checkbox" class="value" id="fetchChargeStats" />
+          <label for="fetchChargeStats" class="translate">Fetching Charging Statistics (Disable to save quota)</label>
+        </div>
+      </div>
+      <div class="row">
+        <div class="col s6 input-field">
+          <input type="checkbox" class="value" id="fetchChargeSessions" />
+          <label for="fetchChargeSessions" class="translate">Fetching Charging Sessions (Disable to save quota)</label>
+        </div>
+      </div>
       <div class="row">
         <div class="col s2 input-field">
           <input type="number" class="value" id="interval" />

package/io-package.json

@@ -1,8 +1,21 @@
 {
   "common": {
     "name": "bmw",
-    "version": "2.8.3",
+    "version": "2.8.4",
     "news": {
+      "2.8.4": {
+        "en": "improved charging sessios parsing\nadded remote to fetch charging session from a specific month\nadd raw JSON of charging session for export",
+        "de": "verbesserte charging sessios Import\nRemote hinzugefügt, um charging sessios aus einem bestimmten Monat abzurufen\nRohes JSON der charging sessios für den Export hinzugefügt",
+        "ru": "улучшенный сеанс зарядки\nдобавить удаленное к сеансу зарядки с определенного месяца\nдобавить сырой JSON зарядной сессии для экспорта",
+        "pt": "análise de sessão de carregamento melhorada\nadicionar remoto para buscar sessão de carregamento de um mês específico\nadicionar JSON cru da sessão de carregamento para exportação",
+        "nl": "verbeterde laadsessie ontleden\nremote toevoegen aan opladen van een bepaalde maand\nrauw JSON toevoegen van laadsessie voor export",
+        "fr": "amélioration de l'analyse des sessions de chargement\najouter distant pour récupérer la session de chargement à partir d'un mois spécifique\najouter JSON brut de la session de tarification pour l'exportation",
+        "it": "migliore sessione di ricarica\naggiungere la sessione di ricarica remota a fetch da un mese specifico\naggiungere grezzo JSON di sessione di ricarica per l'esportazione",
+        "es": "mejora de la sesión de carga\nañadir remoto para buscar sesión de carga de un mes específico\nañadir JSON crudo de la sesión de carga para la exportación",
+        "pl": "ulepszona sesja pobierania opłat\ndodaj zdalny do pobierania sesji ładowania z określonego miesiąca\ndodać surowy JSON sesji pobierania opłat za eksport",
+        "uk": "поліпшення зарядки сеансу\nдодати дистанційне сеанс зарядки fetch з конкретного місяця\nдодати сиру JSON на зарядку для експорту",
+        "zh-cn": "改进充值会话解析\n添加远程以获取特定月的充电会话\n添加用于导出的充电会话的原始 JSON"
+      },
       "2.8.3": {
         "en": "login fixed",
         "de": "Anmeldung gefixt",
@@ -53,10 +66,6 @@
       "2.7.0": {
         "en": "Improve rate limit handling",
         "de": "Rate Limit Handling verbessert"
-      },
-      "2.6.3": {
-        "en": "Add start and stop charging remotes",
-        "de": "Start und Stop Charging Remotes hinzugefügt"
       }
     },
     "titleLang": {
@@ -125,7 +134,9 @@
     "interval": 5,
     "brand": "bmw",
     "ignorelist": "",
-    "captcha": ""
+    "captcha": "",
+    "fetchChargeStats": true,
+    "fetchChargeSessions": true
   },
   "objects": [],
   "instanceObjects": [

package/main.js

@@ -209,20 +209,29 @@ class Bmw extends utils.Adapter {
       await this.updateDemands();
       await this.sleep(5000);
       await this.updateTrips();
-      this.updateInterval = setInterval(async () => {
-        await this.sleep(2000);
-        await this.updateDevices();
-      }, this.config.interval * 60 * 1000);
-      this.demandInterval = setInterval(async () => {
-        await this.sleep(2000);
-        await this.updateDemands();
-        await this.sleep(5000);
-        await this.updateTrips();
-      }, 24 * 60 * 60 * 1000);
-      this.refreshTokenInterval = setInterval(async () => {
-        await this.refreshToken();
-        await this.sleep(5000);
-      }, (this.session.expires_in - 123) * 1000);
+      this.updateInterval = setInterval(
+        async () => {
+          await this.sleep(2000);
+          await this.updateDevices();
+        },
+        this.config.interval * 60 * 1000,
+      );
+      this.demandInterval = setInterval(
+        async () => {
+          await this.sleep(2000);
+          await this.updateDemands();
+          await this.sleep(5000);
+          await this.updateTrips();
+        },
+        24 * 60 * 60 * 1000,
+      );
+      this.refreshTokenInterval = setInterval(
+        async () => {
+          await this.refreshToken();
+          await this.sleep(5000);
+        },
+        (this.session.expires_in - 123) * 1000,
+      );
     }
   }
   async login() {
@@ -272,16 +281,22 @@ class Bmw extends utils.Adapter {
           this.log.error('Start relogin in 5min');
 
           this.reLoginTimeout && clearTimeout(this.reLoginTimeout);
-          this.reLoginTimeout = setTimeout(async () => {
-            //get adapter settings and set captcha to null
-            const adapterSettings = await this.getForeignObjectAsync('system.adapter.' + this.namespace);
-            adapterSettings.native.captcha = null;
-            await this.setForeignObjectAsync('system.adapter.' + this.namespace, adapterSettings);
-          }, 5000 * 60 * 1);
+          this.reLoginTimeout = setTimeout(
+            async () => {
+              //get adapter settings and set captcha to null
+              const adapterSettings = await this.getForeignObjectAsync('system.adapter.' + this.namespace);
+              adapterSettings.native.captcha = null;
+              await this.setForeignObjectAsync('system.adapter.' + this.namespace, adapterSettings);
+            },
+            5000 * 60 * 1,
+          );
         }
         if (error.response && error.response.status === 400) {
           this.log.error('Please check username and password');
         }
+        if (error.response && error.response.status === 429) {
+          this.log.error('Login Rate Limit exceeded, please wait 5 minutes');
+        }
       });
     if (!authUrl || !authUrl.redirect_to) {
       this.log.error(JSON.stringify(authUrl));
@@ -413,14 +428,18 @@ class Bmw extends utils.Adapter {
             }
           }
           this.vinArray.push(vehicle.vin);
-          await this.extendObjectAsync(vehicle.vin, {
+          let vehicleName = vehicle.model;
+          if (!vehicleName && vehicle.attributes) {
+            vehicleName = vehicle.attributes.model;
+          }
+          await this.extendObject(vehicle.vin, {
             type: 'device',
             common: {
-              name: vehicle.model || vehicle.attributes?.model,
+              name: vehicleName,
             },
             native: {},
           });
-          await this.extendObjectAsync(vehicle.vin + '.state', {
+          await this.extendObject(vehicle.vin + '.state', {
             type: 'channel',
             common: {
               name: 'Current status of the car v4',
@@ -446,14 +465,22 @@ class Bmw extends utils.Adapter {
             { command: 'start-charging' },
             { command: 'stop-charging' },
             { command: 'force-refresh', name: 'Force Refresh' },
+            {
+              command: 'fetch-charges',
+              name: 'Fetch Charge Sessions/Statistics for month',
+              type: 'string',
+              role: 'text',
+              def: '2024-06',
+            },
           ];
           remoteArray.forEach((remote) => {
-            this.setObjectNotExists(vehicle.vin + '.remotev2.' + remote.command, {
+            this.extendObject(vehicle.vin + '.remotev2.' + remote.command, {
               type: 'state',
               common: {
                 name: remote.name || '',
                 type: remote.type || 'boolean',
                 role: remote.role || 'boolean',
+                def: remote.def == null ? false : remote.def,
                 write: true,
                 read: true,
               },
@@ -463,9 +490,10 @@ class Bmw extends utils.Adapter {
           this.json2iob.parse(vehicle.vin, vehicle, {
             forceIndex: true,
             descriptions: this.description,
+            channelName: vehicleName,
           });
 
-          await this.updateChargingSessionv2(vehicle.vin);
+          await this.updateChargingSessionv2(vehicle.vin, 200);
         }
       })
       .catch((error) => {
@@ -477,9 +505,12 @@ class Bmw extends utils.Adapter {
         }
         this.log.info('Adapter will retry in 3 minutes to get vehicles');
         this.reLoginTimeout && clearTimeout(this.reLoginTimeout);
-        this.reLoginTimeout = setTimeout(() => {
-          this.getVehiclesv2();
-        }, 1000 * 60 * 3);
+        this.reLoginTimeout = setTimeout(
+          () => {
+            this.getVehiclesv2();
+          },
+          1000 * 60 * 3,
+        );
       });
     await this.sleep(5000);
   }
@@ -498,7 +529,8 @@ class Bmw extends utils.Adapter {
       headers['bmw-vin'] = vin;
       await this.requestClient({
         method: 'get',
-        url: 'https://cocoapi.bmwgroup.com/eadrax-vcs/v4/vehicles/state?apptimezone=120&appDateTime=' + Date.now() + '&tireGuardMode=ENABLED',
+        url:
+          'https://cocoapi.bmwgroup.com/eadrax-vcs/v4/vehicles/state?apptimezone=120&appDateTime=' + Date.now() + '&tireGuardMode=ENABLED',
         headers: headers,
       })
         .then(async (res) => {
@@ -564,7 +596,7 @@ class Bmw extends utils.Adapter {
             },
             native: {},
           });
-          await this.setStateAsync(vin + '.servicedemands.json', JSON.stringify(res.data), true);
+          await this.setState(vin + '.servicedemands.json', JSON.stringify(res.data), true);
         })
         .catch(async (error) => {
           if (error.response && error.response.status === 429) {
@@ -650,11 +682,11 @@ class Bmw extends utils.Adapter {
   sleep(ms) {
     return new Promise((resolve) => setTimeout(resolve, ms));
   }
-  async updateChargingSessionv2(vin) {
+  async updateChargingSessionv2(vin, maxResults = 40, dateInput) {
     if (this.nonChargingHistory[vin]) {
       return;
     }
-    if (Date.now() - this.lastChargingSessionUpdate < 1000 * 60 * 60 * 6) {
+    if (Date.now() - this.lastChargingSessionUpdate < 1000 * 60 * 60 * 6 && !dateInput) {
       this.log.debug('updateChargingSessionv2 to early ' + vin);
       return;
     }
@@ -670,30 +702,40 @@ class Bmw extends utils.Adapter {
     };
 
     const d = new Date();
-    const dateFormatted =
+    let dateFormatted =
       d.getFullYear().toString() +
       '-' +
       ((d.getMonth() + 1).toString().length == 2 ? (d.getMonth() + 1).toString() : '0' + (d.getMonth() + 1).toString());
     // const day = d.getDate().toString().length == 2 ? d.getDate().toString() : "0" + d.getDate().toString();
-    const fullDate = new Date(new Date().getTime() - new Date().getTimezoneOffset() * 60000).toISOString().replace('Z', '000');
+    let fullDate = new Date(new Date().getTime() - new Date().getTimezoneOffset() * 60000).toISOString().replace('Z', '000');
 
+    if (dateInput) {
+      dateFormatted = dateInput;
+      const tempDate = new Date(dateInput + '-01T00:00:00.000Z');
+      fullDate = new Date(tempDate.getTime() - tempDate.getTimezoneOffset() * 60000).toISOString().replace('Z', '000');
+    }
     const urlArray = [];
-    urlArray.push({
-      url:
-        'https://cocoapi.bmwgroup.com/eadrax-chs/v2/charging-sessions?vin=' +
-        vin +
-        '&next_token&date=' +
-        dateFormatted +
-        '-01T00%3A00%3A00.000Z&maxResults=40&include_date_picker=true',
-      path: '.chargingSessions.',
-      name: 'chargingSessions',
-    });
-
-    urlArray.push({
-      url: 'https://cocoapi.bmwgroup.com/eadrax-chs/v2/charging-statistics?vin=' + vin + '&currentDate=' + fullDate,
-      path: '.charging-statistics.',
-      name: 'charging statistics',
-    });
+    if (this.config.fetchChargeSessions) {
+      urlArray.push({
+        url:
+          'https://cocoapi.bmwgroup.com/eadrax-chs/v2/charging-sessions?vin=' +
+          vin +
+          '&next_token&date=' +
+          dateFormatted +
+          '-01T00%3A00%3A00.000Z&maxResults=' +
+          maxResults +
+          '&include_date_picker=false',
+        path: '.chargingSessions.',
+        name: 'chargingSessions',
+      });
+    }
+    if (this.config.fetchChargeStats) {
+      urlArray.push({
+        url: 'https://cocoapi.bmwgroup.com/eadrax-chs/v2/charging-statistics?vin=' + vin + '&currentDate=' + fullDate,
+        path: '.charging-statistics.',
+        name: 'charging statistics',
+      });
+    }
     for (const element of urlArray) {
       await this.sleep(10000);
       this.log.debug('update ' + vin + element.path);
@@ -708,7 +750,7 @@ class Bmw extends utils.Adapter {
           if (data.chargingSessions) {
             data = data.chargingSessions;
           }
-          await this.extendObjectAsync(vin + element.path + dateFormatted, {
+          await this.extendObject(vin + element.path + dateFormatted, {
             type: 'channel',
             common: {
               name: element.name + ' of the car v2',
@@ -729,13 +771,22 @@ class Bmw extends utils.Adapter {
                 session.id = session.id.split('_')[1] ? session.id.split('_')[1] : session.id;
                 session.timestamp = new Date(session.date).valueOf();
                 if (session.energyCharged.replace) {
-                  session.energy = session.energyCharged.replace('~', '').trim().split(' ')[0];
-                  session.unit = session.energyCharged.replace('~', '').trim().split(' ')[1];
+                  session.energy = session.energyCharged.replace('~', '').replace('<', '').trim().split(' ')[0];
+                  session.unit = session.energyCharged.replace('~', '').replace('<', '').trim().split(' ')[1];
                 }
                 if (session.subtitle.replace) {
-                  const cleanedSubtitle = session.subtitle.replace('~', '').replace('•', '').replace('  ', ' ').replace('  ', ' ').trim();
-                  session.duration = cleanedSubtitle.split(' ')[1];
-                  session.cost = cleanedSubtitle.split(' ')[2];
+                  //subtitle = Zuhause • 2h 16min • ~ 5,97 EUR
+                  //remove all tildes
+                  let cleanedSubtitle = session.subtitle.replace(/~/g, '');
+                  //remove all small than
+                  cleanedSubtitle = cleanedSubtitle.replace(/</g, '');
+                  //split array on dots
+                  cleanedSubtitle = cleanedSubtitle.split('•');
+                  // const cleanedSubtitle = session.subtitle.replace('~', '').replace('•', '').replace('  ', ' ').replace('  ', ' ').trim();
+                  session.location = cleanedSubtitle[0].trim();
+                  session.duration = cleanedSubtitle[1].trim();
+                  session.cost = cleanedSubtitle[2].trim().split(' ')[0];
+                  session.currency = cleanedSubtitle[2].trim().split(' ')[1];
                 }
                 newSessions.push(session);
               } catch (error) {
@@ -743,6 +794,18 @@ class Bmw extends utils.Adapter {
               }
             }
             data.sessions = newSessions;
+            await this.extendObject(vin + element.path + dateFormatted + '.raw', {
+              type: 'state',
+              common: {
+                name: 'Raw Data as JSON',
+                type: 'string',
+                role: 'json',
+                write: false,
+                read: true,
+              },
+              native: {},
+            });
+            await this.setState(vin + element.path + dateFormatted + '.raw', JSON.stringify(data), true);
             await this.json2iob.parse(vin + element.path + dateFormatted, data, { preferedArrayName: 'date' });
             try {
               const datal = data.sessions[0];
@@ -853,9 +916,12 @@ class Bmw extends utils.Adapter {
         error.response && this.log.error(JSON.stringify(error.response.data));
         this.log.error('Start relogin in 1min');
         this.reLoginTimeout && clearTimeout(this.reLoginTimeout);
-        this.reLoginTimeout = setTimeout(() => {
-          this.login();
-        }, 1000 * 60 * 1);
+        this.reLoginTimeout = setTimeout(
+          () => {
+            this.login();
+          },
+          1000 * 60 * 1,
+        );
       });
   }
 
@@ -904,6 +970,11 @@ class Bmw extends utils.Adapter {
           this.updateDevices();
           return;
         }
+        if (command === 'fetch-charges') {
+          this.log.info('fetch charges');
+          await this.updateChargingSessionv2(vin, 200, state.val);
+          return;
+        }
         const action = command.split('_')[1];
         command = command.split('_')[0];
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.bmw",
-  "version": "2.8.3",
+  "version": "2.8.4",
   "description": "Adapter for BMW",
   "author": {
     "name": "TA2k",
@@ -33,7 +33,7 @@
     "@eslint/js": "^9.15.0",
     "@iobroker/testing": "^5.0.0",
     "@tsconfig/node16": "^16.1.3",
-    "@types/node": "^22.9.0",
+    "@types/node": "^22.9.1",
     "eslint": "^9.15.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.2.1",