Dominic Ottaviano / XBEE_900HP_SPI

This is an experimental driver for the XBee 900 HP pro module's SPI connection. This driver is unfinished and stability is not guaranteed. Use with caution.

Dependents:   Sentinel_BASE Sentinel_NODE

Diff: xbee900hp.h

Revision:
13:273adaa03a61
Parent:
12:7b29ddc34cc1
Child:
14:55631bb4aa44
diff -r 7b29ddc34cc1 -r 273adaa03a61 xbee900hp.h
--- a/xbee900hp.h	Wed Apr 27 05:38:38 2016 +0000
+++ b/xbee900hp.h	Wed Apr 27 05:41:13 2016 +0000
@@ -13,12 +13,13 @@
     /**
     * Initialize the xBee Module
     *
-    * pin_mosi -> mbed SPI MOSI pin
-    * pin_miso -> mbed SPI MISO pin
-    * pin_sck  -> mbed SPI SCK pin
-    * pin_attn -> Signals that some message from the XBee module is available
-    * pin_rst  -> Resets the XBee module
-    * freq     -> sets the SPI clock frequency. The XBee has a maximum SPI clock rate of 3.5 MHz.
+    * @params 
+    *   pin_mosi -> mbed SPI MOSI pin
+    *   pin_miso -> mbed SPI MISO pin
+    *   pin_sck  -> mbed SPI SCK pin
+    *   pin_attn -> Signals that some message from the XBee module is available
+    *   pin_rst  -> Resets the XBee module
+    *   freq     -> sets the SPI clock frequency. The XBee has a maximum SPI clock rate of 3.5 MHz.
     */
     xbee900hp(PinName pin_mosi,PinName pin_miso,PinName pin_sck,PinName pin_attn, PinName pin_rst, unsigned int freq);