Diff: RF22Datagram.h

Revision:

5:0386600f3408

Parent:

0:79c6d0071c4c

--- a/RF22Datagram.h	Sun Feb 19 21:12:10 2012 +0000
+++ b/RF22Datagram.h	Sat Mar 02 20:49:07 2013 +0000
@@ -1,7 +1,7 @@
 // RF22Datagram.h
 // Author: Mike McCauley (mikem@open.com.au)
 // Copyright (C) 2011 Mike McCauley
-// $Id: RF22Datagram.h,v 1.3 2011/02/15 01:18:03 mikem Exp $
+// $Id: RF22Datagram.h,v 1.4 2012/05/30 01:50:21 mikem Exp $
 // ported to mbed by Karl Zweimueller
 
 #ifndef RF22Datagram_h
@@ -26,9 +26,9 @@
     /// 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)
-    RF22Datagram(uint8_t thisAddress ,PinName slaveSelectPin , PinName mosi, PinName miso, PinName sclk, PinName interrupt );
+    RF22Datagram(uint8_t thisAddress , PinName slaveSelectPin , PinName mosi, PinName miso, PinName sclk, PinName interrupt );
     
     /// Initialises this instance and the radio module connected to it.
     /// Overrides the init() function in RF22
@@ -46,7 +46,7 @@
     /// RF22_BROADCAST_ADDRESS is a valid address which will cause the message
     /// to be accepted by all RF22Datagram nodes within range.
     /// \param[in] buf Pointer to the binary message to send
-    /// \param[in] len Number of octets to send
+    /// \param[in] len Number of octets to send (> 0)
     /// \param[in] address The address to send the message to.
     /// \return true if the message was transmitted.
     boolean sendto(uint8_t* buf, uint8_t len, uint8_t address);