onstar2mqtt/README.md

onstar2mqtt

A service that utilizes the OnStarJS library to expose OnStar data to MQTT topics. Mostly focused around EVs, however happy to accept PRs for other vehicle types.

There is no official relationship with GM, Chevrolet nor OnStar. In fact, it would be nice if they'd even respond to development requests, so we wouldn't have to reverse engineer their API.

Running

Collect the following information:

1. Generate a v4 uuid for the device ID
2. OnStar login: username, password, PIN
3. Your car's VIN. Easily found in the monthly OnStar diagnostic emails.
4. MQTT server information: hostname, username, password
   1. If using TLS, define MQTT_PORT and MQTT_TLS=true

Supply these values to the ENV vars below.

Docker

docker run \
  --env ONSTAR_DEVICEID= \
  --env ONSTAR_VIN= \
  --env ONSTAR_USERNAME= \
  --env ONSTAR_PASSWORD= \
  --env ONSTAR_PIN= \
  --env MQTT_HOST= \
  --env MQTT_USERNAME \
  --env MQTT_PASSWORD \
  michaelwoods/onstar2mqtt:latest

docker-compose

  onstar2mqtt:
    container_name: onstar2mqtt
    image: michaelwoods/onstar2mqtt
    restart: unless-stopped
    env_file:
      - /srv/containers/secrets/onstar2mqtt.env
    environment:
    - ONSTAR_DEVICEID=
    - ONSTAR_VIN=
    - MQTT_HOST=

onstar2mqtt.env:

ONSTAR_USERNAME=
ONSTAR_PASSWORD=
ONSTAR_PIN=
MQTT_USERNAME=
MQTT_PASSWORD=

Node.js

It's a typical node.js application, define the same environment values as described in the docker sections and run with: npm run start. Currently, only tested with Node.js 12.x.

Home Assistant configuration templates

MQTT auto discovery is enabled. For further integrations see HA-MQTT.md.

Development

Running

npm run start

Testing

npm run test

Coverage

rpm run coverage

Releases

npm version [major|minor|patch] -m "Version %s" && git push --follow-tags

Publish the release on GitHub to trigger a release build (ie, update 'latest' docker tag).

TODO

1. Logging library
2. Figure out metric->imperial unit handling
3. Enable write actions to lock doors, flash lights, remote start, etc.