Skip to content

Commit

Permalink
reviewed files' doc comment at beginning of examples
Browse files Browse the repository at this point in the history
  • Loading branch information
2bndy5 committed Mar 5, 2024
1 parent 42b95ba commit 9174559
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 1 deletion.
2 changes: 2 additions & 0 deletions examples/scanner/scanner.ino
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@
*
* Inspired by cpixip.
* See https://forum.arduino.cc/t/poor-mans-2-4-ghz-scanner/54846
*
* See documentation at https://nRF24.github.io/RF24
*/

/*
Expand Down
2 changes: 2 additions & 0 deletions examples/scannerGraphic/scannerGraphic.ino
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@
* convenience set radio data rate or further development. See our other
* RF24/scanner example that only uses the Serial Monitor instead of a graphic
* display.
*
* See documentation at https://nRF24.github.io/RF24
*/
#include <Adafruit_GFX.h> // dependency of Adafruit display libraries
#include "RF24.h"
Expand Down
10 changes: 10 additions & 0 deletions examples_linux/ncurses/scanner_curses.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@
modify it under the terms of the GNU General Public License
version 2 as published by the Free Software Foundation.
*/

/**
* Channel scanner
*
* Example to detect interference on the various channels available.
* This is a good diagnostic tool to check whether you're picking a
* good channel for your application.
*
* See documentation at https://nRF24.github.io/RF24
*/
#include <cstdio> // sprintf()
#include <string> // string, getline()
#include <ctime> // time_t, time(), difftime()
Expand Down
2 changes: 2 additions & 0 deletions examples_linux/scanner.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
*
* Inspired by cpixip.
* See https://forum.arduino.cc/t/poor-mans-2-4-ghz-scanner/54846
*
* See documentation at https://nRF24.github.io/RF24
*/

/*
Expand Down
8 changes: 7 additions & 1 deletion examples_linux/scanner.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
"""A scanner example written in python using the std lib's ncurses wrapper."""
"""A scanner example written in python using the std lib's ncurses wrapper.
This is a good diagnostic tool to check whether you're picking a
good channel for your application.
See documentation at https://nRF24.github.io/RF24
"""

# pylint: disable=no-member
import curses
Expand Down

0 comments on commit 9174559

Please sign in to comment.