Skip to main content

Configuration Options

Contents

Overview

CoPilot offers a wide variety of configuration options. These options can be used to enable the same settings for each device when rolling out a deployment to multiple users. (For instance, pre-selecting the language and voice to be used on each device.)

CoPilot uses a number of different names for the same configuration file. Although each file may contain the same or similar information, each file has a different order of preference.

Each file is placed in the same location, the “Program Files/CoPilot” folder.

User.cfg

User.cfg is written by CoPilot after the first launch. This file will contain all configuration changes made by the user that differ from the default CoPilot settings. CoPilot will write any changes made during operation and upon exit.

If at any time the file is deleted or does not exist, CoPilot will simply create a new file and write all the new settings.

Any manual editing of this file should happen when CoPilot is not running. Any manual edits to this file—for instance, setting up an initial deployment—will be overwritten if the user makes any relevant changes. For example, if you pre-configure the voice to UK English but the user selects German, the user.cfg would be overwritten with the driver’s preference of German.

CoPilot allows third-party applications to write configuration settings into the user.cfg file while the application is running. For further information, please see the SDK or CPIK libraries documentation. The table below details the APIs available in SDK and CPIK libraries:

SDK AppCPIK libraries
Msg_ConfigSetIntVal ConfigurationSetting
Msg_ConfigGetIntVal ConfigurationException
Msg_ConfigSetStrVal ConfigurationException.ConfigurationError
Msg_ConfigGetStrVal
Msg_AddConfigCallback
Msg_ConfigRspCallback

Product.cfg

CoPilot will never generate a product.cfg. It will never write to this file either. But if the file exists, CoPilot will read the settings.

This file can be very useful to set up default settings for a standard deployment. If for any reason the user.cfg is removed (back to factory setting), the product.cfg will stay constant and will maintain any default settings required with a first run.

If the driver changes any settings within the CoPilot application which have been pre-configured in product.cfg—for instance changing the language and voice setting—these will be written to the user.cfg and will be the default maintained following an exit and relaunch.

Order of preference

  1. CoPilot first checks whether a setting is available in user.cfg
  2. If a setting is not available in user.cfg then it will check product.cfg
  3. If a setting is not available in user.cfg or product.cfg, it will take the default value.

Writing the settings when multiple files present

Once any settings is changed either by the user or automatically, CoPilot will do following :

  1. Setting value matches default, exists in user.cfg, and differs in product.cfg/user_ro.cfg, it will write to user.cfg.
  2. Setting value matches default, exists in user.cfg and doesn’t differ from product.cfg/user/cfg then it will not write to user.cfg.
  3. Setting value matches default and doesn’t exist in product.cfg/user_ro.cfg then it will not write to user.cfg.
  4. Setting value doesn’t match default, exists in user.cfg, and differs from product.cfg/user_ro.cfg, it will write to user.cfg.
  5. Setting value doesn’t match default, exists in user.cfg, and doesn’t differ from product.cfg/user.cfg, it will not write to user.cfg.
  6. Setting value doesn’t match default and doesn’t exist in product.cfg/user.cfg, it will write to user.cfg.

User.cfg within SDK integration application

This file has no relevance to the CoPilot settings and only enables the SDK connection between the two applications.

The only section required within this configuration file is:

[ConnectionInfo1]
"Enabled"=1

Any additional sections will be ignored by the CoPilot application.

Configuration Settings

The table below details the configuration settings that can be added to CoPilot. It includes values for the user.cfg and the CPIK libraries APIs. In the user.cfg, boolean values can be set to 1 (true) or 0 (false), while the CPIK libraries APIs always require a string value.

For example:

In user.cfg, you would set:

[FlowTraffic]
"FlowTrafficEnabled" = 1

Using the CPIK libraries APIs, that same setting would be:

ConfigurationSetting boolConfig = ConfigurationSetting.create( ConfigurationSetting.FLOW_TRAFFIC_AVAILABILITY, ConfigurationSetting.FLOW_TRAFFIC_ENABLED);

Settings

