Skip to content

Q
qgroundcontrol
Switch branch/tag
Find file
Normal viewHistoryPermalink
xbee_setup.3.html 3.42 KB
Newer Older
Franz's avatar
added libxbee library
258ce38a
 
Franz committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 
<HTML><HEAD><TITLE>Manpage of XBEE_SETUP</TITLE>
</HEAD><BODY>
<H1>XBEE_SETUP</H1>
Section: Linux Programmer's Manual (3)<BR>Updated: 2009-11-01<BR><A HREF="#index">Index</A>
<A HREF="../index.html">Return to Main Contents</A><HR>

<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>

xbee_setup
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>

<B>#include &lt;<A HREF="file:/usr/include/xbee.h">xbee.h</A>&gt;</B>

<P>
<B>int xbee_setup(char *</B><I>path</I><B>, int </B><I>baudrate</I><B>);</B>

<P>
<B>int xbee_setuplog(char *</B><I>path</I><B>, int </B><I>baudrate</I><B>, int </B><I>logfd</I><B>);</B>

<P>
<B>int xbee_setupAPI(char *</B><I>path</I><B>, char </B><I>cmdSeq</I><B>, int </B><I>cmdTime</I><B>);</B>

<P>
<B>int xbee_setuplogAPI(char *</B><I>path</I><B>, int </B><I>baudrate</I><B>, int </B><I>logfd</I><B>, char </B><I>cmdSeq</I><B>, int </B><I>cmdTime</I><B>);</B>


<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>

<P>
<B>A VERSION OF THIS FUNCTION MUST BE CALLED BEFORE ANY OTHER libxbee FUNCTION!</B>

The
<B>xbee_setup</B>()

function will setup libxbee so that it can handle an XBee.
It takes 2 arguments.
<P>
The argument
<I>path</I>

is the path to the serial port that the XBee is connected to (e.g. /dev/ttyUSB0).
<P>
The
<I>baudrate</I>

is the baud rate that the local XBee is configured to run at. The following are avaliable:

<PRE>
<B>1200</B>
<B>2400</B>
<B>4800</B>
<B>9600</B>
<B>19200</B>
<B>38400</B>
<B>57600</B>
<B>115200</B> - this is potentially unstable (read the XBee manual to find out why...)
</PRE>


<P>
Using
<B>xbee_setuplog</B>()

is exactly the same, but instead you give an open file descriptor. All log messages will be written to this file (you can use stderr or stdout if you want!).
<P>
Using
<B>xbee_setupAPI</B>()

is exactly the same, but instead you provide the 'Command Sequence' character and the 'Guard Time' that your local XBee has been configured with.
libxbee will then place your XBee in API mode 2, and when you call xbee_end() it will return your XBee to its previous API mode.
<P>
Using
<B>xbee_setuplogAPI</B>()

is simply a combination of
<B>xbee_setuplog</B>()

and
<B>xbee_setupAPI</B>()

<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>

If any error occures,
<B>-1</B>

is returned. Otherwise
<B>0</B>

is returned.
<A NAME="lbAF">&nbsp;</A>
<H2>EXAMPLE</H2>

To setup libxbee to use /dev/ttyUSB0 at 57600 baud:

<PRE>
#include &lt;<A HREF="file:/usr/include/xbee.h">xbee.h</A>&gt;
if (xbee_setup(&quot;/dev/ttyUSB0&quot;,57600) == -1) {
  printf(&quot;Oh no...);
  <A HREF="../man1/exit.1.html">exit</A>(1);
}
</PRE>


<A NAME="lbAG">&nbsp;</A>
<H2>AUTHOR</H2>

Attie Grande &lt;<A HREF="mailto:attie@attie.co.uk">attie@attie.co.uk</A>&gt; 
<A NAME="lbAH">&nbsp;</A>
<H2>SEE ALSO</H2>

<B><A HREF="../man3/libxbee.3.html">libxbee</A></B>(3),

<B><A HREF="../man3/xbee_newcon.3.html">xbee_newcon</A></B>(3),

<B><A HREF="../man3/xbee_getpacket.3.html">xbee_getpacket</A></B>(3),

<B><A HREF="../man3/xbee_senddata.3.html">xbee_senddata</A></B>(3)

<P>

<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT><A HREF="#lbAB">NAME</A><DD>
<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT><A HREF="#lbAE">RETURN VALUE</A><DD>
<DT><A HREF="#lbAF">EXAMPLE</A><DD>
<DT><A HREF="#lbAG">AUTHOR</A><DD>
<DT><A HREF="#lbAH">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:08:23 GMT, March 30, 2011
</BODY>
</HTML>