Available settings
This page describes the user settings available through the Client Integration Library (CIL). For information on how to observe and modify these settings, see Managing settings .
All settings listed here are accessible via CIL. Settings marked as Read/Write can be modified, while Read-only settings can only be observed.
BetterRouteUserPreference
Sets user preferences to either automatic acceptance or manual decision-making (including steering or via the upcoming panel) when a better route is found.
| Property | Value |
|---|
| Key | com.tomtom.automotive.feature.BetterRouteUserPreference |
| Type | enum |
| Default | automatic |
| CIL Access | Read-only |
Options
| Value | Description |
|---|
automatic | Automatic |
manual_acceptance | Manual Acceptance |
AudioGuidanceMode
Settings for alerts, sounds and guidance
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.AudioGuidanceMode |
| Type | enum |
| Default | unmuted |
| CIL Access | Read/Write |
Options
| Value | Description |
|---|
unmuted | Plays a mix of alert sounds, text messages and guidance |
alerts_only | Only plays alert sounds |
muted | Mutes all sounds and guidance, except for emergency alerts |
AverageSpeedZones
Alert for average speed zones, belongs to global toggle cameras
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.AverageSpeedZones |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
Cameras
Global toggle to unmute or mute alerts for all camera options. If enabled, it will show the list of options to be alerted. If disabled, then the audio alert for the options under cameras are muted and the options would be hidden.
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.Cameras |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
DangerZones
Alert for danger zone cameras, belongs to global toggle safety warnings
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.DangerZones |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
DayNightMode
Controls the day/night mode appearance of the app
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.DayNightMode |
| Type | enum |
| Default | automatic |
| CIL Access | Read-only |
Options
| Value | Description |
|---|
always_day | Always use day mode |
always_night | Always use night mode |
automatic | Automatically switch between day and night mode |
EnableAccidentAlerts
Alert for accidents, belongs to global toggle hazards and regulations
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.EnableAccidentAlerts |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
EnableAnimalsOnRoadAlerts
Alert for animals on road, belongs to global toggle hazards and regulations
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.EnableAnimalsOnRoadAlerts |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
EnableAutomaticMapUpdate
The user setting for controlling the automatic map updates functionality of the onboard map. If enabled, relevant regions are downloaded and installed automatically. Changes will be applied at shutdown unless com.tomtom.automotive.feature.ApplyMapUpdatesInstantly is true.
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.EnableAutomaticMapUpdate |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
EnableBadRoadConditionsAlerts
Alert for bad road conditions, belongs to global toggle hazards and regulations
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.EnableBadRoadConditionsAlerts |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
EnableBrokenDownVehicleAlerts
Alert for broken down vehicle, belongs to global toggle hazards and regulations
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.EnableBrokenDownVehicleAlerts |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
EnableDangerousSituationAlerts
Alert for dangerous situation, belongs to global toggle hazards and regulations
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.EnableDangerousSituationAlerts |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
EnableObjectsOnRoadAlerts
Alert for objects on road, belongs to global toggle hazards and regulations
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.EnableObjectsOnRoadAlerts |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
EnablePeopleOnRoadAlerts
Alert for people on road, belongs to global toggle hazards and regulations
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.EnablePeopleOnRoadAlerts |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
EnableReducedVisibilityAlerts
Alert for reduced visibility, belongs to global toggle hazards and regulations
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.EnableReducedVisibilityAlerts |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
EnableReducedVisibilityFogAlerts
Alert for fog, belongs to global toggle hazards and regulations
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.EnableReducedVisibilityFogAlerts |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
EnableReducedVisibilityHeavyRainAlerts
Alert for heavy rain, belongs to global toggle hazards and regulations
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.EnableReducedVisibilityHeavyRainAlerts |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
EnableSearchFeedbackLoop
Enables the search feedback loop
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.EnableSearchFeedbackLoop |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
EnableSlipperyRoadAlerts
Alert for slippery road, belongs to global toggle hazards and regulations
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.EnableSlipperyRoadAlerts |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
EnableStrongWindAlerts
Alert for strong wind, belongs to global toggle hazards and regulations
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.EnableStrongWindAlerts |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
EnableWrongWayDriverAlerts
Alert for wrong way driver, belongs to global toggle hazards and regulations
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.EnableWrongWayDriverAlerts |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
FixedSpeedCameras
Alert for fixed speed camera, belongs to global toggle cameras
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.FixedSpeedCameras |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
HazardsAndRegulations
Global toggle to unmute or mute alerts for all hazards and regulations options. If enabled, it will show the list of options to be alerted. If disabled, then the audio alert for the options under the hazards and regulations are muted and the options would be hidden.
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.HazardsAndRegulations |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
InitialCameraMode
Defines the initial camera mode
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.InitialCameraMode |
| Type | enum |
| Default | north_up |
| CIL Access | Read-only |
Options
| Value | Description |
|---|
north_up | Top down, north up camera |
3d | Tilted, direction up camera |
direction_up | Top down, direction up camera |
LaneLevelGuidance
Shows lane level guidance if enabled
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.LaneLevelGuidance |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
LowEmissionZone
Alert for low emission zone, if its not an electric vehicle, belongs to global toggle hazards and regulations
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.LowEmissionZone |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
MapStyle
Id of selected map styles set. Available values: default is always available, other values are based on map display configuration ‘styling’ entry and must match names of entries in ‘mapStyleMapping’.
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.MapStyle |
| Type | string |
| Default | default |
| CIL Access | Read-only |
MinChargeAtChargingStop
The minimum charge the vehicle should have when arriving at the next charging stop
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.MinChargeAtChargingStop |
| Type | int |
| Default | 15 |
| CIL Access | Read-only |
MinChargeAtDestination
The minimum charge the vehicle should have when arriving at the destination
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.MinChargeAtDestination |
| Type | int |
| Default | 15 |
| CIL Access | Read-only |
MobileSpeedCameras
Alert for mobile speed camera, belongs to global toggle cameras
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.MobileSpeedCameras |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
PrioritizeChargingStationsSupportingPlugAndCharge
Determines if charging stations that support both the OEM-partner eMSP and Plug & Charge should be prioritized in both EV Search requests (such charging stations will then be ranked higher) and EV routing requests (such charging stations are more likely to be included in the automatically generated charging plan).
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.PrioritizeChargingStationsSupportingPlugAndCharge |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
RailroadCrossing
Alert for railroad crossing, belongs to global toggle hazards and regulations
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.RailroadCrossing |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
ReachableEvRangeOnMap
Shows EV vehicles reachable range on the map when enabled. This setting is used only when vehicle has an electric engine (not HYBRID or ICE).
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.ReachableEvRangeOnMap |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
RedLightCameras
Alert for red light camera, belongs to global toggle cameras
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.RedLightCameras |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
RedLightSpeedCameras
Alert for red light speed camera, belongs to global toggle cameras
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.RedLightSpeedCameras |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
RestrictedCameras
Alert for restricted camera, belongs to global toggle cameras
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.RestrictedCameras |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
RiskZones
Alert for risk zone cameras, belongs to global toggle safety warnings
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.RiskZones |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
RoadClosure
Alert for road closures, belongs to global toggle hazards and regulations
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.RoadClosure |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
RoadWorks
Alert for road works, belongs to global toggle hazards and regulations
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.RoadWorks |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
SafetyWarnings
Global toggle to unmute or mute alerts for all safety warning options. If enabled, it will show the list of options to be alerted. If disabled, then the audio alert for the options under safety warnings are muted and the options would be hidden.
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.SafetyWarnings |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
ShowBuildingsOnMap
Shows buildings on the map when enabled
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.ShowBuildingsOnMap |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
ShowTrafficFlowOnMap
Shows traffic flow on the map when enabled
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.ShowTrafficFlowOnMap |
| Type | boolean |
| Default | false |
| CIL Access | Read-only |
ShowTrafficIncidentsOffRoute
Shows traffic incidents not on the route when enabled
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.ShowTrafficIncidentsOffRoute |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
SpeedEnforcementZone
Alert for speed enforcement zone, belongs to global toggle cameras
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.SpeedEnforcementZone |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
Traffic
Alert for traffic jams, belongs to global toggle hazards and regulations
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.Traffic |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
VanType
Specifies the type of van vehicle selected, such as van or camper
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.VanType |
| Type | enum |
| Default | van |
| CIL Access | Read-only |
Options
| Value | Description |
|---|
van | Represents a standard van vehicle type. Ideal for users who drive regular-sized vans. |
camper | Represents a camper van vehicle type. Ideal for users who travels in camper vans |
automaticExtendedUpcomingEventsPanelEnabled
Whether to automatically switch to extended upcoming events panel
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.automaticExtendedUpcomingEventsPanelEnabled |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
junctionViewEnabled
Whether to display the junction view in the horizon panel
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.junctionViewEnabled |
| Type | boolean |
| Default | true |
| CIL Access | Read-only |
voiceGuidanceMode
Voice guidance mode
| Property | Value |
|---|
| Key | com.tomtom.automotive.settings.voiceGuidanceMode |
| Type | enum |
| Default | comprehensive |
| CIL Access | Read-only |
Options
| Value | Description |
|---|
comprehensive | Most detailed audio messages. Will only work well, if the language is supported by the generator |
compact | Less content audio messages might be provided i.e. no street names |
