Analyzer Frame Types

Documentation for output produced by Saleae's built-in Analyzers

Python high level analyzers allow users to write custom code that processes the output of another analyzer.

Right now, there are 8 analyzers that can be used with high level analyzers:

In order to write a high level analyzer, the data format produced by the connected source analyzer must be understood.

For example, a high level analyzer which consumes serial data needs to understand the serial analyzer output format in order to extract bytes, and this code is very different from the code required to extract data bytes from CAN data.

# Reading serial data
def decode(self, frame):
print(frame.data['data'])
# Reading CAN data
def decode(self, frame):
if frame.type == 'identifier_field':
print(frame.data['identifier'])
elif frame.type == 'data_field':
print(frame.data['data'])
elif frame.type == 'crc_field':
print(frame.data['crc'])

To write a Python high level analyzer for a specific input analyzer, navigate to the section for that analyzer.

There is one page for each analyzer that is compatible with python HLAs. Each analyzer produces one or more frame types. These frame types have string names and will be in the type member of the frame class.

Each frame type may have data properties. The documentation page will list the data properties for that frame type, along with the data type and a description. These can be accessed from the frame.data dictionary.

Here is an example of you you might handle different frame types from I2C:

def decode(self, frame):
if frame.type == 'address':
if frame.data['read'] == True:
print('read from ' + str(frame.data['address']))
else
print('write to ' + str(frame.data['address']))
elif frame.type == 'data':
print(frame.data['data'])
elif frame.type == 'start':
print('I2C start condition')
elif frame.type == 'stop':
print('I2C stop condition')

Not all analyzers are supported yet. If there is a specific analyzer which does not yet support "FrameV2" which you would like to use with Python High Level Analyzers, please let us know!