Configuration Options

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:

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¶

String Values¶