Skip to content

CHANGELOG.md

Latest commit

 

History

History
1082 lines (669 loc) · 46.4 KB

CHANGELOG.md

File metadata and controls

1082 lines (669 loc) · 46.4 KB
Raw

Changelog

2.10.1

Bug Fixes:

  • OnStarJS2 2.16.6 - Stop retrying auth on Access Denied and other permanent failures
  • OnStarJS2 2.16.6 - Strip UTF-8 BOM before parsing cached token files

Other Updates:

2.10.0

Bug Fixes:

  • State Class Corrections - Correct state_class for lifetime accumulator sensors (total_increasing → total) and EV trip odometer (total_increasing → measurement)

Other Updates:

Add-on Updates:

  • Update Node.js to 24.x in Docker image

2.9.0

New Features:

  • Brake Pad Life Sensors - Add brake pad life sensors for front and rear brake pad life percentage, status indication request, and BPLM driver enable

Other Updates:

2.8.4

Bug Fixes:

  • Axios Downgrade - Downgrade axios to ^1.14.0 (1.14.1 was pulled from the npm registry)
  • OnStarJS2 2.16.3 - Pin axios to ^1.14.0 in OnStarJS2 as well

Other Updates:

2.8.3

⚠️ RETRACTED: This version included the malicious axios@1.14.1, merged via a Dependabot PR during the attack window (details). All associated container images have been deleted. Please update to v2.8.4 immediately.

Other Updates:

2.8.2

Bug Fixes:

  • OnStarJS2 2.16.1 - Propagate HTTP status/statusText on RequestError responses for better error diagnostics

Other Updates:

2.8.1

Bug Fixes:

  • Dynamic Command Response Logging - Replace static command response logging with dynamic field enumeration using a reusable logResponseData() helper. Adds missing response logging for getOnstarPlan, getWarrantyInfo, and getSxmSubscriptionInfo handlers.

Also includes all new features from 2.8.0:

  • Universal Status Attributes - All diagnostic sensors now expose status and status_color as HA entity attributes, allowing any HA card (Mushroom, card-mod, etc.) to dynamically colorize sensors. Sensors with existing custom status_color attributes are preserved as-is.
  • Warranty Info Command - New getWarrantyInfo command and sensor showing vehicle warranty coverage details (active/expired warranties, warranty info)
  • SXM Subscription Info Command - New getSxmSubscriptionInfo command and sensor showing SiriusXM subscription status (active subscriptions, radio ID, package name, expiry date)
  • Update to OnStarJS2 2.16.0 - Add getWarrantyInfo and getSxmSubscriptionInfo commands
  • Note: The getOnstarPlan command only returns full plan details for primary account holders; shared accounts will receive onstarInfo with active status but plan details will be empty

Other Updates:

2.8.0

New Features:

  • Universal Status Attributes - All diagnostic sensors now expose status and status_color as HA entity attributes, allowing any HA card (Mushroom, card-mod, etc.) to dynamically colorize sensors. Sensors with existing custom status_color attributes are preserved as-is.
  • Warranty Info Command - New getWarrantyInfo command and sensor showing vehicle warranty coverage details (active/expired warranties, warranty info)
  • SXM Subscription Info Command - New getSxmSubscriptionInfo command and sensor showing SiriusXM subscription status (active subscriptions, radio ID, package name, expiry date)

Other Updates:

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v2.8.0
  • Update to OnStarJS2 2.16.0 - Add getWarrantyInfo and getSxmSubscriptionInfo commands
  • Note: The getOnstarPlan command only returns full plan details for primary account holders; shared accounts will receive onstarInfo with active status but plan details will be empty

2.7.0

New Features:

  • Individual EV Charging Metrics Sensors - Add 8 standalone sensors from EV charging metrics data (battery level, range, charge state, plug state, odometer, temperature, lifetime energy, charge ETA). These sensors work independently of the diagnostics API, providing EV data even on Connected Access plans where the diagnostics API returns 403.

Other Updates:

2.6.0

New Features:

  • EV Charging Metrics in Diagnostics - Update diagnostic sensors with EV charging metrics data
  • EV Ignition Sensor - New binary sensor for ignition state from EV charging metrics