User.cfg Section HeaderUser.cfg Config NameTypeCPIK libraries Config Name and Description
FlowTrafficFlowTrafficEnabled
Bool
FLOW_TRAFFIC_AVAILABILITY
Whether or not traffic is enabled
FlowTrafficDisplayTrafficBar
Bool
TRAFFIC_BAR_VISIBILITY
Whether or not to show the traffic bar
ApplicationPlayWelcome
Bool
PLAY_WELCOME
Whether or not to play the welcome greeting when starting CoPilot. SayWelcome must also be on.
SpeechVerboseSpeech
Int
VERBOSE_SPEECH
Whether or not to speak the full road name
SpeechSpeakCalculatingRoute
Bool
SPEAK_CALCULATING_ROUTE
Speak calculating route
User SettingsChevronDisplaySetting
Int
CHEVRON_DISPLAY
The information displayed below the chevron
User SettingsInfobarRightSideIndex
Int
INFO_BAR_RIGHT
The information to show in the right side info bar
User SettingsInfobarLeftSideIndex
Int
INFO_BAR_LEFT
The information to show in the left side info bar
User SettingsSayWelcome
Bool
SAY_WELCOME
Whether or not to play the welcome greeting when starting CoPilot. PlayWelcome must also be on.
User SettingsShowArrivalPopup
Bool
SHOW_ARRIVAL_POPUP
Show a popup when arriving at your destination
User SettingsApproachingStopDistHundredths
Int
APPROACHING_STOP_DIST_HUNDREDTHS
The distance at which to change the phrase “Arriving” to “Arrived”
User SettingsRouteSyncEnabled
Bool
ROUTE_SYNC_AVAILABILITY
Whether or not routesync is enabled
User SettingsAllowEnableCompliance
Bool
ALLOW_ENABLE_COMPLIANCE
Turn on route compliance
User SettingsWifiHotSpotToken
String
WIFI_HOTSPOT_TOKEN
An SSID token name for which to block map downloads on. Note: We reserve the string value “unknown ssid”. Do not use the value for this config or CoPilot will not download map data.
User SettingsRoutingSideStreetMileCostX1000
Int
ROUTING_SIDE_STREET_MILE_X1000
The cost to apply for side of street routing. See values in below table.
User SettingsShowCompliancePopup
Deprecated in CoPilot 10.19.3.48
Bool
SHOW_COMPLIANCE_POPUP
Whether or not to show the compliance popup.
User SettingsEditAcctSettings
Bool
EDIT_ACCOUNT_SETTINGS
Whether or not to display the Account IDs dialog.
User SettingsDisplayStopNameStyle
Int
DISPLAY_STOP_NAME_STYLE
How to display the stop name. Possible displays are name only, address only, or all information.
User SettingsShowStopSide
Bool
STOP_SIDE_DISPLAY
Whether or not to display the stop side.
User SettingsEnableTurnAlert
Int
ENABLE_TURN_ALERT
Provides alerts ahead of navigation turn instructions
User SettingsSideOfStreetMatchType
Available in CoPilot 10.9.0.1180 and Higher
Int
SIDE_OF_STREET_MATCH_TYPE
Determines whether to use the side of street provided by the address or by the latitude/longitude coordinates in the event that they return conflicting information.
User Settings NavMessageDisplay
Available in CoPilot 10.9.0.1180 and Higher
Int
NAV_MESSAGE_DISPLAY
Sets the type of banner to include at the top of all navigation views. (Default is no banner.)
Fleet PortalDriverID
String
DRIVER_ID
Driver identification
Fleet PortalDeviceID
String
DEVICE_ID
Device identification
Fleet PortalPartnerID
String
PARTNER_ID
Partner identification
Fleet PortalPostToFleetPortal
Bool
POST_TO_FLEET_PORTAL
Whether or not to post to fleet portal
SpeedAlertsEnableAdvancedAlerts
Bool
ENABLE_ADVANCED_ALERTS
Enable advanced speed alerts
TruckWarningsDrivexactEnabled
Bool
DRIVEXACT_ALERTS
Whether or not DrivExact alerts are enabled.
GraphicsUseCustomDPI
Deprecated as of version 10.9.0.1049
Use getDPI
Bool
USE_CUSTOM_DPI
Whether or not to use custom DPI
GraphicsCustomDPI
Deprecated as of version 10.9.0.1049
Use getDPI
Int
CUSTOM_DPI
The value of custom DPI
GPSNumExtrapolationPts
Int
NUM_EXTRA_POLATION_PTS
The number of extrapolation points
GPSSpeakArrivedAtDestinationInstr
Int
SPEAK_ARRIVED_AT_DESTINATION_INSTR
The value of speak arrived at destination
GPSFrequency
Int
GPS_FREQUENCY
Change to -1 for GPS logging
GPSMessages
Int
GPS_MESSAGED
Change for 255 GPS logging
GPSInfoLogGPSTracks
bool
LOG_GPS_TRACKS
Enable GPS logging
DataRequestManagerNotificationInterval
Int
NOTIFICATION_INTERVAL
The interval, in MB, at which notifications of download progress will be sent via the onMapdataUpdate callback
DataRequestManagerDownloadDataOnSDCard
Available in CoPilot 10.14.0.425 and Higher
Bool
DOWNLOAD_DATA_ON_SD_CARD
When enabled, map data will be downloaded onto the device’s SD card. This setting will also prompt CoPilot to display “Processing” and “CoPilot is Ready!” messages during the download process.
DownloadResumeOnStartup
Bool
RESUME_DOWNLOAD_ON_STARTUP
Whether or not to resume partially complete map downloads on startup
DownloadWiFiOnly
Int
MAP_DOWNLOADS_WIFI_ONLY
Setting to restrict ap downloads to only take place over Wi-Fi. Note: This setting does not apply to Windows laptop versions of CoPilot, which cannot detect if a device is connected to the internet via Wi-Fi or a cellular network.
OptimizationUniqueClusterStrictness
Int
UNIQUE_CLUSTER_STRICTNESS
Sets strictness for unique clustering within Optimization
HttpProxyPort
Int
HTTP_PROXY_PORT
Sets the port number of the http proxy setting. User can choose any port number to set.
HttpProxyHost
String
HTTP_PROXY_HOST
Sets the host IP address for the http proxy setting.
HttpProxyUserName
String
HTTP_PROXY_USERNAME
Sets the username for the http proxy setting. Username will appear in the user.cfg file in the encrypted format.
HttpProxyPassword
String
HTTP_PROXY_PASSWORD
Sets the password for the http proxy setting. Password will appear in the user.cfg file in the encrypted format.
MapDataDownloadPackageMapDataNotificationInterval
Int
MAP_DATA_NOTIFICATION_INTERVAL
Sets the interval, in MB, at which download progress notifications will be sent via the onMapdataUpdate callback if the map download is initiated through the My Maps screen.
CellDataUsageDisableCellUsagePrompt
Bool
Sets whether CoPilot prompts the user to select whether cellular data should be enabled for features that require data downloads, including map updates and traffic information. The prompt is shown by default, which is a “false” (0) value for this setting.

