diff --git a/README.md b/README.md index fe0015c..678a5c8 100644 --- a/README.md +++ b/README.md @@ -8,50 +8,42 @@ There is no affiliation with this project and GM, Chevrolet nor OnStar. In fact, ## Running Collect the following information: 1. [Generate](https://www.uuidgenerator.net/version4) a v4 uuid for the device ID -1. OnStar login: username, password, PIN -1. Your car's VIN. Easily found in the monthly OnStar diagnostic emails. -1. MQTT server information: hostname, username, password - 1. If using TLS, define `MQTT_PORT` and `MQTT_TLS=true` +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 + 4a. If using TLS, define `MQTT_PORT` and `MQTT_TLS=true` -Supply these values to the ENV vars below. -### [Docker](https://hub.docker.com/r/michaelwoods/onstar2mqtt) -```shell -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 -```yaml - 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: -```shell -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. +It's a typical node.js application, but I am unfamiliar on how to pass ENV vars, so if someone wants to create a PR to explain how to do that, be my guest. +To install and run do the following commands. +`sudo wget https://www.github.com/bennydabee/onstar2mqtt + cd onstar2mqtt + npm install +` +The following is required as I am unfamilar with the ENV vars for NPM. +` + cd src + sudo nano index.js +` +Make the following lines similar to this +`deviceId: process.env.ONSTAR_DEVICEID || 'uuidhere', + vin: process.env.ONSTAR_VIN || 'vinhere', + username: process.env.ONSTAR_USERNAME 'usernamehere', + password: process.env.ONSTAR_PASSWORD 'password here', + onStarPin: process.env.ONSTAR_PIN 'pinhere', +` +` +const mqttConfig = { + host: process.env.MQTT_HOST || 'haip', + username: process.env.MQTT_USERNAME || 'mqttusername', + password: process.env.MQTT_PASSWORD || 'mqttpassword', + port: parseInt(process.env.MQTT_PORT) || 1883, + tls: process.env.MQTT_TLS || false, + prefix: process.env.MQTT_PREFIX || 'homeassistant', + namePrefix: process.env.MQTT_NAME_PREFIX || '', +` +After all this run `cd ..` and then `npm run start` and it should now connect and you will have OnStarJS in your HA MQTT ### Home Assistant configuration templates MQTT auto discovery is enabled. For further integrations and screenshots see [HA-MQTT.md](HA-MQTT.md).