LOG

Requests logs from the receiver

Platform:

OEM719, OEM729, OEM7500, OEM7600, OEM7700, OEM7720, PwrPak7, CPT7, CPT7700, SMART7, SMART2

Many different types of data can be logged using different methods of triggering the log events. Every log element can be directed to any combination of the receiver’s ports. The ontime trigger option requires the addition of the period parameter. See Logs for further information and a complete list of data log structures. The LOG command tables in this section show the binary format followed by the ASCII command format.

The optional parameter [hold] prevents a log from being removed when the UNLOGALL command, with its defaults, is issued. To remove a log which was invoked using the [hold] parameter requires the specific use of the UNLOG command. To remove all logs that have the [hold] parameter, use the UNLOGALL command with the held field set to 1.

The [port] parameter is optional. If [port] is not specified, [port] is defaulted to the port that the command was received on.

The maximum number of logs the OEM7 family of receivers can handle at a time is 128 logs for firmware versions 7.09.00 and greater or 80 logs for firmware versions prior to 7.09.00. If an attempt is made to log more than the maximum number of logs at a time, the receiver responds with an Insufficient Resources error. Note that RXSTATUSEVENTA logs are requested on most ports by default and these logs count against the maximum.
The user is cautioned that each log requested requires additional CPU time and memory buffer space. Too many logs may result in lost data and low CPU idle time. Receiver overload can be monitored using the idle-time field and buffer overload bits of the Receiver Status in any log header.
Only the MARKPOS, MARK2POS, MARK3POS and MARK4POS log, MARK1TIME, MARK2TIME, MARK3TIME and MARK4TIME log and ‘polled’ log types are generated, on the fly, at the exact time of the mark. Synchronous and asynchronous logs output the most recently available data.
Use the ONNEW or ONALL trigger with the MARKPOS, MARK2POS, MARK3POS and MARK4POS log and MARK1TIME, MARK2TIME, MARK3TIME and MARK4TIME log.
Polled log types do not all allow fractional offsets.
If ONTIME trigger is used with asynchronous logs, the time stamp in the log does not necessarily represent the time the data was generated but rather the time when the log is transmitted.
Published logs are not placed in a queue if there is no physical or virtual connection when the log is generated. Thus, a log requested ONNEW, ONCHANGED or ONALL that is in SAVECONFIG may not be received if it is published before connections are made. This can happen if there's no cable connected or if the communication protocol has not been established yet (e.g. CAN, Ethernet, USB, etc).
PwrPak7M variants do not support the FILE port.

Message ID: 1

Abbreviated ASCII Syntax:

LOG [port] message ONNEW
LOG [port] message ONCHANGED
LOG [port] message ONTIME period [offset [hold]]
LOG [port] message ONNEXT
LOG [port] message ONCE
LOG [port] message ONMARK

Factory Default:

LOG COM1 RXSTATUSEVENTA ONNEW 0 0 HOLD
LOG COM2 RXSTATUSEVENTA ONNEW 0 0 HOLD
LOG COM3 RXSTATUSEVENTA ONNEW 0 0 HOLD
LOG USB1 RXSTATUSEVENTA ONNEW 0 0 HOLD
LOG USB2 RXSTATUSEVENTA ONNEW 0 0 HOLD
LOG USB3 RXSTATUSEVENTA ONNEW 0 0 HOLD
LOG ICOM1 RXSTATUSEVENTA ONNEW 0 0 HOLD
LOG ICOM2 RXSTATUSEVENTA ONNEW 0 0 HOLD
LOG ICOM3 RXSTATUSEVENTA ONNEW 0 0 HOLD
LOG ICOM4 RXSTATUSEVENTA ONNEW 0 0 HOLD
LOG ICOM5 RXSTATUSEVENTA ONNEW 0 0 HOLD
LOG ICOM6 RXSTATUSEVENTA ONNEW 0 0 HOLD
LOG ICOM7 RXSTATUSEVENTA ONNEW 0 0 HOLD

Abbreviated ASCII Example 1:

LOG COM1 BESTPOS ONTIME 7 0.5 HOLD

The above example shows BESTPOS logging to com port 1 at 7 second intervals and offset by 0.5 seconds (output at 0.5, 7.5, 14.5 seconds and so on). The [hold] parameter is set so that logging is not disrupted by the UNLOGALL command.

To send a log once, the trigger option can be omitted.

Abbreviated ASCII Example 2:

LOG COM1 BESTPOS ONCE

Using the NovAtel Connect utility there are two ways to initiate data logging from the receiver's serial ports. Either enter the LOG command in the Console window or use the interface provided in the Logging Control window. Ensure the Power Settings on the computer are not set to go into Hibernate or Standby modes. Data is lost if one of these modes occurs during a logging session.

