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 3rd party applications to write configuration settings into the user.cfg file while the application is running. For further information, please see the SDK or SDK Libraries documentation. The table below details the APIs available in SDK and SDK Libraries:

SDK App SDK 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 SDK Libraries APIs. In the user.cfg, boolean values can be set to 1 (true) or 0 (false), while the SDK Libraries APIs always require a string value.

For example:

In user.cfg, you would set:

[FlowTraffic]
"FlowTrafficEnabled" = 1

Using the SDK Libraries APIs, that same setting would be:

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

Settings #

User.cfg Section Header User.cfg Config Name Type SDK Libraries Config Name and Description
FlowTraffic FlowTrafficEnabled
Bool
FLOW_TRAFFIC_AVAILABILITY
Whether or not traffic is enabled
FlowTraffic DisplayTrafficBar
Bool
TRAFFIC_BAR_VISIBILITY
Whether or not to show the traffic bar
Application PlayWelcome
Bool
PLAY_WELCOME
Whether or not to play the welcome greeting when starting CoPilot. SayWelcome must also be on.
Speech VerboseSpeech
Int
VERBOSE_SPEECH
Whether or not to speak the full road name
Speech SpeakCalculatingRoute
Bool
SPEAK_CALCULATING_ROUTE
Speak calculating route
UserSettings ChevronDisplaySetting
Int
CHEVRON_DISPLAY
The information displayed below the chevron
UserSettings InfobarRightSideIndex
Int
INFO_BAR_RIGHT
The information to show in the right side info bar
UserSettings InfobarLeftSideIndex
Int
INFO_BAR_LEFT
The information to show in the left side info bar
UserSettings SayWelcome
Bool
SAY_WELCOME
Whether or not to play the welcome greeting when starting CoPilot. PlayWelcome must also be on.
UserSettings ShowArrivalPopup
Bool
SHOW_ARRIVAL_POPUP
Show a popup when arriving at your destination
UserSettings ApproachingStopDistHundredths
Int
APPROACHING_STOP_DIST_HUNDREDTHS
The distance at which to change the phrase “Arriving” to “Arrived”
UserSettings RouteSyncEnabled
Bool
ROUTE_SYNC_AVAILABILITY
Whether or not routesync is enabled
UserSettings AllowEnableCompliance
Bool
ALLOW_ENABLE_COMPLIANCE
Turn on route compliance
UserSettings WifiHotSpotToken
String
WIFI_HOTSPOT_TOKEN
An SSID token name for which to block map downloads on.
UserSettings RoutingSideStreetMileCostX1000
Int
ROUTING_SIDE_STREET_MILE_X1000
The cost to apply for side of street routing. See values in below table.
UserSettings ShowCompliancePopup
Bool
SHOW_COMPLIANCE_POPUP
Whether or not to show the compliance popup.
UserSettings EditAcctSettings
Bool
EDIT_ACCOUNT_SETTINGS
Whether or not to display the Account IDs dialog.
UserSettings DisplayStopNameStyle
Int
DISPLAY_STOP_NAME_STYLE
How to display the stop name. Possible displays are name only, address only, or all information.
UserSettings ShowStopSide
Bool
STOP_SIDE_DISPLAY
Whether or not to display the stop side.
UserSettings EnableTurnAlert
Int
ENABLE_TURN_ALERT
Provides alerts ahead of navigation turn instructions
UserSettings SideOfStreetMatchType
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.
UserSettings 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.)
FleetPortal DriverID
String
DRIVER_ID
Driver identification
FleetPortal DeviceID
String
DEVICE_ID
Device identification
FleetPortal PartnerID
String
PARTNER_ID
Partner identification
FleetPortal PostToFleetPortal
Bool
POST_TO_FLEET_PORTAL
Whether or not to post to fleet portal
SpeedAlerts EnableAdvancedAlerts
Bool
ENABLE_ADVANCED_ALERTS
Enable advanced speed alerts
TruckWarnings DrivexactEnabled
Bool
DRIVEXACT_ALERTS
Whether or not DrivExact alerts are enabled.
Graphics UseCustomDPI
Deprecated as of version 10.9.0.1049
Use getDPI
Bool
USE_CUSTOM_DPI
Whether or not to use custom DPI
Graphics CustomDPI
Deprecated as of version 10.9.0.1049
Use getDPI
Int
CUSTOM_DPI
The value of custom DPI
GPS NumExtrapolationPts
Int
NUM_EXTRA_POLATION_PTS
The number of extrapolation points
GPS SpeakArrivedAtDestinationInstr
Int
SPEAK_ARRIVED_AT_DESTINATION_INSTR
The value of speak arrived at destination
GPS Frequency
Int
GPS_FREQUENCY
Change to -1 for GPS logging
GPS Messages
Int
GPS_MESSAGED
Change for 255 GPS logging
GPSInfo LogGPSTracks
bool
LOG_GPS_TRACKS
Enable GPS logging
DataRequestManager NotificationInterval
Int
NOTIFICATION_INTERVAL
The interval, in MB, at which notifications of download progress will be sent via the onMapdataUpdate callback
DataRequestManager DownloadDataOnSDCard
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.
Download ResumeOnStartup
Bool
RESUME_DOWNLOAD_ON_STARTUP
Whether or not to resume partially complete map downloads on startup
Download Wi-Fi Only
Int
MAP_DOWNLOADS_WIFI_ONLY
Setting to restrict ap downloads to only take place over Wi-Fi
Optimization UniqueClusterStrictness
Int
UNIQUE_CLUSTER_STRICTNESS
Sets strictness for unique clustering within Optimization
HttpProxy Port
Int
HTTP_PROXY_PORT
Sets the port number of the http proxy setting. User can choose any port number to set.
HttpProxy Host
String
HTTP_PROXY_HOST
Sets the host IP address for the http proxy setting.
HttpProxy UserName
String
HTTP_PROXY_USERNAME
Sets the user name for the http proxy setting. User name will appear in the user.cfg file in the encrypted format.
HttpProxy Password
String
HTTP_PROXY_PASSWORD
Sets the password for the http proxy setting. Password will appear in the user.cfg file in the encrypted format.

