update examples' comment about pin numbers

nRF24 · Jun 16, 2024 · 8a2bc41 · 8a2bc41
1 parent f59f8b2
commit 8a2bc41
Show file tree

Hide file tree

Showing 14 changed files with 67 additions and 46 deletions.
diff --git a/examples/acknowledgement_payloads.py b/examples/acknowledgement_payloads.py
@@ -11,12 +11,11 @@
 print(__file__)  # print example name
 
 ########### USER CONFIGURATION ###########
-# See https://github.com/TMRh20/RF24/blob/master/pyRF24/readme.md
-# Radio CE Pin, CSN Pin, SPI Speed
-# CE Pin uses GPIO number with BCM and SPIDEV drivers, other platforms use
+# CE Pin uses GPIO number with RPi and SPIDEV drivers, other drivers use
 # their own pin numbering
-# CS Pin addresses the SPI bus number at /dev/spidev<a>.<b>
-# ie: RF24 radio(<ce_pin>, <a>*10+<b>); spidev1.0 is 10, spidev1.1 is 11 etc..
+# CS Pin corresponds the SPI bus number at /dev/spidev<a>.<b>
+# ie: radio = RF24(<ce_pin>, <a>*10+<b>)
+# where CS pin for /dev/spidev1.0 is 10, /dev/spidev1.1 is 11 etc...
 CSN_PIN = 0  # aka CE0 on SPI bus 0: /dev/spidev0.0
 if RF24_DRIVER == "MRAA":
     CE_PIN = 15  # for GPIO22

diff --git a/examples/fake_ble_test.py b/examples/fake_ble_test.py
@@ -20,12 +20,11 @@
 print(__file__)  # print example name
 
 ########### USER CONFIGURATION ###########
-# See https://github.com/TMRh20/RF24/blob/master/pyRF24/readme.md
-# Radio CE Pin, CSN Pin, SPI Speed
-# CE Pin uses GPIO number with BCM and SPIDEV drivers, other platforms use
+# CE Pin uses GPIO number with RPi and SPIDEV drivers, other drivers use
 # their own pin numbering
-# CS Pin addresses the SPI bus number at /dev/spidev<a>.<b>
-# ie: RF24 radio(<ce_pin>, <a>*10+<b>); spidev1.0 is 10, spidev1.1 is 11 etc..
+# CS Pin corresponds the SPI bus number at /dev/spidev<a>.<b>
+# ie: radio = RF24(<ce_pin>, <a>*10+<b>)
+# where CS pin for /dev/spidev1.0 is 10, /dev/spidev1.1 is 11 etc...
 CSN_PIN = 0  # aka CE0 on SPI bus 0: /dev/spidev0.0
 if RF24_DRIVER == "MRAA":
     CE_PIN = 15  # for GPIO22

diff --git a/examples/general_network_test.py b/examples/general_network_test.py
@@ -19,6 +19,12 @@
 
 print(__file__)  # print example name
 
+########### USER CONFIGURATION ###########
+# CE Pin uses GPIO number with RPi and SPIDEV drivers, other drivers use
+# their own pin numbering
+# CS Pin corresponds the SPI bus number at /dev/spidev<a>.<b>
+# ie: radio = RF24(<ce_pin>, <a>*10+<b>)
+# where CS pin for /dev/spidev1.0 is 10, /dev/spidev1.1 is 11 etc...
 CSN_PIN = 0  # aka CE0 on SPI bus 0: /dev/spidev0.0
 if RF24_DRIVER == "MRAA":
     CE_PIN = 15  # for GPIO22

diff --git a/examples/getting_started.py b/examples/getting_started.py
@@ -11,12 +11,11 @@
 print(__file__)  # print example name
 
 ########### USER CONFIGURATION ###########
-# See https://github.com/TMRh20/RF24/blob/master/pyRF24/readme.md
-# Radio CE Pin, CSN Pin, SPI Speed
-# CE Pin uses GPIO number with BCM and SPIDEV drivers, other platforms use
+# CE Pin uses GPIO number with RPi and SPIDEV drivers, other drivers use
 # their own pin numbering
-# CS Pin addresses the SPI bus number at /dev/spidev<a>.<b>
-# ie: RF24 radio(<ce_pin>, <a>*10+<b>); spidev1.0 is 10, spidev1.1 is 11 etc..
+# CS Pin corresponds the SPI bus number at /dev/spidev<a>.<b>
+# ie: radio = RF24(<ce_pin>, <a>*10+<b>)
+# where CS pin for /dev/spidev1.0 is 10, /dev/spidev1.1 is 11 etc...
 CSN_PIN = 0  # aka CE0 on SPI bus 0: /dev/spidev0.0
 if RF24_DRIVER == "MRAA":
     CE_PIN = 15  # for GPIO22

diff --git a/examples/interrupt_configure.py b/examples/interrupt_configure.py
@@ -31,12 +31,11 @@
 
 
 ########### USER CONFIGURATION ###########
-# See https://github.com/TMRh20/RF24/blob/master/pyRF24/readme.md
-# Radio CE Pin, CSN Pin, SPI Speed
-# CE Pin uses GPIO number with BCM and SPIDEV drivers, other platforms use
+# CE Pin uses GPIO number with RPi and SPIDEV drivers, other drivers use
 # their own pin numbering
-# CS Pin addresses the SPI bus number at /dev/spidev<a>.<b>
-# ie: RF24 radio(<ce_pin>, <a>*10+<b>); spidev1.0 is 10, spidev1.1 is 11 etc..
+# CS Pin corresponds the SPI bus number at /dev/spidev<a>.<b>
+# ie: radio = RF24(<ce_pin>, <a>*10+<b>)
+# where CS pin for /dev/spidev1.0 is 10, /dev/spidev1.1 is 11 etc...
 CSN_PIN = 0  # aka CE0 on SPI bus 0: /dev/spidev0.0
 if RF24_DRIVER == "MRAA":
     CE_PIN = 15  # for GPIO22

diff --git a/examples/manual_acknowledgements.py b/examples/manual_acknowledgements.py
@@ -15,12 +15,11 @@
 print(__file__)  # print example name
 
 ########### USER CONFIGURATION ###########
-# See https://github.com/TMRh20/RF24/blob/master/pyRF24/readme.md
-# Radio CE Pin, CSN Pin, SPI Speed
-# CE Pin uses GPIO number with BCM and SPIDEV drivers, other platforms use
+# CE Pin uses GPIO number with RPi and SPIDEV drivers, other drivers use
 # their own pin numbering
-# CS Pin addresses the SPI bus number at /dev/spidev<a>.<b>
-# ie: RF24 radio(<ce_pin>, <a>*10+<b>); spidev1.0 is 10, spidev1.1 is 11 etc..
+# CS Pin corresponds the SPI bus number at /dev/spidev<a>.<b>
+# ie: radio = RF24(<ce_pin>, <a>*10+<b>)
+# where CS pin for /dev/spidev1.0 is 10, /dev/spidev1.1 is 11 etc...
 CSN_PIN = 0  # aka CE0 on SPI bus 0: /dev/spidev0.0
 if RF24_DRIVER == "MRAA":
     CE_PIN = 15  # for GPIO22

diff --git a/examples/mesh_example.py b/examples/mesh_example.py
@@ -20,6 +20,12 @@ def millis():
     return int((time.monotonic() - start) * 1000) % (2**32)
 
 
+########### USER CONFIGURATION ###########
+# CE Pin uses GPIO number with RPi and SPIDEV drivers, other drivers use
+# their own pin numbering
+# CS Pin corresponds the SPI bus number at /dev/spidev<a>.<b>
+# ie: radio = RF24(<ce_pin>, <a>*10+<b>)
+# where CS pin for /dev/spidev1.0 is 10, /dev/spidev1.1 is 11 etc...
 CSN_PIN = 0  # aka CE0 on SPI bus 0: /dev/spidev0.0
 if RF24_DRIVER == "MRAA":
     CE_PIN = 15  # for GPIO22

diff --git a/examples/mesh_example_master.py b/examples/mesh_example_master.py
@@ -9,6 +9,12 @@
 
 print(__file__)  # print example name
 
+########### USER CONFIGURATION ###########
+# CE Pin uses GPIO number with RPi and SPIDEV drivers, other drivers use
+# their own pin numbering
+# CS Pin corresponds the SPI bus number at /dev/spidev<a>.<b>
+# ie: radio = RF24(<ce_pin>, <a>*10+<b>)
+# where CS pin for /dev/spidev1.0 is 10, /dev/spidev1.1 is 11 etc...
 CSN_PIN = 0  # aka CE0 on SPI bus 0: /dev/spidev0.0
 if RF24_DRIVER == "MRAA":
     CE_PIN = 15  # for GPIO22

diff --git a/examples/multiceiver_demo.py b/examples/multiceiver_demo.py
@@ -12,12 +12,11 @@
 print(__file__)  # print example name
 
 ########### USER CONFIGURATION ###########
-# See https://github.com/TMRh20/RF24/blob/master/pyRF24/readme.md
-# Radio CE Pin, CSN Pin, SPI Speed
-# CE Pin uses GPIO number with BCM and SPIDEV drivers, other platforms use
+# CE Pin uses GPIO number with RPi and SPIDEV drivers, other drivers use
 # their own pin numbering
-# CS Pin addresses the SPI bus number at /dev/spidev<a>.<b>
-# ie: RF24 radio(<ce_pin>, <a>*10+<b>); spidev1.0 is 10, spidev1.1 is 11 etc..
+# CS Pin corresponds the SPI bus number at /dev/spidev<a>.<b>
+# ie: radio = RF24(<ce_pin>, <a>*10+<b>)
+# where CS pin for /dev/spidev1.0 is 10, /dev/spidev1.1 is 11 etc...
 CSN_PIN = 0  # aka CE0 on SPI bus 0: /dev/spidev0.0
 if RF24_DRIVER == "MRAA":
     CE_PIN = 15  # for GPIO22

diff --git a/examples/network_helloworld_rx.py b/examples/network_helloworld_rx.py
@@ -13,6 +13,12 @@
 
 print(__file__)  # print example name
 
+########### USER CONFIGURATION ###########
+# CE Pin uses GPIO number with RPi and SPIDEV drivers, other drivers use
+# their own pin numbering
+# CS Pin corresponds the SPI bus number at /dev/spidev<a>.<b>
+# ie: radio = RF24(<ce_pin>, <a>*10+<b>)
+# where CS pin for /dev/spidev1.0 is 10, /dev/spidev1.1 is 11 etc...
 CSN_PIN = 0  # aka CE0 on SPI bus 0: /dev/spidev0.0
 if RF24_DRIVER == "MRAA":
     CE_PIN = 15  # for GPIO22

diff --git a/examples/network_helloworld_tx.py b/examples/network_helloworld_tx.py
@@ -14,6 +14,12 @@
 
 print(__file__)  # print example name
 
+########### USER CONFIGURATION ###########
+# CE Pin uses GPIO number with RPi and SPIDEV drivers, other drivers use
+# their own pin numbering
+# CS Pin corresponds the SPI bus number at /dev/spidev<a>.<b>
+# ie: radio = RF24(<ce_pin>, <a>*10+<b>)
+# where CS pin for /dev/spidev1.0 is 10, /dev/spidev1.1 is 11 etc...
 CSN_PIN = 0  # aka CE0 on SPI bus 0: /dev/spidev0.0
 if RF24_DRIVER == "MRAA":
     CE_PIN = 15  # for GPIO22

diff --git a/examples/scanner.py b/examples/scanner.py
@@ -12,12 +12,11 @@
 print(__file__)  # print example name
 
 ########### USER CONFIGURATION ###########
-# See https://github.com/TMRh20/RF24/blob/master/pyRF24/readme.md
-# Radio CE Pin, CSN Pin, SPI Speed
-# CE Pin uses GPIO number with BCM and SPIDEV drivers, other platforms use
+# CE Pin uses GPIO number with RPi and SPIDEV drivers, other drivers use
 # their own pin numbering
-# CS Pin addresses the SPI bus number at /dev/spidev<a>.<b>
-# ie: RF24 radio(<ce_pin>, <a>*10+<b>); spidev1.0 is 10, spidev1.1 is 11 etc..
+# CS Pin corresponds the SPI bus number at /dev/spidev<a>.<b>
+# ie: radio = RF24(<ce_pin>, <a>*10+<b>)
+# where CS pin for /dev/spidev1.0 is 10, /dev/spidev1.1 is 11 etc...
 CSN_PIN = 0  # aka CE0 on SPI bus 0: /dev/spidev0.0
 if RF24_DRIVER == "MRAA":
     CE_PIN = 15  # for GPIO22

diff --git a/examples/scanner_curses.py b/examples/scanner_curses.py
@@ -14,12 +14,11 @@
 print(__file__)  # print example name
 
 ########### USER CONFIGURATION ###########
-# See https://github.com/TMRh20/RF24/blob/master/pyRF24/readme.md
-# Radio CE Pin, CSN Pin, SPI Speed
-# CE Pin uses GPIO number with BCM and SPIDEV drivers, other platforms use
+# CE Pin uses GPIO number with RPi and SPIDEV drivers, other drivers use
 # their own pin numbering
-# CS Pin addresses the SPI bus number at /dev/spidev<a>.<b>
-# ie: RF24 radio(<ce_pin>, <a>*10+<b>); spidev1.0 is 10, spidev1.1 is 11 etc..
+# CS Pin corresponds the SPI bus number at /dev/spidev<a>.<b>
+# ie: radio = RF24(<ce_pin>, <a>*10+<b>)
+# where CS pin for /dev/spidev1.0 is 10, /dev/spidev1.1 is 11 etc...
 CSN_PIN = 0  # aka CE0 on SPI bus 0: /dev/spidev0.0
 if RF24_DRIVER == "MRAA":
     CE_PIN = 15  # for GPIO22

diff --git a/examples/streaming_data.py b/examples/streaming_data.py
@@ -10,12 +10,11 @@
 print(__file__)  # print example name
 
 ########### USER CONFIGURATION ###########
-# See https://github.com/TMRh20/RF24/blob/master/pyRF24/readme.md
-# Radio CE Pin, CSN Pin, SPI Speed
-# CE Pin uses GPIO number with BCM and SPIDEV drivers, other platforms use
-# their own pin numbering
-# CS Pin addresses the SPI bus number at /dev/spidev<a>.<b>
-# ie: RF24 radio(<ce_pin>, <a>*10+<b>); spidev1.0 is 10, spidev1.1 is 11 etc..
+# CE Pin uses GPIO number with RPi and SPIDEV drivers, other drivers use
+# their own pin numbering.
+# CS Pin corresponds the SPI bus number at /dev/spidev<a>.<b>
+# ie: radio = RF24(<ce_pin>, <a>*10+<b>)
+# where CS pin for /dev/spidev1.0 is 10, /dev/spidev1.1 is 11 etc...
 CSN_PIN = 0  # aka CE0 on SPI bus 0: /dev/spidev0.0
 if RF24_DRIVER == "MRAA":
     CE_PIN = 15  # for GPIO22