CPIK libraries string values

Configuration NameDescriptionConfiguration Values
SIDE_OF_STREET_MATCH_TYPE
Available in CoPilot 10.9.0.1180 and Higher
Determines whether to use the side of street provided by the address or by the latitude/longitude coordinates in the event that they return conflicting information.REQUIRE_ADDRESS_AND_LAT_LON_MATCH
PREFER_ADDRESS
PREFER_LAT_LON
FLOW_TRAFFIC_AVAILABILITYWhether or not the traffic service is enabled on the device.FLOW_TRAFFIC_ENABLED
FLOW_TRAFFIC_DISABLED
TRAFFIC_BAR_VISIBILITYWhether or not to show the traffic bar.TRAFFIC_BAR_SHOW
TRAFFIC_BAR_HIDE
ALLOW_INSERT_GPS_STOP
Available in CoPilot 10.9.0.1180 and Higher
When enabled, if the current GPS location is added to an existing trip, it will be added as the first stop WITHOUT replacing any stops. By default, CoPilot will replace the first stop with your current GPS location when you add it—if you have more than one stop.ADD_GPS_STOP
DO_NOT_ADD_GPS_STOP
PLAY_WELCOMEWhether or not to play the welcome greeting when starting CoPilot. SAY_WELCOME must also be on.PLAY_WELCOME_TRUE
DO_NOT_PLAY_WELCOME
SAY_WELCOMEWhether or not to play the welcome greeting when starting CoPilot. PLAY_WELCOME must also be on.SAY_WELCOME_TRUE
DO_NOT_SAY_WELCOME
SPEAK_CALCULATING_ROUTEWhether to speak calculating route.SPEAK_CALCULATING_ROUTE_TRUE
DO_NOT_SPEAK_CALCULATING_ROUTE
CHEVRON_DISPLAYThe information displayed below the chevron.CHEVRON_DISPLAY_NONE
CHEVRON_DISPLAY_CURRENT_ROAD
CHEVRON_DISPLAY_DESTINATION
CHEVRON_DISPLAY_NEAREST_TOWN
CHEVRON_DISPLAY_HEADING
CHEVRON_DISPLAY_LAT_LON
CHEVRON_DISPLAY_NAME_ADDRESS
CHEVRON_DISPLAY_NAME_ADDRESS
CHEVRON_DISPLAY_NAME_ZIPCODE
CHEVRON_DISPLAY_INSIGHTSTOP_NOTE
CHEVRON_DISPLAY_INSIGHTSTOP_CUSTOM
INFO_BAR_LEFTThe information to show in the left side info bar.INFO_BAR_DISPLAY_ELEVATION
INFO_BAR_DISPLAY_CURRENT_TIME
INFO_BAR_DISPLAY_ETT
INFO_BAR_DISPLAY_HEADING
INFO_BAR_DISPLAY_SPEED
INFO_BAR_DISPLAY_ETA
INFO_BAR_DISPLAY_DISTANCE
INFO_BAR_RIGHTThe information to show in the right side info bar.INFO_BAR_DISPLAY_ELEVATION
INFO_BAR_DISPLAY_CURRENT_TIME
INFO_BAR_DISPLAY_ETT
INFO_BAR_DISPLAY_HEADING
INFO_BAR_DISPLAY_SPEED
INFO_BAR_DISPLAY_ETA
INFO_BAR_DISPLAY_DISTANCE
SHOW_ARRIVAL_POPUPWhether to show a popup when arriving at your destination.SHOW_ARRIVAL_POPUP_TRUE
DO_NOT_SHOW_ARRIVAL_POPUP
ALLOW_ENABLE_COMPLIANCEWhether to turn on route compliance.ENABLE_COMPLIANCE_TRUE
ENABLE_COMPLIANCE_FALSE
POST_TO_FLEET_PORTALWhether or not CoPilot should communicate with FleetPortal.POST_TO_FLEET_PORTAL_TRUE
POST_TO_FLEET_PORTAL_FALSE
ENABLE_ADVANCED_ALERTSWhether to enable advanced speed alerts.ENABLE_ADVANCE_ALERTS
DISABLE_ADVANCE_ALERTS
ROUTING_SIDE_STREET_MILE_X100The cost to apply for side of street routing.SIDEOFSTREET_OFF
SIDEOFSTREET_MINIMAL
SIDEOFSTREET_MODERATE
SIDEOFSTREET_AVERAGE
SIDEOFSTREET_STRICT
SIDEOFSTREET_ADHERE
SIDEOFSTREET_STRONGADHERE
EDIT_ACCOUNT_SETTINGSWhether or not to display the Account IDs dialog.EDIT_ACCOUNT_SETTINGS_ENABLE
EDIT_ACCOUNT_SETTINGS_DISABLE
DRIVEXACT_ALERTSWhether or not DriveExact alerts are enabled.DRIVEXACT_ALERTS_ENABLE
DRIVEXACT_ALERTS_DISABLE
DISPLAY_STOP_NAME_STYLEHow to display the stop name.STOP_DISPLAY_ALL_INFORMATION
STOP_DISPLAY_NAME_ONLY
STOP_DISPLAY_ADDRESS_ONLY
STOP_SIDE_DISPLAYWhether or not to display the stop side.SHOW_STOP_SIDE
HIDE_STOP_SIDE
RESUME_DOWNLOAD_ON_STARTUPWhether or not to resume partially complete map downloads on startup.RESUME
DO_NOT_RESUME
ENABLE_TURN_ALERTWhether or not to provide alerts ahead of navigation turn instructions.TURN_ALERT_ENABLED
TURN_ALERT_DISABLED
MAP_DOWNLOADS_WIFI_ONLYWhether or not may downloads should be restricted to only take place over Wi-FiWIFI_ONLY
ALL_CONNECTIONS_ALLOWED
UNIQUE_CLUSTER_STRICTNESSSets strictness for unique clustering within Optimization.UNIQUE_CLUSTER_OFF
UNIQUE_CLUSTER_ON
UNIQUE_CLUSTER_ONLY
NAV_MESSAGE_DISPLAY
Available in CoPilot 10.9.0.1180 and Higher
Sets the type of banner to include at the top of all navigation views. (Default is no banner.)NAV_MESSAGE_DISPLAY_NONE
NAV_MESSAGE_DISPLAY_CURRENT_ROAD
NAV_MESSAGE_DISPLAY_DESTINATION
NAV_MESSAGE_DISPLAY_NEAREST_TOWN
NAV_MESSAGE_DISPLAY_HEADING
NAV_MESSAGE_DISPLAY_LAT_LON
NAV_MESSAGE_DISPLAY_NAME_ADDRESS
NAV_MESSAGE_DISPLAY_NAME_ZIPCODE
NAV_MESSAGE_DISPLAY_INSIGHTSTOP_NOTE
NAV_MESSAGE_DISPLAY_INSIGHTSTOP_CUSTOM
NAV_MESSAGE_DISPLAY_CUSTOM_MESSAGE
ALTERNATE_ROUTES_ALLOWEDSet to DO_NOT_ALLOW_ALTERNATE_ROUTES if you do not want CoPilot to suggest any alternate routes to the driver when it plans a route. (For example, if you want CoPilot to match a route planned in the back office.) Default is allow.

If you are licensed for ActiveTraffic, CoPilot will still provide detours to avoid heavy traffic if the traffic ahead is causing a significant delay of more than 10 minutes AND CoPilot finds an alternate route that is quicker.

ALLOW_ALTERNATE_ROUTES
DO_NOT_ALLOW_ALTERNATE_ROUTES
SHOW_COMPLIANCE_POPUP
Deprecated in CoPilot 10.19.3.48
Whether or not to show the compliance popup.SHOW_COMPLIANCE_POPUP_ENABLED
SHOW_COMPLIANCE_POPUP_DISABLED
Last updated October 28, 2022.
Contents