Skip to content

Latest commit

 

History

History
471 lines (449 loc) · 15.4 KB

README.md

File metadata and controls

471 lines (449 loc) · 15.4 KB
Raw

npm-vwconnectapi

NPM package for a VW Connect API based on https://github.com/TA2k/ioBroker.vw-connect

Clone this repository to $path and use

sudo npm install --location=global $path

to install.

Example code:

const api = require('npm-vwconnectapi');
var log = new api.Log();
var vwConn = new api.VwWeConnect();
vwConn.setLogLevel("INFO"); // optional, ERROR (default), INFO, WARN or DEBUG
vwConn.setCredentials("YourEmail", "YourPassword", "YourPin");
vwConn.setConfig("id"); // type
vwConn.getData()
  .then(() => {
    log.info("SOC " + vwConn.idData.data.batteryStatus.currentSOC_pct + "%");

    vwConn.setActiveVin("the VIN of your ID"); // must exist in vwConn.vehicles
    //vwConn.startClimatisation(17).then(...)
    //vwConn.stopClimatisation().then(...)
    //vwConn.stopCharging().then(...)
    vwConn.startCharging()
      .then(() => {
        log.info("Charging started");
      })
      .catch(() => {
        log.error("Error while starting the charging");
      })
      .finally(() => {
        log.info("Exiting ...");
        vwConn.onUnload();
        process.exit(1);
      });
  })
  .catch(() => {
    log.error("something went wrong");
    process.exit(1);
  });

Methods supplied by the API:

All methods work with promises.

vwConn.setCredentials(user, password, pin)

Login credentials. Pin is not needed for the ID connect, but probably for other car types.

vwConn.setConfig(type)

Set the login type.

  • "id" for the ID series.
  • "idCharger" for ID Charger without an ID linked to the account.
  • Other possible values "vw", "skoda", "seat", "audi", "vwv2" and "go".

vwConn.setLogLevel(logLevel)

Set/change the log level to "DEBUG", "INFO" or "ERROR" (default).

vwConn.getData()

Fills all data objects. If the process is not explicitly exited after getData (see example) it will regularly update the data in a given interval.

vwConn.setActiveVin(VIN)

Sets the VIN that is used for climatisation and charging. Setting is mandatory before clima or charging actions, VIN needs to exists in the vwConn.vehicles data.

vwConn.startClimatisation(temperature)

Start the air-conditioning with the given temperature.

vwConn.stopClimatisation()

Stop the air-conditioning.

vwConn.setTargetSOC(targetSOC)

Change the target SOC for charging.

vwConn.startCharging()

Start charging.

vwConn.stopCharging()

Stop charging.

Objects supplied by the API:

vwConn.vehicles - List of vehicles

{
  "data": [
  {
    "vin":"WVWZZZE1ZMP123456",
    "role":"PRIMARY_USER",
    "enrollmentStatus":"COMPLETED",
    "model":"test",
    "nickname":"ID.3",
    "capabilities": [
      { "id":"access", "status":[1008], "userDisablingAllowed":false },
      { "id":"automation", "expirationDate":"2024-01-11T00:00:00Z", "userDisablingAllowed":true },
      { "id":"charging", "expirationDate":"2024-01-11T00:00:00Z", "userDisablingAllowed":true},
      { "id":"chargingStations", "status":[4001], "expirationDate":"2024-01-11T00:00:00Z", "userDisablingAllowed":true},
      { "id":"climatisation", "expirationDate":"2024-01-11T00:00:00Z", "userDisablingAllowed":true },
      { "id":"destinations", "expirationDate":"2024-01-11T00:00:00Z", "userDisablingAllowed":true },
      { "id":"fuelStatus", "userDisablingAllowed":false },
      { "id":"ignition", "status":[1008], "userDisablingAllowed":false },
      { "id":"mapUpdate", "status":[4001], "expirationDate":"2024-01-11T00:00:00Z", "userDisablingAllowed":true },
      { "id":"measurements", "status":[1008], "userDisablingAllowed":false },
      { "id":"onlineSpeech", "expirationDate":"2024-01-11T00:00:00Z", "userDisablingAllowed":true },
      { "id":"parkingPosition", "status":[1008], "userDisablingAllowed":false },
      { "id":"routing", "expirationDate":"2024-01-11T00:00:00Z", "userDisablingAllowed":true },
      { "id":"state", "status":[1008], "userDisablingAllowed":false },
      { "id":"trafficInformation", "status":[4001], "expirationDate":"2024-01-11T00:00:00Z", "userDisablingAllowed":true },
      { "id":"vehicleLights", "status":[1008], "userDisablingAllowed":false },
      { "id":"webRadio", "expirationDate":"2024-01-11T00:00:00Z", "userDisablingAllowed":true }
    ],
    "images": {}
  }
  ]
}

vwConn.stations - List of wallboxes

