Go to file

dependabot[bot] 9cf676b7d0 Bump onstarjs from 2.3.8 to 2.3.9 Bumps [onstarjs](https://github.com/samrum/OnStarJS) from 2.3.8 to 2.3.9. - [Release notes](https://github.com/samrum/OnStarJS/releases) - [Changelog](https://github.com/samrum/OnStarJS/blob/master/CHANGELOG.md) - [Commits](https://github.com/samrum/OnStarJS/compare/v2.3.8...v2.3.9) --- updated-dependencies: - dependency-name: onstarjs dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>		2022-07-25 08:03:31 +00:00
.github	Merge pull request #162 from michaelwoods/dependabot/github_actions/docker/setup-buildx-action-2	2022-06-07 20:18:11 -04:00
images	update docs with latest dashboard	2021-06-10 13:49:39 -04:00
src	Update measurement.js	2022-06-22 20:51:20 -04:00
test	updated the test conditions for the unique id	2022-05-24 18:44:09 -04:00
.babelrc	Add linting support	2021-06-10 23:44:31 -04:00
.dockerignore	github action and metadata files	2020-12-02 14:13:11 -05:00
.eslintrc.yml	Add linting support	2021-06-10 23:44:31 -04:00
.gitignore	Add location support. Fixes #87	2021-11-16 12:01:29 -05:00
.nvmrc	add .nvmrc	2021-11-16 10:45:38 -05:00
Dockerfile	add device config and minor updates	2020-12-27 21:55:49 -05:00
HA-MQTT.md	Update HA-MQTT.md	2022-06-07 22:53:48 -04:00
LICENSE	Initial version that queries vehicles and its diagnostics then prints to console.	2020-11-30 16:26:14 -05:00
package-lock.json	Bump onstarjs from 2.3.8 to 2.3.9	2022-07-25 08:03:31 +00:00
package.json	Bump onstarjs from 2.3.8 to 2.3.9	2022-07-25 08:03:31 +00:00
README.md	Update README.md	2022-06-07 22:45:45 -04:00

README.md

onstar2mqtt

A service that utilizes the OnStarJS library to expose OnStar data to MQTT topics.

The functionality is mostly focused around EVs (specifically the Bolt EV), however PRs for other vehicle types are certainly welcome.

There is no affiliation with this project and 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:

Generate a v4 uuid for the device ID
OnStar login: username, password, PIN
Your car's VIN. Easily found in the monthly OnStar diagnostic emails.
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, this is only tested with Node.js 12.x.

Home Assistant configuration templates

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

Development

Running

npm run start

Testing

npm run test

Coverage

npm 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).