Support Document

0 mins to read

User Guide

October 2023




Understanding Keyless Monitor

Keyless Monitor is a MyGeotab Add-In that enables Integrators, Partners, and Customers to configure, control, and monitor the Keyless hardware.

Keyless Monitor allows MyGeotab Administrators to send commands – such as lock and unlock – to vehicles remotely, configure Tenant access to the Keyless Service, as well as see the Keyless status data and feedback.

Installation and setup

The following table outlines the two ways to install the Keyless Monitor.

Marketplace

Install the Keyless Monitor Add-In directly from Marketplace

Manual installation using a config file

Consult How to install/add an add-in manually into a MyGeotab database and use the following config file text:


{

"url": "https://app.geotab.com/addins/geotab/keyless-monitor/manifest.json"

}

Setting up the Keyless Tenant configuration

NOTE: Only users with the Administrator Security clearance are permitted to access and interact with Keyless Monitor. Additionally, users with an Administrator Sub-Clearance are not permitted.


A Keyless Tenant is your database’s access to the Keyless Service. It is a setup that is made for each database, which enables the Keyless functionality.

When running the Add-In for the first time, it automatically checks if there is a Keyless Tenant configured for the database. If the Keyless Tenant is not found, you are prompted to create one.


NOTE: If your MyGeotab database is intended to connect to the Keyless Service UAT environment for pre-release testing, please follow the instructions in the Keyless UAT Environment Setup document instead.

Creating a new Keyless Tenant

1

From MyGeotab, navigate to Administration > Users.

2

Create a new user with the Administrator clearance.

3

Start the Keyless Monitor Add-In and enter the new user credentials for the Service User Account.


✱ NOTE: If NFC access is being used for Keyless, additional configuration will be required. This is outside the scope of this document.

Keyless Monitor functions

Viewing a vehicle’s Keyless device status information

1

Select a device using the dropdown menu.

2

Once selected, a Keyless device check is performed for the following points:

  1. Vehicle state (ignition, driving state)
  2. Device serial number and Telematics Firmware version
  3. IOX-KEYLESS or IOX-KEYBOX hardware versions
  4. Continuous Connect Parameter
  5. Device Public Keys
  6. ✱ NOTE: Public Key is mandatory for the Keyless to work. If there is a wrong Public Key on the device, it is marked red.

  7. Device Rate Plan
  8. Last keyless activity to verify the timestamp of the last keyless command executed

Keyless readiness check: Success or fail

