FILECONFIG

Open or close a log file

Platform:

OEM7600, OEM7700, OEM7720, PwrPak7, CPT7, CPT7700

PwrPak7M variants and Legacy CPT7 receivers (PN 80023560) do not support this command.

To record logs, log requests are sent to the FILE port. Before the logs sent to the FILE port can be saved in a file, the file must be opened using the FILECONFIG command.

When configured to be open, a log file will be opened when the active file media is ready and has sufficient space. Once a log file is opened, any logs requested for the FILE port are recorded to the file.

Use the FILESTATUS log to determine the state of the log file.

The file media is separately configured: On receiver cards, this is always USBSTICK, which is the only media available. On the PwrPak7, the active file media is configured using the FILEMEDIACONFIG command.

When a file is opened, the file name is automatically generated based on the following format:

<PSN>_<INDEX>.LOG

where:

• <PSN> is the PSN of the receiver

• <INDEX> is a number from 1 to 511.

  The lowest number that produces an unused file name is selected. If there is no such number available, the FILESTATUS log will report an error.

  The number is not zero-padded (i.e. the sequence is as follows: 1,2, ... ,9,10,11,12, ... ,99,100, ... , 510,511).

When a file is closed and the receiver has a valid time, the file is renamed based on the following format:

<PSN>_<UTC Date>_<UTC Time>.LOG

where:

• <PSN> is the PSN of the receiver

• <UTC_Date> is the UTC date in the format YYYY-MM-DD

• <UTC_Time> is the UTC time in the format HH-MM-SS

Example file name: NOV12001200A_2017-01-10_12-14-34.LOG

When a file is closed, but the receiver does not have a valid time, the file is left with its automatically generated name.

Other Notes:

• The FILE port represents the internal logging to flash memory. It has a NOVATEL Interface Mode - output only, no input is possible.

• Only logs that are published after the log file is open are recorded.

• Only one log file can be open at a time.

• Logs requested to the FILE port are still produced even if the log file is closed; however the logs are not recorded. (This is similar to requesting logs to COM4 when there's no cable on COM4.) If a new log file is opened, recording of the previously requested logs continues with the new file.

• When a file is closed, the log file is renamed to the format <PSN>_<UTC Date>_<UTC Time>.LOG, where the UTC time is the time when the file is closed. If the time is not available, the file is not renamed. If there is already a file with the intended name, the file is not renamed.

• After closing a file, the file system will be flushed to ensure that all data is written to the media.

• A disk is considered "full" when is has <= 10 MB of free space. This buffer is left in place to allow the system time and space to open up a new file if required.

Message ID: 2116

Abbreviated ASCII Syntax:

FILECONFIG FileOperation

Factory Default:

FILECONFIG CLOSE

Example:

FILECONFIG OPEN

Field	Field Type	ASCII Value	Binary Value	Description	Format	Binary Bytes	Binary Offset
1	Command header	-	-	FILECONFIG header This field contains the command name for abbreviated ASCII or the message header for ASCII (see page 1) or Binary (see page 1).	-	H	0
2	FileOperation	OPEN	1	Open (create) a new logging file	Enum	4	H
		CLOSE	2	Close the logging file