dloggereditor

October 2018

Overview

Purpose:

The dloggereditor program is a Graphical User Interface that guides a user through steps to generate the specification file for the dlogger program.

The dloggereditor task is started from the command line.

Enter:

dloggereditor [dlogger_spec_filename] &

Where:

dlogger_spec_filename

-          Optional Argument

 

-          The pathname of the file to edit or create

Example:

dloggereditor /specs/dlogger_spec.103 &

General Actions

To create a new dlogger specs file

To load a previously generated dlogger specs file

To set the font preferences within the dloggereditor

Keywords Tab

When a new dlogger spec file is created, default values will appear within the screen for several of the required spec file keywords

Hovering over data in the Keyword column will display a description describing what the keyword is used for. Hovering over data in the Value column will display the associated type of data to enter.

To edit the information in the Value column, double click on the Value column of the row to edit. This will allow you to select new variable names or enter additional information. For instance, double clicking on the cyflex_str_var cell will display a Variable Selection dialog to select a different string variable.

To insert additional keywords into the spec file, right click on an existing Keywords tab row and select Insert Row. A new row will appear under the current selected row.

 

Once a new row is inserted, select the drop-down list within the Keyword column of the newly selected row to select a new keyword to be entered in the specification file.

To delete keywords from the spec file, right click over the row to remove on the Keywords tab and select Remove Row.

The following is a list of all keywords that can be added to the specification file from the Keywords Tab.

Generated Keywords In Spec File

Definition

Type

*@DLOGGER

Identifies this is a dlogger spec file

String

*@DESCRIPTION

A title to be written to the output file

Computed Expression

*@GROUP

Measurement name in meta-data section of output file for GROUP

String Variable

*@MODE

Test mode to include in the output file meta-data section for MODE

String Variable

*@PROGRAM

Program name to include in the output file meta-data section for PROGRAM

String Variable

*@TEST_ID

Test Id to include in the output file meta-data section for TEST ID

String Variable

*@TEST_TYPE

Test Name to include int the output file meta-data section for TEST TYPE

String Variable

*@SCAN_INTERVAL

Time between data samples in output file

Literal value (<time>[units])

or

Variable name

@CLEAR_STATISTICS_EVENT

Event to trigger statistical buffers within dlogger to reset to 0

Event Name - String

@DONE_EVENT

Name of event set at completion of data collection

Event Name - String

@ENABLE

Logical variable that must be TRUE before logging can start

Logical Variable

@FIFO_LOG_BUFFER

Presence of keyword signifies to activate First-In First-Out Logging

 

@FIFO_POST_TRIGGER_INTERVAL

Length of time to obtain scans after the FIFO trigger event (stop or release event) has been received

 

@FIFO_POST_TRIGGER_SCANS

Number of scans to obtain after the FIFO trigger event (stop or release event) has been received

Integer value

@FORCE_DIRECT_FILE_WRITE

Indicates that data should be written directly to the output file when high data rates are used

Yes or No

@FTP_EVENT

Event that triggers the output file to be finalized, and initiates file transfer

Event Name - String

@GET_NEW_SCAN_INTERVAL

Event that triggers a re-evaluation of the SCAN_INTERVAL computed expression

Event Name  String

@LOG_DIGITAL_DESCRIPTION

Flag used to determine if logical variable descriptions for all logical variables should be logged instead of 0 or 1

Yes or No

@LOG_STATISTICS

Flag used to specify that statistics should be computed for the variables specified via the @SCAN_LIST keyword

Yes or No

@LOGGING_ACTIVE_LABEL

The name of a CyFlex logical variable that indicates dlogger is actively collecting data and logging it.

Logical Variable

@MAX_SCANS

Maximum number of samples in a sampling session

Integer value

@MAX_STATISTICAL_SCANS

Maximum number of scans when the @LOG_STATISTICS keyword is specified

Integer value

@OUTPUT_PATH

Directory path to the output file

String variables

or

Directory Path - String

@DARTS_STEADY_STATE

Presence of keyword signifies the darts_ss_specs file variables should be included in the scan list

 

@READ_SPEC_FILE_EVENT

Event that triggers the dlogger to re-read the spec file

Event Name - String

@REG_NAME

Name that identifies the instance of dlogger within the OS

String

@RELEASE_EVENT

Event that signals the end of a sampling interval and terminates the dlogger task after the data files are written

Event Name - String

@START_EVENT

Event that triggers the start of a sampling interval

Event Name - String

@STOP_EVENT

Event that triggers the end of a sampling interval

Event Name - String

@SYNC_EVENT

Event that triggers a scan of all channels

Event Name - String

@RUNNING_AVERAGE

Window width of a running average window in units of time and the event that causes the data to be logged

Note: The second and third column are used to enter information for this keyword. The Value column should contain the window_width[units].