Bug Fixes:

  • Boolean State Values - Convert boolean state values to string for MQTT publishing

Other Updates:

2.5.2

Bug Fixes:

  • EV Charging Metrics Sensor Update - Fix HA sensors not updating when refreshEVChargingMetrics command is used
  • topicArray.map Crash - Resolve crash from lodash removal
  • OnStarJS2 2.15.1 - Prevent unnecessary retry when auth code already captured via CDP

Other Updates:

2.5.1

Bug Fixes:

  • Missing Environment Variables - Add missing exports for ONSTAR_RECALL_REFRESH, ONSTAR_STATE_CACHE, and OPENID_CLOCK_TOLERANCE_SEC in run.sh to properly pass configuration to the application

2.5.0

New Features:

  • Optional State Cache - Enable with ONSTAR_STATE_CACHE: true to merge partial API responses with cached data, preventing Home Assistant template warnings when the API returns incomplete data on refresh cycles. Note: On first run with an empty cache, you may still see template warnings until the cache builds up over a few refresh cycles

Other Updates:

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v2.5.0
  • Update to OnStarJS2 2.15.0 with proactive Xvfb cleanup and diagnostics for improved browser automation reliability

2.4.3

Build Updates:

  • Node.js 22 LTS - Replaced HA base image Node.js 18 with Node.js 22 LTS from NodeSource to meet onstar2mqtt engine requirements and resolve EBADENGINE warnings

Other Updates:

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v2.4.3
  • Update to OnStarJS2 2.14.3 with improved Xvfb stability for long-running sessions and container restarts

2.4.2

Bug Fixes:

  • HA Polling Status Code Fix - Fix HA polling status code sensor showing unknown for OpenID errors

Other Updates:

2.4.1

Bug Fixes:

  • MQTT Availability Fix - Fixed critical bug where availability status was not restored on reconnection
  • MQTT Connection Lifecycle - Improved connection event handling
  • Volume Sensor State Class Fix - Fixed Home Assistant errors for fuel sensors by changing instantaneous volume measurements to use 'volume_storage' device class

Other Updates:

2.4.0

New Features:

OnStarJS2 v2.14.0 Enhancements:

  • New refreshEVChargingMetrics Command - Added support for manually refreshing EV charging metrics on demand (requires OnStarJS2 2.14.0)

OnStar2MQTT Enhancements:

  • Unit Cache Fix for v3 API - Implemented intelligent unit caching to handle v3 API instability where units intermittently become null, preventing sensor display issues

Other Updates:

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v2.4.0
  • Update to OnStarJS 2.14.0 with new EV charging refresh capability
  • Add persistent unit cache to disk for improved reliability across restarts

2.3.0

New Features:

OnStarJS2 v2.13.0 Enhancements:

  • Enhanced JWT Clock Tolerance Handling - Improved JWT expiration handling with configurable clock tolerance for IdP-issued tokens with clock skew
  • Improved JWT Expiration Handling - Updated JWT expiration decoding to use millisecond precision for more accurate token validation
  • Browser Launch Improvements - Updated browser launch arguments for improved performance and stability
  • Xvfb Cleanup Enhancements - Improved Xvfb cleanup process with ability to reuse existing Xvfb servers

Other Updates:

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v2.3.0
  • Update to OnStarJS 2.13.0 with enhanced authentication and token handling
  • Add configuration option for OpenID clock tolerance to handle authentication issues related to clock skew
  • Add an apparmor profile

2.2.1

This is a bug fix and maintenance release focused on improving recall tracking accuracy and fixing issues with vehicle details, OnStar plans, and text EV sensors.

  • OnStar API v3 Support - Updated to OnStarJS 2.12.1 with enhanced API v3 compatibility

What This Means for You:

  • Some sensors that worked with older OnStar API versions may no longer be available or may have different names
  • Sensor entity IDs and names may change in Home Assistant
  • You may need to update Home Assistant automations/dashboards that reference changed sensors
  • Review your dashboards for any broken sensor references after upgrading

Important: Manual Sensor Cleanup Required (v2.2.1)

