/python-saleae

Python library to control a Saleae Logic Analyzer

Primary LanguagePythonMIT LicenseMIT

python-saleae

Build Status Documentation Status

This library implements the control protocol for the Saleae Logic Analyzer. It is based off of the documentation and example here: https://github.com/saleae/SaleaeSocketApi

IMPORTANT: You must enable the 'Remote Scripting Server' in Saleae. Click on "Options" in the top-right, the "Developer" tab, and check "Enable scripting socket server". This should not require a restart.

This library requires Saleae Logic 1.2.x or greater. Unfortunately there is no way to check the version of Logic running using the scripting protocol so this is difficult to check at runtime.

Note: Unfortunately, the new Logic2 software does not yet support remote access, so you will have to use the original Logic software.

You can track Logic2 remote access progress on this thread from Saleae: https://discuss.saleae.com/t/scripting-socket-api/108/3

Currently, this is basically a direct mapping of API calls with some small sanity checking and conveniences. It has not been extensively tested beyond my immediate needs, but it also should not have any known problems.

To get a feel for how the library works and what it can do, try the built-in demo:

#!/usr/bin/env python3
import saleae
saleae.demo()

Issues, updates, pull requests, etc should be directed to github.

Installation

The easiest method is to simply use pip:

(sudo) pip install saleae

Usage

import saleae
s = saleae.Saleae()
s.capture_to_file('/tmp/test.logicdata')