The following checks are made to assess that the vehicle is ready to successfully use Keyless:

    1. The device’s serial number and Telematics Firmware version are correct for Keyless.
    2. ✱ NOTE: A GO device version 9 or newer is required.

    3. The device’s Rate Plan is correct.
    4. ✱ NOTE: A ProPlus+Keyless Rate Plan is required.

    5. The device has at least one Public Key, which belongs to this database’s Keyless Tenant.

    ✱ NOTE: Public Keys are automatically synchronized to a device by Geotab’s Keyless Service. To send a key, use the Send Keys button under Advanced Options. See Send Keys for more information.


    If any of the success criteria are not met, a warning message displays indicating how to resolve the issue.

    Sending remote commands (over the mobile data network)

    Select a device using the dropdown menu.

    It is possible to send the following Keyless commands remotely:

    1. Locate – Honk the horn or flash the lights, in order to guide the Driver to the correct vehicle.
    2. Lock – Lock all doors.
    3. Unlock – Unlock all doors.
    4. Starter Enable – Enable push to start button capability on the vehicle, by powering the key fob. If a Starter Inhibit Relay is optionally installed the Starter Enable command will activate the relay coil, closing the original circuit and allowing the vehicle to start.
      1. If the vehicle’s ignition is On: This will have no additional effect. The key fob is already powered for the ignition to start, and the optional Starter Inhibit relay is in a state to allow the vehicle to start.
      2. If the vehicle ignition is Off:
        1. The GO device places the key fob powered on for ten minutes, allowing time for the driver to start the vehicle. If the ignition is on within the 10-minute window, the key fob remains on as well.
        2. Once the vehicle Ignition is off, the GO device keeps the key fob powered on for 10 minutes, allowing the driver to restart the vehicle within that time window, when no further commands are received.
        3. The optional Starter Inhibit relay is deactivated, closing the original circuit and allowing the vehicle to start, and continues in that state until a Starter Inhibit command is received, independent of the 10 minutes as described.
        4. NOTE: For GO device firmware versions < 38.6, the optional Starter Inhibit re-activates after a GO device reset, opening the circuit, and preventing the vehicle from starting. In this rare case the Driver, with working local vehicle access, is advised to request to unlock the vehicle again when an Unlock also issues a Starter Enable. Or re-request a Starter Enable from Keyless Monitor.

      3. Starter Inhibit – Disable push to start button capability on the vehicle, by powering off the key fob. If a starter inhibitor is optionally installed, by this same command, the relay coil deactivates, opening the original circuit and preventing the vehicle from starting.
        1. If the vehicle’s ignition is on: The GO device will fail to communicate, and display an error. Executing Starter Inhibit while the ignition is on is prohibited for safety reasons. The key fob remains powered for continued operation of the vehicle, and the optional Starter Inhibit relay remains in the same state.
        2. If the vehicle ignition is off:
          1. The GO device turns off the key fob, preventing the vehicle from being started.
          2. The optional Starter Inhibit relay is re-activated, opening the original circuit and preventing the vehicle from starting.
      4. Reset – For Keyless and Shared Mobility Integration Partner implementations only. Reset the state of the vehicle (reservation state) so it can accept new reservations.
      5. Additionally, the following IOX-KEYBOX Keyless Hardware commands are supported, and are visible when selecting the Advanced checkbox. For scenarios of use where the original vehicle key is retrieved and used throughout the driver's usage period, refer to the following:

      6. Unlock Keybox – Unlock the IOX-KEYBOX drawer.
      7. Lock Keybox – Lock the IOX-KEYBOX drawer.

      NOTES:

      1. Remote commands are being sent using the Geotab Keyless Service and will only be successful if the vehicle is in a location with mobile network data connectivity.
      2. For when reservations are being used through a Keyless and Shared Mobility Integration Partner (not applicable to Keyless Lite Solution users), remote commands do not require a valid reservation (or virtual key) and can be always sent to the device.

      Keyless command responses: See feedback

      Every keyless action results in feedback, which you can see in the Keyless Monitor. Choose your desired time range and click the Load List button.

      For a description of the feedback see

      Keyless Live Monitor

      It is possible to start the device live monitoring by clicking the Start Live Monitor button. In this case every five seconds all the Keyless data is pulled from MyGeotab and displayed on the main page.

      To stop Live Monitor, click the Stop Live Monitor button.

      Advanced options

      There are some advanced features and options for Integrators. For example, sending a special Key Fob configuration to a Tesla vehicle. Select the Advanced Options checkbox to display these options:

      1. Check Tenant Allows you to check the current tenant configuration. An example configuration looks like the following:

      { { "database": "testdatabase", "server": "my.geotab.com", "serviceAccount": { "username": "test-keyless-tenant@geotab.com" }, "isNotificationEnabled": true } Tenant Keys: C83FF576, - }

      The configuration is read-only and can be only modified via the Geotab Keyless Service.

      1. Send Keys – In order to execute Keyless commands using Bluetooth a public key is required. This is automatically sent by the Keyless Service to your device. If you need to update the public key, or if you do not want to wait until the keys are automatically synchronized, use Send Keys to send the Tenant public key to your device manually.
      2. ∞ (Indefinite) Starter Enable As with Starter Enable, enable push to start button capability on the vehicle, by turning on the key fob, however with no time limit. If a Starter Inhibit Relay is optionally installed, by this same command, the relay coil activates, closing the original circuit and allowing the vehicle to start.
        1. If the vehicle’s ignition is On: This will have no additional effect. The key fob is already powered for the ignition to start, and the optional Starter Inhibit relay is in a state to allow the vehicle to start.
        2. If the vehicle ignition is Off:
          1. The GO device places the key fob powered on indefinitely until the Starter Inhibit command is received. This enables the vehicle to start without having the 10-minute limit in Starter Enable.
          2. The optional Starter Inhibit relay is deactivated, closing the original circuit and allowing the vehicle to start, and continues in that state until a Starter Inhibit command is received.
        1. NOTE: For GO device firmware versions < 38.6, the optional Starter Inhibit re-activates after a GO device reset, opening the circuit, and preventing the vehicle from starting. In this rare case the Driver, with working local vehicle access, is advised to request to unlock the vehicle again when an Unlock also issues a Starter Enable. Or re-request a Starter Enable or ∞ (Indefinite) Starter Enable from Keyless Monitor.

      1. Send Config – Certain vehicles require a special key fob configuration, which needs to be sent once using the Keyless Monitor. Select the Advanced Options checkbox, then select one of the following for setting configurations:
      1. Default configuration
      2. Tesla Model S/X (2015+)
      3. Tesla Model 3/Y (2018+)
      4. Extended lock configuration (the button pulse duration is extended to 5000 ms)
      5. Lock-Unlock-Inverted configuration (the lock and unlock commands are inverted, mostly due to wrong wiring of the IOX-KEYLESS key fob)
      6. Swap-Trunk-Lock configuration (the trunk and lock commands are inverted, mostly due to wrong wiring of the IOX-KEYLESS key fob)

      NOTE: There are additional configurations available for Geotab Support teams.



    scroll-up