After upgrading to v2.2.1 from v1.x (and in some rare cases, version 2.1.x/2.0.x) , you will need to manually remove deprecated sensors from both your MQTT broker and Home Assistant:

Step 1 (v2.2.1): Delete Retained MQTT Topics from Broker

First, delete the related retained MQTT topics from your MQTT broker to prevent deprecated sensors from being recreated. Both config and state topics must be removed:

  • Using MQTT Explorer or similar tool:

    • Connect to your MQTT broker
    • Navigate to homeassistant/sensor/YOUR_VIN/ and homeassistant/binary_sensor/YOUR_VIN/
    • For each deprecated sensor, delete both:
      • Config topic: homeassistant/sensor/YOUR_VIN/deprecated_sensor/config
      • State topic: homeassistant/sensor/YOUR_VIN/deprecated_sensor/state

  • Using mosquitto_pub command:

    # Delete config topic
mosquitto_pub -h YOUR_MQTT_HOST -u YOUR_MQTT_USER -P YOUR_MQTT_PASS -t "homeassistant/sensor/YOUR_VIN/deprecated_sensor/config" -n -r

# Delete state topic
mosquitto_pub -h YOUR_MQTT_HOST -u YOUR_MQTT_USER -P YOUR_MQTT_PASS -t "homeassistant/sensor/YOUR_VIN/deprecated_sensor/state" -n -r

    (Replace deprecated_sensor with each deprecated sensor name, -n sends empty payload, -r sets retained flag)

Step 2 (v2.2.1): Remove Sensors from Home Assistant

  1. Navigate to Settings → Devices & Services → MQTT
  2. Find your vehicle device in the list
  3. Review all sensors and look for any that show as "Unavailable" or "Unknown"
  4. Delete deprecated sensors by clicking on each sensor and selecting "Delete"

Step 3 (v2.2.1): Restart Home Assistant

  1. Restart Home Assistant to ensure all changes take effect

Why This Cleanup is Necessary:

  • MQTT discovery creates new sensors but doesn't automatically remove old ones
  • Deprecated sensors from API v2 may conflict with new API v3 sensors
  • Old sensors will remain as "ghost" entities until manually removed
  • Retained MQTT topics will cause deleted sensors to be recreated on restart unless also deleted from the broker

Recommendation: Test in a sandbox/test environment first if possible, or be prepared to update your Home Assistant configurations after upgrading.

Other Updates:

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v2.2.1
  • Update to OnStarJS 2.12.1
  • Bug fix: Commands for vehicle details and OnStar plans, text EV sensors
  • Bug fix: Change recall sensor to show unrepaired active recall count
  • Bug fix: Include expired and inactive recalls in unrepaired active count

2.2.0

New Features:

  • OnStar API v3 Support - Updated to OnStarJS 2.12.0 with enhanced API v3 compatibility
  • Vehicle Recall Monitoring - Automatic recall checking on startup and every 7 days (configurable via ONSTAR_RECALL_REFRESH)
  • Vehicle Image Entity - Vehicle photo automatically downloaded, cached, and published to Home Assistant
  • EV Charging Metrics - 10 specialized sensors available on-demand via button (target charge level, battery capacity, trip consumption, etc.)
  • New Commands - setChargeLevelTarget, getEVChargingMetrics, getVehicleRecallInfo

What This Means for You:

  • Some sensors that worked with older OnStar API versions may no longer be available or may have different names
  • Sensor entity IDs and names may change in Home Assistant
  • You may need to update Home Assistant automations/dashboards that reference changed sensors
  • Review your dashboards for any broken sensor references after upgrading

Important: Manual Sensor Cleanup Required (v2.2.0)

After upgrading to v2.2.0 from v1.x (and in some rare cases, version 2.1.x/2.0.x) , you will need to manually remove deprecated sensors from both your MQTT broker and Home Assistant:

Step 1 (v2.2.0): Delete Retained MQTT Topics from Broker

