SoftwareSerial support from Paul Stoffregen

andrew.rapp · andrew.rapp · commit fd5e924d8162 · 2012-10-16T03:33:26.000Z
git-svn-id: https://xbee-arduino.googlecode.com/svn/trunk@45 42c8444e-1c8e-11de-a108-cd2f117ce590
diff --git a/XBee.cpp b/XBee.cpp
@@ -781,11 +781,12 @@ uint8_t XBee::getNextFrameId() {
 	return _nextFrameId;
 }
 
-void XBee::begin(long baud) {
-	_serial->begin(baud);
+// Support for SoftwareSerial. Contributed by Paul Stoffregen
+void XBee::begin(Stream &serial) {
+	_serial = &serial;
 }
 
-void XBee::setSerial(HardwareSerial &serial) {
+void XBee::setSerial(Stream &serial) {
 	_serial = &serial;
 }
 
diff --git a/XBee.h b/XBee.h
@@ -699,9 +699,9 @@ class XBee {
 	 */
 	void readPacketUntilAvailable();
 	/**
-	 * Starts the serial connection at the supplied baud rate
+	 * Starts the serial connection on the specified serial port
 	 */
-	void begin(long baud);
+	void begin(Stream &serial);
 	void getResponse(XBeeResponse &response);
 	/**
 	 * Returns a reference to the current response
@@ -720,7 +720,7 @@ class XBee {
 	/**
 	 * Specify the serial port.  Only relevant for Arduinos that support multiple serial ports (e.g. Mega)
 	 */
-	void setSerial(HardwareSerial &serial);
+	void setSerial(Stream &serial);
 private:
 	bool available();
 	uint8_t read();
@@ -738,7 +738,7 @@ class XBee {
 	uint8_t _nextFrameId;
 	// buffer for incoming RX packets.  holds only the api specific frame data, starting after the api id byte and prior to checksum
 	uint8_t _responseFrameData[MAX_FRAME_DATA_SIZE];
-	HardwareSerial* _serial;
+	Stream* _serial;
 };
 
 /**
diff --git a/build.xml b/build.xml
@@ -2,7 +2,7 @@
 <project default="dist" name="XBee-Arduino">
 	<property file="build.properties"/>
 	<property name="dist.dir" value="dist"/>
-	<property name="release" value="0.2.1"/>
+	<property name="release" value="0.4-softserial-beta"/>
 	
 	<target name="init">
 		<mkdir dir="${dist.dir}/XBee"/>
@@ -16,6 +16,7 @@
 			<fileset dir=".">
 				<include name="XBee.h"/>
 				<include name="XBee.cpp"/>
+				<include name="keywords.txt"/>
 				<include name="COPYING"/>
 			</fileset>
 		</copy>
@@ -27,7 +28,8 @@
 				<exclude name=".DS_Store"/>
 			</fileset>
 		</copy>
-				
+				
+
 		<zip basedir="${dist.dir}" destfile="xbee-arduino-${release}.zip"/>
 	</target>
 	
diff --git a/examples/AtCommand/AtCommand.pde b/examples/AtCommand/AtCommand.pde
@@ -18,25 +18,24 @@
  */
 
 #include <XBee.h>
-#include <NewSoftSerial.h>
+#include <SoftwareSerial.h>
 
 /*
 This example is for Series 1 (10C8 or later firmware) or Series 2 XBee radios
 Sends a few AT command queries to the radio and checks the status response for success
 
-This example uses the NewSoftSerial library to view the XBee communication.  I am using a 
+This example uses the SoftSerial library to view the XBee communication.  I am using a 
 Modern Device USB BUB board (http://moderndevice.com/connect) and viewing the output
-with the Arduino Serial Monitor.    
-You can obtain the NewSoftSerial library here http://arduiniana.org/libraries/NewSoftSerial/
+with the Arduino Serial Monitor.
 */
 
-// Define NewSoftSerial TX/RX pins
-// Connect Arduino pin 9 to TX of usb-serial device
-uint8_t ssRX = 9;
-// Connect Arduino pin 10 to RX of usb-serial device
-uint8_t ssTX = 10;
+// Define SoftSerial TX/RX pins
+// Connect Arduino pin 8 to TX of usb-serial device
+uint8_t ssRX = 8;
+// Connect Arduino pin 9 to RX of usb-serial device
+uint8_t ssTX = 9;
 // Remember to connect all devices to a common Ground: XBee, Arduino and USB-Serial device
-NewSoftSerial nss(ssRX, ssTX);
+SoftwareSerial nss(ssRX, ssTX);
 
 XBee xbee = XBee();
 
@@ -52,7 +51,8 @@ AtCommandRequest atRequest = AtCommandRequest(shCmd);
 AtCommandResponse atResponse = AtCommandResponse();
 
 void setup() { 
-  xbee.begin(9600);
+  Serial.begin(9600);
+  xbee.begin(Serial);
   // start soft serial
   nss.begin(9600);
   
diff --git a/examples/RemoteAtCommand/RemoteAtCommand.pde b/examples/RemoteAtCommand/RemoteAtCommand.pde
@@ -18,25 +18,24 @@
  */
 
 #include <XBee.h>
-#include <NewSoftSerial.h>
+#include <SoftwareSerial.h>
 
 /*
 This example is for Series 1 (10C8 or later firmware) or Series 2 XBee
 Sends two Remote AT commands to configure the remote radio for I/O line monitoring
 
-This example uses the NewSoftSerial library to view the XBee communication.  I am using a 
+This example uses the SoftSerial library to view the XBee communication.  I am using a 
 Modern Device USB BUB board (http://moderndevice.com/connect) and viewing the output
-with the Arduino Serial Monitor.    
-You can obtain the NewSoftSerial library here http://arduiniana.org/libraries/NewSoftSerial/
+with the Arduino Serial Monitor.
 */
 
-// Define NewSoftSerial TX/RX pins
-// Connect Arduino pin 9 to TX of usb-serial device
-uint8_t ssRX = 9;
-// Connect Arduino pin 10 to RX of usb-serial device
-uint8_t ssTX = 10;
+// Define SoftSerial TX/RX pins
+// Connect Arduino pin 8 to TX of usb-serial device
+uint8_t ssRX = 8;
+// Connect Arduino pin 9 to RX of usb-serial device
+uint8_t ssTX = 9;
 // Remember to connect all devices to a common Ground: XBee, Arduino and USB-Serial device
-NewSoftSerial nss(ssRX, ssTX);
+SoftwareSerial nss(ssRX, ssTX);
 
 XBee xbee = XBee();
 
@@ -58,7 +57,8 @@ RemoteAtCommandRequest remoteAtRequest = RemoteAtCommandRequest(remoteAddress, i
 RemoteAtCommandResponse remoteAtResponse = RemoteAtCommandResponse();
 
 void setup() { 
-  xbee.begin(9600);
+  Serial.begin(9600);
+  xbee.begin(Serial);
   // start soft serial
   nss.begin(9600);
   
diff --git a/examples/Series1_IoSamples/Series1_IoSamples.pde b/examples/Series1_IoSamples/Series1_IoSamples.pde
@@ -18,27 +18,26 @@
  */
 
 #include <XBee.h>
-#include <NewSoftSerial.h>
+#include <SoftwareSerial.h>
 
 /*
 This example is for Series 1 XBee Radios only
 Receives I/O samples from a remote radio with 16-bit addressing.
 The remote radio must have IR > 0, at least one digital or analog input enabled
 and DL set to the 16-bit address of the receiving XBee (the one connected to the Arduino).
  
-This example uses the NewSoftSerial library to view the XBee communication.  I am using a 
+This example uses the SoftSerial library to view the XBee communication.  I am using a 
 Modern Device USB BUB board (http://moderndevice.com/connect) and viewing the output
 with the Arduino Serial Monitor.    
-You can obtain the NewSoftSerial library here http://arduiniana.org/libraries/NewSoftSerial/
 */
 
 // Define NewSoftSerial TX/RX pins
-// Connect Arduino pin 9 to TX of usb-serial device
-uint8_t ssRX = 9;
-// Connect Arduino pin 10 to RX of usb-serial device
-uint8_t ssTX = 10;
+// Connect Arduino pin 8 to TX of usb-serial device
+uint8_t ssRX = 8;
+// Connect Arduino pin 9 to RX of usb-serial device
+uint8_t ssTX = 9;
 // Remember to connect all devices to a common Ground: XBee, Arduino and USB-Serial device
-NewSoftSerial nss(ssRX, ssTX);
+SoftwareSerial nss(ssRX, ssTX);
 
 XBee xbee = XBee();
 
@@ -47,7 +46,8 @@ Rx16IoSampleResponse ioSample = Rx16IoSampleResponse();
 //Rx64IoSampleResponse ioSample = Rx64IoSampleResponse();
 
 void setup() { 
-  xbee.begin(9600);
+  Serial.begin(9600);
+  xbee.setSerial(Serial);
   // start soft serial
   nss.begin(9600);
 }
diff --git a/examples/Series1_Rx/Series1_Rx.pde b/examples/Series1_Rx/Series1_Rx.pde
@@ -18,7 +18,6 @@
  */
 
 #include <XBee.h>
-#include <NewSoftSerial.h>
 
 /*
 This example is for Series 1 XBee (802.15.4)
@@ -58,7 +57,8 @@ void setup() {
   pinMode(dataLed,  OUTPUT);
   
   // start serial
-  xbee.begin(9600);
+  Serial.begin(9600);
+  xbee.setSerial(Serial);
   
   flashLed(statusLed, 3, 50);
 }
diff --git a/examples/Series1_Tx/Series1_Tx.pde b/examples/Series1_Tx/Series1_Tx.pde
@@ -18,7 +18,6 @@
  */
  
 #include <XBee.h>
-#include <NewSoftSerial.h>
 
 /*
 This example is for Series 1 XBee
@@ -66,8 +65,8 @@ void flashLed(int pin, int times, int wait) {
 void setup() {
   pinMode(statusLed, OUTPUT);
   pinMode(errorLed, OUTPUT);
-  
-  xbee.begin(9600);
+  Serial.begin(9600);
+  xbee.setSerial(Serial);
 }
 
 void loop() {
diff --git a/examples/Series2_IoSamples/Series2_IoSamples.pde b/examples/Series2_IoSamples/Series2_IoSamples.pde
@@ -18,27 +18,26 @@
  */
 
 #include <XBee.h>
-#include <NewSoftSerial.h>
+#include <SoftwareSerial.h>
 
 /*
 This example is for Series 2 (ZigBee) XBee Radios only
 Receives I/O samples from a remote radio.
 The remote radio must have IR > 0 and at least one digital or analog input enabled.
 The XBee coordinator should be connected to the Arduino.
  
-This example uses the NewSoftSerial library to view the XBee communication.  I am using a 
+This example uses the SoftSerial library to view the XBee communication.  I am using a 
 Modern Device USB BUB board (http://moderndevice.com/connect) and viewing the output
-with the Arduino Serial Monitor.    
-You can obtain the NewSoftSerial library here http://arduiniana.org/libraries/NewSoftSerial/
+with the Arduino Serial Monitor.
 */
 
 // Define NewSoftSerial TX/RX pins
-// Connect Arduino pin 9 to TX of usb-serial device
-uint8_t ssRX = 9;
-// Connect Arduino pin 10 to RX of usb-serial device
-uint8_t ssTX = 10;
+// Connect Arduino pin 8 to TX of usb-serial device
+uint8_t ssRX = 8;
+// Connect Arduino pin 9 to RX of usb-serial device
+uint8_t ssTX = 9;
 // Remember to connect all devices to a common Ground: XBee, Arduino and USB-Serial device
-NewSoftSerial nss(ssRX, ssTX);
+SoftwareSerial nss(ssRX, ssTX);
 
 XBee xbee = XBee();
 
@@ -47,7 +46,8 @@ ZBRxIoSampleResponse ioSample = ZBRxIoSampleResponse();
 XBeeAddress64 test = XBeeAddress64();
 
 void setup() { 
-  xbee.begin(9600);
+  Serial.begin(9600);
+  xbee.setSerial(Serial);
   // start soft serial
   nss.begin(9600);
 }
diff --git a/examples/Series2_Rx/Series2_Rx.pde b/examples/Series2_Rx/Series2_Rx.pde
@@ -18,7 +18,6 @@
  */
  
 #include <XBee.h>
-#include <NewSoftSerial.h>
 
 /*
 This example is for Series 2 XBee
@@ -55,7 +54,8 @@ void setup() {
   pinMode(dataLed,  OUTPUT);
   
   // start serial
-  xbee.begin(9600);
+  Serial.begin(9600);
+  xbee.begin(Serial);
   
   flashLed(statusLed, 3, 50);
 }
diff --git a/examples/Series2_Sleep/Series2_Sleep.pde b/examples/Series2_Sleep/Series2_Sleep.pde
@@ -18,7 +18,7 @@
  */
 
 #include <XBee.h>
-#include <NewSoftSerial.h>
+#include <SoftwareSerial.h>
 
 /*
 This example is for Series 2 (ZigBee) XBee Radios only, though Series 1 also support sleep mode.
@@ -29,7 +29,7 @@ The end device sleep mode must be set to 1 (SM=1), to enable pin sleep.
 Set SP=AF0 (28 seconds) on the coordinator.  This will instruct the coordinator to buffer any packets, for up to 28 seconds,
 while the end device is sleeping.  When the end device wakes, it will poll the coordinator and receive the packet.
 
-Note: I'm using the NewSoftSerial library to communicate with the Arduino since the Arduino's Serial is being used by the XBee
+Note: I'm using the SoftSerial library to communicate with the Arduino since the Arduino's Serial is being used by the XBee
 
 How it works:
 When you send a "1", the Arduino will sleep the XBee.
@@ -43,9 +43,6 @@ end device receives the packet when it wakes from sleep.
 Remember to connect all devices to a common Ground: XBee, Arduino and USB-Serial device
 */
 
-// TODO: monitor XBee current consumption while sleeping
-// TODO: send packets while sleeping
-
 // create the XBee object
 XBee xbee = XBee();
 
@@ -58,24 +55,25 @@ ZBTxRequest zbTx = ZBTxRequest(addr64, payload, sizeof(payload));
 ZBTxStatusResponse txStatus = ZBTxStatusResponse();
 ZBRxResponse rx = ZBRxResponse();
 
-// note: xbee sleep pin doesn't need 3.3. to sleep -- open circuit also will sleep it, but of course needs 0V to wake!
-// connect Arduino digital 8 to XBee sleep pin (9) through a voltage divider.  I'm using 10K resistors. 
-uint8_t sleepPin = 8;
+// note: xbee sleep pin doesn't need 3.3. to sleep -- open circuit also will sleep it, but of course it needs 0V to wake!
+// connect Arduino digital 7 to XBee sleep pin (9) through a voltage divider.  I'm using a 10K resistor. 
+uint8_t sleepPin = 7;
 
-// SoftSerial RX: connect Arduino digitial 9 to the TX of of usb-serial device.  note: I'm using Modern Device's USB BUB (set to 5V).  You can use a 3.3V usb-serial with a voltage divider on RX (TX does not require since Arduino is 3.3V tolerant)
-uint8_t ssRX = 9;
-// SoftSerial TX: connect Arduino digital 10 to RX of usb-serial device
-uint8_t ssTX = 10;
+// SoftSerial RX: connect Arduino digitial 8 to the TX of of usb-serial device.  note: I'm using Modern Device's USB BUB (set to 5V).  You can use a 3.3V usb-serial with a voltage divider on RX (TX does not require since Arduino is 3.3V tolerant)
+uint8_t ssRX = 8;
+// SoftSerial TX: connect Arduino digital 9 to RX of usb-serial device
+uint8_t ssTX = 9;
 
-NewSoftSerial nss(ssRX, ssTX);
+SoftwareSerial nss(ssRX, ssTX);
 
 void setup() {
   pinMode(sleepPin, OUTPUT);
   // set to LOW (wake)
   digitalWrite(sleepPin, LOW);
   
   // start XBee communication
-  xbee.begin(9600);
+  Serial.begin(9600);
+  xbee.setSerial(Serial);
   // start soft serial
   nss.begin(9600);
 }
diff --git a/examples/Series2_Tx/Series2_Tx.pde b/examples/Series2_Tx/Series2_Tx.pde
@@ -18,7 +18,6 @@
  */
 
 #include <XBee.h>
-#include <NewSoftSerial.h>
 
 /*
 This example is for Series 2 XBee
@@ -57,7 +56,8 @@ void setup() {
   pinMode(statusLed, OUTPUT);
   pinMode(errorLed, OUTPUT);
 
-  xbee.begin(9600);
+  Serial.begin(9600);
+  xbee.setSerial(Serial);
 }
 
 void loop() {   
diff --git a/keywords.txt b/keywords.txt

Original file line number	Diff line number	Diff line change
`@@ -781,11 +781,12 @@ uint8_t XBee::getNextFrameId() {`
`781`	`781`	`return _nextFrameId;`
`782`	`782`	`}`
`783`	`783`
`784`		`-void XBee::begin(long baud) {`
`785`		`- _serial->begin(baud);`
	`784`	`+// Support for SoftwareSerial. Contributed by Paul Stoffregen`
	`785`	`+void XBee::begin(Stream &serial) {`
	`786`	`+ _serial = &serial;`
`786`	`787`	`}`
`787`	`788`
`788`		`-void XBee::setSerial(HardwareSerial &serial) {`
	`789`	`+void XBee::setSerial(Stream &serial) {`
`789`	`790`	`_serial = &serial;`
`790`	`791`	`}`
`791`	`792`