TomTom Digital Cockpit - API reference

This is the API reference documentation for TomTom Digital Cockpit version 1.0.4428.

Copyright

Copyright © 2020 TomTom NV. All rights reserved.

This software is the proprietary copyright of TomTom NV and its subsidiaries and may be used for internal evaluation purposes or commercial use strictly subject to separate license agreement between you and TomTom NV. If you are the licensee, you are only permitted to use this software in accordance with the terms of your license agreement. If you are not the licensee, you are not authorized to use this software in any manner and should immediately return or destroy it.

All modules:

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

This module contains the static configuration and settings classes, used to set up the Bugsee error reporting tool.

Link copied to clipboard

The companion app communications service API module.

Link copied to clipboard

A library to handle and simplify usage of the Android media library. It's meant to be a thin layer on top of Android's MediaBrowser to easily retrieve standard Android media content and deal with playback actions.

Link copied to clipboard

Media sources library: a library to create and customize rich user interfaces for media playback.

Link copied to clipboard

This module defines the Media Service API, which advertises the active media source, what content is being played, and enables interaction with those media sources.

Link copied to clipboard

This module defines the Media Settings Service API, to load and store media frontend state.

Link copied to clipboard

This module contains testing API usable for functional tests specific to the media frontend.

Link copied to clipboard

This module contains testing API for functional tests of media components.

Link copied to clipboard

This TomTom-internal module contains tooling for unit and instrumented tests of media domain components.

Link copied to clipboard

This TomTom-internal module contains tooling for unit tests of media domain components.

This module contains the base tooling necessary for developing a TomTom Digital Cockpit frontend that exposes NavApp Components.

This module contains a set of classes that are responsible for instantiating NavApp singletons shared between the navigation frontends.

This module contains an activity that checks the setup of navapp components before opening the real TomTom Digital Cockpit activity.

This module contains navigation cues, to be shown to the end-user.

Link copied to clipboard

This module contains static configuration key definitions that can be used to configure the Alexa service of TomTom Digital Cockpit.

Link copied to clipboard

This module contains classes and functions which are intended for use by services or frontends that interact with the Alexa Voice Personal Assistant (VPA).

Link copied to clipboard

This module provides service APIs that can be implemented to extend the TomTom Digital Cockpit platform Alexa Auto implementation.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

This module provides classes which are intended to be used by service implementations which reflect the state of a remote Bluetooth device and local Bluetooth adapter.

The Bluetooth connectivity service API module provides an interface for services that provide information about nearby Bluetooth devices, and methods to change their connection state. The service API also provides methods to change the policy of the local Bluetooth profiles, such as PBAP_CLIENT, MAP_CLIENT and A2DP_SINK.

This module provides some extension functions for the build-time generated BluetoothConnectivityServiceMock class.

The mobile companion app service API module.

Link copied to clipboard

This module contains utility classes for contacts.

Link copied to clipboard

The contacts common core library is used when working on features provided by the contacts service.

Link copied to clipboard

The contacts UI common core library used in a frontend to represent a contact.

Link copied to clipboard

This module contains useful helper classes used with the contacts service interface.

Link copied to clipboard

The contacts service API module.

This module provides service APIs for reading and modifying the settings relating to contacts.

This module contains tools to ease the addition of debug tabs to the debug panel.

This module contains an activity that hosts only the debug menu frontend.

Link copied to clipboard

This module contains classes which are intended for use by services or frontends that interact with EV Charging service interfaces.

This module contains APIs that should be implemented by a component that instantiates the eMSP plugins in the system and mediates calls to them so that the system can provide a UI that allows the end-user to charge their EV from the infotainment system.

This module defines the IviExperimental and IviInternal annotations.

A vehicle may have multiple infotainment screens, each of which is identified by an IVI instance ID. This module contains types to identify an IVI instance.

Link copied to clipboard

This module contains tools to ease the usage and integration of Android's Lifecycle aware components.

Link copied to clipboard

This module contains utilities to serialize various types to Android's Parcel type.

Link copied to clipboard

This module contains a utility object that provides system information; for example, whether the current module is built in debug mode or whether the app is running on an emulator.

Link copied to clipboard

This module defines a functions that can be used to generate a thread dump at any point during runtime.

Link copied to clipboard

The text-to-speech common API library.

Link copied to clipboard

This module contains a utility class that serves as generic immutable unique ID. The generic class allows for type-safe ID creation.

Link copied to clipboard

This module contains general purpose utilities to simplify common use cases.

Link copied to clipboard

This module contains the API of TomTom Digital Cockpit's configuration framework.

Contains utilities for TomTom Digital Cockpit's configuration framework for development purposes.

Static and dynamic configuration provider implementations.

Link copied to clipboard

This module contains internal utilities related to Android's binder IPC mechanism. These utilities are used by TomTom Digital Cockpit's IPC framework.

Link copied to clipboard

This module contains the API of TomTom Digital Cockpit's IPC framework.

