Skip to content

Commit 78865f4

Browse files
committed
update docs' landing page
1 parent 622d40a commit 78865f4

2 files changed

Lines changed: 27 additions & 21 deletions

File tree

.cspell.config.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ words:
1010
- busdevice
1111
- busio
1212
- capsys
13+
- CIRCUITPY
1314
- circuitpython
15+
- datasheet
1416
- digitalio
1517
- Disabl
1618
- Dmitry
@@ -21,21 +23,31 @@ words:
2123
- Grinberg
2224
- hexlified
2325
- HHHBB
26+
- Hinch
27+
- Itsy
2428
- Kbps
2529
- LENG
2630
- levelname
2731
- Mbps
32+
- microcontroller
2833
- micropython
2934
- minversion
3035
- MOSI
3136
- multicasted
3237
- multicasting
3338
- multicasts
39+
- multiceiver
3440
- mypy
41+
- Pinout
3542
- pytest
3643
- raspberrypi
44+
- Rhys
45+
- seealso
3746
- setuptools
3847
- spidev
3948
- testpaths
49+
- toctree
4050
- urandom
51+
- venv
52+
- versionadded
4153
- xfer

docs/index.rst

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ to the MCU via a digital input pin during the interrupt example.
176176

177177
.. tip::
178178
User reports and personal experiences have improved results if there is a capacitor of
179-
100 microfarads (+ another optional 0.1 microfarads capacitor for added stability) connected
179+
100 microfarad (+ another optional 0.1 microfarad capacitor for added stability) connected
180180
in parallel to the VCC and GND pins.
181181
.. important::
182182
The nRF24L01's VCC pin is not 5V compliant. All other nRF24L01 pins *should* be 5V compliant,
@@ -242,11 +242,9 @@ For CPython in Linux
242242
What to purchase
243243
=================
244244

245-
See the following links to Sparkfun or just google "nRF24L01+".
246-
247-
* `2.4GHz Transceiver IC - nRF24L01+ <https://www.sparkfun.com/products/690>`_
248-
* `SparkFun Transceiver Breakout - nRF24L01+ <https://www.sparkfun.com/products/691>`_
249-
* `SparkFun Transceiver Breakout - nRF24L01+ (RP-SMA) <https://www.sparkfun.com/products/705>`_
245+
Just do a Google search for the term "nRF24L01+".
246+
This chip is no longer recommended for new designs (since 2014),
247+
but it is still widely available from some less reputable online retailers (amazon.com included).
250248

251249
It is worth noting that you
252250
generally want to buy more than 1 as you need 2 for testing -- 1 to send & 1 to receive and
@@ -266,8 +264,7 @@ then adding capacitor(s) (100 µF + an optional 0.1µF) in parallel (& as close
266264
as possible) to the VCC and GND pins is highly recommended. Stabilizing the power
267265
input provides significant performance increases. More finite details about the
268266
nRF24L01 are available from the datasheet (referenced here in the documentation as the
269-
`nRF24L01+ Specification Sheet <https://www.sparkfun.com/datasheets/
270-
Components/SMD/nRF24L01Pluss_Preliminary_Product_Specification_v1_0.pdf>`_)
267+
`nRF24L01+ Specification Sheet <https://github.com/nRF24/RF24/blob/beb8ffebc5be0f5470fb08c851f941d0c70a45e0/datasheets/nRF24L01_datasheet_v2.pdf>`_)
271268

272269
About the nRF24L01+PA+LNA modules
273270
---------------------------------
@@ -310,16 +307,14 @@ nRF24L01(+) clones and counterfeits
310307
This library does not directly support clones/counterfeits as there is no way for the library
311308
to differentiate between an actual nRF24L01+ and a clone/counterfeit. To determine if your
312309
purchase is a counterfeit, please contact the retailer you purchased from (also `reading this
313-
article and its links might help
314-
<https://hackaday.com/2015/02/23/nordic-nrf24l01-real-vs-fake/>`_). The most notable clone is the `Si24R1 <https://lcsc.com/product-detail/
315-
RF-Transceiver-ICs_Nanjing-Zhongke-Microelectronics-Si24R1_C14436.html>`_. I could not find
316-
the `Si24R1 datasheet <https://datasheet.lcsc.com/szlcsc/
317-
1811142211_Nanjing-Zhongke-Microelectronics-Si24R1_C14436.pdf>`_ in english. Troubleshooting
318-
the SI24R1 may require `replacing the onboard antenna with a wire
319-
<https://forum.mysensors.org/post/96871>`_. Furthermore, the Si24R1 has different power
310+
article and its links might help <https://hackaday.com/2015/02/23/nordic-nrf24l01-real-vs-fake/>`_).
311+
The most notable clone is the `Si24R1 <https://lcsc.com/product-detail/RF-Transceiver-ICs_Nanjing-Zhongke-Microelectronics-Si24R1_C14436.html>`_.
312+
I could not find the `Si24R1 datasheet <https://datasheet.lcsc.com/szlcsc/1811142211_Nanjing-Zhongke-Microelectronics-Si24R1_C14436.pdf>`_
313+
in english. Troubleshooting
314+
the SI24R1 may require `replacing the onboard antenna with a wire <https://forum.mysensors.org/post/96871>`_.
315+
Furthermore, the Si24R1 has different power
320316
amplifier options as noted in the `RF_PWR section (bits 0 through 2) of the RF_SETUP register
321-
(address 0x06) of the datasheet <https://datasheet.lcsc.com/szlcsc/
322-
1811142211_Nanjing-Zhongke-Microelectronics-Si24R1_C14436.pdf#%5B%7B%22num%22%3A329%2C%22gen%22%3A0%7D%2C%7B%22name%22%3A%22XYZ%22%7D%2C0%2C755%2Cnull%5D>`_.
317+
(address 0x06) of the datasheet <https://datasheet.lcsc.com/szlcsc/1811142211_Nanjing-Zhongke-Microelectronics-Si24R1_C14436.pdf#%5B%7B%22num%22%3A329%2C%22gen%22%3A0%7D%2C%7B%22name%22%3A%22XYZ%22%7D%2C0%2C755%2Cnull%5D>`_.
323318
While the options' values differ from those identified by this library's API, the
324319
underlying commands to configure those options are almost identical to the nRF24L01.
325320
The Si24R1 is also famous for not supporting :py:attr:`~circuitpython_nrf24l01.rf24.RF24.auto_ack`
@@ -351,11 +346,10 @@ Future Project Ideas/Additions
351346
The following are only ideas; they are not currently supported by this circuitpython library.
352347

353348
* `There's a few blog posts by Nerd Ralph demonstrating how to use the nRF24L01 via 2 or 3
354-
pins <http://nerdralph.blogspot.com/2015/05/nrf24l01-control-with-2-mcu-pins-using.
355-
html>`_ (uses custom bitbanging SPI functions and an external circuit involving a
349+
pins <http://nerdralph.blogspot.com/2015/05/nrf24l01-control-with-2-mcu-pins-using.html>`_
350+
(uses custom bit-banging SPI functions and an external circuit involving a
356351
resistor and a capacitor)
357-
* TCI/IP OSI layer, maybe something like `TMRh20's RF24Ethernet
358-
<http://nRF24.github.io/RF24Ethernet/>`_
352+
* TCI/IP OSI layer, maybe something like `TMRh20's RF24Ethernet <http://nRF24.github.io/RF24Ethernet/>`_
359353

360354
Sphinx documentation
361355
-----------------------

0 commit comments

Comments
 (0)