First, delete the related retained MQTT topics from your MQTT broker to prevent deprecated sensors from being recreated. Both config and state topics must be removed:

  • Using MQTT Explorer or similar tool:

    • Connect to your MQTT broker
    • Navigate to homeassistant/sensor/YOUR_VIN/ and homeassistant/binary_sensor/YOUR_VIN/
    • For each deprecated sensor, delete both:
      • Config topic: homeassistant/sensor/YOUR_VIN/deprecated_sensor/config
      • State topic: homeassistant/sensor/YOUR_VIN/deprecated_sensor/state

  • Using mosquitto_pub command:

    # Delete config topic
mosquitto_pub -h YOUR_MQTT_HOST -u YOUR_MQTT_USER -P YOUR_MQTT_PASS -t "homeassistant/sensor/YOUR_VIN/deprecated_sensor/config" -n -r

# Delete state topic
mosquitto_pub -h YOUR_MQTT_HOST -u YOUR_MQTT_USER -P YOUR_MQTT_PASS -t "homeassistant/sensor/YOUR_VIN/deprecated_sensor/state" -n -r

    (Replace deprecated_sensor with each deprecated sensor name, -n sends empty payload, -r sets retained flag)

Step 2 (v2.2.0): Remove Sensors from Home Assistant

  1. Navigate to Settings → Devices & Services → MQTT
  2. Find your vehicle device in the list
  3. Review all sensors and look for any that show as "Unavailable" or "Unknown"
  4. Delete deprecated sensors by clicking on each sensor and selecting "Delete"

Step 3 (v2.2.0): Restart Home Assistant

  1. Restart Home Assistant to ensure all changes take effect

Why This Cleanup is Necessary:

  • MQTT discovery creates new sensors but doesn't automatically remove old ones
  • Deprecated sensors from API v2 may conflict with new API v3 sensors
  • Old sensors will remain as "ghost" entities until manually removed
  • Retained MQTT topics will cause deleted sensors to be recreated on restart unless also deleted from the broker

Recommendation: Test in a sandbox/test environment first if possible, or be prepared to update your Home Assistant configurations after upgrading.

Other Updates:

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v2.2.0
  • Add ONSTAR_RECALL_REFRESH configuration parameter (default: 604800000 ms / 7 days)
  • Improve EV battery percentage sensor mapping
  • Fix vehicle recall sensor and vehicle image entity handling
  • Fix EV sensor handling for API v3
  • Add support for 'Active' charging state value
  • Add comprehensive tests for EV charging metrics functionality

2.1.1

Important Update: This version includes OnStar API v3 changes that may affect some sensors.

  • As this is a major change, some issues may occur. Please report any problems you encounter by opening an issue on GitHub.
  • Most new sensors have been added. Any remaining sensors will be added in future updates. Current ETA is by the end of December 2025.

New Features:

  • OnStar API v3 Support - Updated to OnStarJS 2.11.0 with full API v3 compatibility
  • Enhanced Reliability - Improved handling of OnStar API field naming variations

What This Means for You:

  • Some sensors that worked with older OnStar API versions may no longer be available or may have different names
  • Sensor entity IDs and names may change in Home Assistant
  • You may need to update Home Assistant automations/dashboards that reference changed sensors
  • Review your dashboards for any broken sensor references after upgrading

Important: Manual Sensor Cleanup Required (v2.1.1)

After upgrading to v2.1.1 from v1.x, you will need to manually remove deprecated sensors from both your MQTT broker and Home Assistant:

Step 1 (v2.1.1): Delete Retained MQTT Topics from Broker

First, delete the related retained MQTT topics from your MQTT broker to prevent deprecated sensors from being recreated. Both config and state topics must be removed:

  • Using MQTT Explorer or similar tool:

    • Connect to your MQTT broker
    • Navigate to homeassistant/sensor/YOUR_VIN/ and homeassistant/binary_sensor/YOUR_VIN/
    • For each deprecated sensor, delete both:
      • Config topic: homeassistant/sensor/YOUR_VIN/deprecated_sensor/config
      • State topic: homeassistant/sensor/YOUR_VIN/deprecated_sensor/state

  • Using mosquitto_pub command:

    # Delete config topic
mosquitto_pub -h YOUR_MQTT_HOST -u YOUR_MQTT_USER -P YOUR_MQTT_PASS -t "homeassistant/sensor/YOUR_VIN/deprecated_sensor/config" -n -r