This module contains the API of the TomTom Digital Cockpit's IPC framework for the integration with the Android Paging library.

This module contains the annotations of TomTom Digital Cockpit's IPC framework.

This module contains the internal logic of TomTom Digital Cockpit's IPC framework to register services and manage the IPC.

Link copied to clipboard

This module contains the base class of all IVI Activities.

This module contains the base application for the IVI system.

This module contains the types used by the generated IVI build config.

This module contains an activity that checks the setup of the app before opening the real TomTom Digital Cockpit activity.

This module contains the default IVI activity.

This module contains an IVI application that reports trace events using Android log.

This internal module contains an empty IVI build config. Clients building an IVI system on top of TomTom Digital Cockpit should not use this API.

Link copied to clipboard

This module contains the API of TomTom Digital Cockpit's IPC framework for testing purpose.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

This module contains a frontend with a mock home panel that can be used in integration tests to substitute the original home panel.

Link copied to clipboard

This module contains frontend with mock task panels that can be used in integration tests to open various task panels.

This module contains an UI component to display notifications.

This module contains Espresso's view matchers and test extensions for integration tests with main process panels.

Link copied to clipboard

This module contains FragmentScenario to launch a fragment with applied stock themes. It can be used in integration tests to get themed views.

Link copied to clipboard

This module contains the base test case class for integration tests with frontends.

Link copied to clipboard
Link copied to clipboard

This module contains test tooling for frontend-related unit tests.

This module contains a service API that can be used to simulate the current location of the vehicle. This is useful for demonstrating and testing of the product.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The messaging common core library is used when working on features provided by the messaging service.

Link copied to clipboard

The messaging service API module provides APIs for clients to send and receive messages.

The messaging app service API module provides APIs that are tightly coupled with the stock messaging frontend.

The messaging debug management service API module provides APIs that are used for internal messaging debugging features.

The messaging provider API module provides APIs for extending TomTom Digital Cockpit with new messaging services.

Link copied to clipboard
Link copied to clipboard

This module contains the service API for DebugVehicleDrivingStateService, offering debugging tools that allow manipulating the VehicleDrivingStateService output.

Link copied to clipboard

This modules contains information on the driving state of the vehicle.

The recent calls service API module that provides clients with a list of phone calls that the device or connected devices have received or made recently.

This module contains the service API for 'safety lock' related functionality.

This module contains the API of TomTom Digital Cockpit's IPC setting service framework.

This module contains the API to manage settings.

This module contains a service API to manage user profiles.

Link copied to clipboard

The debug panel service API module provides APIs for clients a way to easily communicate with the System UI about the debug panel.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

This module contains utility classes for telecom.

Link copied to clipboard

This module contains utility classes for telecom.

Link copied to clipboard

The telecom common model library is used when working on features provided by the telecom service.

Link copied to clipboard

This module contains utility classes for telecom.

Link copied to clipboard

The telecom service API module provides APIs for clients to make and receive calls. These can, for instance, be phone calls using devices connected with the Bluetooth hands-free profile.

The telecom management service API module is used by the IviInCallService to notify the TelecomService about call state changes. Clients (frontends) should not call this API but only call the TelecomService API, possibly except for debugging purposes.

Link copied to clipboard

This module contains the default configuration of the trace event logger.

This module contains the service API to allow clients to receive trace events from all processes.

Link copied to clipboard

This module contains the internal service API to allow all processes to forward trace events to a service.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

This module provides classes which are intended to be used by vehicle functions service implementations.

This module provides interfaces and classes that can be used to build services and frontends that process events from the vehicle, and alter vehicle state. For example, the vehicle's HVAC functionality can be triggered and the resulting HVAC state changes are reported back.

This module provides APIs for clients to simulate vehicle engine state properties such as the battery level for debugging purposes.

This module provides APIs for clients to configure a vehicle profile for debugging purposes.

The VehicleElectricEngineService interface provides access to state information coming from electric vehicle (EV) or hybrid vehicle properties.

The VehicleHvacService interface provides access to state information coming from the vehicle heating, ventilation and air conditioning (HVAC) controls.

The VehicleSpecificationService interface provides information about the vehicle's specifications, containing physical vehicle properties.

The VehicleSurroundingsSensorsService interface provides access to state information coming from the vehicle surroundings sensors.

Link copied to clipboard

This module contains classes which are intended for use by services or frontends that interact with the VPA (Voice Personal Assistant) service interfaces.

Link copied to clipboard

The VPA UI common core library contains panel definitions and view models that can be used to build a VPA frontend.

Link copied to clipboard

This module provides service APIs for performing actions initiated by user interaction with the VPA (Voice Personal Assistant) UI.

Link copied to clipboard

This module provides service APIs for interacting with a specific VPA (voice personal assistant) engine.

Link copied to clipboard

This module provides service APIs for interacting with one or more VPAs (voice personal assistants).

This module provides service APIs for reading and modifying the settings of one or more VPAs (voice personal assistants).