Metadata-Version: 2.4
Name: sal-extract
Version: 1.0.0
Summary: Extracts Saleae Logic data & metadata from .sal files.
Keywords: saleae,readtape,sal-extract,meta.json
Author: Joan Touzet
Author-email: wohali@apache.org
Requires-Python: >=3.11
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator
Requires-Dist: click (>=8.3.3,<9.0.0)
Requires-Dist: logic2-automation (>=1.0.11,<2.0.0)
Description-Content-Type: text/markdown

# Saleae Logic 2.x data extractor

The `sal-export` program will extract recorded tracks from a `.sal` file. It does this by running Logic and using the automation interface.

It will also extract the internal `meta.json` file which includes many useful pieces of information not otherwise available, including:

* track names, enable status, and ordering
* marker information
* notes
* datetime of data capture
* sample rate
* (limited) device calibration information


## Usage

```
Usage: sal-extract [OPTIONS] [SALS]...

  Extracts Saleae Logic 2.x .sal files to a directory with the file's stem
  name. If the output directory does not exist, it is created.

  On MacOS/Linux, the path to Logic must be specified using the --app-path
  (-a) option.

Options:
  -o, --outpath DIRECTORY  Use as a parent directory for all output
                           directories.
  -p, --port INTEGER       Saleae Logic automation port  [default: 10430]
  -a, --app-path FILE      Path to the Saleae Logic binary, May need to be
                           provided if not installed in the default location.
  --help                   Show this message and exit.
```


## Further reading

* [Saleae Logic automation interface](https://saleae.github.io/logic2-automation/getting_started.html)
* [Is the `.sal` file format documented?](https://www.saleae.com/support/logic-software/saving-and-exporting-data/sal-file-format)
  * [Forum post with `meta.json` detail](https://discuss.saleae.com/t/logic-2-capture-format-sal/1858)

