Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-rfm/badge/?version=latest
:target: https://docs.circuitpython.org/projects/rfm/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/jerryneedell/Adafruit_CircuitPython_RFM/workflows/Build%20CI/badge.svg
:target: https://github.com/jerryneedell/Adafruit_CircuitPython_RFM/actions
:alt: Build Status
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Code Style: Ruff
Support for RFM69 and RFM9x modules
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://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
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-rfm/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-rfm
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-rfm
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-rfm
Installing to a Connected CircuitPython Device with Circup
==========================================================
Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install adafruit_rfm
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
See examples in the GitHub Repository. <https://github.com/jerryneedell/Adafruit_CircuitPython_RFM.git>
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/rfm/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/jerryneedell/Adafruit_CircuitPython_RFM/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-rfm",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, rfm, RFM69, RFM9x, radio",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/5e/fa/9768e5097c0ac425734512d7bf6b91dfe02bb94057d2fc6dcde296c88542/adafruit_circuitpython_rfm-1.0.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-rfm/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/rfm/en/latest/\n :alt: Documentation Status\n\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\n.. image:: https://github.com/jerryneedell/Adafruit_CircuitPython_RFM/workflows/Build%20CI/badge.svg\n :target: https://github.com/jerryneedell/Adafruit_CircuitPython_RFM/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Code Style: Ruff\n\nSupport for RFM69 and RFM9x modules\n\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://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\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-rfm/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-rfm\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-rfm\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 .env/bin/activate\n pip3 install adafruit-circuitpython-rfm\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install adafruit_rfm\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\nSee examples in the GitHub Repository. <https://github.com/jerryneedell/Adafruit_CircuitPython_RFM.git>\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/rfm/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`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/jerryneedell/Adafruit_CircuitPython_RFM/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Support for RFM69 and RFM9x modules",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/jerryneedell/Adafruit_CircuitPython_RFM"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" rfm",
" rfm69",
" rfm9x",
" radio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a1ab22a74f8f021a3f6c31cc2f809f95b817e43498f3099ccbf82308a64be480",
"md5": "2ad9feafeccce739d4a422c320bb7173",
"sha256": "ac001f74e5c1f2676bd0ba953af9ad13346407e69b06d962763b49fb43292d8d"
},
"downloads": -1,
"filename": "adafruit_circuitpython_rfm-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2ad9feafeccce739d4a422c320bb7173",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 31325,
"upload_time": "2024-08-19T16:33:29",
"upload_time_iso_8601": "2024-08-19T16:33:29.659459Z",
"url": "https://files.pythonhosted.org/packages/a1/ab/22a74f8f021a3f6c31cc2f809f95b817e43498f3099ccbf82308a64be480/adafruit_circuitpython_rfm-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5efa9768e5097c0ac425734512d7bf6b91dfe02bb94057d2fc6dcde296c88542",
"md5": "6780ba29b14b4a4ae120c5bf3516053c",
"sha256": "3867add41c0f8ff01b6aeb019ef50a7d44434e4777d5ac853c667ca28b908220"
},
"downloads": -1,
"filename": "adafruit_circuitpython_rfm-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "6780ba29b14b4a4ae120c5bf3516053c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 46222,
"upload_time": "2024-08-19T16:33:30",
"upload_time_iso_8601": "2024-08-19T16:33:30.747012Z",
"url": "https://files.pythonhosted.org/packages/5e/fa/9768e5097c0ac425734512d7bf6b91dfe02bb94057d2fc6dcde296c88542/adafruit_circuitpython_rfm-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-19 16:33:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jerryneedell",
"github_project": "Adafruit_CircuitPython_RFM",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-rfm"
}
JSON
