Software Release Notes
Last Updated:
Introduction
This document serves as official release notes documentation for the Geotab Keyless® product. Modifications made to any Geotab software (e.g. the Geotab Keyless Service API, GO® device firmware, and the Keyless Mobile SDK) impacting the Geotab Keyless product will be detailed in this document.
Testing Your Integration with an Upcoming Release
As a recommended best practice, we encourage you to verify your integration with planned upcoming releases.
To be notified of upcoming releases: Subscribe to receive Technical Updates; consult details as outlined in this document.
To test your integration with an upcoming release of GO Firmware: Work with your Geotab Partner contact, or Geotab contact, to move some of your GO devices to the specific upcoming version, via the Manual Firmware channel. The Manual channel allows you to place and hold devices on a single GO Firmware version. We will send a notification (via our Technical Updates distribution list) once a highly vetted version for all customers + Keyless customers is available, and you will therefore only verify your integration against this highly vetted version that is the most likely candidate to be promoted to the Keyless Firmware Channel, going out to all Keyless customers.
Refer to the document to test your integration with an upcoming release of the Keyless Service.
Advisory: Integrating Mobile SDK 1.2.* Required for Bluetooth Communication with IOX-BT (IOX-Keybox at GA and Future IOX-Keyless)
Communicated on: (initially in our Technical Updates).
More Information
If a driver is using your iOS app without Mobile SDK 1.2.0 and a device installation using IOX-BT for Bluetooth (IOX-Keybox at GA and Future IOX-Keyless), Bluetooth communications will not function.
- Bluetooth communications for both IOX-Keyless and IOX-Keybox will be handled by a new small component, IOX-BT.
- This is a transitionary step until our GO Device natively handles Bluetooth.
- More information will be made available ahead of this change and key for you to know
- i) all IOX-Keybox in field will require IOX-BT to receive future updates;
- ii) all IOX-Keyless in the field will continue to work with included Bluetooth, while all new units as of our future cutover date will require IOX-BT.
- The change to IOX-BT is estimated for Q2 2025 for IOX-Keybox (timed with our upcoming GA) and shortly after for IOX-Keyless.
Current and Upcoming Releases
Keyless Service
The Geotab Keyless API supplements the MyGeotab API for management of the Geotab Keyless platform. This includes keyless vehicle access via Bluetooth, NFC, and Over-the-Air (OTA) command administration. Please refer to the Geotab Keyless Swagger page for full API documentation.
NOTICE: This service follows the maintenance hours policy as outlined in Geotab Unified Service Level Agreement - SLA. The “Americas” maintenance region will be observed for the Keyless Service, however, not every window will be utilized. Scheduled deployments are communicated to integrators as per above Testing Your Integration with an Upcoming Release communication notes. Most deployments are completed with minimal to no downtime, technical updates will mention otherwise.
Keyless Service v1.5.0
Released
Improvements: - This release includes security updates and enhancements.
| | |
GO Device Firmware
The Geotab Keyless System is functional on all Geotab GO devices beginning with the GO9 device. This section details all GO device firmware releases supported by the Keyless platform.
- General firmware release notes (not Keyless specific) can be found in
- Additional information on GO device firmware is available via the .
Firmware x.42.45
Released
Fixed Issues: - Addressed the root causes of multiple (yet very infrequent) cases leading to Keyless command failures.
- Key fob and relay state are preserved across firmware updates or situations with a GO initiated power reset. Excluded cases where power is lost: a physical GO device unplug, a loose connection of the GO due to poor install, or a depleted vehicle battery.
| | |
Improvements: - Improved the time to re-establish a Bluetooth connection following a connection failure.
- Reduced the time to a successful retry from an initial failed Bluetooth command.
- After periods of inactivity, Keyless functionality is more immediately available.
| | |
Issues: - Device logs with Keyless installed may be delayed due to a known issue.
| | |
IOX-Keybox Firmware
The IOX-Keybox maintains its own firmware separate from the GO device, that is separately released and controlled, providing IOX-Keybox specific features and key fob specific configurations.
Firmware 1.0
Released
Fixed Issues: - Addressed potential battery drain when modem connectivity is lost at the end of a trip.
| | |
Firmware 0.32 (General Availability)
Released
NOTE: Devices on lower firmware versions cannot receive ongoing firmware updates. We highly recommend replacements for ongoing reliability improvements and new features. Your Partner Reseller has or will be in touch about replacing these units free of cost. While we are planning to make it possible to adapt the IOX-Keybox hardware to alternative key fob types in the future, the current hardware (on which this firmware version is supported) cannot be adapted to new key fob types. | | |
Improvements: - Bluetooth communications is now handled by IOX-BT, increasing Bluetooth reliability.
- NOTE: Installation of the IOX-BT is required for Bluetooth communications (mobile device vehicle access).
- NOTE: Please contact your shared mobility partner integrator and ask if they have updated to Keyless Mobile SDK 1.2; this update is required for your drivers to successfully use their application on iOS devices with this IOX-Keybox version. Please read our advisory.
- Simplified and improved harness HRN-KEYBOXV2 connecting the GO’s IOX port to the IOX-Keybox, for improved unlock/lock reliability in high current draw conditions.
- Firmware rollback logic has been implemented (0.32 is the lowest supported version).
- All known issues reported in the release notes for Beta firmware versions have been resolved.
| | |
Issues: - The IOX-Keybox does not limit MIME message retries when transmission fails due to modem connection state. This can prevent the GO and IOX-Keybox from going to sleep when expected when an unreliable modem connection is present.
| | |
Keyless Mobile SDK
Geotab provides a Keyless mobile SDK for Android and iOS to assist integrators in developing mobile interactions with the Geotab Keyless Platform.
Android Keyless SDK v1.2.1
Released
For Integrators who never adopted 1.2.0, please additionally see: Android Keyless SDK v1.2.0 Fixed Issues: - Resolved an issue that prevented Bluetooth connection/commands with Keyless enabled vehicles on certain makes of Android phones.
| | |
iOS Keyless SDK v1.2.0
Released
Integrating 1.2.0 is very highly recommended for iOS:
- Bluetooth communications for both IOX Keyless and IOX-Keybox will be handled by a new small component, IOX-BT. FYI this is a transitionary step until our GO Device natively handles Bluetooth.
- FYI: More information will be made available ahead of this change and key for you to know
- i) all IOX-Keybox in field will require IOX-BT to receive future updates;
- ii) all IOX-Keyless in field will continue to work with included Bluetooth, while all new units as of our future cutover date will require IOX-BT.
- The change to IOX-BT is estimated for Q2 2025 for IOX-Keybox (timed with our upcoming GA) and shortly after for IOX-Keyless.
If a driver is using your iOS app without Mobile SDK 1.2.0 and a hardware installation using IOX-BT for Bluetooth, Bluetooth communications will not function.
New Features: - Added diagnostic log storage and upload functionality.
- For updating existing apps, see .
- Integrators developing new apps should consult the .
| | |
Improvements: - Improved feedback when Bluetooth is disabled on mobile devices.
- Migrated SDK to Swift Package Manager.
- Updated GitHub README.md to include more information on how to integrate the SDK with documented examples.
- React native implementation example created.
- Renamed error types. See documented changes here:
- .
| | |
Fixed Issues: KeylessManager could be left in an incorrect state due to Bluetooth connections established before advertising.Some errors were being logged with a null error type. | | |
Keyless Monitor v1.7.1
Geotab provides the Keyless Monitor add-in for MyGeotab to assist integrators and administrators in reviewing Keyless-related telematics logging and issuing ad-hoc OTA commands.
Released
Fixed Issues: Error on loading add-in on database with more than 5k devices. | | |
Keyless Lite v1.1.3
Geotab provides the Keyless Lite add-in for Geotab Drive as a simplified solution for vehicle access.
Released
New Features: - Language support for Germany, Spanish, French (France), Italian, and Dutch is now available for users. NOTE: The language presented is determined based on the Language selected in the UI Settings tab of the user’s profile in MyGeotab. (This is now included in the Keyless Lite setup instructions.) Also covered in June 2025 Geotab Updates.
| | |
Improvements: - Alerts generated when Keyless Lite becomes disconnected from a vehicle shortly after successful lock/unlock will no longer appear.
- Updates for security vulnerabilities.
| | |
Fixed Issues: - Text that is too long to fit in detail fields such as Model or License will now be truncated instead of overflowing onto other screen elements.
| | |
Past Releases
Keyless Service
Keyless Service v1.3.0
Released
Improvements: This release includes security updates and enhancements.Improved Service Reliability and Performance: We have resolved several bugs related to transaction processing to improve overall system stability. Backend services have been optimized for greater efficiency, ensuring a more reliable experience. | | |
Keyless Service v1.2.4
Released
Improvements: Improved Service Performance and Efficiency: We have optimized our backend processes to reduce system latency, resulting in faster and more efficient service operations.Enhanced Security for Data in Transit: Improved service security by disabling outdated encryption protocols (TLS 1.0 and TLS 1.1). | | |
Behaviour Changes: - Updates to Service Connection Cipher Requirements:
- Based on current client API usage patterns, this update to supported TLS protocols is not expected to affect any existing client connections
| | |
Keyless Service v1.2.3
Released
Fixed Issues: Updates for security vulnerabilities | | |
Keyless Service v1.2.2
Released
Fixed Issues: Enhanced system stability and reliability through various internal improvements and bug fixes.Error handling during MyGeotab maintenance previously would result in API requests returning 500 Internal Server Error, which lacked sufficient information. This is now correctly returning 503 Service Unavailable. | | |
Improvements: More robust internal error handling. Additionally, API clients will now benefit from more detailed and informative error codes.Swagger spec usage clarifications for workflows related to subscription notifications. | | |
Behaviour Changes: Tenant management operations with the API that are using the legacy my# MyGeotab server URI convention will be transformed to the primary federation URI. Example: my1234.geotab.com becomes my.geotab.comNo action is required for integrations - other than to be aware that GET and PATCH response bodies will have their server value translated. | | |
Keyless Service v1.2.1
Released
Fixed Issues: Security patches and related maintenance. | | |
Improvements: Consistency in swagger documentation for endpoints that return a 401 Unauthorized response. | | |
Keyless Service v1.2.0
Released
Fixed Issues: Enhanced system stability and reliability through various improvements. | | |
Improvements: Improved API and processing performance when interacting with NFC stored virtual keys.Tenant CREATE and UPDATE API operations will now have stricter validations performed to ensure the request is correct and aligns with MyGeotab federation and database state. | | |
Breaking Changes: - Removed support for API version 1.0 and its legacy DeviceCommand endpoint as announced in the advisory in July 2024. (Our apologies for incorrectly communicating this change in v1.1.49.)
| | |
Keyless Service v1.1.49
Released
Fixed Issues: Addressed a potential denial-of-service vulnerability.Improved the stability of database interactions. | | |
Keyless Service v1.1.48
Released
Fixed Issues: Corrected HTTP response reporting for transient issues (response code 503 instead of 500). | | |
Improvements: Deprecated Keyless API version 1.0 has been removed from Swagger page & documentation.The ability to access API version 1.0 will be removed permanently in a future release of Keyless Service. For more information see the advisory sent to integrators in July 2024.Prevent tenant registration using @geotab.com user accounts.API call performance and resiliency improvements.Removed support for Keyless API version 1.0 in swagger UI. | | |
Keyless Service v1.1.47
Released
Fixed Issues: Addressed security vulnerabilities in package dependencies. | | |
Improvements: Completed caching component improvements for better system resiliency.Incremental changes to the integration approach with MyGeotab, towards increased stability and maintainability. These improvements will be gradual over the next few releases. | | |
Keyless Service v1.1.46
Released
Fixed Issues: Resolved an issue that caused errors when generating synchronization tasks, ensuring smoother operation.Addressed security vulnerabilities in package dependencies to enhance overall system security.. | | |
Improvements: Improved caching components to optimize performance and resiliency.Corrected default deployment configurations. Added support for registering tenants that have databases belonging to the afmfe.att.com federation.. | | |
Keyless Service v1.1.45
Released
Fixed Issues: Fixed a rare situation resulting in delayed message processing.Fixed the handling of database transactions for better reliability. | | |
Improvements: Updated dependencies for enhanced security, compatibility, and performance.Improved logging for better security and auditing. | | |
Keyless Service v1.1.44.1 Hotfix
Released
Fixed Issues: This update addresses an issue to improve transaction consistency and reliability. | | |
Keyless Service v1.1.44
Released
Fixed Issues: Updated the Keyless Service API to correctly respond with 503 SERVICE_UNAVAILABLE for transient fault scenarios, enabling integrators to implement proper retry mechanisms.Updated the Keyless Service API to provide detailed information about the number of virtual keys registered per database when an error occurs while attempting to create a stored virtual key due to exceeding the key limit, aiding integrators in resolving the issue. | | |
Improvements: Infrastructure and logging optimizations.Security vulnerabilities fixed. | | |
Keyless Service v1.1.43
Released
Fixed Issues: Sometimes the invalid operation of creating a stored Virtual Key with no tap card serial numbers provided would return a 500 error instead of a 400. This has been corrected to consistently return a 400 error. | | |
Improvements: Reliability improvements in notification generation.Security vulnerabilities fixed. | | |
Keyless Service v1.1.42
Released
Fixed Issues: Synchronization of Public Keys & Virtual Keys were occasionally delayed due to service interruptions. | | |
Keyless Service v1.1.41
Released
Fixed Issues: API responses are intermittently slow or erroring: Infrastructure networking changes to improve API responsiveness in some scenarios. This addresses a long-standing issue where requests periodically could exceed 60s in processing time, significantly delaying the response or may have failed with an error response code. | | |
Keyless Service v1.1.40
The Geotab Keyless API supplements the MyGeotab API for management of the Geotab Keyless platform. This includes keyless vehicle access via Bluetooth, NFC, and Over-the-Air (OTA) command administration. Please refer to the Geotab Keyless Swagger page for full API documentation.
Released
Improvements: Added additional internal observability. | | |
Keyless Service v1.1.39
Released
Improvements: Added Geotab API Terms of Service link to API Swagger page.Removed basicAuth authentication method from API Swagger page.Note that basicAuth (Basic) option for the authentication header used with the Keyless Service continues to be available, but is not recommended as it is not supported nor maintained. After a year of having its deprecation noted in the Technical Integration Manual, we have formally removed references to basicAuth in our documentation.Please alternatively use the Authenticate API endpoint to get a bearer token and use the bearerAuth (Bearer) option in their authentication headers. See the Technical Integration Manual for more details.Removed documentation references to authentication over MyAdmin as it is unsupported.When navigating to the Keyless Service API Swagger page, API version 1.1 will be selected by default. | | |
Keyless Service v1.1.38
Released
Fixed Issues: Delete Stored Virtual Key Sync: The Keyless Service was not synchronizing requests to delete stored virtual keys, stored keys would only be deleted if the device was available to receive the command when first issued. This is now resolved.Incorrect API Response: POST method for api/tenants endpoint will now return a 409 response for an existing tenant conflict instead of returning a 400 response. User not authorized response (403) is now documented on Swagger page for api/tenants endpoint as well. | | |
Keyless Service v1.1.37
Released
Fixed Issues: NFC Virtual Keys: The Keyless Service was occasionally incorrectly reporting “Maximum of 4 active virtual keys can exist. Limit exceeded.” This is now resolved.Notifications - NFC “Tap and Go” Check-in Request: Notification of OnlineCheckinComplete was incorrectly sent instead of TapCheckinComplete for GO9b devices on GO FW 38. GO9b devices are those which start with serial number “GA”. | | |
Keyless Service v1.1.34
Released
Please be aware to accommodate integrations. Please see the full summary. Bluetooth CheckIn & CheckOut Notifications when used with GO FW 38: Notifications for the following Bluetooth Event Types have been deprecated: - BleCheckInComplete
- BleCheckOutComplete
NFC On Demand / “Tap & Go” (Online Access) Notification Change: The event type communicated upon successful execution (Keyless successfully acts on your NFC Online CheckIn request) when the original request was initiated by the user (Driver) (via NFC long tap) has changed between GO FW 37 and GO FW 38: - GO FW 37: OnlineCheckInComplete
- GO FW 38: TapCheckInComplete
In the case where the original request was not initiated by the user (Driver), then the event type remains in GO FW 38 OnlineCheckInComplete.
| | |
Fixed Issues: - To reduce changes needed by Integrators, we have restored the following original Event Types which were replaced in 1.1.32 when GO FW 38 is used:
- CheckIn is restored from OccupationAttempt.
- TapCheckInComplete is restored from DeviceOccupied.
- CheckOutComplete and OnlineCheckOutComplete is restored from DeviceVacant
- NOTE: TapCheckInComplete is communicated in lieu of OnlineCheckInComplete (< 1.1.32) or DeviceOccupied (1.1.32) when the original request was initiated by the user (Driver) (via NFC long tap). When the original request was not initiated by the user (Driver), then OnlineCheckInComplete is restored from DeviceOccupied.
| | |
Improvements: MyGeotab Authentication rate limit error handling has been introduced and will limit users to 10 Authentication requests per minute. | | |
Keyless Service v1.1.32
Released
Fixed Issues: Allow Alpha Subdomain for Keyless Tenant CreationAdded the alpha.geotab.com federation to the list of allowed MyGeotab servers. This allows MyGeotab databases in this federation to be used with Keyless.Notification Timestamp Unit Bug on x.38 Change timestamp reported in notification object from seconds to milliseconds.Fix 500 Error on API Authentication Call | | |
Improvements: New Event Notification Support for Firmware Version x.38The x.38 firmware version removes support for BLE notification feedback through Keyless. While new notification types have been defined, the Keyless service will only notify on the new event types defined in x.38 and the old event types on x.37.Automatic retries on transient failures.Formalized message for unknown errors. | | |
Keyless Service v1.1.25.1
Released
Fixed Issues: Missing tap cards in offline virtual keys. | | |
Improvements: Allow sub-clearances of Administrator and Drive App User to create virtual keys. | | |
Keyless Service v1.1.24.1
Released
Fixed Issues: Public key synchronization. | | |
Improvements: Improved server logging efficiency.Handle changes in server path for MyGeotab databases.Error handling with useful reasons.Optional Virtual Key request properties. | | |
Keyless Service v1.1.22
Released
Improvements: Improved server logging efficiency. Allow GroupDriveUserSecurityId to access VK endpoint to accommodate Keyless Lite add-in. | | |
Keyless Service v1.1.19
Released
Fixed Issues: Keyless tenant corruption due to MyGeotab database migrations.Integrators are no longer required to re-create the Keyless tenant in the event that a database is migrated to a different server.Integrators can reference generic server names (my.geotab.com, preview.geotab.com…etc) when interacting with the Keyless service.Stored Virtual Key multiple tapCard sorting bug.Fixes issue where a small subset of tapCardSerialNumbers are not delivered to the GO device .Webhook notification type mischaracterization. | | |
Improvements: Offline NotificationsVehicle access notification window extended to 24 hrs.The preview.geotab.com subdomain has been added to Keyless trusted servers. | | |
Keyless Service v1.1.12
Released
Fixed Issues: API throws a 500 error when creating Virtual Key with multiple tap cards.Send multiple commands enumeration bug. | | |
Improvements: Notification system overall improvements.Create Virtual Key improvements. | | |
Keyless Service v1.1.6
Released
New Features: - New Reservation privilege added - STARTER_ENABLE_OVERRIDE
- Bypasses default starter inhibit logic. Used to mobilize push-to-start vehicles for the duration of the virtual key, without the user having to interact with the virtual key after initial mobilization.
- VirtualKey ID added to OfflineCheckIn notifications.
| | |
Fixed Issues: DeviceCommand timestamp hotfix. | | |
Improvements: Notification Status added to webhook notifications.Application updated to .NET 5.0. | | |
Keyless Service v1.1.0
Released
New Features: - API versioning support.
- New endpoint added - DELETE .../virtual-keys/{virtualkeyId}
| | |
Improvements: OTA Admin Command message pipeline optimization.POST .../commands endpoint augmented to allow for multiple operations within a single callOptional inclusion of reservation contextPOST .../virtual-keysDeclare virtual keys to be locally stored on GO device | | |
Keyless Service v1.0.0
Released
GO Device Firmware
Firmware x.40.41
Released
New Features: - Support for Bluetooth communications with IOX-BT: With our upcoming General Availability (GA) IOX-Keybox release, it will leverage IOX-BT for Bluetooth communications. IOX-Keyless(-NK) will additionally use IOX-BT for Bluetooth communications at a later date. This version introduces support for Bluetooth communications by IOX-BT. More information to come on this transition; no need to order IOX-BT.
| | |
Fixed Issues: After updating to this firmware version, relay state will be preserved across subsequent firmware updates to any other version with this fix (>= x.40.37). Excluded cases where power is lost: physical GO device unplug, a loose connection due to poor install, vehicle battery depletes.Fixed a rare issue that could cause an OTA command failure.Fixed a potential cause of battery drain. | | |
Improvements: iOS mobile devices connecting to IOX-Keyless establish Bluetooth connections faster.In rare cases where an incomplete command is received, which cannot be acted upon, the state is reset immediately increasing the success of a fast user initiated second attempt. | | |
Known Issues: - If an OTA command is sent that includes a Check-In and does not follow our command consistency guidelines (see the Technical Integration Manual) during an active reservation, the attempted Check-In will fail and the existing reservation will be terminated without a Check-Out.
- For the following case, it will take a full 10 minutes for the key fob power to turn off:
- i) there is less than 10 minutes until the active virtual key’s validity period expires;
- ii) the key fob is powered on;
- iii) the ignition is turned off;
- iv) the GO device has a firmware update or a GO initiated power reset.
- In the infrequent case when an IOX-Keyless(-NK), IOX-BT, or IOX-NFCREADERA firmware update is being applied, commands cannot be received and acted upon; this happens within 5 min. after the first ignition off after a GO firmware update is pushed, with which the IOX device firmware update is coupled, and lasts typically 1 min. In the rare case that a user is sending commands in this time window, they will need to be resent for successful completion.
| | |
Firmware x.40.33
Released
Fixed Issues: Singular Check-In or Check-Out commands over Bluetooth will now cause the GO device to respond with a 3342 status code with the value of 0 (NO_COMMAND) instead of providing no feedback.Previously, the following erroneous behavior was observed; this is now resolved:There is an active Bluetooth Virtual Key A with privileges UseMaximumMobilizationTimeout and/or StarterEnableOverride.The GO firmware updates, which includes a power reset.For the duration of Virtual Key A, these privileges will be correctly honored upon an IgnitionEnable command.For all future Bluetooth Virtual Keys with privileges UseMaximumMobilizationTimeout and/or StarterEnableOverride, these privileges were not correctly honored upon an IgnitionEnable command, and now they are correctly honored.- Previously, the following erroneous behavior was observed; the process of upgrading to 40.33 will trigger this issue, but once upgraded, this issue is resolved going forward for all future updates. Previous erroneous behavior pattern, which is now resolved:
- Either of the following is the case:
- There is an active Bluetooth Virtual Key with privileges UseMaximumMobilizationTimeout and/or StarterEnableOverride and there is an active IgnitionEnable command.
- OR there is an active IndefiniteStarterEnable command.
- The GO firmware updates, which includes a power reset, or any other situation where a power reset is initiated. Excluded additional cases where power is lost: physical GO device unplug, a loose connection due to poor install, vehicle battery depletes.
- The Virtual Key privileges are not honored, and the IndefiniteStarterEnable command is not honored.
- To reduce cases triggered by this firmware update, we have:
- Identified customers using these Virtual Key privileges and the IndefiniteStarterEnable command.
- We’ve identified per customer the hour in the day in which the vehicles are least used.
- We will push the update to 40.33 in this hour.
Sometimes when Bluetooth Virtual Key privileges UseMaxiumumMobilizationTimeout and/or StarterEnableOverride or the IndefiniteStarterEnable command are used, and there is a power reset, the key fob and optional starter inhibit relay will still be powered off after 10 minutes. The process of upgrading to 40.33 will trigger this issue, but once upgraded, this issue is resolved going forward for all future updates.Sending two commands of the same type in quick succession will cause the response ‘Fail, command already in progress’ to appear in Keyless Monitor. A small percentage of these failures will also result in the action not being taken (i.e. vehicle is still unlocked after issuing two Lock commands). This has been resolved.A very small minority of commands were failing due to the GO device erroneously going into an inactive (“sleep”) state ahead of full command completion; the majority of these cases have been resolved; in the very rare case of recurrence, Keyless Monitor will represent this as ‘ ‘Fault - CarShare BLE command timeout’. | | |
Improvements: Reliability improvements to symptoms where commands fail for a prolonged period of time (typically 30 minutes or up to 24 hours).Current key fob power state and optional starter inhibitor relay state is remembered across GO remote (Geotab initiated) power resets.Improvements to Bluetooth speed, performance and power consumption.Increased traceability of device communication that improves the ability to investigate issues. | | |
Known Issues: If an OTA command is sent that includes a Check-In and does not follow our command consistency guidelines (see the Technical Integration Manual) during an active reservation, the attempted Check-In will fail and the existing reservation will be terminated without a Check-Out. | | |
Firmware x.40.21
Released
Improvements: General quality improvements, including increased internal logging for faster troubleshooting and issue awareness.Improved Keyless event data retention during loss of coverage or device restarts.No impact on Keyless Integrations. | | |
Known Issues: 3342 not logged in response to a single Check-In or Check-Out:If your integration is currently sending a single Check-In or Check-Out command over Bluetooth, not combined with an Unlock or Lock, and is expecting a response via 3342 to proceed, note that 3342 is no longer logged for those commands in GO FW 40.21.We are taking steps to re-institute Check-In and Check-Out logging of 3342 in our next FW release; in the interim, we advise you to take steps to understand the impact to your integration. | | |
Firmware x.38.27
Released
Please be aware to accommodate integrations. Please see the full summary. The following Bluetooth Commands are deprecated: - Check-In (Bluetooth): Formerly used to start a Booking.
- Check-Out (Bluetooth): Formerly used to end a Booking.
If any of the above commands are sent, they are simply ignored: 3342 (New BLE Command) will be logged, but the commands are otherwise not executed nor is any other response (success/fail) provided. The following status data are no longer communicated in response to the above commands: 3346, 3347, 3380, 3343. If Check-In/Check-Out is combined with any other command (Unlock, Lock, etc.): - The Check-In/Check-Out is ignored.
- The other commands are not ignored.
The following Bluetooth Virtual Key Privileges are deprecated: - Check-In Override {CheckInOverride}
- Booking Timeout Reset {ResetAtEndOfBooking}
- Check-Out Failure Override {IgnoreCheckoutFail}
Should they be used, they are simply ignored. | | |
Fixed Issues: Starter enable grace period (10 minutes) reset on each NFC interaction. | | |
Improvements: For IOX-Keyless, we extended the Bluetooth connection timeout timer from 2 minutes to 10 minutes. The IOX-Keyless will maintain a Bluetooth connection to an idle phone for 10 minutes now, reducing the amount of reconnect attempts required of the integrator.For future GO FW updates after GO FW 38, the IOX-Keyless starter inhibitor relay state persists.Locate commands can always be sent to any vehicle with all restrictions removed; previously a user could only send a command for an unbooked vehicle, or for which the VK was assigned. | | |
Firmware x.37.20
Released
New Features: Start and end time requirements on virtual keys added as optional entity(move to x.37). If a timestamp is not provided, it will default to start time with when the virtual key is created. The end time if not specified would be 4294967295000; // (Sunday, February 7, 2106 6:28:15 AM). | | |
Improvements: For Online check-in requests, send up status data as NFC commands (as opposed to admin)Added new commands for IOX-Keybox.Connection failure rate was high especially in an environment with many bluetooth devices, and we will now reset the BLE module when this happens. | | |
Firmware x.36.21
Released
Fixed Issues: IndefiniteStarterEnable bug introduced in x.36.16.Internal inhibit is triggered when UseMaxumumMobilizationTimeout reservation privilege is applied to a Virtual Key. | | |
Firmware x.36.16
Released
New Features: New custom parameter: fDisableOnlineCheckInOnce enabled, the GO device will not send a CheckIn Request to the Keyless integrator if an NFC CheckIn is attempted and the tapCard Serial Number is not found in local memory. | | |
Fixed Issues: Homologized StatusData naming convention for OTA CheckIn commands.No device feedback on reception of Reset command while not in an active booking.The GO device sends Bluetooth feedback twice on error.GO device reset triggered by IOX entering sleep condition.IOX-Keyless v3 PCB reporting incorrect Hardware version. | | |
Improvements: Sustained 30 min heartbeat.Allows to turn on/off CC with rapid feedback.Allows devices to recover if issues occur during sleep.Bluetooth robustness improvements.Relay actuation closed loop feedback . | | |
Firmware x.35.6
Released
New Features: Only actuate Relay 1 upon reception of StarterEnable command on IOX-Keyless v2 boards (all boards manufactured/shipped prior to November 2021).Reduces current consumption by ~20mA when starter is enabled.Requires all starter inhibit installations to utilize only relay 1. | | |
Fixed Issues: Bluetooth/Modem bug fix implementation:Bug caused devices to cease bluetooth and OTA communication until the next device heartbeat interval (30 minutes). | | |
Improvements: NFC/HID tap/hold to begin reservation:Short tap/long hold strategy to begin a NFC/HID reservation modified.Short tap or long hold can be utilized to begin reservation on device.Short tap/long hold difference still required for unlock/lock/check-out events to ensure user differentiation between lock event and end reservation event.Long hold duration for NFC extended by two seconds:Long hold for NFC events to Check-In/Check-Out of a virtual key now require the user to hold the card against the reader for ~7 seconds in order to register as a long hold. Change made to prevent inadvertent Check-Out events if a user intended to short tap.Send virtual key ID with all Check-Out events:Virtual key ID sent with all Check-Out events for the purposes of synchronizing device reservation state with reservation SW backend.Force status data logs on unlock/lock events:On all lock/unlock event triggers, GO will bypass curve logging and communicate current status data backlogs to the cloud, in an effort to improve response times for unlock/lock feedback to integrators.IgnitionEnable timer:StarterEnable timer extended from 5 minutes to 10 minutes for all IgnitionEnable commands received to allow more time for users to start the vehicle after access. | | |
Firmware x.33.43
Released
New Features: Introduction of voltage threshold in which continuous connect will be automatically turned off to prevent battery drain.Default threshold value set to 11.5V.This can be modified via a custom parameter. | | |
Fixed Issues: Modem firmware bug resulting in internal reset conditions. | | |
Improvements: Continuous Connect performance optimization (Keep-alive messaging structure).Multiple operation encapsulated OTA commands.Mimics the Bluetooth workflow and allows for Check-in OTA. | | |
Firmware x.33.32
Released
Initial Release | | |
New Features: Support for NFC vehicle access. | | |
Fixed Issues: Modem firmware bug resulting in internal reset conditions. | | |
Improvements: Continuous Connect functionality enabled by default for devices on the ProPlus + Keyless rate plan.Custom Parameter can be applied to disable Continuous Connect functionality. | | |
IOX-Keybox Firmware
Firmware 0.23/0.30 (Beta)
Last Released
While we are planning to make it possible to adapt the IOX-Keybox hardware to alternative key fob types in the future, the current Beta hardware (on which this firmware version is supported) cannot be adapted to new key fob types. Known Issues: There is a low risk that the first attempt of an unlock/lock will fail; a second try soon after is highly likely to successfully complete.When the v2 harness HRN-Keybox (pictured here) is used, there is a low risk that the IOX-Keybox becomes unresponsive and requires a physical unplug & re-plugin to regain a working state. We are actively working on an updated harness.There is a low risk of future IOX-Keybox firmware updates failing. If so, please request a replacement, which will be provided free of cost.Bluetooth connections persist while driver's mobile phone stays in Bluetooth range, increasing likelihood of vehicle and mobile phone battery drain.Known Performance Issues: IOX-Keybox takes a longer time to respond to commands than IOX-Keyless. | | |
Keyless Mobile SDK
Android Keyless SDK v1.2.0
Released
New Features: Added diagnostic log storage and upload functionality. For updating existing apps, see . Integrators developing new apps should consult the . | | |
Improvements: Deprecated KeylessClient interface in favour of KeylessManager.KeylessManager is now initialized as a singleton.Will respond with a clear error when a Virtual Key is malformed.Updated GitHub README.md to include more information on how to integrate the SDK with documented examples.Renamed error types. See documented changes here: | | |
Fixed Issues: KeylessManager could be left in an incorrect state on closing Bluetooth connection.The presence of other Bluetooth devices in close proximity were resulting in the inability to establish Keyless Bluetooth connections. | | |
Android Keyless SDK v1.1.1
Released
Fixed Issues: Return more granularity in Keyless errors.Close bluetooth connection when app is force closed. | | |
iOS Keyless SDK v1.1.0
Released
New Features: Added Keyless Manager. | | |
Improvements: Will now provide clearer errors when performing actions in an invalid state.Error now reported when disconnected in the middle of a command. | | |
Android Keyless SDK v1.1.0
Released
Fixed Issues: Fix circular dependency.Improve logging.Fix permissions permission issues. | | |
Android Keyless SDK v1.0.3
Released
New Features: Add Keyless Manager. | | |
Fixed Issues: - Reset incoming buffer on error.
| | |
Android Keyless SDK v1.0.2
Released
Fixed Issues: Google Protobuf dependency update. Switched from protobuf-lite to protobuf-javalite. | | |
Android Keyless SDK v1.0.1
Released
Fixed Issues: Fix for crash that occurs as a result of turning off Bluetooth while trying to connect to a device. | | |
Android Keyless SDK v1.0.0
Released
iOS Keyless SDK v1.0.1
Released
Fixed Issues: Reset incoming buffer on error. | | |
iOS Keyless SDK v1.0.0
Released
Keyless Monitor Add-in
Keyless Monitor v1.8.0
Released
Improvements: Security vulnerabilities fixed. Added a LUKe config for Longer-Power-On. | | |
Keyless Monitor v1.7.1
Released
Improvements: Fix for a critical performance issue that caused the Keyless Monitor to crash on databases with over 5,000 devices. | | |
Keyless Monitor v1.6.0
Geotab provides the Keyless Monitor add-in for MyGeotab to assist integrators and administrators in reviewing Keyless-related telematics logging and issuing ad-hoc OTA commands.
Released
Improvements: Error reported when the user account used during registration of Keyless Monitor is not found has been made more clear.Additional warnings added to Keyless Fleet Summary and Keyless Monitor tabs to show when a Keyless installation needs attention (incorrect firmware, missing IOX-BT, hardware needs replacement, etc.) | | |
Keyless Monitor v1.5.1
Released
Fixed Issues: GO firmware version 42.45 will now show green in the Keyless Fleet Summary and will not display a warning about being on the wrong firmware channel. | | |
Keyless Monitor v1.5.0
Released
Improvements: For vehicles that leverage a Keyless device that depends on IOX-BT, a warning will be raised if IOX-BT is not installed.Deprecated features such as using Keyless Service API v1.0 and reporting on Continuous Connect status have been removed.Faster loading of UI elements due to optimized querying.Controls for sending configs are disabled for vehicles with IOX-KEYBOX installed (IOX-KEYBOX should always use default config).Added warnings/guidance for mis-aligned firmware versions and IOX-KEYBOX beta unit replacement. Changed remediation action descriptions in Keyless Fleet Summary from mouse-over tooltips to a dedicated column. | | |
Fixed Issues: The registration page was not highlighting the registration username in red or green based on the existence of the entered account.Too many remediation actions in the vehicle details frame would overflow onto other UI elements. | | |
Keyless Monitor v1.4.4
Released
Improvements: Log message for ‘IOX-Keyless serial number’ renamed to ‘Keyless Actuator Serial Number’ to reflect a log common to multiple Keyless products. | | |
Fixed Issues: Keyless Monitor will no longer poll for logs using the ‘Live monitor’ feature when users navigate away from add-in. | | |
Keyless Monitor v1.4.2
Released
Improvements: Security vulnerabilities fixed. | | |
Keyless Monitor v1.4.1
Released
Improvements: Visibility of the add-in has been restricted to users with Administrator security clearance since such clearance is already required to use the add-in to begin with.NOTE: A new security clearance feature option called View "Keyless Monitor" add-in has been added that will make the add-in visible for users if it is enabled for their assigned security clearance, however Administrator security clearance is still required to use the add-in.Improved speed and reduction of API calls when fetching Keyless logs.Fixed an issue where the add-in will be stuck in a permanent loading state if Devices are added to the database and their rate plan hasn’t been synchronized yet.Added support for registering databases in the afmfe federation with the Keyless Service.Security vulnerabilities fixed. | | |
Keyless Monitor v1.4.0
Released
Improvements: New MyGeotab databases have the option to register to the UAT or Production environment from the initial add-in page.LUKe flash read log messages now report 'No config exists, using default' instead of an error if a config has never been downloaded to a GO device.If a second public key is not present on a GO device a dash will be displayed in the vehicle information instead of 'B2E64153'.Security vulnerabilities fixed. | | |
Keyless Monitor v1.3.0
Released
Improvements: Initial registration window now offers a dropdown to specify if the MyGeotab tenant being registered is part of the ‘my.geotab.com’ or ‘gov.geotab.com’ domain. | | |
Keyless Monitor v1.2.0
Released
Fixed Issues: Fix initial live monitor call to 'append' exiting early when no data exists initial start.Disable buttons when the user doesn't have ProPlus + Keyless rate plan.Reason: Previous behavior disabled buttons when an IOX-Keyless device or an IOX-Keybox wasn't found, but it was discovered that certain workflows gave a false-positive on a device being present.Fix debug table not fully displaying when there was a single row of data.Clicking a button command no longer shows 'Command accepted!', instead displays 'Command sent!'. | | |
Keyless Monitor v1.1.1
Released
Fixed Issues: Removed option to enable notifications during tenant creation.Reason: Without registering a webhook URL via the Keyless Service API, enabling notifications will not do anything.Removed the 'Locate Keybox' button.Reason: Button does not perform any real function.Monitor will now prevent users from sending commands when no Keyless devices are found.Resolved showing stale/previous device event data when switching devices.Fixed behaviour where, while live monitoring is enabled, the log grid is scrolled to the bottom, regardless of whether new data is found or not.New behaviour is to only auto-scroll when there is new event data. | | |
Keyless Monitor v1.1.0
Released
Fixed Issues: Added delay between clicks of ‘Start Live Monitor’ to prevent duplicate execution. | | |
Improvements: Added logging for IOX-Keybox events. | | |
Keyless Monitor v1.0.2
Released
Improvements: Added detection for IOX-Keybox. | | |
Keyless Monitor v1.0.0
Released
Keyless Lite Add-in
Keyless Lite v1.1.2
Released
Improvements: Add-in will now show as ‘Verified’ in the MyGeotab Add-Ins tab of System Settings.Updates for security vulnerabilities. | | |
Keyless Lite v1.1.1
Released
Fixed Issues: Executing commands would fail if Virtual Key was requested from a mobile device with time set ahead of the time on the GO. | | |
Improvements: UI tweaksUpdates for security vulnerabilities. | | |
Keyless Lite v1.0.5
Released
Fixed Issues: Executing commands would fail if Virtual Key was requested from a mobile device with time set ahead of the time on the GO. | | |
Improvements: Selecting another vehicle, deselecting the current vehicle, or logging out of Geotab Drive will now cause the Bluetooth connection to the current vehicle to disconnect, allowing other users to connect.Updates for security vulnerabilities. | | |
Keyless Lite v1.0.4
Released
Fixed Issues: Opening the Keyless Lite add-in without internet access after downloading a Virtual Key fails with an error.This has been resolved, as long as the add-in has been accessed (causing the Virtual Key to be downloaded) while connected to the internet, subsequent attempts to open the add-in while assigned to the same vehicle should work regardless of internet connectivity.Fonts in the UI are not consistent while not connected to the internet. This is resolved. | | |
Improvements: Marketplace add-in will automatically discover the appropriate Keyless Service environment.It is no longer necessary to use a custom version of the add-in to test with the UAT environment.Any integrator that wishes to remove the older add-in can reference the section “Deprecated Keyless Lite UAT Add-in Removal” in this document Keyless UAT Environment Setup. | | |
Keyless Lite v1.0.3
Released
Improvements: Added additional logging for errors. | | |
Keyless Lite v1.0.2
Released
Improvements: Added logging functionality. | | |
Keyless Lite v1.0.1
Released
Improvements: Updated app icon. | | |
Keyless Lite v1.0.0
Released
Appendix A - Past Advisories
Keyless Service API v1.0 Removal
Communicated on:
We will be removing the ability to use the version 1.0 Keyless Service API on September 18, 2024.
Once this change is in place API requests made with the HTTP header field "X-Version" set to 1.0 will no longer succeed. To ensure continued functionality of your integration, update the HTTP header field "X-Version" to 1.1 which is already available.
In the absence of the HTTP header field "X-Version", requests will default to the 1.1 endpoint after September 18, 2024.
To see the difference between the API versions you can access the Swagger documentation at http://keyless.geotab.com and choose between API versions using the drop-down menu in the top right corner.
Ensure your integration is updated to account for the changes to the following endpoint:
POST /api/tenants/{database}/devices/{serialNumber}/commands
If you require any assistance or have any questions about migrating to the 1.1 API please reach out to your point of contact in Geotab Solutions Engineering.
The Technical Integration Manual will be updated on September 18, 2024 to reflect these changes (see https://docs.google.com/document/d/19qimSpiobA7Inn7N6lMHTHtvFfIWa37vZxcZJFQKIWQ/edit#heading=h.8tcv9quqvj3w).
Integration Simplification in GO FW 38.27 + Keyless Service 1.1.34
Communicated on:
! IMPORTANT: Do you need support or have questions about these changes? Please contact your Geotab point of contact, or keylessinfo@geotab.com, and we will ensure support is provided.
These changes will require Geotab Keyless Integrator awareness to potentially accommodate changes in your integrations, in order to ensure our joint customers are not impacted and have a smooth transition.
Please accommodate for these changes with higher urgency than normal due to an identified connectivity issue impacting reliability with GO9B™ devices. The fix for this issue is in GO FW 38.27 + Keyless Service 1.1.34. We sincerely apologize for this urgency and we thank you for your understanding.
Oct 25 - Nov 15 - UPDATE | Implement and verify any accommodations needed to adapt to these changes. - Changes are complete? Notify your Geotab contact or keylessinfo@geotab.com once you’ve confirmed your integration changes are complete. We will then upgrade customers using your integration with GO FW 37 and 38 to 38.27.
- Do you need more time? Please email keylessinfo@geotab.com and we will discuss offering you 1 more week (Nov 15 new target date) and offer additional support if needed.
Customers using GO FW 39+ will not see any change. |
Nov 15 | If we haven’t previously upgraded your customers using GO FW 37 and 38, we will update them to 38.27. Customers using GO FW 39+ will not see any change. |
Nov 22 | If you’ve advised us you need more time, your customers will be updated on this date or sooner once you’ve completed your changes are complete. |
Today, the Keyless Integrator (partner virtual key management system) is in the best position to manage and authorize user access to vehicles, yet the Geotab Keyless product additionally handles that logic.
The goal of these changes are to simplify the experience for Keyless integrations by removing unnecessary reservation management logic – check-in and check-out over Bluetooth – logic that the Integrator is in the best position to handle as the primary component managing reservations and vehicle occupancy access.
In a future version, similar changes will happen for NFC, with no changes to NFC check-in/out logic at this time, however there has been a notification change for user initiated on demand / “tap & go” NFC check-in, outlined below.
Please verify your integration with:
- GO FW 38.27
- Keyless Service 1.1.34
GO Device Firmware Version 38.27
If your integration relies on this logic, please be aware.
The following Bluetooth Commands are deprecated:
- Check-In (Bluetooth): Formerly used to start a Booking.
- Check-Out (Bluetooth): Formerly used to end a Booking.
If any of the above commands are sent, they are simply ignored: 3342 (New BLE Command) will be logged, but the commands are otherwise not executed nor is any other response (success/fail) provided.
The following status data are no longer communicated in response to the above commands: 3346, 3347, 3380, 3343.
If Check-In/Check-Out is combined with any other command (Unlock, Lock, etc.):
- The Check-In/Check-Out is ignored.
- The other commands are not ignored.
The following Bluetooth Virtual Key Privileges are deprecated:
- Check-In Override {CheckInOverride}
- Booking Timeout Reset {ResetAtEndOfBooking}
- Check-Out Failure Override {IgnoreCheckoutFail}
Should they be used, they are simply ignored.
Adapting Existing Bluetooth Workflows that Rely on Check-In to Restrict Vehicle Interaction: If your workflow previously relied on Check-In to exclude other users from executing commands against the vehicle, for access over Bluetooth in GO FW 38, there is no built-in mechanism in place to prevent that from happening. You must implement a method of restricting a secondary user from doing so if so desired.
Measures to Ensure Success in case of FW Rollback
In case we need to rollback to GO FW 37, to ensure proper operation of the deprecated Bluetooth Virtual Key Privileges:
- Ensure that the virtual key end book time is far in the future.
- Every command has both check-in and check-in override set.
These proactive measures will ensure consistent operation between both firmware versions.
Keyless Service 1.1.34 + GO FW Version 38.27
If your integration relies on this logic, please be aware.
Bluetooth CheckIn & CheckOut Notifications: Notifications for the following Bluetooth Event Types have been deprecated:
BleCheckInCompleteBleCheckOutCompleteNFC On Demand / “Tap & Go” (Online Access) Notification Change: The event type communicated upon successful execution (Keyless successfully acts on your NFC Online CheckIn request) when the original request was initiated by the user (Driver) (via NFC long tap) has changed between GO FW 37 and GO FW 38 in order to provide a consistent response whether the request was initiated through online or offline access:
GO FW 37: OnlineCheckInCompleteGO FW 38: TapCheckInCompleteIn the case where the original request was not initiated by the user (Driver), then the event type remains in GO FW 38 OnlineCheckInComplete.
