OnStarJS
NodeJS Library for making OnStar API requests
Install / Use
/learn @samrum/OnStarJSREADME
Archived
This plugin has been archived and is no longer maintained.
Check out OnStarJS2 for an actively maintained fork.
OnStarJS
An unofficial NodeJS library to make OnStar requests.
Use at your own risk. This is an unofficial library.
Usage
Use the Get Account Vehicles request to see which requests your vehicle supports if you don't already know.
Sample
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: "foo@bar.com",
password: "p@ssw0rd",
onStarPin: "1234",
});
try {
await onStar.alert({
action: ["Flash"],
});
await onStar.start();
} catch (e) {
console.error(e);
}
Additional Configuration Options
<details> <summary>checkRequestStatus</summary>Default Value: true
When false, requests resolve when the API returns an 'In Progress' response. For requests that return data, this option is ignored.
This is useful because, with the usual request polling to wait for a "Complete" response from the API, requests will take much longer to resolve.
</details> <details> <summary>requestPollingIntervalSeconds</summary>Default Value: 6
When checkRequestStatus is true, this is how often status check requests will be made
Default Value: 60
When checkRequestStatus is true, this is how long a request will make subsequent status check requests before timing out.
Responses
For commands that return data like diagnostics or location, the data returned by the API is accessible via result.response.data
Commands
<details> <summary>Get Account Vehicles</summary>onStar.getAccountVehicles();
onStar.start();
onStar.cancelStart();
onStar.alert([options]);
| Option | Default | Valid Values | | -------- | -------------------------- | -------------------------- | | action | ["Flash", "Honk"] | ["Flash", "Honk"] | | delay | 0 | Any integer (minutes) | | duration | 1 | Any integer (minutes) | | override | ["DoorOpen", "IgnitionOn"] | ["DoorOpen", "IgnitionOn"] |
</details> <details> <summary>Cancel Alert</summary>onStar.cancelAlert();
onStar.lockDoor([options]);
| Option | Default | Valid Values | | ------ | ------- | --------------------- | | delay | 0 | Any integer (minutes) |
</details> <details> <summary>Unlock Door</summary>onStar.unlockDoor([options]);
| Option | Default | Valid Values | | ------ | ------- | --------------------- | | delay | 0 | Any integer (minutes) |
</details> <details> <summary>Lock Trunk</summary>Locks the trunk but doesn't automatically close it.
onStar.lockTrunk([options]);
| Option | Default | Valid Values | | ------ | ------- | --------------------- | | delay | 0 | Any integer (minutes) |
</details> <details> <summary>Unlock Trunk</summary>Unlocks the trunk but doesn't automatically open it. All doors remain locked.
onStar.unlockTrunk([options]);
| Option | Default | Valid Values | | ------ | ------- | --------------------- | | delay | 0 | Any integer (minutes) |
</details> <details> <summary>Location</summary>Returns the location of the vehicle
onStar.location();
Example Response
{ location: { lat: '50', long: '-75' } }
onStar.chargeOverride([options]);
| Option | Default | Valid Values | | ------ | ------------ | ------------------------------- | | mode | "CHARGE_NOW" | "CHARGE_NOW", "CANCEL_OVERRIDE" |
</details> <details> <summary>Get Charging Profile</summary>onStar.getChargingProfile();
onStar.setChargingProfile([options]);
| Option | Default | Valid Values | | ---------- | ----------- | ---------------------------------------------------------------------------------------- | | chargeMode | "IMMEDIATE" | "DEFAULT_IMMEDIATE", "IMMEDIATE", "DEPARTURE_BASED", "RATE_BASED", "PHEV_AFTER_MIDNIGHT" | | rateType | "MIDPEAK" | "OFFPEAK", "MIDPEAK", "PEAK" |
</details> <details> <summary>Diagnostics</summary>onStar.diagnostics([options]);
| Option | Default | Valid Values | | -------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | diagnosticItem | ["ODOMETER", "TIRE PRESSURE", "AMBIENT AIR TEMPERATURE", "LAST TRIP DISTANCE"] | ["ENGINE COOLANT TEMP", "ENGINE RPM", "LAST TRIP FUEL ECONOMY", "EV ESTIMATED CHARGE END", "EV BATTERY LEVEL", "OIL LIFE", "EV PLUG VOLTAGE", "LIFETIME FUEL ECON", "HOTSPOT CONFIG", "LIFETIME FUEL USED", "ODOMETER", "HOTSPOT STATUS", "LIFETIME EV ODOMETER", "EV PLUG STATE", "EV CHARGE STATE", "TIRE PRESSURE", "AMBIENT AIR TEMPERATURE", "LAST TRIP DISTANCE", "INTERM VOLT BATT VOLT", "GET COMMUTE SCHEDULE", "GET CHARGE MODE", "EV SCHEDULED CHARGE START", "FUEL TANK INFO", "HANDS FREE CALLING", "ENERGY EFFICIENCY", "VEHICLE RANGE"] |
</details>Development
- Clone this repository
- Install latest LTS version of Node.js
- Enable Corepack using
corepack enable - Install dependencies using
pnpm install
Tests
All
Run both unit and functional tests
pnpm test
Unit
pnpm test:unit
Functional
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
Credits
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.
