Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

homebridge-onstar

samrum199MIT1.5.39TypeScript support: included

Unofficial OnStar plugin for Homebridge

homebridge-plugin, onstar, chevrolet, chevy, gm, gmc, buick, cadillac

readme

homebridge-onstar (OnStar Accessory)

npm version build Coverage Status verified-by-homebridge

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

Lock/Unlock Doors Switch

"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"

Reset Doors Switch to an Unlocked State

"doorsDefaultToUnlocked": true

Default the doors switch to an unlocked state.

Charger Switch

"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"

Alert Switch

"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.

changelog

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

1.5.39 (2024-07-27)

Bug Fixes

1.5.38 (2024-06-05)

Bug Fixes

1.5.37 (2024-04-17)

Bug Fixes

1.5.36 (2024-03-24)

1.5.35 (2024-01-18)

1.5.34 (2023-11-15)

1.5.33 (2023-11-01)

1.5.32 (2023-10-10)

1.5.31 (2023-09-03)

1.5.30 (2023-08-04)

1.5.29 (2023-06-24)

1.5.28 (2023-06-06)

1.5.27 (2023-04-30)

1.5.26 (2023-04-26)

1.5.25 (2023-03-31)

Bug Fixes

  • deps: bump onstarjs from 2.3.17 to 2.3.18 (#261) (cd85d03)

1.5.24 (2023-03-09)

Bug Fixes

  • deps: bump onstarjs from 2.3.16 to 2.3.17 (#259) (6d24845)

1.5.23 (2023-02-14)

Bug Fixes

  • deps: bump onstarjs from 2.3.15 to 2.3.16 (#258) (6c2d934)

1.5.22 (2023-01-25)

Bug Fixes

  • deps: bump onstarjs from 2.3.14 to 2.3.15 (#257) (680e693)

1.5.21 (2022-12-31)

Bug Fixes

  • deps: bump decode-uri-component from 0.2.0 to 0.2.2 (#250) (c1dfc9e)
  • deps: bump json5 from 2.2.0 to 2.2.3 (#254) (add5c54)
  • deps: bump minimatch from 3.0.4 to 3.1.2 (#251) (b45eb09)
  • deps: bump onstarjs from 2.3.13 to 2.3.14 (#253) (75f5125)
  • deps: bump qs from 6.5.2 to 6.5.3 (#252) (37dc0a4)

1.5.20 (2022-11-03)

Bug Fixes

  • deps: bump onstarjs from 2.3.11 to 2.3.12 (#248) (5d0ad0c)
  • deps: bump onstarjs from 2.3.12 to 2.3.13 (#249) (5826fc0)

1.5.19 (2022-10-15)

Bug Fixes

  • deps: bump onstarjs from 2.3.10 to 2.3.11 (#245) (40443d1)

1.5.18 (2022-09-15)

Bug Fixes

  • deps: bump onstarjs from 2.3.9 to 2.3.10 (#244) (4bcb8f5)

1.5.17 (2022-07-20)

Bug Fixes

  • deps: bump onstarjs from 2.3.8 to 2.3.9 (#242) (0742767)

1.5.16 (2022-06-01)

Bug Fixes

  • deps: bump @rollup/plugin-typescript from 8.3.1 to 8.3.2 (#213) (0394dde)
  • deps: bump onstarjs from 2.3.7 to 2.3.8 (#238) (c271f76)

1.5.15 (2022-05-04)

Bug Fixes

  • deps: bump onstarjs from 2.3.6 to 2.3.7 (#221) (cd76d3f)

1.5.14 (2022-03-31)

Bug Fixes

  • deps: bump minimist from 1.2.5 to 1.2.6 (#211) (78982f8)
  • deps: bump onstarjs from 2.3.5 to 2.3.6 (#212) (d71b49d)

1.5.13 (2022-03-23)

Bug Fixes

  • deps: bump @rollup/plugin-typescript from 8.3.0 to 8.3.1 (#196) (71cdf14)
  • deps: bump follow-redirects from 1.14.7 to 1.14.9 (#197) (42676f7)
  • deps: bump onstarjs from 2.3.4 to 2.3.5 (#208) (1476328)

1.5.12 (2022-03-03)

Bug Fixes

  • deps: bump onstarjs from 2.3.3 to 2.3.4 (#194) (eee1da6)

1.5.11 (2022-01-27)

Bug Fixes

  • deps: bump onstarjs from 2.3.2 to 2.3.3 (#184) (d1a9017)
  • deps: bump shelljs from 0.8.4 to 0.8.5 (#175) (e627a9e)
  • deps: bump trim-off-newlines from 1.0.1 to 1.0.3 (#181) (5c85194)

1.5.10 (2022-01-13)

Bug Fixes

  • deps: bump follow-redirects from 1.14.4 to 1.14.7 (#172) (c060247)
  • deps: bump onstarjs from 2.3.1 to 2.3.2 (#173) (473c75d)

1.5.9 (2021-12-18)

Bug Fixes

  • deps: bump onstarjs from 2.3.0 to 2.3.1 (#163) (794a5dd)

1.5.8 (2021-10-17)

Bug Fixes

  • deps: bump ansi-regex from 5.0.0 to 5.0.1 (#142) (c2a8a0e)
  • deps: bump onstarjs from 2.2.4 to 2.3.0 (#140) (cebf968)
  • deps: bump tmpl from 1.0.4 to 1.0.5 (#134) (05e8d92)

1.5.6 (2021-09-19)

Bug Fixes

  • deps: bump axios from 0.21.1 to 0.21.4 (#133) (57e4fc9)
  • deps: bump onstarjs from 2.2.3 to 2.2.4 (#126) (46e1d76)
  • deps: bump path-parse from 1.0.6 to 1.0.7 (#122) (9be9d17)

1.5.5 (2021-08-04)

Bug Fixes

  • deps: bump onstarjs from 2.2.2 to 2.2.3 (#117) (4218c2e)

1.5.4 (2021-06-22)

Bug Fixes

  • deps: bump hosted-git-info from 2.8.8 to 2.8.9 (#93) (52a8b2a)
  • deps: bump onstarjs from 2.2.1 to 2.2.2 (#94) (19f1bb9)

1.5.3 (2021-06-01)

Bug Fixes

  • deps: bump browserslist from 4.16.3 to 4.16.6 (#76) (1eeddbc)
  • deps: bump onstarjs from 2.0.14 to 2.1.0 (#65) (ab9aaa5)
  • deps: bump onstarjs from 2.1.0 to 2.1.1 (#66) (d7fe357)
  • deps: bump onstarjs from 2.1.1 to 2.2.1 (#81) (646830e)
  • deps: bump ws from 7.4.4 to 7.4.6 (#79) (56a8ff8)

1.5.2 (2021-04-14)

Bug Fixes

1.5.1 (2021-03-11)

Bug Fixes