The right most column should contain the name of the event that causes the averages to be written to the output file

* - Denotes required keyword

Scan List Tab

When creating a new dlogger spec file from within the dloggereditor, a default dummy variable row is added to the Scan List Tab. This dummy row is available to get additional rows added to the Scan List.

To edit data within the default dummy variable row, double click on the CyFlex Variable column to display a Variable Selection dialog. Within the Variable Selection dialog, select the type of variable to log from the Group drop-down and select the variable name to log from Variable drop-down.

If a Statistical Variable type variable name is selected, select the SubVariable statistical member to be logged from within the Variable Selection box.

If a Logical Variable type variable name is selected, a choice between logging the logical variable true and false state descriptions or 0 or 1 can be made. To log the logical variable true and false state descriptions, select LOG_DIGITAL_DESC within the Statistical Variable column for the selected variable.

To select the PAM keyword to associate with the selected variable name, double click the Channel Keyword column and select the corresponding PAM keyword from the drop down.

To insert additional Scan List rows, right click a table row within the Scan List Tab and select Insert Row

To remove Scan List rows, right click a table row within the Scan List Tab and select Remove Row

The following is a list of keywords that are added to the specification file from the Scan List Tab

Generated Keyword In Spec File

Definition

*@SCAN_LIST

PAM keyword names correlating to CyFlex Variable Names to be logged

* - Denotes required keyword

Meta Data List Tab

When creating a new dlogger spec file from within the dloggereditor, a default dummy variable row is added to the Meta Data List Tab. This dummy row is available in order to get additional rows added to the Meta Data section of the output file.

To edit data in default dummy Meta Data row, double click on the PAM Keyword column to display the drop-down list of PAM keywords. Select a PAM Keyword from the drop-down list.

 

To select a corresponding CyFlex Variable for the selected PAM Keyword, double click within the CyFlex Variable column to display Variable Selection dialog. Select the variable name from the Variable drop-down.

 

To have a string literal value written to the output file for a selected PAM Keyword, double click within the CyFlex Variable column to display the Variable Selection dialog. Within the Literal text box, enter a string with double quotes around it.

 

To insert additional Meta Data List rows, right click a table row within the Meta Data List Tab and select Insert Row

 

To remove Meta Data List rows, right click a table row within the Meta Data List Tab and select Remove Row

The following is a list of keywords that are added to the specification file from the Meta Data List Tab

Generated Keyword In Spec File

Definition

*@META_DATA

List of specified PAM Keywords and corresponding CyFlex variable names where the CyFlex variable values will be captured once when the dlogger output file is written.

* - Denotes required keyword

Scan List Aux User Tab

When creating a new dlogger spec file from within the dloggereditor, a dummy commented out row is added to the Scan List Aux User Tab. This dummy row is available to add additional rows to the Scan List Aux User section of the output file.

To edit data in default dummy Scan List Aux User row, double click on the CyFlex Variable column to display the Variable Selection dialog. Within the Variable Selection dialog, select the type of variable to log from the Group drop-down and select the variable name to log from Variable drop-down.

When selecting a variable name from the Variable Selection dialog, the Alternate Name box will be automatically get filled in with the selected variable name. To edit the data within Alternate Name box, double click within the Alternate Name column and enter in the correct information.

 

To insert additional Scan List Aux User rows, right click a table row within the Scan List Aux User Tab and select Insert Row

 

To remove Scan List User Aux rows, right click a table row within the Scan List Aux User Tab and select Remove Row

 

The following is a list of keywords that are added to the specification file from the Scan List Aux User Tab

Generated Keyword In Spec File

Definition

@SCAN_LIST_AUX_USER

List of CyFlex variable values that are logged within the dlogger output file as the Alternate Name if one is specified. If the Alternate Name is not specified, the CyFlex Variable is referenced as the CyFlex Variable in the output file.

ECM List Tab

When creating a new dlogger spec file from within the dloggereditor, a dummy commented out row is added to the ECM List Tab. This dummy row is available to add additional rows to the ECM List section of the output file.

To edit data in default dummy ECM List row, double click on the ASAM Specs Path column to display the ASAM3 Spec File Selection dialog. Within the ASAM3 Spec File Selection dialog, select the Spec File drop-down box to select the location and filename for the ECM parameters to be logged. Next, select the ECM Instance drop-down list to select the ECM name and index number.

 

To insert additional ECM List rows, right click a table row within the ECM List Tab and select Insert Row

To remove ECM List rows, right click a table row within the ECM List Tab and select Remove Row

The following is a list of keywords that are added to the specification file from the ECM List Tab

Generated Keyword In Spec File

Definition

@ECM_LIST

Location and filename of an ecm spec file where ecm variables names will be read to add to the list of variables that are logged within the dlogger output file