Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-rfm69/badge/?version=latest
:target: https://docs.circuitpython.org/projects/rfm69/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
: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
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
CircuitPython RFM69 packet radio module. This supports basic RadioHead-compatible sending and
receiving of packets with RFM69 series radios (433/915Mhz).
.. 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 .venv
source .venv/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 2000000 (2MHz).
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)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/rfm69/en/latest/>`_.
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>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_RFM69/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-rfm69",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, rfm69, packet, radio, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/c0/4f/d635942ae214d507f1da473b23e43952b3bbc962cb837edcdd1b8cdd8cd2/adafruit_circuitpython_rfm69-2.1.21.tar.gz",
"platform": null,
"description": "\nIntroduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-rfm69/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/rfm69/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_RFM69/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_RFM69/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nCircuitPython RFM69 packet radio module. This supports basic RadioHead-compatible sending and\nreceiving of packets with RFM69 series radios (433/915Mhz).\n\n.. warning:: This is NOT for LoRa radios!\n\n.. note:: This is a 'best effort' at receiving data using pure Python code--there is not interrupt\n support so you might lose packets if they're sent too quickly for the board to process them.\n You will have the most luck using this in simple low bandwidth scenarios like sending and\n receiving a 60 byte packet at a time--don't try to receive many kilobytes of data at a time!\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-rfm69/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-rfm69\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-rfm69\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-rfm69\n\n\nUsage Example\n=============\nSee examples/rfm69_simpletest.py for a simple demo of the usage.\nNote: the default baudrate for the SPI is 2000000 (2MHz).\nThe maximum setting is 10Mhz but\ntransmission errors have been observed expecially when using breakout boards.\nFor breakout boards or other configurations where the boards are separated,\nit may be necessary to reduce the baudrate for reliable data transmission.\nThe baud rate may be specified as an keyword parameter when initializing the board.\nTo set it to 1000000 use :\n\n.. code-block:: python\n\n # Initialze RFM radio\n rfm9x = adafruit_rfm9x.RFM9x(spi, CS, RESET, RADIO_FREQ_MHZ, baudrate=1000000)\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/rfm69/en/latest/>`_.\n\nFor 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>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_RFM69/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for RFM69 packet radio.",
"version": "2.1.21",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_RFM69"
},
"split_keywords": [
"adafruit",
" rfm69",
" packet",
" radio",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2a7dc4736c799aec10f30d95f7dcc01556eba8cc0e696e1ce905041849fbee8e",
"md5": "b3acc8edb399a15c3fc800673de27041",
"sha256": "45676939045854546d6b0f652e3cbf00854ce81e92add0cc28efbb09e7a05a56"
},
"downloads": -1,
"filename": "adafruit_circuitpython_rfm69-2.1.21-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b3acc8edb399a15c3fc800673de27041",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 15740,
"upload_time": "2024-05-13T13:21:27",
"upload_time_iso_8601": "2024-05-13T13:21:27.661909Z",
"url": "https://files.pythonhosted.org/packages/2a/7d/c4736c799aec10f30d95f7dcc01556eba8cc0e696e1ce905041849fbee8e/adafruit_circuitpython_rfm69-2.1.21-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c04fd635942ae214d507f1da473b23e43952b3bbc962cb837edcdd1b8cdd8cd2",
"md5": "f35e28429919cd0ec68da1f6c453ae6c",
"sha256": "7b9b1235fb2e367b9d664ef0a616a3a21bd5d547fd0ded6510a311625ca31ee1"
},
"downloads": -1,
"filename": "adafruit_circuitpython_rfm69-2.1.21.tar.gz",
"has_sig": false,
"md5_digest": "f35e28429919cd0ec68da1f6c453ae6c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 40437,
"upload_time": "2024-05-13T13:21:29",
"upload_time_iso_8601": "2024-05-13T13:21:29.056853Z",
"url": "https://files.pythonhosted.org/packages/c0/4f/d635942ae214d507f1da473b23e43952b3bbc962cb837edcdd1b8cdd8cd2/adafruit_circuitpython_rfm69-2.1.21.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-13 13:21:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_RFM69",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
},
{
"name": "adafruit-circuitpython-typing",
"specs": []
}
],
"lcname": "adafruit-circuitpython-rfm69"
}
JSON
