use xbee module from aversive

[protos/xbee-avr.git] / notes.txt

diff --git a/notes.txt b/notes.txt
index f8c697a..260ad08 100644 (file)
--- a/notes.txt
+++ b/notes.txt
@@ -159,3 +159,20 @@ Rules
 
 Calling a xbee function needs to set prio to XBEE_PRIO only.
 Calling i2c_send_command must be done from a lower prio than I2C_PRIO.
+
+libxbee / xbee module
+=====================
+
+Library
+-------
+
+xbee_dev = structure describing an xbee device
+xbee_channel = structure describing a channel, used to associates a req
+  with its answer
+
+xbee.[ch]: main interface to libxbee, creation of dev, registeration of channels
+xbee_atcmd.[ch]: get an AT command from its name or small id string
+xbee_buf.[ch]: not used
+xbee_neighbor.[ch]: helper to add/delete neighbors, use malloc()/free()
+xbee_rxtx.[ch]: parse rx frames, provides xbee_proto_xmit()
+xbee_stats.[ch]: helper to maintain stats