Metadata-Version: 1.2
Name: pulse_pal
Version: 0.0.6
Summary: Unofficial port of Pulse Pal for Python 3
Home-page: https://github.com/mmyros/pulse_pal
Author: Maxym Myroshnychenko
Author-email: mmyros@gmail.com
License: MIT license
Description: ======================
        Pulse Pal for Python 3
        ======================
        
        
        .. image:: https://img.shields.io/pypi/v/pulse_pal.svg
                :target: https://pypi.python.org/pypi/pulse_pal
        
        .. image:: https://img.shields.io/travis/mmyros/pulse_pal.svg
                :target: https://travis-ci.com/mmyros/pulse_pal
        
        .. image:: https://readthedocs.org/projects/pulse-pal/badge/?version=latest
                :target: https://pulse-pal.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        
        
        
        Unofficial port of Pulse Pal for Python 3
        
        
        * Free software: MIT license
        * Documentation: https://pulse-pal.readthedocs.io.
        
        
        Features
        --------
        - Python 3 compatibility
        - Easy install through pip
        - Command line interface (In progress)
        - Limited support
        
        Installation
        ------------
        .. code-block:: bash
        
           pip install pulse_pal
        
        Usage
        -----
        See help:
        
        .. code-block:: bash
        
           pulse_pal --help
        
        Set phase 1 voltage to 5:
        
        .. code-block:: bash
        
           pulse_pal --do set --port COM2 --param_name phase1Voltage --param_value 5
        
        Trigger channel 1:
        
        .. code-block:: bash
        
           pulse_pal --do trigger --channel 1
        
        
        Test your Pulse Pal connection
        ------------------------------
        
        - Easy (from console):
        
        .. code-block:: bash
        
           pulse_pal --do test
        
        - Low-level (from python):
        
        .. code-block:: python
        
            def test_pulse_pal(serialPortName='COM10'):
                import serial,struct
        
                OpMenuByte = 213
                serialObject = serial.Serial(serialPortName, 115200, timeout=1)
                handshakeByteString = struct.pack('BB', OpMenuByte, 72)
                serialObject.write(handshakeByteString)
                Response=serialObject.read(5)
                print(len(Response))
        
            test_pulse_pal('COM10')
        
        
        
        
        =======
        History
        =======
        
        0.1.0 (2020-10-08)
        ------------------
        
        * First release on PyPI.
        
Keywords: pulse_pal
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.5
