adafruit-circuitpython-rfm 1.0.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2024 Jerry Needell for Adafruit Industries
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,128 @@
1
+ Metadata-Version: 2.1
2
+ Name: adafruit-circuitpython-rfm
3
+ Version: 1.0.0
4
+ Summary: Support for RFM69 and RFM9x modules
5
+ Author-email: Adafruit Industries <circuitpython@adafruit.com>
6
+ License: MIT
7
+ Project-URL: Homepage, https://github.com/jerryneedell/Adafruit_CircuitPython_RFM
8
+ Keywords: adafruit,blinka,circuitpython,micropython,rfm,RFM69,RFM9x,radio
9
+ Classifier: Intended Audience :: Developers
10
+ Classifier: Topic :: Software Development :: Libraries
11
+ Classifier: Topic :: Software Development :: Embedded Systems
12
+ Classifier: Topic :: System :: Hardware
13
+ Classifier: License :: OSI Approved :: MIT License
14
+ Classifier: Programming Language :: Python :: 3
15
+ Description-Content-Type: text/x-rst
16
+ License-File: LICENSE
17
+ Requires-Dist: Adafruit-Blinka
18
+ Requires-Dist: adafruit-circuitpython-busdevice
19
+ Requires-Dist: asyncio
20
+ Provides-Extra: optional
21
+
22
+ Introduction
23
+ ============
24
+
25
+
26
+ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-rfm/badge/?version=latest
27
+ :target: https://docs.circuitpython.org/projects/rfm/en/latest/
28
+ :alt: Documentation Status
29
+
30
+
31
+ .. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
32
+ :target: https://adafru.it/discord
33
+ :alt: Discord
34
+
35
+
36
+ .. image:: https://github.com/jerryneedell/Adafruit_CircuitPython_RFM/workflows/Build%20CI/badge.svg
37
+ :target: https://github.com/jerryneedell/Adafruit_CircuitPython_RFM/actions
38
+ :alt: Build Status
39
+
40
+
41
+ .. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
42
+ :target: https://github.com/astral-sh/ruff
43
+ :alt: Code Style: Ruff
44
+
45
+ Support for RFM69 and RFM9x modules
46
+
47
+
48
+ Dependencies
49
+ =============
50
+ This driver depends on:
51
+
52
+ * `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
53
+ * `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
54
+
55
+ Please ensure all dependencies are available on the CircuitPython filesystem.
56
+ This is easily achieved by downloading
57
+ `the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
58
+ or individual libraries can be installed using
59
+ `circup <https://github.com/adafruit/circup>`_.
60
+
61
+
62
+ Installing from PyPI
63
+ =====================
64
+
65
+ On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
66
+ PyPI <https://pypi.org/project/adafruit-circuitpython-rfm/>`_.
67
+ To install for current user:
68
+
69
+ .. code-block:: shell
70
+
71
+ pip3 install adafruit-circuitpython-rfm
72
+
73
+ To install system-wide (this may be required in some cases):
74
+
75
+ .. code-block:: shell
76
+
77
+ sudo pip3 install adafruit-circuitpython-rfm
78
+
79
+ To install in a virtual environment in your current project:
80
+
81
+ .. code-block:: shell
82
+
83
+ mkdir project-name && cd project-name
84
+ python3 -m venv .venv
85
+ source .env/bin/activate
86
+ pip3 install adafruit-circuitpython-rfm
87
+
88
+ Installing to a Connected CircuitPython Device with Circup
89
+ ==========================================================
90
+
91
+ Make sure that you have ``circup`` installed in your Python environment.
92
+ Install it with the following command if necessary:
93
+
94
+ .. code-block:: shell
95
+
96
+ pip3 install circup
97
+
98
+ With ``circup`` installed and your CircuitPython device connected use the
99
+ following command to install:
100
+
101
+ .. code-block:: shell
102
+
103
+ circup install adafruit_rfm
104
+
105
+ Or the following command to update an existing version:
106
+
107
+ .. code-block:: shell
108
+
109
+ circup update
110
+
111
+ Usage Example
112
+ =============
113
+
114
+ See examples in the GitHub Repository. <https://github.com/jerryneedell/Adafruit_CircuitPython_RFM.git>
115
+
116
+ Documentation
117
+ =============
118
+ API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/rfm/en/latest/>`_.
119
+
120
+ For information on building library documentation, please check out
121
+ `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
122
+
123
+ Contributing
124
+ ============
125
+
126
+ Contributions are welcome! Please read our `Code of Conduct
127
+ <https://github.com/jerryneedell/Adafruit_CircuitPython_RFM/blob/HEAD/CODE_OF_CONDUCT.md>`_
128
+ before contributing to help this project stay welcoming.
@@ -0,0 +1,10 @@
1
+ adafruit_rfm/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
2
+ adafruit_rfm/rfm69.py,sha256=BC5ds_CAHgoAv3Oxc_4bYIOIM4I_85Jum-EzUnNAo0I,27367
3
+ adafruit_rfm/rfm9x.py,sha256=T8gtl6suGtmW8i3Ef6fHOvLulm0rvofRxXsvujZMWNo,20768
4
+ adafruit_rfm/rfm9xfsk.py,sha256=spVYCZbpBBT0HazO_T_AjBztqIBIRVLqqFmZkrTXJZw,23675
5
+ adafruit_rfm/rfm_common.py,sha256=Kr1yV_nMqIKjytCBSq_3hd5IUXWupWI4LDB44iqjaIA,23474
6
+ adafruit_circuitpython_rfm-1.0.0.dist-info/LICENSE,sha256=rfNVYK3Omk396XFdBDNObwLh5qX4IkchlvreZ0rZCdM,1104
7
+ adafruit_circuitpython_rfm-1.0.0.dist-info/METADATA,sha256=dtUOwS00jAFLK6k-zd0VJ4liZcKDCHqwKn2OhWsRCAI,4113
8
+ adafruit_circuitpython_rfm-1.0.0.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
9
+ adafruit_circuitpython_rfm-1.0.0.dist-info/top_level.txt,sha256=lAt8Cd4Senkkdsa6ZQETVhUOasLzNQoNr0pXK62s47U,13
10
+ adafruit_circuitpython_rfm-1.0.0.dist-info/RECORD,,
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: setuptools (72.1.0)
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
5
+
@@ -0,0 +1 @@
1
+ adafruit_rfm
File without changes