An unofficial NodeJS library to make OnStar requests.

Use at your own risk. This is an unofficial library.

Use the Get Account Vehicles request to see which requests your vehicle supports if you don't already know.

Use a random version 4 uuid as a deviceId. Generator available here.

import OnStar from "onstarjs";

const onStar = OnStar.create({
  deviceId: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  vin: "1G2ZF58B774109863",
  username: "[email protected]",
  password: "p@ssw0rd",
  onStarPin: "1234",
});

try {
  await onStar.alert({
    action: ["Flash"],
  });

  await onStar.start();
} catch (e) {
  console.error(e);
}

For commands that return data like diagnostics or location, the data returned by the API is accessible via result.response.data

onStar.getAccountVehicles();

onStar.start();

onStar.cancelStart();

onStar.alert([options]);

onStar.cancelAlert();

onStar.lockDoor([options]);

onStar.unlockDoor([options]);

onStar.location();

{ location: { lat: '50', long: '-75' } }

onStar.chargeOverride([options]);

onStar.getChargingProfile();

onStar.setChargingProfile([options]);

onStar.diagnostics([options]);

This project uses pnpm for package management.

Run both unit and functional tests

pnpm test

pnpm test:unit

These tests will execute actual requests to the OnStar API. They will perform a Get Account Vehicles request followed by a Cancel Alert request.

Because of this, the test will require actual OnStar credentials to run. To provide them, copy .env.example to .env and replace the placeholder values inside.

pnpm test:functional

Made possible by mikenemat's work in gm-onstar-probe. Their work describing the process for remote start enabled the rest of the methods implemented here.