Support Document
0 mins to read
•Keyless Monitor: User Guide
Support Document
0 mins to read
•Keyless Monitor is a MyGeotab Add-In enabling Integrators, Partners, and Customers to configure, control, and monitor Geotab Keyless hardware. Keyless Monitor, available only to MyGeotab Administrator users, allows you to send commands to vehicles remotely, configure Tenant access to the Keyless Service and NFC Key Fobs, as well as see the Keyless status data and feedback.
Keyless Monitor is a MyGeotab Add-In enabling Integrators, Partners, and Customers to configure, control, and monitor Geotab Keyless hardware.
Keyless Monitor, available only to MyGeotab Administrator users, allows you to send commands – such as lock and unlock – to vehicles remotely, configure Tenant access to the Keyless Service and NFC Key Fobs, as well as see the Keyless status data and feedback.
There are two ways to install the Keyless Monitor:
Marketplace | Install the Keyless Monitor Add-In directly from the Geotab Marketplace: https://marketplace.geotab.com/solutions/keyless-monitor-beta/ |
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" } |
✱ NOTE: Only users with Security clearance ‘Administrator’ are permitted to access and interact with Keyless Monitor. Additionally, users with a Sub-Clearance of ‘Administrator’ will not be permitted.
If you run the Add-In for the first time, it will automatically check if there is a Keyless Tenant, which is your database’s access to the Keyless Service, already configured for the database. A Keyless Tenant is a setup which is made for each database, which enables Keyless functionality to occur.
If the Tenant is not found, you will be prompted to create and configure one:
In order to create a new Keyless Tenant, you need to perform following steps:
1 | Navigate to Administration > Users from the main menu. |
2 | Create a new user with the Administrator clearance |
3 | Start the Keyless Monitor Add-In and fill in the credentials of the freshly created user for the service user account. |
4 | If you are using NFC for vehicle access: You have the checkbox option Enable Vehicle Access Event Notifications (Webhooks). This will allow you to receive notifications using webhooks when using the NFC Tap And Go (Online Access). This functionality is currently only recommended if NFC access is being used for Keyless. If it is not, leave this checkbox unmarked. |
Select a device using the dropdown element on the right side of the page:
Once selected, there will be a Keyless device check performed in the background, checking following points:
The following checks are made to assess that the vehicle is ready to successful use Keyless:
If any of the success criteria were not met, warning messages will be displayed towards resolving the problem:
Select a device using the dropdown element on the right side of the page:
It is possible to send following Keyless commands remotely:
Additionally, the following IOX-KEYBOX Keyless Hardware commands are supported, typically to retrieve a hybrid fob - bladed key, when it is needed to start the ignition.
✱ NOTE: 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.
✱ NOTE: For when reservations are being used via Keyless + Mobility Integration Partner (not applicable to Keyless Lite Solution users), remote commands don’t require a valid reservation (or ‘virtual key’) and can be always sent to the device.
Every keyless action will result in a feedback, which you can see in the Keyless Monitor. Choose the time range and press the Load List button:
It is possible to start the device live monitoring by pressing the Start Live Monitor button. In this case every 5 seconds all the Keyless data will be pulled from MyGeotab and displayed on the main page.
Live Monitor can be stopped by pressing the Stop Live Monitor button.
Some advanced features / options for integrators mostly - e.g. to send a special key fob configuration to a Tesla vehicle.
This function will allow you to check the current tenant configuration. An example configuration will look like this:
{ { "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.
In order to be able to execute Keyless commands via Bluetooth you need to have a public key, which is being sent automatically by the Keyless Service to your device. If you need to update the public key or you don’t want to wait until the keys are automatically synchronized, you can always send the Tenant public key to your device manually.
This command mimics the use of the IgnitionEnable Operation with a use of the UseMaximumMobilizationTimeout privilege. Upon reception, the GO places the keyfob in an ON state for 10 minutes or until an IgnitionInhibit Operation is received, and places the relay onboard the IOX-KEYLESS in an ON state indefinitely or until an IgnitionInhibit Operation is received.
This command can be only used in conjunction with a bladed-key vehicle. The common use case is where a customer rents the vehicle for a long period of time and doesn’t want to use the mobile app to open / close the vehicle, since he has got the physical key fob.
✱ NOTE: It is not recommended to send a IgnitionEnable command after the IndefiniteStarterEnable command as it will invalidate the IndefnitieStarterEnable, resulting in the keyfob being placed in a power OFF state after 10 minutes of vehicle inactivity.
Sending a IgnitionEnable+ IndefiniteStarterEnable Operations in the same command is NOT supported
Sending a IgnitionInhibit+ IndefiniteStarterEnable Operation in the same command is NOT supported
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:
✱ NOTE: There are additional configurations available for Geotab support department engineers.
The option to send these via the Keyless Monitor Add-In is enabled by selecting the Advanced Options checkbox, then selecting the correct option for the customer’s Tesla model: