Metadata-Version: 2.1
Name: irreceiver
Version: 0.9.2
Summary: A module to parse the NEC IR remote control protocol in Python
Home-page: https://github.com/computersarecool/irreceiver
Author: Willy Nolan
Author-email: contact@interactiondepartment.com
License: MIT
Description: # IRReceiver
        *A module to parse the NEC IR remote control protocol in Python*
        
        ## Description
        This is a fully tested module that creates a parser for the NEC IR remote control protocol.
        
        The NEC protocol is used by many remotes, you can read about it [here](https://www.sbprojects.net/knowledge/ir/nec.php).
        
        **NOTE: Although there is an example of this sketch that is made for the Raspberry PI, it is unlikely to work. 
        The Raspberry Pi does [not have a real time operating system](https://www.socallinuxexpo.org/sites/default/files/presentations/Steven_Doran_SCALE_13x.pdf)
        and in my testing this did not work reliably. Not even close.**
        
        ## Dependencies
        - This project has no external dependencies but the example code does depend on being run on a Raspberry Pi.
        - All code follows PEP 8 and is run through [YAPF](https://github.com/google/yapf) before it is committed
        
        ## Tested On
        - A Raspberry Pi (first generation)
        - A Yamaha MRX-90M remote
        
        ## To Install
        - `pip install irreceiver`
        
        
        ## To Use
        - An example file can be found in the `examples` directory.
        - Here is a basic example of decoding an list of IR timing pulses:
        ```python
        from irreceiver import NecDecoder
        decoder = NecDecoder()
        # Create PULSES, a list of IR pulse timings
        message = decoder.decode(PULSES)
        ```
        
        ## Project Structure
        Directory structure should be clear. All code is in the `irreceiver` directory.
        
        
        ### License
        
        :copyright: Willy Nolan 2020
        
        [MIT License](http://en.wikipedia.org/wiki/MIT_License)
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
