You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
92 lines
3.0 KiB
92 lines
3.0 KiB
14 years ago
|
.\" libxbee - a C library to aid the use of Digi's Series 1 XBee modules
|
||
|
|
.\" running in API mode (AP=2).
|
||
|
|
.\"
|
||
|
|
.\" Copyright (C) 2009 Attie Grande (attie@attie.co.uk)
|
||
|
|
.\"
|
||
|
|
.\" This program is free software: you can redistribute it and/or modify
|
||
|
|
.\" it under the terms of the GNU General Public License as published by
|
||
|
|
.\" the Free Software Foundation, either version 3 of the License, or
|
||
|
|
.\" (at your option) any later version.
|
||
|
|
.\"
|
||
|
|
.\" This program is distributed in the hope that it will be useful,
|
||
|
|
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
|
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
|
|
.\" GNU General Public License for more details.
|
||
|
|
.\"
|
||
|
|
.\" You should have received a copy of the GNU General Public License
|
||
|
|
.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||
|
|
.TH LIBXBEE 3 2009-11-01 "GNU" "Linux Programmer's Manual"
|
||
|
|
.SH NAME
|
||
|
|
libxbee
|
||
|
|
.SH DESCRIPTION
|
||
|
|
libxbee is a C library to aid the use of Series 1 Digi XBee radios running in API mode (AP=2).
|
||
|
|
.sp
|
||
|
|
I have tried to keep flexibility to a maximum.
|
||
|
|
By allowing connections to individual nodes to be created - you don't have to address each packet,
|
||
|
|
or filter through incomming packets to get at the one you are after. This is all taken care of
|
||
|
|
for you by
|
||
|
|
.BR libxbee
|
||
|
|
!
|
||
|
|
.sp
|
||
|
|
libxbee is still in development, so if you find any bugs or have any enhancement requests, please
|
||
|
|
feel free to submit an issue on the project page:
|
||
|
|
.in +4n
|
||
|
|
.nf
|
||
|
|
http://code.google.com/p/libxbee/
|
||
|
|
.fi
|
||
|
|
.in
|
||
|
|
or contact me (Attie) directly:
|
||
|
|
.in +4n
|
||
|
|
.nf
|
||
|
|
attie@attie.co.uk
|
||
|
|
.fi
|
||
|
|
.in
|
||
|
|
.SH "MAN PAGES"
|
||
|
|
Documentation is avaliable via the following man pages, or by example in the 'sample' folder in the SVN repository
|
||
|
|
.in +4n
|
||
|
|
.sp
|
||
|
|
.BR xbee_pkt "(3) - libxbee's packet structure"
|
||
|
|
.sp 0
|
||
|
|
.BR xbee_con "(3) - libxbee's connection structure"
|
||
|
|
.sp
|
||
|
|
.BR xbee_setup "(3) - function to setup libxbee (and its variants)"
|
||
|
|
.sp 0
|
||
|
|
.BR xbee_end "(3) - function to end the libxbee session and close any open handles"
|
||
|
|
.sp
|
||
|
|
.BR xbee_logit "(3) - function that allows the user to add to the xbee log output"
|
||
|
|
.sp
|
||
|
|
.BR xbee_newcon "(3) - function to create a new connection"
|
||
|
|
.sp 0
|
||
|
|
.BR xbee_purgecon "(3) - function to purge packets from a connection"
|
||
|
|
.sp 0
|
||
|
|
.BR xbee_endcon "(3) - function to end a connection"
|
||
|
|
.sp
|
||
|
|
.BR xbee_senddata "(3) - function to send data to a remote XBee (and its variants)"
|
||
|
|
.sp 0
|
||
|
|
.BR xbee_getpacket "(3) - function to get a packet from a connection (and its variants)"
|
||
|
|
.sp
|
||
|
|
.BR xbee_hasdigital "(3) - function to check if digital sample is in the packet"
|
||
|
|
.sp 0
|
||
|
|
.BR xbee_getdigital "(3) - function to get digital sample from the packet"
|
||
|
|
.sp
|
||
|
|
.BR xbee_hasanalog "(3) - function to check if analog sample is in the packet"
|
||
|
|
.sp 0
|
||
|
|
.BR xbee_getanalog "(3) - function to get the analog sample from the packet"
|
||
|
|
.fi
|
||
|
|
.in
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
.BR xbee_pkt (3),
|
||
|
|
.BR xbee_con (3),
|
||
|
|
.BR xbee_setup (3),
|
||
|
|
.BR xbee_end (3),
|
||
|
|
.BR xbee_logit (3),
|
||
|
|
.BR xbee_newcon (3),
|
||
|
|
.BR xbee_flushcon (3),
|
||
|
|
.BR xbee_endcon (3),
|
||
|
|
.BR xbee_senddata (3),
|
||
|
|
.BR xbee_getpacket (3),
|
||
|
|
.BR xbee_hasdigital (3),
|
||
|
|
.BR xbee_getdigital (3),
|
||
|
|
.BR xbee_hasanalog (3),
|
||
|
|
.BR xbee_getanalog (3)
|