[
{
  "connection_state":"connected",
  "connectors": [
    {
    "availability":"available",
    "id":"1"
    }
  ],
  "id": "asdfd-asdf-asdf-abbd-dfasfasdfsdf",
  "last_contact":"2021-02-14T14:36:16.815Z",
  "lifecycle_state":"activated",
  "name":"Zuhause",
  "authorization_mode":"authorization_csms",
  "model":"EVBOX_MGWB"
}
]

vwConn.homechargingRecords - Charging records of the wallbox

[
{
 "authentication_method":"private_card_owned", // none / private_card_owned / ???
 "authorization_mode":"authorization_csms", // no_authorization_cs / authorization_csms / ???
 "charging_session_id":"0ab26cbe-4421-47f0-bd4b-asfasfdsdsd",
 "connector_id":1,
 "rfid_card_id":"e1f2b4de-c265-46da-8307-sfasfsdf", // optional, only when authentication_method != none
 "rfid_card_label":"We Charge Wallbox Card", // optional, only when authentication_method != none
 "rfid_card_serial_number":"VW-ASDFASDF-asdf-1", // optional, only when authentication_method != none
 "session_faulted":false,
 "start_date_time":"2021-02-10T11:21:56.000Z",
 "station_id":"d29f2eb8-asdf-asdf-asdf-asdfsdfds",
 "station_name":"Zuhause",
 "station_serial_number":"1055dfsdfas",
 "stop_date_time":"2021-02-12T19:26:13.000Z",
 "total_energy_wh":"17230",
 "transaction_id":"ba75dcf5-3146-4453-a9a1-asdfewasdfs",
 "station_model":"EVBOX_MGWB",
 "current_station_name":"Zuhause"
},
{
...more records...
}
]

vwConn.chargeAndPay - Charging records from WeCharge subscriptions

[
{
  "id":"99c0a332-3243-47c4-1234-b1a4d12342-1234243,
  “subscription_id":"1899c83f-e5db-49d0-9aba-396328363“,
  “location_evse_id":"DE*HLG*E123456*5“,
  “location_name“:“some location name“,
  “location_address“:“some location address“,
  “location_connector_power_type":"AC_3_PHASE",
  "location_coordinates_latitude":"52.12345",
  "location_coordinates_longitude“:“9.123456",
  "currency":"EUR",
  "total_energy":0.333,
  "total_price":0.105,
  "total_time":235,
  "created_at":"2021-03-07T15:15:15.166Z",
  "updated_at":"2021-03-07T15:15:15.734Z",
  "end_date_time":"2021-03-07T15:15:10.000Z",
  "start_date_time":"2021-03-07T15:11:15.000Z",
  "timezone":"Europe/Berlin"
},
{
...more records...
}
]

vwConn.idData - Car data for the IDs