String Values #

SDK Libraries Config Values SDK Libraries Config Names
REQUIRE_ADDRESS_AND_LAT_LON_MATCH SIDE_OF_STREET_MATCH_TYPE
PREFER_ADDRESS SIDE_OF_STREET_MATCH_TYPE
PREFER_LAT_LON SIDE_OF_STREET_MATCH_TYPE
ADD_GPS_STOP ALLOW_INSERT_GPS_STOP
DO_NOT_ADD_GPS_STOP ALLOW_INSERT_GPS_STOP
FLOW_TRAFFIC_ENABLED FLOW_TRAFFIC_AVAILABILITY
FLOW_TRAFFIC_DISABLED FLOW_TRAFFIC_AVAILABILITY
TRAFFIC_BAR_SHOW TRAFFIC_BAR_VISIBILITY
TRAFFIC_BAR_HIDE TRAFFIC_BAR_VISIBILITY
PLAY_WELCOME_TRUE PLAY_WELCOME
DO_NOT_PLAY_WELCOME PLAY_WELCOME
SPEAK_CALCULATING_ROUTE_TRUE SPEAK_CALCULATING_ROUTE
DO_NOT_SPEAK_CALCULATING_ROUTE SPEAK_CALCULATING_ROUTE
CHEVRON_DISPLAY_NONE CHEVRON_DISPLAY
CHEVRON_DISPLAY_CURRENT_ROAD CHEVRON_DISPLAY
CHEVRON_DISPLAY_DESTINATION CHEVRON_DISPLAY
CHEVRON_DISPLAY_NEAREST_TOWN CHEVRON_DISPLAY
CHEVRON_DISPLAY_HEADING CHEVRON_DISPLAY
CHEVRON_DISPLAY_LAT_LON CHEVRON_DISPLAY
INFO_BAR_DISPLAY_ELEVATION INFO_BAR_LEFT, INFO_BAR_RIGHT
INFO_BAR_DISPLAY_CURRENT_TIME INFO_BAR_LEFT, INFO_BAR_RIGHT
INFO_BAR_DISPLAY_ETT INFO_BAR_LEFT, INFO_BAR_RIGHT
INFO_BAR_DISPLAY_HEADING INFO_BAR_LEFT, INFO_BAR_RIGHT
INFO_BAR_DISPLAY_SPEED INFO_BAR_LEFT, INFO_BAR_RIGHT
INFO_BAR_DISPLAY_ETA INFO_BAR_LEFT, INFO_BAR_RIGHT
INFO_BAR_DISPLAY_DISTANCE INFO_BAR_LEFT, INFO_BAR_RIGHT
INFO_BAR_DISPLAY_CUSTOM_A INFO_BAR_LEFT, INFO_BAR_RIGHT
INFO_BAR_DISPLAY_CUSTOM_B INFO_BAR_LEFT, INFO_BAR_RIGHT
SAY_WELCOME_TRUE SAY_WELCOME
DO_NOT_SAY_WELCOME SAY_WELCOME
SHOW_ARRIVAL_POPUP_TRUE SHOW_ARRIVAL_POPUP
DO_NOT_SHOW_ARRIVAL_POPUP SHOW_ARRIVAL_POPUP
ROUTESYNC_ENABLED ROUTE_SYNC_AVAILABILITY
ROUTESYNC_DISABLED ROUTE_SYNC_AVAILABILITY
ENABLE_COMPLIANCE_TRUE ALLOW_ENABLE_COMPLIANCE
ENABLE_COMPLIANCE_FALSE ALLOW_ENABLE_COMPLIANCE
POST_TO_FLEET_PORTAL_TRUE POST_TO_FLEET_PORTAL
POST_TO_FLEET_PORTAL_FALSE POST_TO_FLEET_PORTAL
ENABLE_ADVANCE_ALERTS ENABLE_ADVANCED_ALERTS
DISABLE_ADVANCE_ALERTS ENABLE_ADVANCED_ALERTS
SIDEOFSTREET_OFF ROUTING_SIDE_STREET_MILE_X1000
SIDEOFSTREET_MINIMAL ROUTING_SIDE_STREET_MILE_X1000
SIDEOFSTREET_MODERATE ROUTING_SIDE_STREET_MILE_X1000
SIDEOFSTREET_AVERAGE ROUTING_SIDE_STREET_MILE_X1000
SIDEOFSTREET_STRICT ROUTING_SIDE_STREET_MILE_X1000
SIDEOFSTREET_ADHERE ROUTING_SIDE_STREET_MILE_X1000
SIDEOFSTREET_STRONGADHERE ROUTING_SIDE_STREET_MILE_X1000
EDIT_ACCOUNT_SETTINGS_ENABLE EDIT_ACCOUNT_SETTINGS
EDIT_ACCOUNT_SETTINGS_DISABLE EDIT_ACCOUNT_SETTINGS
DRIVEXACT_ALERTS_ENABLE DRIVEXACT_ALERTS
DRIVEXACT_ALERTS_DISABLE DRIVEXACT_ALERTS
STOP_DISPLAY_ALL_INFORMATION DISPLAY_STOP_NAME_STYLE
STOP_DISPLAY_NAME_ONLY DISPLAY_STOP_NAME_STYLE
STOP_DISPLAY_ADDRESS_ONLY DISPLAY_STOP_NAME_STYLE
SHOW_STOP_SIDE STOP_SIDE_DISPLAY
HIDE_STOP_SIDE STOP_SIDE_DISPLAY
RESUME RESUME_DOWNLOAD_ON_STARTUP
DO_NOT_RESUME RESUME_DOWNLOAD_ON_STARTUP
TURN_ALERT_ENABLED ENABLE_TURN_ALERT
TURN_ALERT_DISABLED ENABLE_TURN_ALERT
WIFI_ONLY MAP_DOWNLOADS_WIFI_ONLY
ALL_CONNECTIONS_ALLOWED MAP_DOWNLOADS_WIFI_ONLY
UNIQUE_CLUSTER_STRICTNESS UNIQUE_CLUSTER_OFF
UNIQUE_CLUSTER_STRICTNESS UNIQUE_CLUSTER_ON
UNIQUE_CLUSTER_STRICTNESS UNIQUE_CLUSTER_ONLY
NAV_MESSAGE_DISPLAY_NONE NAV_MESSAGE_DISPLAY
NAV_MESSAGE_DISPLAY_CURRENT_ROAD NAV_MESSAGE_DISPLAY
NAV_MESSAGE_DISPLAY_DESTINATION NAV_MESSAGE_DISPLAY
NAV_MESSAGE_DISPLAY_NEAREST_TOWN NAV_MESSAGE_DISPLAY
NAV_MESSAGE_DISPLAY_HEADING NAV_MESSAGE_DISPLAY
NAV_MESSAGE_DISPLAY_LAT_LON NAV_MESSAGE_DISPLAY
NAV_MESSAGE_DISPLAY_NAME_ADDRESS NAV_MESSAGE_DISPLAY
NAV_MESSAGE_DISPLAY_NAME_ZIPCODE NAV_MESSAGE_DISPLAY
NAV_MESSAGE_DISPLAY_INSIGHTSTOP_NOTE NAV_MESSAGE_DISPLAY
NAV_MESSAGE_DISPLAY_INSIGHTSTOP_CUSTOM NAV_MESSAGE_DISPLAY
NAV_MESSAGE_DISPLAY_CUSTOM_MESSAGE NAV_MESSAGE_DISPLAY
ADVANCED_ETA_CALCULATION_THRESHOLD
ADVANCED_ETA_HYSTERESIS
AT_RISK_THRESHOLD
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_ZIPCODE
CHEVRON_DISPLAY_INSIGHTSTOP_NOTE
CHEVRON_DISPLAY_INSIGHTSTOP_CUSTOM
Last updated June 1, 2021.