Neutralize Pesky Miscreants

    nodejs-connected-drive
    TypeScript icon, indicating that this package has built-in type declarations

    3.1.1 • Public • Published

    BMW Connected Drive

    A NodeJS client library written in TypeScript with test coverage. The implementation is intended for use in Smart Home applications.

    Requirements

    node >= 12.0

    Installation

    npm i -S nodejs-connected-drive

    Example usage

    import { ConnectedDrive, RemoteService } from "nodejs-connected-drive";
    
    // Setup the API client
    const api = new ConnectedDrive(username, password);
    
    // Fetch a list of vehicles associated with the credentials
    const [{vin: vehicleIdentificationNumber}] = await api.getVehicles();
    
    // Trigger the Remote Service for remotely heating/cooling the car.
    await api.executeRemoteService(vehicleIdentificationNumber, RemoteService.CLIMATE_NOW);

    API

    Documentation is available here

    Notable functions are listed on the ConnectedDrive class:

    • ConnectedDrive.getVehicles
    • ConnectedDrive.executeRemoteService
    • ConnectedDrive.getStatusOfAllVehicles
    • ConnectedDrive.getVehicleDetails
    • ConnectedDrive.getVehicleTechnicalDetails

    Disclaimer

    This library is not an official integration from BMW Connected Drive. This library is neither endorsed nor supported by BMW Connected Drive. This implementation is based on reverse engineering REST calls used by the BMW Connected Drive web app, and may thus intermittently stop working if the underlying API is updated.

    Any utilization, consumption and application of this library is done at the user's own discretion. This library, its maintainers and BMW Connected Drive cannot guarantee the integrity of this library or any applications of this library.

    Install

    npm i nodejs-connected-drive

    DownloadsWeekly Downloads

    11

    Version

    3.1.1

    License

    MIT

    Unpacked Size

    47.3 kB

    Total Files

    47

    Last publish

    Collaborators

    • jorgenkg