# Delete state topic
mosquitto_pub -h YOUR_MQTT_HOST -u YOUR_MQTT_USER -P YOUR_MQTT_PASS -t "homeassistant/sensor/YOUR_VIN/deprecated_sensor/state" -n -r

    (Replace deprecated_sensor with each deprecated sensor name, -n sends empty payload, -r sets retained flag)

Step 2 (v2.1.1): Remove Sensors from Home Assistant

  1. Navigate to Settings → Devices & Services → MQTT
  2. Find your vehicle device in the list
  3. Review all sensors and look for any that show as "Unavailable" or "Unknown"
  4. Delete deprecated sensors by clicking on each sensor and selecting "Delete"

Step 3 (v2.1.1): Restart Home Assistant

  1. Restart Home Assistant to ensure all changes take effect

Why This Cleanup is Necessary:

  • MQTT discovery creates new sensors but doesn't automatically remove old ones
  • Deprecated sensors from API v2 may conflict with new API v3 sensors
  • Old sensors will remain as "ghost" entities until manually removed
  • Retained MQTT topics will cause deleted sensors to be recreated on restart unless also deleted from the broker

Recommendation: Test in a sandbox/test environment first if possible, or be prepared to update your Home Assistant configurations after upgrading.

Other Updates:

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v2.1.1
  • Add additional new sensors
  • Fix Multiple Sensor Issues
  • Fix Sensor Attribute Templates
  • Fix: Improve Sensor Handling

2.1.0

Important Update: This version includes OnStar API v3 changes that may affect some sensors.

  • As this is a major change, some issues may occur. Please report any problems you encounter by opening an issue on GitHub.
  • Most new sensors have been added. Any remaining sensors will be added in future updates. Current ETA is by the end of December 2025.

New Features:

  • OnStar API v3 Support - Updated to OnStarJS 2.11.0 with full API v3 compatibility
  • Enhanced Reliability - Improved handling of OnStar API field naming variations

What This Means for You:

  • Some sensors that worked with older OnStar API versions may no longer be available or may have different names
  • Sensor entity IDs and names may change in Home Assistant
  • You may need to update Home Assistant automations/dashboards that reference changed sensors
  • Review your dashboards for any broken sensor references after upgrading

Important: Manual Sensor Cleanup Required (v2.1.0)

After upgrading to v2.1.0, you will need to manually remove deprecated sensors from both your MQTT broker and Home Assistant:

Step 1 (v2.1.0): Delete Retained MQTT Topics from Broker

First, delete the related retained MQTT topics from your MQTT broker to prevent deprecated sensors from being recreated. Both config and state topics must be removed:

  • Using MQTT Explorer or similar tool:

    • Connect to your MQTT broker
    • Navigate to homeassistant/sensor/YOUR_VIN/ and homeassistant/binary_sensor/YOUR_VIN/
    • For each deprecated sensor, delete both:
      • Config topic: homeassistant/sensor/YOUR_VIN/deprecated_sensor/config
      • State topic: homeassistant/sensor/YOUR_VIN/deprecated_sensor/state

  • Using mosquitto_pub command:

    # Delete config topic
mosquitto_pub -h YOUR_MQTT_HOST -u YOUR_MQTT_USER -P YOUR_MQTT_PASS -t "homeassistant/sensor/YOUR_VIN/deprecated_sensor/config" -n -r

# Delete state topic
mosquitto_pub -h YOUR_MQTT_HOST -u YOUR_MQTT_USER -P YOUR_MQTT_PASS -t "homeassistant/sensor/YOUR_VIN/deprecated_sensor/state" -n -r

    (Replace deprecated_sensor with each deprecated sensor name, -n sends empty payload, -r sets retained flag)

Step 2 (v2.1.0): Remove Sensors from Home Assistant

  1. Navigate to Settings → Devices & Services → MQTT
  2. Find your vehicle device in the list
  3. Review all sensors and look for any that show as "Unavailable" or "Unknown"
  4. Delete deprecated sensors by clicking on each sensor and selecting "Delete"

Step 3 (v2.1.0): Restart Home Assistant

  1. Restart Home Assistant to ensure all changes take effect

