Overview
The DecoderScript Reference Manual and User Guide is delivered with each Wireless Protocol Suite installation package under Developer Tools.
The main purpose of this manual is to describe DecoderScript, the language used in writing decoders. DecoderScript allows you to create new decoders or modify existing decoders to expand the functionality of your protocol analyzer. DecoderScript displays protocol data, checks the values of fields, validates checksums, converts and combines field values for convenient presentation. Decoders can also be augmented with custom C++-coded functions, called "methods", to extend data formatting, validation, transformations, and so on.
A decoder defines field-by-field how a protocol message can be taken apart and displayed. The core of each "decoder" is a program that defines how the protocol data is broken up into fields and displayed in the Frame Display window of the analyzer software.
This manual provides instruction on how to create and use custom decoders. When reading the manual for the first time, we encourage you to read the chapters in sequence. The chapters are organized in such a way to introduce you to DecoderScript writing step- by- step.
Screenshots of the protocol analyzer have been included in the manual to illustrate what you see on your own screen as you develop decoders. But you should be aware for various reasons, the examples may be slightly different from the ones that you create. The differences could be the result of configuration differences or because you are running a newer version of the program. Do not worry if an icon seems to be missing, a font is different, or even if the entire color scheme appears to have changed. The examples are still valid.
Examples of decoders, methods, and frame recognizers are included in this manual. You can cut and paste from these examples to create your own decoders.
A quick note here: Usually the pasted code appears the same as the original in your editor. Some editors, however, change the appearance of the text when it is pasted (something to do with whether it is ASCII or Unicode text). If you find that the pasted text does not appear the same as the original, you can transfer the code into a simple text editor like Notepad, save it as an ANSI (ASCII) file, then use it in your decoder.
Decoder code you author should go in the directory
%public%\Documents\Teledyne LeCroy Wireless\My Decoders
which normally resolves to
C:\Users\Public\Documents\Teledyne LeCroy Wireless\My Methods.
We will be updating our web site with new and updated utilities, etc., on a regular basis and we urge decoder writers to check there occasionally.
Contacting Teledyne LeCroy Frontline Technical Support
Technical support is available in several ways. The online help system provides answers to many user related questions. Frontline's website has documentation on common problems, as well as software upgrades and utilities to use with our products.
|
On the Web |
|
|
Email Support |
|
|
Phone: +1 (434) 984-4500 |
If you need to talk to a technical support representative about your Frontline product, support is available between 9 am and 5 pm, U.S. Eastern Time zone, and between 9 am and 5 pm, Pacific Time zone, on Monday through Friday. Technical support is not available on U.S. national holidays. |
|
Instructional Videos |
Teledyne LeCroy provides a series of videos to assist the user and may answer your questions. These videos can be accessed in the Video Library. |
Trademarks and Service Marks
Teledyne LeCroy and Frontline are trademarks of Teledyne LeCroy.
The Bluetooth SIG owns the Bluetooth® wordmark and logos. Any use of such marks by Teledyne LeCroy is under license.
Microsoft and Windows are registered trademarks of Microsoft Corporation.
macOS is a registered trademark of Apple Inc.
Linux is a registered trademark of Linus Torvalds.
All other trademarks and registered trademarks are property of their respective owners.
Document Disclaimer
The information contained in this document has been carefully checked and is believed to be reliable. However, no responsibility can be assumed for inaccuracies that may not have been detected.
Teledyne LeCroy reserves the right to revise the information presented in this document without notice or penalty.
Copyright
© 2020 Teledyne LeCroy, Inc. All Rights Reserved
This document may be printed and reproduced without additional permission, but all copies should contain this copyright notice.