Skip to content
This repository
Browse code

Update README

  • Loading branch information...
commit 976b817cdd077d4818751d4aacc573d186aa0e85 1 parent 4f43062
authored

Showing 1 changed file with 5 additions and 28 deletions. Show diff stats Hide diff stats

  1. 33  README
33  README
... ...
@@ -1,28 +1,12 @@
1 1
 About:
2 2
 
3  
-The Xbee Network Protocol is designed to allow Xbee-enabled Arduino Megas (and eventually UNOs) to communicate 
4  
-with one another wirelessly (the versions used with XNP were Xbee Series 1 radios broadcasting at 2.4 GHz). 
5  
-In an XNP network, each Xbee radio is configured in a basic send/receive configuration with the same PAN IDs. 
6  
-When an Xbee is connected to an Arduino Mega using one of the SerialX ports (XNP defaults to Serial1, PINs 18 
7  
-and 19), XNP allows the Arduinos to communicate in real-time with other similarly-configured Arduino Megas. 
8  
-The XNP protocol allows any number of Xbee-enabled Megas to communicate with one-another and has three different 
9  
-modes of operation for different applications (Full Mesh Networking, Non-Mesh Networking, and Fast-and-Furious 
10  
-Networking). Each mode has strengths and weakness over the other depending on the application.
11  
-
12  
-You will need two Arduino Mega-2560's to run the Alpha-code, Two Adafruit Xbee radio adapter kits (or equivalent) 
13  
-and Two Series 1 Xbee Radios to get started. I provide a detailed instruction guide on how to setup an XNP router, 
14  
-and documentation that will help you to understand how it works. The sketch started with example code from Lady Ada's 
15  
-tutorials on Xbee and the Tweet-A-Week kit. The maximum number of XNP-enabled Xbee Arduino Megas that can successfully 
16  
-talk in the same room has not been confirmed, but so far I have had 5 working together on my desk with a 100% data 
17  
-transmission success rate.
  3
+The Xbee Network Protocol is designed to allow Xbee-enabled Arduino Megas (and eventually UNOs) to communicate with one another wirelessly (the versions used with XNP were Xbee Series 1 radios broadcasting at 2.4 GHz). In an XNP network, each Xbee radio is configured in a basic send/receive configuration with the same PAN IDs. When an Xbee is connected to an Arduino Mega using one of the SerialX ports (XNP defaults to Serial1, PINs 18 and 19), XNP allows the Arduinos to communicate in real-time with other similarly-configured Arduino Megas. The XNP protocol allows any number of Xbee-enabled Megas to communicate with one-another and has three different modes of operation for different applications (Full Mesh Networking, Non-Mesh Networking, and Fast-and-Furious Networking). Each mode has strengths and weakness over the other depending on the application.
  4
+
  5
+You will need two Arduino Mega-2560's to run the Alpha-code, Two Adafruit Xbee radio adapter kits (or equivalent) and Two Series 1 Xbee Radios to get started. I provide a detailed instruction guide on how to setup an XNP router, and documentation that will help you to understand how it works. The sketch started with example code from Lady Ada's tutorials on Xbee and the Tweet-A-Week kit. The maximum number of XNP-enabled Xbee Arduino Megas that can successfully talk in the same room has not been confirmed, but so far I have had 5 working together on my desk with a 100% data transmission success rate.
18 6
 
19 7
 Release:
20 8
 
21  
-This is the ALPHA-S code release for XNP, and should be stable for users trying it out. It still does not have
22  
-UNO compatibility yet, I'm going to start working on that now. All you have to do to get this up and running is 
23  
-paste the sketch into an Arduino window, set the IDENTITY = to some number (unique for each router) and load the 
24  
-sketch. You will see Hello World packets going back and forth from Router 2 to Router 1. :) The code is still 
25  
-Very un-optimized and needs alot of work yet, and I hope the community will help!
  9
+This is the ALPHA-S code release for XNP, and should be stable for users trying it out. It still does not have UNO compatibility yet, I'm going to start working on that now. All you have to do to get this up and running is paste the sketch into an Arduino window, set the IDENTITY = to some number (unique for each router) and load the sketch. You will see Hello World packets going back and forth from Router 2 to Router 1. :) The code is still Very un-optimized and needs alot of work yet, and I hope the community will help!
26 10
 
27 11
 Comments / Questions:
28 12
 
@@ -35,14 +19,7 @@ You will find all current documentation on the XNP website: http://sojournstudio
35 19
 
36 20
 Credits:
37 21
 
38  
-Lady Ada and her team at Adafruit Industries have been my greatest inspiration for this and my other RiderNet 
39  
-projects, and much credit goes to her for code examples, wonderful tutorials and fantastic support, all of which 
40  
-were critical to getting XNP and what I'm calling the "RiderX" projects up and running. The weekly Ask An Engineer 
41  
-webcast/show has provided me with weekly insights, answers to engineering questions and Huge motivation to continue 
42  
-forward. So where credit for XNP is concerned, I share that equally with Lady Ada and Adafruit Industries who 
43  
-provided me with the hardware, software and inspiration to write XNP.Len17 on the Adafruit Forums has already given
44  
-me a huge help in converting character strings into unsigned-long integers (Thanks Len!).
45  
-
  22
+Lady Ada and her team at Adafruit Industries have been my greatest inspiration for this and my other RiderNet projects, and much credit goes to her for code examples, wonderful tutorials and fantastic support, all of which were critical to getting XNP and what I'm calling the "RiderX" projects up and running. The weekly Ask An Engineer webcast/show has provided me with weekly insights, answers to engineering questions and Huge motivation to continue forward. So where credit for XNP is concerned, I share that equally with Lady Ada and Adafruit Industries who provided me with the hardware, software and inspiration to write XNP.Len17 on the Adafruit Forums has already givenme a huge help in converting character strings into unsigned-long integers (Thanks Len!).
46 23
 
47 24
 Cheers,
48 25
 

0 notes on commit 976b817

Please sign in to comment.
Something went wrong with that request. Please try again.