Why This Cleanup is Necessary:

  • MQTT discovery creates new sensors but doesn't automatically remove old ones
  • Deprecated sensors from API v2 may conflict with new API v3 sensors
  • Old sensors will remain as "ghost" entities until manually removed
  • Retained MQTT topics will cause deleted sensors to be recreated on restart unless also deleted from the broker

Recommendation: Test in a sandbox/test environment first if possible, or be prepared to update your Home Assistant configurations after upgrading.

Other Updates:

2.0.2

Important Update: This version includes OnStar API v3 changes that may affect some sensors.

  • As this is a major change, some issues may occur.
  • Please report any problems you encounter by opening an issue on GitHub.
  • Most new sensors have been added. Any remaining sensors will be added in future updates.
    • Current ETA is by the end of December 2025.

New Features:

  • OnStar API v3 Support - Updated to OnStarJS 2.10.0 with full API v3 compatibility
  • Enhanced Reliability - Improved handling of OnStar API field naming variations

What This Means for You:

  • Some sensors that worked with older OnStar API versions may no longer be available or may have different names
  • Sensor entity IDs and names may change in Home Assistant
  • You may need to update Home Assistant automations/dashboards that reference changed sensors
  • Review your dashboards for any broken sensor references after upgrading
  • Recommendation: Test in a sandbox/test environment first if possible, or be prepared to update your Home Assistant configurations after upgrading.

Other Updates:

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v2.0.2
  • Bookworm Base Image - Switched to Debian Bookworm base images for better long-term support and stability
  • Add/Fix Device and State Classes in New Sensors
  • Fix device_tracker for OnStar API v3
  • Fix Multiple Sensor Issues

2.0.1

Important Update: This version includes OnStar API v3 changes that may affect some sensors.

  • As this is a major change, some issues may occur.
  • Please report any problems you encounter by opening an issue on GitHub.
  • Most new sensors have been added. Any remaining sensors will be added in future updates.
    • Current ETA is by the end of December 2025.

New Features:

  • OnStar API v3 Support - Updated to OnStarJS 2.10.0 with full API v3 compatibility
  • Enhanced Reliability - Improved handling of OnStar API field naming variations

What This Means for You:

  • Some sensors that worked with older OnStar API versions may no longer be available or may have different names
  • Sensor entity IDs and names may change in Home Assistant
  • You may need to update Home Assistant automations/dashboards that reference changed sensors
  • Review your dashboards for any broken sensor references after upgrading
  • Recommendation: Test in a sandbox/test environment first if possible, or be prepared to update your Home Assistant configurations after upgrading.

Other Updates:

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v2.0.1
  • Bookworm Base Image - Switched to Debian Bookworm base images for better long-term support and stability
  • Add/Fix Device and State Classes in New Sensors

2.0.0

Important Update: This version includes OnStar API v3 changes that may affect some sensors.

  • As this is a major change, some issues may occur.
  • Please report any problems you encounter by opening an issue on GitHub.
  • Most new sensors have been added. Any remaining sensors will be added in future updates.
    • Current ETA is by the end of December 2025.

New Features:

  • OnStar API v3 Support - Updated to OnStarJS 2.10.0 with full API v3 compatibility
  • Enhanced Reliability - Improved handling of OnStar API field naming variations

What This Means for You:

  • Some sensors that worked with older OnStar API versions may no longer be available or may have different names
  • Sensor entity IDs and names may change in Home Assistant
  • You may need to update Home Assistant automations/dashboards that reference changed sensors
  • Review your dashboards for any broken sensor references after upgrading
  • Recommendation: Test in a sandbox/test environment first if possible, or be prepared to update your Home Assistant configurations after upgrading.

Other Updates:

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v2.0.0
  • Bookworm Base Image - Switched to Debian Bookworm base images for better long-term support and stability

1.25.0

1.24.1

1.24.0

1.23.1

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v1.23.1
  • Optimizations to new authentication method introduced in v1.22.0
  • Further improvements to help text in configuration options

1.23.0

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v1.23.0
  • Switch to Debian based images for new authentication compatibility
  • Update to help text in configuration options

