Common configuration file parameters

From UgCS
Jump to: navigation, search

Main Page UgCS Connecting UgCS and DJI A2, Naza-M v2, Phantom 2, Wookong-M

Download this page as a PDF file


VSM configuration file is a text file specified via command line argument - -config of the VSM application.
Example: --config /etc/opt/ugcs/vsm-ardupilot.conf

Each configuration parameter is defined as a line in the configuration file with the following structure: name1.name2....nameX = value
where name1, name2 ... nameX are arbitrary names separated by dots to divide a variable into logical blocks and a value which can be a number value or a text string depending on the context. See below the description about common VSM configuration parameters.

UgCS server configuration

VSM can connect to UgCS in two different ways:
• Listen for connection form the UgCS server. See Listening address and Listening port. When VSM is configured in listening mode automatic VSM discovery can be set up, too. See Automatic service discovery
• Initiate connection to UgCS server. See UgCS server address and UgCS server port.
At least one of the above must be configured for VSM to work.

Listening address
Optional.
Name: ucs.local_listening_address = [IP address]
Description: Local address to listen for incoming connections from UgCS server.
Default: 0.0.0.0 (listen on all local addresses)
Example: ucs.local_listening_address = 10.0.0.2

Listening port
Optional.
Name: ucs.local_listening_port = [port number]
Description: Local TCP port to listen for incoming connections from UgCS server.
Example: ucs.local_listening_port = 5556

UgCS server address.
Optional.
Name: ucs.address = [IP address]
Description: UgCS server address to connect to.
Example: ucs.address = 1.2.3.4

UgCS server port.
Optional.
Name: ucs.port = [port number]
Description: UgCS server port.
Example: ucs.port = 3335

Retry timeout.
Optional.
Name: ucs.retry_timeout = [seconds]
Description: Retry timeout for outgoing server connections in seconds.
Default: 10
Example: retry_timeout = 11

Automatic service discovery

VSM can respond to automatic service discovery requests form UgCS server. When this parameter is not configured, service discovery is disabled.
Optional.
Name: service_discovery.vsm_name = [Service name]
Description: Human readable service name.
Example: service_discovery.vsm_name = Ardupilot VSM

Logging configuration

Level.
Optional.
Name: log.level = [error|warning|info|debug]
Description: Logging level.
Default: info
Example: log.level = debug

File path.
Optional.
Name: log.file_path = [path to a file]
Description: Absolute or relative (to the current directory) path to a logging file. Logging is disabled if logging file is not defined. File should be writable. Backslash should be escaped with a backslash.
Example: log.file = /var/opt/ugcs/log/vsm-ardupilot/vsm-ardupilot.log
Example: log.file = C:\\Users\\John\\AppData\\Local\\UGCS\\logs\\vsm-ardupilot\\vsm-ardupilot.log

Maximum single file size.
Optional.
Name: log.single_max_size = [size]
Description: Maximum size of a single log file. When maximum size is exceeded, existing file is renamed by adding a time stamp and logging is continued into the empty file. [size] should be defined as a number postfixed by a case insensitive multiplier:
– Gb, G, Gbyte, Gbytes: for Giga-bytes
– Mb, M, Mbyte, Mbytes: for Mega-bytes
– Kb, K, Kbyte, Kbytes: for Kilo-bytes
– no postfix: for bytes
Default: 100 Mb
Example: log.single_max_size = 500 Mb

Maximum number of old log files.
Optional.
Name: log.max_file_count = [number]
Description: Log rotation feature. Maximum number of old log files to keep. After reaching single_max_size of current log file, VSM will rename it with current time in extension and start new one. VSM will delete older logs so the number of old logs does not exceed the max_file_count.
Default: 1
Example: log.max_file_count = 5

Mission dump path

Optional.
Name: [prefix].mission_dump_path = [path to a file]
Description: File to dump all generated missions to. Timestamp is appended to the name. Delete the entry to disable mission dumping. All directories in the path to a file should be already created.
Example: vehicle.ardupilot.mission_dump_path = C:\\tmp\\ardupilot_dump

Command execution control

When vehicle is connected via unreliable link VSM will retry each command several times before failing. This section describes the parameters which control the command execution.

Command try count
Name: vechicle.command_try_count = <number of="" times>="">
Description: Number of times the command will be issued before declaring it as failed. Must be greater than zero.
Default: 3
Example: vechicle.command_try_count = 5

Command timeout
Name: vechicle.command_timeout = <timeout in="" seconds>="">
Description: Time to wait for response on issued command before retrying.
Unit: second
Default: 1

Vehicle serial prefix.
Optional.
Name: vehicle.serial_prefix = string
Description: String value used as prefix for all vehicle serial numbers conected to this VSM. Can be used to connect vehicles with equal serial numbers to the same server via different VSMs
Default: not defined
Example: vehicle.serial_prefix = group1: