Metadata-Version: 2.1
Name: adafruit-circuitpython-rfm69
Version: 1.5.0
Summary: CircuitPython library for RFM69 packet radio.
Home-page: https://github.com/adafruit/Adafruit_CircuitPython_RFM69
Author: Adafruit Industries
Author-email: circuitpython@adafruit.com
License: MIT
Description: 
        Introduction
        ============
        
        .. image:: https://readthedocs.org/projects/adafruit-circuitpython-rfm69/badge/?version=latest
            :target: https://circuitpython.readthedocs.io/projects/rfm69/en/latest/
            :alt: Documentation Status
        
        .. image :: https://img.shields.io/discord/327254708534116352.svg
            :target: https://discord.gg/nBQh6qu
            :alt: Discord
        
        .. image:: https://github.com/adafruit/Adafruit_CircuitPython_RFM69/workflows/Build%20CI/badge.svg
            :target: https://github.com/adafruit/Adafruit_CircuitPython_RFM69/actions/
            :alt: Build Status
        
        CircuitPython RFM69 packet radio module.  This supports basic RadioHead-compatible sending and
        receiving of packets with RFM69 series radios (433/915Mhz).
        
        .. note:: This does NOT support advanced RadioHead features like guaranteed delivery--only 'raw' packets are currently supported.
        
        .. warning:: This is NOT for LoRa radios!
        
        .. note:: This is a 'best effort' at receiving data using pure Python code--there is not interrupt
            support so you might lose packets if they're sent too quickly for the board to process them.
            You will have the most luck using this in simple low bandwidth scenarios like sending and
            receiving a 60 byte packet at a time--don't try to receive many kilobytes of data at a time!
        
        Dependencies
        =============
        This driver depends on:
        
        * `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
        * `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
        
        Please ensure all dependencies are available on the CircuitPython filesystem.
        This is easily achieved by downloading
        `the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
        
        Installing from PyPI
        ====================
        
        On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
        PyPI <https://pypi.org/project/adafruit-circuitpython-rfm69/>`_. To install for current user:
        
        .. code-block:: shell
        
            pip3 install adafruit-circuitpython-rfm69
        
        To install system-wide (this may be required in some cases):
        
        .. code-block:: shell
        
            sudo pip3 install adafruit-circuitpython-rfm69
        
        To install in a virtual environment in your current project:
        
        .. code-block:: shell
        
            mkdir project-name && cd project-name
            python3 -m venv .env
            source .env/bin/activate
            pip3 install adafruit-circuitpython-rfm69
        
        
        Usage Example
        =============
        See examples/rfm69_simpletest.py for a simple demo of the usage.
        Note: the default baudrate for the SPI is 5000000 (5MHz). 
        The maximum setting is 10Mhz but 
        transmission errors have been observed expecially when using breakout boards.
        For breakout boards or other configurations where the boards are separated,
        it may be necessary to reduce the baudrate for reliable data transmission.
        The baud rate may be specified as an keyword parameter when initializing the board.
        To set it to 1000000 use :
        
        .. code-block:: python
        
            # Initialze RFM radio
            rfm9x = adafruit_rfm9x.RFM9x(spi, CS, RESET, RADIO_FREQ_MHZ,baudrate=1000000)
        
        
        Contributing
        ============
        
        Contributions are welcome! Please read our `Code of Conduct
        <https://github.com/adafruit/Adafruit_CircuitPython_RFM69/blob/master/CODE_OF_CONDUCT.md>`_
        before contributing to help this project stay welcoming.
        
        Documentation
        =============
        
        For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
        
Keywords: adafruit rfm69 packet radio hardware micropython circuitpython
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Hardware
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Description-Content-Type: text/x-rst