1.22.0

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v1.22.0
  • Fix for latest authentication errors
  • Remove support for ARMHF, ARMv7 and i386 architectures

1.21.2

1.21.1

1.21.0

1.20.2

1.20.1

1.20.0

1.19.1

1.19.0

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v1.19.0
  • Enable TOTP login which was figured out by @metheos - Thanks a lot to @metheos without whom this project could not continue!

1.18.8

1.18.7

1.18.6

1.18.5

1.18.4

1.18.3

1.18.2

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v1.18.2
  • Update embedded OnStarJS version
  • Throw errors when invalid VIN format and/or invalid PIN (not 4 digits) are provided

1.18.1

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v1.18.1
  • Fixes button name to command mismatch and adds checks for this condition to avoid recurrence in the future
  • Also addresses issue Start vehicle button issue #166

1.18.0

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v1.18.0
  • Added icons to buttons published via MQTT auto-discovery
  • Updated Tests
  • Did some code cleanup

1.17.1

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v1.17.1
  • Add unique_id to device_tracker auto-discovery config
  • Fix polling refresh interval sensor not publishing
  • Tweak tire pressure message sensor names
  • Logging update
  • Add tests

1.17.0

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v1.17.0
  • Added an option to group all numeric/component sensors and command status sensors in the same MQTT device if desired. The default which carries over from the previous version is to group them separately.
  • Added Oil Life and Tire Pressure status messages to MQTT auto-discovery topics.
  • Added additional tests

1.16.1

1.16.0

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v1.16.0
  • Add OnStar polling status sensors to MQTT auto-discovery
    • At this point, pretty much every available sensor, button and status is published to MQTT auto-discovery topics
  • Add additional tests
  • Add command buttons to Command Status Monitors Sensors section in addition to the main vehicle sensors MQTT device
  • Fix regression from previous release
  • Move some code out of index
  • Logging updates

1.15.0

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v1.15.0
  • Command Status and Timestamp from last command run are published to MQTT auto-discovery topics and are grouped in a MQTT device grouping for all command status sensors for the same vehicle
  • Fix a bug in the alert function command handling
  • Add suggested area for sensor groupings

1.14.1

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v1.14.1
  • Improve logic for button publish
  • Fix some sensor state_class/device_class mappings based on discussion in PR #158
  • Standardize case for command topic payload fields
  • Minor logging change
  • Fix minor logging issue
  • Code formatting updates

1.14.0

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v1.14.0
  • Buttons are added disabled by default because it's easy to accidentally press the wrong button and trigger an action at an inopportune time. Enable at your own risk and you assume all responsibility for your actions.
  • All available buttons for all vehicles are included for now, so only enable the buttons you need and/or work for your vehicle.
  • Changed the model displayed in the MQTT device in HA from "Model Year" to "Model Year + Model Name".

1.13.1

1.13.0

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v1.13.0
  • Changed the dependency on OnStarJS to embedded to enable easier key rotation updates
  • Added Trunk Open/Close commands based on PR 248 in OnStarJSand added delay option
  • Added additional packages to base install due to change of embedded dependency
  • Modifications to allow sending all commands with options using MQTT

1.12.5

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v1.12.5
  • Improve diagnostic response handling for manually run command
  • Minor updates to command state message

1.12.4

1.12.3

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v1.12.3
  • Fix minor regression from v1.12.0
  • Add "completionTimestamp" field for uniformity to every MQTT topic that publishes a command or polling status

1.12.2

1.12.1

1.12.0

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v1.12.0

  • Added device_tracker auto discovery by @BigThunderSR in BigThunderSR/onstar2mqtt#143

    • The device_tracker auto discovery config is published to: "homeassistant/device_tracker/(VIN)/config" and the GPS coordinates are still read from the original topic automatically at: "homeassistant/device_tracker/(VIN)/getlocation/state".
    • Also added GPS based speed and direction to the device_tracker attributes

  • Added new retained topic of "homeassistant/(VIN)/refresh_interval_current_val" to monitor current refresh value set via MQTT

