homebridge-onstar (OnStar Accessory)


Homebridge support for OnStar!

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

Configuration

Basic Config (Climate)

{
"accessories": [
{
"accessory": "OnStar",
"name": "Car",
"deviceId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"vin": "1G2ZF58B774109863",
"username": "foo@bar.com",
"password": "p@ssw0rd",
"onStarPin": "1234"
}
]
}

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

With this config, a climate control (remote start) switch will be available in the Home app.

Siri Command: "Turn on the Car climate"

Additional Config Options

$3

"enableDoors": true

Enables locking/unlocking the vehicle doors.

Querying the current state of locks through OnStar is slow, so the switch will always reset to a locked state.

Siri command: "Unlock the Car"

$3

"doorsDefaultToUnlocked": true

Default the doors switch to an unlocked state.

$3

"enableCharger": true

Enable a switch that will set the vehicle charge mode to immediate (for EV/PHEV). Turning the switch off does nothing.

Siri command: "Turn on the Car charger"

$3

"enableAlert": true

Enable a switch that triggers an alert for the vehicle (horn + lights flashing).

Siri command: "Turn on the Car alert"

Notes

- Toggling switches off is possible using Siri/Shortcuts/Scenes
- When secret keys are rotated by MyChevrolet/OnStar, the plugin may stop working until the keys are updated.
- homebridge-onstar will return success once requests are considered _In Progress_. As such, OnStar request failures after the initial request are made won't be handled.

Credits

OnStarJS (Shoutout to mikenemat and gm-onstar-probe)

homebridge-tesla for being a great reference to refer to on how to set up various homebridge services.