# `rf24-py`
[pypi-link]: https://pypi.org/project/rf24-py/
[pypi-badge]: https://img.shields.io/pypi/v/rf24-py
[rtd-badge]: https://img.shields.io/readthedocs/rf24-rs
[docs]: https://rf24-rs.readthedocs.io/en/latest/python-api/
[rf24-rs]: https://github.com/nRF24/rf24-rs
[py-min-ver]: https://img.shields.io/badge/python->=3.9-blue
[changelog-badge]: https://img.shields.io/badge/keep_a_change_log-v1.1.0-ffec3d
[changelog-link]: https://rf24-rs.readthedocs.io/en/latest/rf24-py-changelog/
[![PyPI - Version][pypi-badge]][pypi-link]
[![Python API][rtd-badge]][docs]
![Minimum Python Version: >=3.8][py-min-ver]
[![CHANGELOG][changelog-badge]][changelog-link]
The python binding for the [rf24-rs] project (written in rust).
This package is only functional on Linux machines.
Although, installing this package in non-Linux environments will
provide the typing information used on Linux.
See the [docs] for more detail about the API.
## Install
To install from pypi.org:
```text
pip install rf24-py
```
To build from source, the [rf24-rs] project uses [uv] to manage dependencies:
```text
uv sync
```
Append `--no-dev` (or set `UV_NO_DEV=1` environment variable) for environments with limited disk space (eg. Raspberry Pi machine).
As of [uv] v0.8.7, the environment variable
[uv]: https://docs.astral.sh/uv
## Examples
The examples are located in [the repository's root path][rf24-rs] "examples/python".
To run the examples, simply pass the example file's path to the python interpreter:
```text
uv run examples/python/getting_started.py
```
Again, the `--no-dev` argument can be applied to the `uv run` command
(or set `UV_NO_DEV=1` environment variable)
for environments with limited disk space.
The examples/python/irq_config.py script requires the [gpiod] package.
The `uv run` command needs to be amended to include this dependency:
```text
uv run --with gpiod examples/python/irq_config.py
```
[gpiod]: https://pypi.org/project/gpiod
Raw data
{
"_id": null,
"home_page": null,
"name": "rf24-py",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "nrf24l01, nRF24L01+, raspberry, pi, linux, driver, radio, transceiver, RF24",
"author": null,
"author_email": "Brendan Doherty <2bndy5@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/08/4b/c22c314b615b6152ea216f9dfea69534dd5834899416b029c2f3919c2ea0/rf24_py-0.5.0.tar.gz",
"platform": null,
"description": "# `rf24-py`\n\n[pypi-link]: https://pypi.org/project/rf24-py/\n[pypi-badge]: https://img.shields.io/pypi/v/rf24-py\n[rtd-badge]: https://img.shields.io/readthedocs/rf24-rs\n[docs]: https://rf24-rs.readthedocs.io/en/latest/python-api/\n[rf24-rs]: https://github.com/nRF24/rf24-rs\n[py-min-ver]: https://img.shields.io/badge/python->=3.9-blue\n[changelog-badge]: https://img.shields.io/badge/keep_a_change_log-v1.1.0-ffec3d\n[changelog-link]: https://rf24-rs.readthedocs.io/en/latest/rf24-py-changelog/\n\n[![PyPI - Version][pypi-badge]][pypi-link]\n[![Python API][rtd-badge]][docs]\n![Minimum Python Version: >=3.8][py-min-ver]\n [![CHANGELOG][changelog-badge]][changelog-link]\n\nThe python binding for the [rf24-rs] project (written in rust).\n\nThis package is only functional on Linux machines.\nAlthough, installing this package in non-Linux environments will\nprovide the typing information used on Linux.\n\nSee the [docs] for more detail about the API.\n\n## Install\n\nTo install from pypi.org:\n\n```text\npip install rf24-py\n```\n\nTo build from source, the [rf24-rs] project uses [uv] to manage dependencies:\n\n```text\nuv sync\n```\n\nAppend `--no-dev` (or set `UV_NO_DEV=1` environment variable) for environments with limited disk space (eg. Raspberry Pi machine).\nAs of [uv] v0.8.7, the environment variable\n\n[uv]: https://docs.astral.sh/uv\n\n## Examples\n\nThe examples are located in [the repository's root path][rf24-rs] \"examples/python\".\nTo run the examples, simply pass the example file's path to the python interpreter:\n\n```text\nuv run examples/python/getting_started.py\n```\n\nAgain, the `--no-dev` argument can be applied to the `uv run` command\n(or set `UV_NO_DEV=1` environment variable)\nfor environments with limited disk space.\n\nThe examples/python/irq_config.py script requires the [gpiod] package.\nThe `uv run` command needs to be amended to include this dependency:\n\n```text\nuv run --with gpiod examples/python/irq_config.py\n```\n\n[gpiod]: https://pypi.org/project/gpiod\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A python package binding the nRF24/rf24-rs rust project.",
"version": "0.5.0",
"project_urls": {
"Documentation": "https://rf24-rs.readthedocs.io/en/latest",
"Source": "https://github.com/nRF24/rf24-rs",
"Tracker": "https://github.com/nRF24/rf24-rs/issues"
},
"split_keywords": [
"nrf24l01",
" nrf24l01+",
" raspberry",
" pi",
" linux",
" driver",
" radio",
" transceiver",
" rf24"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "154cf845a9d7cf6b5eac3b2494d3d62e26f2a54d5fc0e3760f2d8314d2f324b5",
"md5": "184de74b956736d71a854b0736a57921",
"sha256": "0627c2d5304f24dce204a098a03da25f105f0fc36e5ac4b6d93153c7bbec96ac"
},
"downloads": -1,
"filename": "rf24_py-0.5.0-cp39-abi3-macosx_10_12_x86_64.whl",
"has_sig": false,
"md5_digest": "184de74b956736d71a854b0736a57921",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 227576,
"upload_time": "2025-09-02T04:46:37",
"upload_time_iso_8601": "2025-09-02T04:46:37.945431Z",
"url": "https://files.pythonhosted.org/packages/15/4c/f845a9d7cf6b5eac3b2494d3d62e26f2a54d5fc0e3760f2d8314d2f324b5/rf24_py-0.5.0-cp39-abi3-macosx_10_12_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f7f168409cb7f82f5712302f4991f3eaf5afa9236ff49825bd37653edb569157",
"md5": "92bd8629ae61c613db0b55f00637bcce",
"sha256": "6fee36e9aa34597fc9a6641a8368e0f222030db30b040e115a59b275bacac0ff"
},
"downloads": -1,
"filename": "rf24_py-0.5.0-cp39-abi3-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "92bd8629ae61c613db0b55f00637bcce",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 214265,
"upload_time": "2025-09-02T04:46:39",
"upload_time_iso_8601": "2025-09-02T04:46:39.984140Z",
"url": "https://files.pythonhosted.org/packages/f7/f1/68409cb7f82f5712302f4991f3eaf5afa9236ff49825bd37653edb569157/rf24_py-0.5.0-cp39-abi3-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c12e02dc0cd618749ed3c44cf2da99fcff7affa6a5d9b216edb8254f6f0022ad",
"md5": "1588952cdcae2d36596ad639afa05291",
"sha256": "f7a4424abf427d6676a6d4487d230c9b5a180ea6cde24c982d285fc64a5adf86"
},
"downloads": -1,
"filename": "rf24_py-0.5.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
"has_sig": false,
"md5_digest": "1588952cdcae2d36596ad639afa05291",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 280293,
"upload_time": "2025-09-02T04:46:41",
"upload_time_iso_8601": "2025-09-02T04:46:41.697902Z",
"url": "https://files.pythonhosted.org/packages/c1/2e/02dc0cd618749ed3c44cf2da99fcff7affa6a5d9b216edb8254f6f0022ad/rf24_py-0.5.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9cd80e510b871fc8f859b001f4594a4cbbc961dc5ed56c3a747bc8219a8fedf6",
"md5": "f22d0d37673e3b70fc565f351588a1f3",
"sha256": "33c0a92e43d7a1131a5b4281b7ea28a1234695c06e0897cbc73deeb4d3964a7c"
},
"downloads": -1,
"filename": "rf24_py-0.5.0-cp39-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl",
"has_sig": false,
"md5_digest": "f22d0d37673e3b70fc565f351588a1f3",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 288526,
"upload_time": "2025-09-02T04:46:43",
"upload_time_iso_8601": "2025-09-02T04:46:43.117999Z",
"url": "https://files.pythonhosted.org/packages/9c/d8/0e510b871fc8f859b001f4594a4cbbc961dc5ed56c3a747bc8219a8fedf6/rf24_py-0.5.0-cp39-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e6e5ae1a5018af216aa62723a94a82b9a51619dc602875c718cfb16228cde79b",
"md5": "bf90b4d6cab151f22ad659f377f387b0",
"sha256": "6433fecf62de79190f000b29d10d0bc1d1811af99ede5b24b312b6b5765ddc4b"
},
"downloads": -1,
"filename": "rf24_py-0.5.0-cp39-abi3-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl",
"has_sig": false,
"md5_digest": "bf90b4d6cab151f22ad659f377f387b0",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 322036,
"upload_time": "2025-09-02T04:46:45",
"upload_time_iso_8601": "2025-09-02T04:46:45.372990Z",
"url": "https://files.pythonhosted.org/packages/e6/e5/ae1a5018af216aa62723a94a82b9a51619dc602875c718cfb16228cde79b/rf24_py-0.5.0-cp39-abi3-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3fe19f78b711d248b0c7a5af2950184f43fd613ed822ced382c5369f9578f6e6",
"md5": "4aa00c444e18129e28734ce4dfd8cf76",
"sha256": "5528954fe93816449448f1b5406bb1f512878278e6f92e6a1029795aab398b2b"
},
"downloads": -1,
"filename": "rf24_py-0.5.0-cp39-abi3-manylinux_2_17_s390x.manylinux2014_s390x.whl",
"has_sig": false,
"md5_digest": "4aa00c444e18129e28734ce4dfd8cf76",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 330803,
"upload_time": "2025-09-02T04:46:47",
"upload_time_iso_8601": "2025-09-02T04:46:47.269547Z",
"url": "https://files.pythonhosted.org/packages/3f/e1/9f78b711d248b0c7a5af2950184f43fd613ed822ced382c5369f9578f6e6/rf24_py-0.5.0-cp39-abi3-manylinux_2_17_s390x.manylinux2014_s390x.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b0e8b216c283f914ec3baccb8ce31b1e4a08723f53d4a69ee130a746115f8e43",
"md5": "f523bf49c243ea93401465ada423a8ac",
"sha256": "5264f5a6220804cf33e127821b7c6a553fae8c09418248c9f137a6068c887c86"
},
"downloads": -1,
"filename": "rf24_py-0.5.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "f523bf49c243ea93401465ada423a8ac",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 293322,
"upload_time": "2025-09-02T04:46:49",
"upload_time_iso_8601": "2025-09-02T04:46:49.059704Z",
"url": "https://files.pythonhosted.org/packages/b0/e8/b216c283f914ec3baccb8ce31b1e4a08723f53d4a69ee130a746115f8e43/rf24_py-0.5.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d23426bc11d44b3ae4c07519ef08245d87736291326b23ce945e75400c4ee2fa",
"md5": "1121c002c23b6e316d287cdd895fa7ed",
"sha256": "87b0ac0b137e64f832c5094d9ea429f5b1224f5fd38aa2b3a7e58777dda4a11e"
},
"downloads": -1,
"filename": "rf24_py-0.5.0-cp39-abi3-manylinux_2_5_i686.manylinux1_i686.whl",
"has_sig": false,
"md5_digest": "1121c002c23b6e316d287cdd895fa7ed",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 311296,
"upload_time": "2025-09-02T04:46:51",
"upload_time_iso_8601": "2025-09-02T04:46:51.054886Z",
"url": "https://files.pythonhosted.org/packages/d2/34/26bc11d44b3ae4c07519ef08245d87736291326b23ce945e75400c4ee2fa/rf24_py-0.5.0-cp39-abi3-manylinux_2_5_i686.manylinux1_i686.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f98e7cdecae58203a8038358abf2a1dcd4247b722f3418b7e04b33c1b43716db",
"md5": "343d4455402ab8edeb3fa0f6b72b5bf9",
"sha256": "ff99e116acfba1c055975f67b33f3bb18997d099aa1d089a6bffb809e7489223"
},
"downloads": -1,
"filename": "rf24_py-0.5.0-cp39-abi3-musllinux_1_2_aarch64.whl",
"has_sig": false,
"md5_digest": "343d4455402ab8edeb3fa0f6b72b5bf9",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 460466,
"upload_time": "2025-09-02T04:46:52",
"upload_time_iso_8601": "2025-09-02T04:46:52.463116Z",
"url": "https://files.pythonhosted.org/packages/f9/8e/7cdecae58203a8038358abf2a1dcd4247b722f3418b7e04b33c1b43716db/rf24_py-0.5.0-cp39-abi3-musllinux_1_2_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c0c46f42809a9e6e380c2025436087ac42cc15f4960bbd4b38588a25c43d0c11",
"md5": "cf02eba9b10d98391dc9c58b6c7572f5",
"sha256": "3c56113e1f9a301d6acebe7a0e5f6990de4ab6a797c6b76bf2bf3fc5d21a8f34"
},
"downloads": -1,
"filename": "rf24_py-0.5.0-cp39-abi3-musllinux_1_2_armv7l.whl",
"has_sig": false,
"md5_digest": "cf02eba9b10d98391dc9c58b6c7572f5",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 553477,
"upload_time": "2025-09-02T04:46:53",
"upload_time_iso_8601": "2025-09-02T04:46:53.911770Z",
"url": "https://files.pythonhosted.org/packages/c0/c4/6f42809a9e6e380c2025436087ac42cc15f4960bbd4b38588a25c43d0c11/rf24_py-0.5.0-cp39-abi3-musllinux_1_2_armv7l.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e3402ffeb75e0201b209ac8dac807764819f1296096a5fc3bbe861600a9add61",
"md5": "2fba2dfb217c0ceec551d578c5b143d0",
"sha256": "b7cb46b315cbac1238de2127c38c73944d1f129fc2d130c3453196a6d714eff5"
},
"downloads": -1,
"filename": "rf24_py-0.5.0-cp39-abi3-musllinux_1_2_i686.whl",
"has_sig": false,
"md5_digest": "2fba2dfb217c0ceec551d578c5b143d0",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 490187,
"upload_time": "2025-09-02T04:46:55",
"upload_time_iso_8601": "2025-09-02T04:46:55.961936Z",
"url": "https://files.pythonhosted.org/packages/e3/40/2ffeb75e0201b209ac8dac807764819f1296096a5fc3bbe861600a9add61/rf24_py-0.5.0-cp39-abi3-musllinux_1_2_i686.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "fdcbed0a46193e28d690cdb2f982d0cd568520d87e62300ff63426cee06e4069",
"md5": "47a884e03d978f8423ed9ed17afedb2d",
"sha256": "2d73eac74ada547505fa65c38b43368b9ee18319879e3178c18b735827848690"
},
"downloads": -1,
"filename": "rf24_py-0.5.0-cp39-abi3-musllinux_1_2_x86_64.whl",
"has_sig": false,
"md5_digest": "47a884e03d978f8423ed9ed17afedb2d",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 464715,
"upload_time": "2025-09-02T04:46:57",
"upload_time_iso_8601": "2025-09-02T04:46:57.444996Z",
"url": "https://files.pythonhosted.org/packages/fd/cb/ed0a46193e28d690cdb2f982d0cd568520d87e62300ff63426cee06e4069/rf24_py-0.5.0-cp39-abi3-musllinux_1_2_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7b9911a3dd3d143a2a04381a8f0f62b769dc59e0635dc32069686f21dc023596",
"md5": "d39964b673b13b97243b2529823802d0",
"sha256": "53b80b13f4912db056d0f0dc8e372c3cb4bd96c0c0c4d5002931f0f7df02ba78"
},
"downloads": -1,
"filename": "rf24_py-0.5.0-cp39-abi3-win32.whl",
"has_sig": false,
"md5_digest": "d39964b673b13b97243b2529823802d0",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 140139,
"upload_time": "2025-09-02T04:46:58",
"upload_time_iso_8601": "2025-09-02T04:46:58.708472Z",
"url": "https://files.pythonhosted.org/packages/7b/99/11a3dd3d143a2a04381a8f0f62b769dc59e0635dc32069686f21dc023596/rf24_py-0.5.0-cp39-abi3-win32.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e06f10542e3b78aef868479d844abbaaac485b73181c7c15d79fd2ca8b6ec067",
"md5": "57b9b8023e28f128924ffaa4d09b96c2",
"sha256": "2eef5f3be9a99e8bcd174b1b5a882e2656261043adc31c2efff9778d69ef0aea"
},
"downloads": -1,
"filename": "rf24_py-0.5.0-cp39-abi3-win_amd64.whl",
"has_sig": false,
"md5_digest": "57b9b8023e28f128924ffaa4d09b96c2",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 146436,
"upload_time": "2025-09-02T04:47:00",
"upload_time_iso_8601": "2025-09-02T04:47:00.152991Z",
"url": "https://files.pythonhosted.org/packages/e0/6f/10542e3b78aef868479d844abbaaac485b73181c7c15d79fd2ca8b6ec067/rf24_py-0.5.0-cp39-abi3-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "084bc22c314b615b6152ea216f9dfea69534dd5834899416b029c2f3919c2ea0",
"md5": "db7aa2479ead7d194277dd8faf8ed5b5",
"sha256": "5bb36e4fcf268452b57fef3fb5e37449cdd8af118bd18c4f2be13c325d729da2"
},
"downloads": -1,
"filename": "rf24_py-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "db7aa2479ead7d194277dd8faf8ed5b5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 77225,
"upload_time": "2025-09-02T04:47:01",
"upload_time_iso_8601": "2025-09-02T04:47:01.743242Z",
"url": "https://files.pythonhosted.org/packages/08/4b/c22c314b615b6152ea216f9dfea69534dd5834899416b029c2f3919c2ea0/rf24_py-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-02 04:47:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nRF24",
"github_project": "rf24-rs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "rf24-py"
}
JSON