1.11.0

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v1.11.0

  • New env options for securing connectivity for MQTTS using TLS:

    • MQTT_REJECT_UNAUTHORIZED (Default: "true", set to "false" only for testing.)
    • MQTT_CA_FILE
    • MQTT_CERT_FILE
    • MQTT_KEY_FILE

  • Automatic creation of pollingStatusTopic

    • No longer need to specify MQTT_ONSTAR_POLLING_STATUS_TOPIC as this is now created automatically
      • Format is "homeassistant/(VIN)/polling_status/"
    • If it is explicitly specified, will use the specified value, so does not break backwards compatibility

  • Ability to dynamically change polling frequency using MQTT

    • Uses the value from "ONSTAR_REFRESH" on initial startup
    • Change the value dynamically by publishing the new refresh value in milliseconds (ms) as an INT to: "homeassistant/(VIN)/refresh_interval"

  • Additional logging enhancements

1.10.0

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v1.10.0
  • Logs descriptive errors to console when required properties such as OnStar VIN/username/password/PIN and/or MQTT username/password/polling status topic are not provided at run time.
  • OnStar password/PIN and MQTT password are now masked in the console log output by default.

1.9.0

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v1.9.0
  • Implement manual diagnostic command response handling
  • Update polling status message handling

1.8.1

1.8.0

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v1.8.0
  • Add diagnostic element messages as attributes to applicable sensors and update tests to account for the changes
  • Publish all diagnostic element messages to same MQTT topic as each sensor for easy retrieval when needed
  • Update example in mqtt.js to include changes in v1.7.0
  • Update example in mqtt.js to include changes in v1.8.0

1.7.0

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v1.7.0
  • Add state_class of measurement to all non-binary sensors to enable long-term statistics saving in HA
  • Add device_class for several additional sensors
  • Change "lit" to "L" which is the correct unit for Liters in HA
  • Change occurrences of "l" to "L" which is the correct unit for Liters

1.6.3

1.6.2

1.6.1

1.6.0

  • Pickup latest upstream updates in BigThunderSR/onstar2mqtt v1.6.0
  • Added ability to provide MQTT topic for Onstar Data Polling Status to monitor success/failure when OnStar is polled for data - Details in README
  • Command Response Status is now published to MQTT topics - Details in README

1.4.3

1.4.2

1.4.1

  • Added detailed descriptions for all required data fields

1.4.0

  • Exposed additional parameters available in the program to the add-on.

1.3.28

1.3.27 - WARNING!!! - BREAKING CHANGE!!! - MANUAL STEPS REQUIRED TO UPGRADE

  • Before upgrading, please copy/save your add-on config, uninstall the existing add-on, install this new version of the add-on, re-add the previously saved configuration, save the config and re-start Home Assistant before using the add-on.
  • Reason: Changed slug name to use "_" instead of "-" due to breaking change in HA Core 2023.9

1.2.27

1.2.26

1.2.25

1.2.24

1.2.23

1.2.22

1.2.21

  • Change add-on to use pre-built image instead of building locally

1.1.21

1.1.20

1.1.19

1.1.18

1.1.17

1.1.16

1.1.15

1.1.14

1.1.13

1.1.12

1.1.11

1.1.10

  • Pickup latest upstream fixes

1.1.9

  • Pickup latest upstream updates - Fixed

1.1.8

  • Pickup latest upstream updates

1.1.7

  • Resolve image issue

1.1.6

  • Signed Assets with CAS

1.1.5

  • Added logo and icon files

1.1.4

  • Rebased BigThunderSR/onstar2mqtt submodule to v1.5.10 to pickup log colorization and timestamp additions from upstream

1.1.3

  • Added option to provide a name for the vehicle using this integration

1.1.2

  • Made some minor optimizations to the Dockerfile

1.1.1

  • Created submodules structure to simplify maintenance and added ability to choose either BigThunderSR or michaelwoods build of onstar2mqtt

1.0.14

  • Code Cleanup

1.0.13

  • Added Ability to Run Two Independent Instances for Two Vehicles

1.0.12

  • Further updates

1.0.11

  • Major updates

1.0.8

  • Major updates

1.0.7

  • Further testing

1.0.6

  • Test process

1.0.0

  • Initial Test