Socket API - Automation

The Socket API scripting utility allows users to programmatically configure our software and trigger captures.

Prerequisites - Software Settings

  • Check that you are using the latest version of the software below.

  • We highly recommend suppressing notifications and error messages while running your automation script. These notifications may block normal operation and can be suppressed by starting the application with the command line option -disablepopups

  • Next, we must enable the scripting socket server. Open Options Menu at the top of the software.

  • Select Preferences

  • Under the Developer Tab, check the box to enable socket server

  • Save Changes

  • Accept firewall changes if the OS requests it

For automated environments, the -socket command line option was previously used to automatically enable the scripting socket server. Unfortunately, we cannot recommend this moving forward due to a known bug. We will fix this in a future release, which will be integrated into Logic v2. For now, please use the Preferences Window as shown above to enable the socket server.

Socket API User's Guide

The document below lists the supported commands using our automation utility.

Python Wrapper - Automation Method #1

For simple automation requirements, we suggest using our Python Sample Application. This is a basic command line utility to automate the Saleae Logic software, which can be used to automatically take a series of shorter captures over an extended time period with basic export functions.

The Python Sample Application implements a very basic form of data export via csv. If more export options are needed, please see the article below:

You may also send supported socket commands directly via the terminal using the Python wrapper, as shown below. See our list of supported commands.

C:\Python>python.exe
>>> import saleae
>>> s = saleae.Saleae()
>>> s._cmd('set_capture_seconds, 1')
>>> s._cmd('capture')

C# Wrapper - Automation Method #2

For more complex automation requirements, you can refer to our C# Wrapper below:

Other Third-Party Implementations

If you would like to share your application, feel free to send us a link to it on any repository hosting provider, and we can share that link here.

Which Export Options are Available via Socket API?

The Socket API currently supports the raw export feature and the protocol-specific export feature. However, the socket API does not support exporting the protocol search results.