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
Create and Use Extensions
Step-by-step guide to creating your first extension from a template in Logic 2.
Extension Installation
Install extensions from the in-app Marketplace or from local source files.
Extension File Format
Structure of extension.json, Python source files, and other required files.
High-Level Analyzer (HLA) Extensions
Learn how to modify your new High Level Analyzer
HLA - Analyzer Frame Format
Documentation for output produced by Saleae's built-in Analyzers
Analyzer Frame Types
Frame type definitions and data properties for each built-in analyzer.
Measurement Extensions
Learn how to create, modify, and share your own Measurement Extensions
Publish an Extension
Upload your extension to GitHub and publish it to the Saleae Marketplace.
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.