@@ -3,25 +3,28 @@ Introduction
33============
44
55.. image :: https://readthedocs.org/projects/adafruit-circuitpython-rfm69/badge/?version=latest
6-
76 :target: https://circuitpython.readthedocs.io/projects/rfm69/en/latest/
8-
97 :alt: Documentation Status
108
119.. image :: https://img.shields.io/discord/327254708534116352.svg
1210 :target: https://discord.gg/nBQh6qu
1311 :alt: Discord
1412
15- CircuitPython RFM69 packet radio module. This supports basic
16- RadioHead-compatible sending and receiving of packets with RFM69 series radios
17- (433/915Mhz). Note this does NOT support advanced RadioHead features like
18- guaranteed delivery--only 'raw' packets are currently supported. In addition
19- this is NOT for LoRa radios! Finally be aware this is a 'best effort' at
20- receiving data using pure Python code--there is not interrupt support so you
21- might lose packets if they're sent too quickly for the board to process them.
22- You will have the most luck using this in simple low bandwidth scenarios like
23- sending and receiving a 60 byte packet at a time--don't try to receive many
24- kilobytes of data at a time!
13+ .. image :: https://travis-ci.org/adafruit/Adafruit_CircuitPython_RFM69.svg?branch=master
14+ :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_RFM69
15+ :alt: Build Status
16+
17+ CircuitPython RFM69 packet radio module. This supports basic RadioHead-compatible sending and
18+ receiving of packets with RFM69 series radios (433/915Mhz).
19+
20+ .. note :: This does NOT support advanced RadioHead features like guaranteed delivery--only 'raw' packets are currently supported.
21+
22+ .. warning :: This is NOT for LoRa radios!
23+
24+ .. note :: This is a 'best effort' at receiving data using pure Python code--there is not interrupt
25+ support so you might lose packets if they're sent too quickly for the board to process them.
26+ You will have the most luck using this in simple low bandwidth scenarios like sending and
27+ receiving a 60 byte packet at a time--don't try to receive many kilobytes of data at a time!
2528
2629Dependencies
2730=============
0 commit comments