Metadata-Version: 1.1
Name: saleae
Version: 0.5.2
Summary: Library to control a Saleae
Home-page: https://github.com/ppannuto/python-saleae
Author: Pat Pannuto
Author-email: pat.pannuto+saleae@gmail.com
License: MIT
Description: python-saleae
        =============
        
        |travisci| |docs|
        
        This library implements the control protocol for the
        `Saleae Logic Analyzer <https://www.saleae.com/>`__. 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.
        
        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 <https://github.com/ppannuto/python-saleae>`__.
        
        
        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')
        
        
        .. |docs| image:: https://readthedocs.org/projects/python-saleae/badge/?version=latest
            :alt: Documentation Status
            :scale: 100%
            :target: https://python-saleae.readthedocs.org/
        
        .. |travisci| image:: https://travis-ci.org/ppannuto/python-saleae.svg?branch=master
            :alt: Build Status
            :target: https://travis-ci.org/ppannuto/python-saleae
        
Keywords: string formatting
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Embedded Systems
Classifier: Topic :: Utilities
