Select a Step ......................................................... Command Line Syntax Examples Firmware/ Library Upgrades Configuration File Format Configuration File Editors Configuration File Transformation Filter Files SynqNet Topology Issues Warning and Error Messages Appendix A: Supported MPI Objects Appendix B: MPI Version Independence Appendix C: FAQs for meiConfig and meiConfigGui Appendix D: Firmware Address Configuration Elements Version History

Filter Files

Filter files are used to designate the inclusion and exclusion of specific configuration elements when saving to and restoring from a file. For example, the following text tells meiConfig to save and restore only Axis 0, Filter 0, and Motor 0:

     include:
           Axis 0
           Filter 0
           Motor 0

Using a filter file can greatly increase meiConfig's performance and decrease configuration file size. However, care must be taken to not exclude elements that are necessary for the successful setup of the system.

meiConfig.exe Command Line Details

The -filter command line option takes a filterFile parameter.

If no filter file is specified by the user, then the Default Filter File is used implictly.

Default Filter File

The Default Filter File, meiConfigFilter.txt, is located in the directory meiConfig_lib, under the directory where the meiConfig utility is installed. It excludes certain elements that are not normally desirable to save or restore. See the Appendix C for details.

In addition to excluding (usually) unnecessary elements, the Default Filter File also contains a commented-out list of all configuration elements. The user can copy elements from the list and paste them into their own filter files.

Filter File Format

A filter file consists of two sections: Include and Exclude.

Include Section
The include section begins with a line that has only the text include:.

If this section is empty, then all elements will be included except those listed in the exclude section.

If this section is not empty, then only those elements listed in it will be included. Sub-elements will also be included, unless they are listed in the exclude section.

Exclude Section
The exclude section begins with a line that has only the text exclude:

All elements listed in the exclude section will be excluded, as well as their sub-elements.

Configuration Elements

A configuration element is a series of identifiers separated by periods. Each identifier is either an MPI object, an MPI structure, or a member of an MPI structure. Below are some examples.

Axis
Axis.MPIAxisConfig
Axis.MPIAxisConfig.settle.onEStop

Individual elements within a list can be specified by including the index or range of indices after the element. The index must be preceded by a space. A continuous range of indices can be specified using a dash. For example, the first 4 filter objects would be specified as:

Filter 0-3

A comma can separate individual indices. For example, the first 4 filters and the eighth filter can be specified as:

Filter 0-3,7

The default filter file contains a list of all configuration elements.

Examples

Include only the filter gain tables.
      include:
            Filter.MPIFilterConfig.gain

Include only the first filter gain table.
      include:
            Filter.MPIFilterConfig.gain 1

Include only the first 10 user coefficients of the first filter gain table.
      include:
            Filter.MPIFilterConfig.gain 0.User 0-9

Include only the motor configurations, but exclude motor limit configurations.
      include:
            Motor

      include:
            Motor.MPIMotorConfig.Limit

Include basic controller configuration, Motion Supervisor-to-Axis mappings and filter coefficients.
      include:
            Control
            Filter.MPIFilterConfig.gain
            Filter.MPFilterConfig.algorithm
            Motion.MPIMotionConfig.axisMap

      exclude:
            Control.MPIControlConfig

Example Files

Below is a list of filter files that may, be located in the meiConfig_lib directory, depending on the version of the release. They can be used as is or as examples.

Previous | Next