Binary

Field	Field Type	Binary Value	Description	Format	Binary Bytes	Binary Offset
1	LOG (binary) header	See Table: Binary Message Header Structure	This field contains the message header	-	H	0
2	port	See Table: Detailed Port Identifier	Output port	Enum	4	H
3	message	Any valid message ID	Message ID of the log to output	Ushort	2	H+4
4	message type	Bits 0-4 = Measurement source1 Bits 5-6 = Format 00 = Binary 01 = ASCII 10 = Abbreviated ASCII, NMEA 11 = Reserved Bit 7 = Response Bit (Message Responses) 0 = Original Message 1 = Response Message	Message type of log	Char	1	H+6
5	Reserved			Char	1	H+7
6	trigger	See Table: Log Triggers		Enum	4	H+8
7	period	Valid values for high rate logging are 0.01, 0.02, 0.05, 0.1, 0.2, 0.25 and 0.5. For logging slower than 1 Hz, any integer value is accepted. When logging ONCE, the corresponding period is 0.	Log period (for ONTIME trigger) in seconds If the value entered is lower than the minimum measurement period, the command will be rejected. Refer to Technical Specifications for the maximum raw measurement rate to calculate the minimum period.	Double	8	H+12
8	offset	Offset for period (ONTIME trigger) in seconds.	A valid value is any integer (whole number) smaller than the period. For example, to log data at 1 second, after every minute, set the period to 60 and the offset to 1. These decimal values, on their own, are also valid: 0.1, 0.2, 0.25 or 0.5, as well as any multiple of the maximum logging rate defined by the receiver model. The offset cannot be smaller than the minimum measurement period supported by the model.	Double	8	H+20
9	hold	0 = NOHOLD	Allow log to be removed by the UNLOGALL command	Enum	4	H+28
9	hold	1 = HOLD	Prevent log from being removed by the default UNLOGALL command	Enum	4	H+28

ASCII

Field	Field Name	ASCII Value	Description	Format
1	LOG (ASCII) header	-	This field contains the command name or the message header depending on whether the command is abbreviated ASCII or ASCII respectively	-
2	port	Table: Detailed Port Identifier	Output port (default = THISPORT)	Enum
3	message	Any valid message name, with an optional A or B suffix	Message name of log to output	Char [ ]
4	trigger	See Table: Log Triggers		Enum
5	period	Valid values for high rate logging are 0.01, 0.02, 0.05, 0.1, 0.2, 0.25 and 0.5. For logging slower than 1 Hz, any integer value is accepted. When logging ONCE, the corresponding period is 0.	Log period (for ONTIME trigger) in seconds (default = 0) If the value entered is lower than the minimum measurement period, the command will be rejected. Refer to Technical Specifications for the maximum raw measurement rate to calculate the minimum period.	Double
6	offset	Any positive double value smaller than the period	Offset for period (ONTIME trigger) in seconds (default = 0) For example, if you want to log data, at 1 second after every minute, set the period to 60 and the offset to 1.	Double
7	hold	NOHOLD	To be removed by the UNLOGALL command (default)	Enum
7	hold	HOLD	Prevent log from being removed by the default UNLOGALL command	Enum

Log Triggers
Binary Value	ASCII VALUE	Description
0	ONNEW	Does not output the current message but outputs when the message is updated (not necessarily changed)
1	ONCHANGED	Outputs the current message and then continues to output when the message is changed
2	ONTIME	Output on a time interval
3	ONNEXT	Output only the next message
4	ONCE	Output only the current message (default). If no message is currently present, the next message is output when available.
5	ONMARK	Output when a pulse is detected on the mark 1 input, MK1I Refer to Technical Specifications for more details on the MK1I pin. ONMARK only applies to MK1I. Events on MK2I (if available) do not trigger logs when ONMARK is used. Use the ONNEW trigger with the MARKTIME, MARK2TIME, MARKPOS or MARK2POS logs.* Once the 1PPS signal has hit a rising edge, for both MARKPOS and MARKTIME logs, a resolution of both measurements is 10 ns. As for the ONMARK trigger for other logs that measure latency, for example RANGE and POSITION logs such as BESTPOS, it takes typically 20-30 ms (50 ms maximum) for the logs to output information from the 1PPS signal. Latency is the time between the reception of the 1PPS pulse and the first byte of the associated log. See also the MARKPOS, MARK2POS, MARK3POS and MARK4POS log and the MARK1TIME, MARK2TIME, MARK3TIME and MARK4TIME log.
6	ONALL	Outputs the current message and then continues to output when the message is updated (not necessarily changed).