What to Send to End Users
A complete decoder package requires the following components:
- The decoder file with a unique decoder ID. The file must have a DEC extension for plain text decoders and DEX for encrypted decoders. This file must be placed in the My Decoders directory, but can be placed in a subdirectory under My Decoders. The protocol analyzer reads the My Decoders directory and the user-defined subdirectories for custom decoders.
- A protocol analyzer product that has the option for creation of decoders if decoders are distributed as DEC files OR a "fileset" that contains the decoder if it is to be distributed in encrypted form. Please see the information about filesets at the end of this section.
In certain cases, some or all of the following are required as well:
- A Frame Recognizer method.
- Any other custom methods used by the decoder.
- A magic number for installation of the decoder (encrypted decoders only).
- A [MyProtocolName].personality file.
Methods must be compiled into a DLL and placed in the My Methods directory in order for the decoder to find them. [MyProtocolName].personality must be placed in the My Decoders directory, but can be placed in a subdirectory under My Decoders. The protocol analyzer reads the My Decoders directory and the user-defined subdirectories for custom decoders.
You may also optionally wish to send all or one of the following:
- Pre-defined protocol stack in [MyProtocolName].personality to appear in the Protocol Stack Wizard.
- I/O Settings Configuration file for serial analyzers.
A pre-defined protocol stack may be useful if there are several protocols in your stack and you need them to be set up in a certain way. If you include a pre-defined stack, your users just need to select that one item in the Protocol Stack Wizard and you're guaranteed to have the stack set up correctly.
To supply an I/O Settings Configuration, start the protocol analyzer, open the I/O Settings window, and setup the parameters exactly as you want them to be. Save the configuration. The file will be saved to the My Configurations\filename.cfg directory by default. Include the CFG file with your decoders and have the user place it in their My Configurations directory. Once the user starts the protocol analyzer, they will need to open the I/O Settings window and load the configuration, but once they do, you will be sure what the parameters are set for.
A convenient way to supply all of these components to an end-user, and ensure they are placed in the correct directories, is to distribute them in a fileset. For more information on filesets and the tools used to create them, please contact your software vendor's Technical Support department.