node-red-contrib-onstar2
Version:
An updated Node-RED Library using OnStarJS2, supporting both v1 and v3 OnStar APIs with automatic version detection
229 lines (155 loc) • 9.59 kB
Markdown
# node-red-contrib-onstar2
[](https://github.com/BigThunderSR/node-red-contrib-onstar2/actions/workflows/codeql-analysis.yml)
[](https://github.com/BigThunderSR/node-red-contrib-onstar2/actions/workflows/dependency-review.yml)
[](https://github.com/BigThunderSR/node-red-contrib-onstar2/actions/workflows/super-linter.yml)
[](https://github.com/BigThunderSR/node-red-contrib-onstar2/actions/workflows/node.js.yml)
[](https://github.com/BigThunderSR/node-red-contrib-onstar2/actions/workflows/npm-publish.yml)
<!-- [](https://github.com/BigThunderSR/node-red-contrib-onstar2/actions/workflows/cas_notarize.yml)
[](https://github.com/BigThunderSR/node-red-contrib-onstar2/actions/workflows/cas_authenticate.yml) -->
A Node-RED node package for controlling GM OnStar vehicles powered by [OnStarJS](https://github.com/samrum/OnStarJS), originally written by [caseyjmorton](https://www.npmjs.com/~caseyjmorton) and published [in the npmjs registry here](https://www.npmjs.com/package/node-red-contrib-onstar). Please note that only US and Canadian OnStar accounts are known to work with this integration.
This fork is for me to experiment with the capabilities exposed in the original version and to add custom commands as necessary.
- **_Following a major re-write, this project was moved to version 2.x and was made fully independent from the original npm package._**
- **_Version 3.0 introduces API modernization with breaking changes for EV charging and diagnostics nodes. See [MIGRATION.md](MIGRATION.md) for upgrade instructions._**
[](https://www.npmjs.com/package/node-red-contrib-onstar2)
<!--  -->
<!--  -->
## Install
```sh
npm install node-red-contrib-onstar2
```
On Linux, macOS, or Windows, you may also need to install browser binaries (and system dependencies) for authentication:
```sh
npx patchright install --with-deps chromium
```
> **⚠️ Alpine Linux users (including Home Assistant Node-RED Add-on):** Patchright is not supported on Alpine. See [Special Instructions](https://github.com/BigThunderSR/node-red-contrib-onstar2/discussions/430) for the workaround.
## Documentation
Each node is self-explanatory with hints provided wherever necessary as well as detailed information in the Help section of each node as necessary.
## 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, [TOTP Key (Please click link for instructions)](https://github.com/BigThunderSR/OnStarJS?tab=readme-ov-file#new-requirement-as-of-2024-11-19)
1. Your car's VIN. Easily found in the monthly OnStar diagnostic emails.
**Important:** [Special Instructions for Running in the official Home Assistant Node-RED Add-on](https://github.com/BigThunderSR/node-red-contrib-onstar2/discussions/430)
## OnStar API Version Support
This project now uses the modernized [onstarjs2](https://github.com/BigThunderSR/OnStarJS) library which supports both v1 and v3 OnStar APIs:
### Automatic API Version Detection
- **Action Commands** (lock/unlock doors/trunk, start/cancel, alert): Automatically use v3 API with fallback to v1 API if needed. The library intelligently detects which API version your vehicle supports and caches this for optimal performance.
- **Diagnostic Commands**: Use v3 API exclusively (returns all available diagnostics automatically)
- **EV Charging Commands**: Use v3 API exclusively with new enhanced methods
### v3 API Benefits
The v3 API provides:
- More reliable command execution
- Enhanced EV charging control
- Comprehensive diagnostic data
- Better error handling
- Improved performance
## Supported Features
### Vehicle Control
- Lock Doors
- Unlock Doors
- Lock Trunk
- Unlock Trunk
- Remote Start
- Cancel Remote Start (Stop)
- Vehicle Alert (Lights and Horn)
- Vehicle Alert (Lights Only)
- Vehicle Alert (Horn Only)
- Cancel Vehicle Alert
- Stop Lights
### Vehicle Information
- Get Vehicle Location
- Get Diagnostic Information (v3 API - returns all diagnostics)
- Get Vehicle Capabilities
- Get Vehicle Details
- Get OnStar Plan
- Get Vehicle Recall Info
### EV Charging Control (v3 API)
- **Set Charge Level Target** - Set desired battery percentage (0-100%)
- **Stop Charging** - Stop current charging session
- **Get EV Charging Metrics** - Retrieve current charging status and metrics
- **Refresh EV Charging Metrics** - Force-refresh live data from vehicle
> **Note:** The following v1 API charging commands are deprecated and replaced:
>
> - `chargeOverride` → Use `Set Charge Level Target` or `Stop Charging`
> - `getChargingProfile` → Use `Get EV Charging Metrics`
> - `setChargingProfile` → Use `Set Charge Level Target`
## Testing
This project includes comprehensive test suites that use mocked API responses instead of making real calls to OnStar servers.
### Running Tests
```sh
# Run all tests (including mocked tests)
npm test
# Run only authentication tests (mocked)
npm run test:auth
# Run only functionality tests (mocked)
npm run test:functionality
# Run all mocked tests (authentication + functionality)
npm run test:mocked
# Run legacy authentication tests (requires real OnStar credentials)
npm run test:auth-legacy
```
### Mocked Tests
The project now includes comprehensive mocked tests that cover both authentication scenarios and successful OnStar operations without making real API calls.
#### Authentication Tests (`test/authentication.spec.js`)
Using [Sinon](https://sinonjs.org/) to mock the OnStarJS API calls:
- **Fast execution**: No network calls or timeouts
- **Reliable results**: Tests don't depend on external service availability
- **Safe testing**: No risk of accidentally triggering real vehicle actions
- **Predictable outcomes**: Controlled responses for different scenarios
The authentication tests cover:
- Invalid credentials scenarios
- Missing configuration parameters
- Invalid TOTP codes
- Invalid VIN formats
- Successful authentication flows
- Configuration node validation
#### Functionality Tests (`test/functionality-mocked.spec.js`)
Comprehensive mocked tests for OnStar operations:
- **get-account-vehicles**: Mock vehicle list with multiple vehicles
- **get-diagnostics**: Mock diagnostic data (odometer, battery, fuel, etc.)
- **locate-vehicle**: Mock GPS coordinates and address information
- **lock-myvehicle**: Mock successful door locking
- **unlock-myvehicle**: Mock successful door unlocking
- **lock-mytrunk**: Mock successful trunk locking
- **unlock-mytrunk**: Mock successful trunk unlocking
- **start-myvehicle**: Mock successful remote start
- **cancel-start-myvehicle**: Mock successful remote start cancellation
- **alert-myvehicle**: Mock successful vehicle alerts (honk/flash)
- **get-mycharge-profile**: Mock EV charging profile data
- **mycharge-override**: Mock charging override commands
All functionality tests verify:
- Correct API method calls with proper parameters
- Expected response data structures
- Proper error handling
- Node.js output validation
### Running Tests with Real API Credentials (Optional)
By default, all tests use mocked API responses to prevent account lockouts. However, you can optionally test against the real OnStar API:
**⚠️ WARNING: Real API testing will:**
- Make actual calls to your OnStar account
- May trigger real actions on your vehicle
- Could lead to account lockout if run too frequently
- Should NEVER be used in CI/CD pipelines
**To run real API tests:**
1. Copy the example environment file:
```bash
cp .env.example .env
```
2. Edit `.env` and fill in your real credentials:
```bash
RUN_REAL_API_TESTS=true
ONSTAR_USERNAME=your.email@example.com
ONSTAR_PASSWORD=YourPassword
ONSTAR_PIN=1234
ONSTAR_VIN=YOUR17DIGITVIN
ONSTAR_DEVICEID=your-device-id-uuid
ONSTAR_TOTP=YOURBASE32TOTPSECRET
```
3. Run the safe real API tests:
```bash
npm run test:real-safe-only
```
**Note:** The `.env` file is automatically excluded from git via `.gitignore` to protect your credentials.
## My other related projects
- [https://github.com/BigThunderSR/onstar2mqtt](https://github.com/BigThunderSR/onstar2mqtt)
- [https://github.com/BigThunderSR/homeassistant-addons-onstar2mqtt](https://github.com/BigThunderSR/homeassistant-addons-onstar2mqtt)