Permalink
Browse files

Documented some questionable behaviour as pointed out by mdenzien

  • Loading branch information...
maniacbug committed Jun 29, 2011
1 parent c151ffb commit ca4820cd27fb5466b73c96dfaf23d6c6d0899a65
Showing with 8 additions and 4 deletions.
  1. +0 −2 README.md
  2. +8 −2 RF24.h
View
@@ -1,7 +1,5 @@
# Arduino driver for nRF24L01 2.4GHz Wireless Transceiver
CLEANUPS BRANCH: Bits and pieces of cleanup that I haven't tested on the radios yet.
Design Goals: This library is designed to be...
* Maximally compliant with the intended operation of the chip
View
10 RF24.h
@@ -252,6 +252,9 @@ class RF24
* getPayloadSize(). However, you can write less, and the remainder
* will just be filled with zeroes.
*
* @todo Write a non-blocking write to support users who want to
* check on progress separately or use an interrupt.
*
* @param buf Pointer to the data to be sent
* @param len Number of bytes to be sent
* @return True if the payload was delivered successfully false if not
@@ -304,19 +307,22 @@ class RF24
/**
* Open a pipe for reading
*
* Up to 5 pipes can be open for reading at once. Open all the
* Up to 6 pipes can be open for reading at once. Open all the
* reading pipes, and then call startListening().
*
* @see openWritingPipe
*
* @warning Pipes 1-5 should share the first 32 bits.
* Only the least significant byte should be unique, e.g.
*
* @code
* openReadingPipe(1,0xF0F0F0F0AA);
* openReadingPipe(2,0xF0F0F0F066);
* @endcode
*
* @warning Pipe 0 is also used by the writing pipe. So if you open
* pipe 0 for reading, and then startListening(), it will overwrite the
* writing pipe. Ergo, do an openWritingPipe() again before write().
*
* @todo Enforce the restriction that pipes 1-5 must share the top 32 bits
*
* @param number Which pipe# to open, 0-5.

0 comments on commit ca4820c

Please sign in to comment.