Metadata-Version: 1.1
Name: python4yahdlc
Version: 1.0.3
Summary: Python bindings for the yahdlc library
Home-page: https://github.com/SkypLabs/python4yahdlc
Author: Paul-Emmanuel Raoul
Author-email: skyper@skyplabs.net
License: GPLv3
Download-URL: https://github.com/SkypLabs/python4yahdlc/archive/v1.0.3.zip
Description: python4yahdlc
        =============
        
        |Build Status|
        
        python4yahdlc is a Python bindings for the
        `yahdlc <https://github.com/bang-olufsen/yahdlc>`__ library.
        
        Dependencies
        ------------
        
        To build and make the Python module work, you need the following
        elements :
        
        -  Python 3
        -  The `setuptools <https://pypi.python.org/pypi/setuptools>`__ package
        
        On Fedora
        ~~~~~~~~~
        
        ::
        
            yum install python3-setuptools
        
        On Debian
        ~~~~~~~~~
        
        ::
        
            aptitude install python3-setuptools
        
        Installation
        ------------
        
        With pip (recommanded)
        ~~~~~~~~~~~~~~~~~~~~~~
        
        ::
        
            pip3 install python4yahdlc
        
        From sources
        ~~~~~~~~~~~~
        
        ::
        
            git clone https://github.com/SkypLabs/python4yahdlc.git
            cd python4yahdlc
            python3 setup.py install
        
        Usage
        -----
        
        To generate a new HDLC data frame :
        
        ::
        
            from yahdlc import *
        
            frame = frame_data('hello world!')
        
        To generate a new HDLC ACK frame with a specific sequence number :
        
        ::
        
            frame = frame_data('', FRAME_ACK, 3)
        
        The highest sequence number is 7 and the following frame types are
        available :
        
        -  FRAME\_DATA
        -  FRAME\_ACK
        -  FRAME\_NACK
        
        Note that when you generate an ACK or NACK frame, the payload is
        useless.
        
        To decode a received HDLC frame :
        
        ::
        
            data, type, seq_no = get_data(frame)
        
        For a more advanced use, take a look at the examples available in the
        `examples <https://github.com/SkypLabs/python4yahdlc/tree/master/examples>`__
        folder.
        
        License
        -------
        
        This project is released under the `GPL version
        3 <https://www.gnu.org/licenses/gpl.txt>`__ license. The
        `yahdlc <https://github.com/bang-olufsen/yahdlc>`__ library is released
        under the
        `MIT <https://github.com/bang-olufsen/yahdlc/blob/master/LICENSE>`__
        license.
        
        .. |Build Status| image:: https://travis-ci.org/SkypLabs/python4yahdlc.svg
           :target: https://travis-ci.org/SkypLabs/python4yahdlc
        
Keywords: hdlc yahdlc bindings
Platform: UNKNOWN
