Diff: RF22ReliableDatagram.h

Revision:

5:0386600f3408

Parent:

0:79c6d0071c4c

--- a/RF22ReliableDatagram.h	Sun Feb 19 21:12:10 2012 +0000
+++ b/RF22ReliableDatagram.h	Sat Mar 02 20:49:07 2013 +0000
@@ -2,7 +2,7 @@
 //
 // Author: Mike McCauley (mikem@open.com.au)
 // Copyright (C) 2011 Mike McCauley
-// $Id: RF22ReliableDatagram.h,v 1.6 2011/02/15 01:18:03 mikem Exp $
+// $Id: RF22ReliableDatagram.h,v 1.7 2012/05/30 01:51:25 mikem Exp $
 // ported to mbed by Karl Zweimueller
 
 #ifndef RF22ReliableDatagram_h
@@ -45,7 +45,7 @@
     /// Constructor. 
     /// \param[in] thisAddress The address to assign to this node. Defaults to 0
     /// \param[in] slaveSelectPin the Arduino pin number of the output to use to select the RF22 before
-    /// accessing it
+    /// accessing it. Defaults to the normal SS pin for your Arduino (D10 for Diecimila, Uno etc, D53 for Mega)
     /// \param[in] interrupt The interrupt number to use. Default is interrupt 0 (Arduino input pin 2)
     RF22ReliableDatagram(uint8_t thisAddress ,PinName slaveSelectPin , PinName mosi, PinName miso, PinName sclk, PinName interrupt );
 
@@ -53,7 +53,8 @@
     /// longer than this time (in milliseconds), 
     /// it will retransmit the message. Defaults to 200ms. The timeout is measured from the end of
     /// transmission of the message. It must be at least longer than the the transmit 
-    /// time of the acknowledgement (6 octets) plus the latency/poll time of the receiver. 
+    /// time of the acknowledgement (preamble+6 octets) plus the latency/poll time of the receiver. 
+    /// For fast modulation schemes you can considerably shorten this time.
     /// The actual timeout is randomly varied between timeout and timeout*2.
     /// \param[in] timeout The new timeout period in milliseconds
     void setTimeout(uint16_t timeout);
@@ -148,4 +149,3 @@
 };
 
 #endif
-