Saleae API Documentation
Welcome to the Saleae API documentation. This covers the Python APIs available for building custom extensions and automating Saleae Logic 2.
Extensions
Guides
Overview
Overview of the three extension types available in Logic 2.
Getting Started
Tutorials for building your first extension in Logic 2.
Create and Use Extensions
Step-by-step guide to creating your first extension from a template in Logic 2.
Measurement Extensions
Build a working analog measurement extension from scratch using the current API.
High-Level Analyzer (HLA) Extensions
Build a working High Level Analyzer that processes protocol data.
Guides
In-depth guides for extension development, packaging, and distribution.
Extension File Format
Structure of extension.json, Python source files, and other required files.
Extension Installation
Install extensions from the in-app Marketplace or from local source files.
Publish an Extension
Upload your extension to GitHub and publish it to the Saleae Marketplace.
HLA Development
Settings, output formats, frame processing, and other HLA development topics.
Measurement Development
Measure declarations, annotations, AnalogSpan, and other measurement development topics.
Debugging
Techniques for debugging extension code in Logic 2.
Examples
Focused code examples and common patterns for extension development.
HLA - Analyzer Frame Format
Focused code examples and common patterns for HLA extension development.
Measurement Examples
Focused code examples and common patterns for measurement extension development.
Analyzer Frame Types
Frame type definitions and data properties for each built-in analyzer.
About Third-Party Extensions
Usage notes, safety guidance, and policies for community-published extensions.
Disabling Marketplace Extensions
Disable access to the Extensions Marketplace using environment variables.
API
saleae.measurements
Measurement extension API.
saleae.range_measurements deprecated
Deprecated: v1 range measurement extension API.
Automation
Guides
Getting Started
Install the Python package, connect to Logic 2, and run your first automated capture.
Launching the Logic 2 Software and Starting the Socket Interface
Start Logic 2 with the automation server enabled via command line or the UI.
Errors
Handle capture errors, USB connectivity issues, and other exceptions from the API.
API
saleae.automation
Automation API for controlling the Saleae Logic 2 software.
- Version
- AppInfo
- DeviceType
- DeviceDesc
- GlitchFilterEntry
- LogicDeviceConfiguration
- DigitalTriggerType
- DigitalTriggerLinkedChannelState
- DigitalTriggerLinkedChannel
- DigitalTriggerCaptureMode
- TimedCaptureMode
- ManualCaptureMode
- CaptureConfiguration
- Manager
- RadixType
- AnalyzerHandle
- DataTableExportConfiguration
- DataTableFilter
- Capture
saleae.automation.errors
Error types raised by the Saleae Automation API.
MSO API
Guides
Getting Started
Get started with the Saleae MSO API
Installation
Install the Saleae MSO API
Usage
Detailed usage examples for the Saleae MSO API
Release Notes
Release history for the Saleae MSO API
API
saleae.mso_api
Saleae MSO API package.
saleae.mso_api.errors
Error types raised by the Saleae MSO API.
saleae.mso_api.utils
Utility classes for binary file parsing and synthetic triggers.