Using HIGH MOBILITY’s Auto APIs: “Digital Key” Category
Continuing with our blog series on the Auto API Guide, today’s post will be covering the next category in the API Guide called Digital Key. This series aims to provide you with an in-depth look at each of the APIs you can use with the HIGH MOBILITY car emulator, the general categories each API falls into, the specifications of each API and what kind of data each API can provide.
To make it easy for you to follow we are working through the APIs as they appear in our Auto API Guide in the Developer Center of the HIGH MOBILITY site, so make sure you’re signed up to the site so you can explore at the same pace.
If you missed the first two blog posts, make sure to check them out. The first category we covered in the series was the Overall category, then we went through Diagnostics and Maintenance, and today’s will cover Digital Key.
The Auto API Guide
To access the full list of APIs, your first port of call is the Auto API Guide, which is located in the HIGH MOBILITY Developer Center (you will need to make sure you are registered before you are able to access this part of the site). To find it from the main Developer Center landing page, simply click on Tutorials in the left-hand column. Underneath Getting Started you will see Possibilities Exploring, and then Auto API Guide. Click on the Auto API Guide link to see the list itself. You’ll notice that each of the APIs are separated into different categories, for example “Diagnostic”, “Chassis”, “Head Unit”, “Parking” and so on.
However, to get a more complete picture of the APIs, a good place to explore is the Car Emulator. To find the Car Emulator, click on the Develop tab at the top of the page. It is the tab with the tool icon on it. Now, click on the image of the car in the center of the page, and the emulator will open up.
(In need of a visual demonstration? Check out this excellent high-definition webinar by HIGH MOBILITY founder Kevin Valdek covering these points. The section on Digital Key begins at 9.50 minutes in).
*Please note that in the Capabilities section of the Car Emulator the functions are listed in alphabetical order, whereas in the API Guide they are grouped in their categories.*
In the Car Emulator tab in the Developer Center you will see on the right-hand side a list of Capabilities. If you look down the list, you’ll see Door Locks under Maintenance. Click on Door Locks.
For each car door you will see a lock and an option to open or close. If you click on the individual lock symbols you can see in the emulator that you are locking or unlocking individual doors.
Elements of this function can be triggered through the APIs, so now head back over to the API Guide by going back to the Developer Center, clicking on the Doc. tab, then on the Documentation button (under Tutorials on the left-hand side), then clicking on Auto API, then on the Tutorials button, and then on Door Locks.
From here we can take a look at the specifications for Door Locks.
In this section you will find all of the details of the position, the location, whether the door is locked or unlocked.
If you scroll down you will see an additional specification, that is the ability to send a command to lock or unlock all doors.
We’ve had a number of questions from users about whether the doors being unlocked means you can already start driving the car. The answer to this is no. If you go back to the Car Emulator and click on Engine in the list of Capabilities on the right-hand side, you will see you have the option to turn the ignition on or off, therefore starting the car and enabling driving.
It would, for example, be a good idea to have both the door locks and the engine permissions in the same application, so you can unlock the car and also start driving it.
The next capability in the Digital Key category is Trunk Access. If you click on Trunk Access in the left-hand column on the Car Emulator page you will see this function represented in the Car Emulator.
First of all, you will notice that their are two different states available within this capability:
1. Trunk lock
2. Trunk position
Within the emulator, you can play around with these two states. You can lock and unlock the trunk as well as open and close it.
As before, these can both be triggered from your application. If you look at the Trunk Access API you will see the exact specifications for this. (To find this head back over to the API Guide by going back to the Developer Center, clicking on the Doc. tab, then on the Documentation button (under Tutorials on the left-hand side), then clicking on Auto API, then on the Tutorials button, and then on Trunk Access.)
Take a look at the specifications on this page. Under Message Specification you can send commands to both lock or unlock the trunk, or open and close the trunk. This is because it’s now common for vehicles to have a trunk that can be opened and closed electronically.
— — — — — — — — — — — — — — — — — — — — — — — — — — — — — — — — — — — — — — — — — — — -
We’ve come to the end of today’s look at the Auto API Guide. In our next post of the series we’ll be examining the category Chassis. We’ll be describing each of the APIs in this category, their functions and how they can be used.
We hope you’ve enjoyed today’s breakdown. If you have any questions, please do reach out to us using the comments below. We’ll be happy to help you.
To stay ahead of all our news, updates, blogs and tutorials, make sure to connect with us via the HIGH MOBILITY Facebook page, Twitter or LinkedIn. You can of course also keep checking back to our Medium site, too!
Until next time, happy building.