{
    "automation": {
        "climatisationTimer": {
            "value": {
                "timers": [
                    {
                        "id": 1,
                        "enabled": false,
                        "singleTimer": {
                            "startDateTime": "2021-03-02T06:00:00Z"
                        }
                    },
                    {
                        "id": 2,
                        "enabled": false,
                        "singleTimer": {
                            "startDateTime": "2021-04-30T23:00:00Z"
                        }
                    }
                ],
                "carCapturedTimestamp": "2023-02-03T16:59:11.753Z",
                "timeInCar": "2023-02-03T17:59:11+01:00"
            }
        },
        "chargingProfiles": {
            "value": {
                "carCapturedTimestamp": "2023-02-03T16:59:12.941Z",
                "timeInCar": "2023-02-03T17:59:11+01:00",
                "profiles": []
            }
        }
    },
    "userCapabilities": {
        "capabilitiesStatus": {
            "value": [
                {
                    "id": "webApp",
                    "userDisablingAllowed": false
                },
                {
                    "id": "automation",
                    "expirationDate": "2024-01-31T00:00:00Z",
                    "userDisablingAllowed": true
                },
                {
                    "id": "charging",
                    "expirationDate": "2024-01-31T00:00:00Z",
                    "userDisablingAllowed": true
                },
                {
                    "id": "chargingProfiles",
                    "expirationDate": "2024-01-31T00:00:00Z",
                    "userDisablingAllowed": false
                },
                {
                    "id": "chargingStations",
                    "expirationDate": "2024-01-31T00:00:00Z",
                    "userDisablingAllowed": true
                },
                {
                    "id": "climatisation",
                    "expirationDate": "2024-01-31T00:00:00Z",
                    "userDisablingAllowed": true
                },
                {
                    "id": "climatisationTimers",
                    "expirationDate": "2024-01-31T00:00:00Z",
                    "userDisablingAllowed": false
                },
                {
                    "id": "destinations",
                    "expirationDate": "2024-01-31T00:00:00Z",
                    "userDisablingAllowed": true
                },
                {
                    "id": "fuelStatus",
                    "expirationDate": "2024-01-31T00:00:00Z",
                    "userDisablingAllowed": false
                },
                {
                    "id": "ignition",
                    "expirationDate": "2024-01-31T00:00:00Z",
                    "userDisablingAllowed": false
                },
                {
                    "id": "mapUpdate",
                    "expirationDate": "2024-01-31T00:00:00Z",
                    "userDisablingAllowed": true
                },
                {
                    "id": "onlineSpeech",
                    "expirationDate": "2024-01-31T00:00:00Z",
                    "userDisablingAllowed": true
                },
                {
                    "id": "parkingInformation",
                    "expirationDate": "2024-01-31T00:00:00Z",
                    "userDisablingAllowed": true
                },
                {
                    "id": "readiness",
                    "userDisablingAllowed": false
                },
                {
                    "id": "routing",
                    "expirationDate": "2024-01-31T00:00:00Z",
                    "userDisablingAllowed": true
                },
                {
                    "id": "trafficInformation",
                    "expirationDate": "2024-01-31T00:00:00Z",
                    "userDisablingAllowed": true
                },
                {
                    "id": "webRadio",
                    "status": [
                        1004
                    ],
                    "expirationDate": "2024-01-31T00:00:00Z",
                    "userDisablingAllowed": true
                }
            ]
        }
    },
    "charging": {
        "batteryStatus": {
            "value": {
                "carCapturedTimestamp": "2023-02-02T16:44:30Z",
                "currentSOC_pct": 63,
                "cruisingRangeElectric_km": 198
            }
        },
        "chargingStatus": {
            "value": {
                "carCapturedTimestamp": "2023-02-02T16:44:30Z",
                "remainingChargingTimeToComplete_min": 0,
                "chargingState": "readyForCharging",
                "chargeMode": "manual",
                "chargePower_kW": 0,
                "chargeRate_kmph": 0,
                "chargeType": "invalid",
                "chargingSettings": "default"
            }
        },
        "chargingSettings": {
            "value": {
                "carCapturedTimestamp": "2023-02-03T16:59:15Z",
                "maxChargeCurrentAC": "maximum",
                "autoUnlockPlugWhenCharged": "off",
                "autoUnlockPlugWhenChargedAC": "off",
                "targetSOC_pct": 90
            }
        },
        "plugStatus": {
            "value": {
                "carCapturedTimestamp": "2023-02-03T16:59:14Z",
                "plugConnectionState": "disconnected",
                "plugLockState": "unlocked",
                "externalPower": "unavailable",
                "ledColor": "none"
            }
        },
        "chargeMode": {
            "value": {
                "preferredChargeMode": "manual",
                "availableChargeModes": [
                    "invalid"
                ]
            }
        }
    },
    "climatisation": {
        "climatisationStatus": {
            "value": {
                "carCapturedTimestamp": "2023-02-03T16:59:13Z",
                "remainingClimatisationTime_min": 0,
                "climatisationState": "off"
            }
        },
        "climatisationSettings": {
            "value": {
                "carCapturedTimestamp": "2023-02-03T16:59:14Z",
                "targetTemperature_C": 22,
                "targetTemperature_F": 72,
                "unitInCar": "celsius",
                "climatizationAtUnlock": false,
                "windowHeatingEnabled": false,
                "zoneFrontLeftEnabled": true,
                "zoneFrontRightEnabled": true
            }
        },
        "windowHeatingStatus": {
            "value": {
                "carCapturedTimestamp": "2023-02-03T16:59:13Z",
                "windowHeatingStatus": [
                    {
                        "windowLocation": "front",
                        "windowHeatingState": "off"
                    },
                    {
                        "windowLocation": "rear",
                        "windowHeatingState": "off"
                    }
                ]
            }
        }
    },
    "climatisationTimers": {
        "climatisationTimersStatus": {
            "value": {
                "timers": [
                    {
                        "id": 1,
                        "enabled": false,
                        "singleTimer": {
                            "startDateTime": "2021-03-02T06:00:00Z"
                        }
                    },
                    {
                        "id": 2,
                        "enabled": false,
                        "singleTimer": {
                            "startDateTime": "2021-04-30T23:00:00Z"
                        }
                    }
                ],
                "carCapturedTimestamp": "2023-02-03T16:59:11.753Z",
                "timeInCar": "2023-02-03T17:59:11+01:00"
            }
        }
    },
    "fuelStatus": {
        "rangeStatus": {
            "value": {
                "carCapturedTimestamp": "2023-02-02T16:44:30Z",
                "carType": "electric",
                "primaryEngine": {
                    "type": "electric",
                    "currentSOC_pct": 63,
                    "remainingRange_km": 198
                },
                "totalRange_km": 198
            }
        }
    },
    "readiness": {
        "readinessStatus": {
            "value": {
                "connectionState": {
                    "isOnline": true,
                    "isActive": false,
                    "batteryPowerLevel": "comfort",
                    "dailyPowerBudgetAvailable": true
                },
                "connectionWarning": {
                    "insufficientBatteryLevelWarning": false,
                    "dailyPowerBudgetWarning": false
                }
            }
        }
    },
    "chargingProfiles": {
        "chargingProfilesStatus": {
            "value": {
                "carCapturedTimestamp": "2023-02-03T16:59:12.941Z",
                "timeInCar": "2023-02-03T17:59:11+01:00",
                "profiles": []
            }
        }
    }
}

vwConn.carData - Car data for all others? Can't test it.