THIS IS A TEST INSTANCE ONLY! REPOSITORIES CAN BE DELETED AT ANY TIME!

No Description
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.
Attie Grande 78da57ad45 Merge branch 'master' of github.com:attie/libxbee3 1 month ago
apps made it easier to invert the reset line in the net_term and pseudo_term sample apps 4 years ago
html fixed typo in xbee_init.3 2 years ago
include Fix constness in Con and Pkt classes 7 months ago
interface/java moved C++ interface & sample into root, and now builds libxbeep.so on linux 6 years ago
make added XBEE_FRAME_TIMEOUT_ENABLED to default configs 2 years ago
man fixed typo in xbee_init.3 2 years ago
manuals Merge branch 'master' into xbee6b 5 years ago
modes fixed xbee_sZB_createSourceRoute_tx_func()... 1 year ago
package Homepage updated to Github repo 3 years ago
sample fixed sample makefiles 2 years ago
xsys_darwin 'clean' compile for OSX 5 years ago
.gitignore updated .gitignore to include cscope.out 5 years ago
COPYING relicensed to LGPLv3 6 years ago
COPYING.LESSER relicensed to LGPLv3 6 years ago
COPYING.header relicensed to LGPLv3 6 years ago
HISTORY updated history 1 year ago
README Update project URL in README 7 months ago
conn.c implemented and used xbee_frameReturnID() 2 years ago
conn.h all project headers now use FILE_H guards, system headers use _FILE_H guards 2 years ago
error.c updated project description in all files 6 years ago
frame.c Implement stale frame timeout. 2 years ago
frame.h Implement stale frame timeout. 2 years ago
internal.h moved system headers into ./include/ so that they can be included from within the project using #include <file> 2 years ago
ll.c Fix constness in XBee class 7 months ago
ll.h Fix constness in XBee class 7 months ago
log.c fixed support for XBEE_DISABLE_LOGGING 3 years ago
log.h all project headers now use FILE_H guards, system headers use _FILE_H guards 2 years ago
makefile tidied up .PHONY declarations in build system 6 years ago
mode.c Fix constness in XBee class 7 months ago
mode.h all project headers now use FILE_H guards, system headers use _FILE_H guards 2 years ago
mutex.c updated project description in all files 6 years ago
mutex.h all project headers now use FILE_H guards, system headers use _FILE_H guards 2 years ago
net.c fixed XBEE_NO_NET_SERVER config option - no longer performs unnecessary actions without server functionality 2 years ago
net.h all project headers now use FILE_H guards, system headers use _FILE_H guards 2 years ago
net_callbacks.c fixed major bug in network server - conValidate() now works correctly 4 years ago
net_callbacks.h all project headers now use FILE_H guards, system headers use _FILE_H guards 2 years ago
net_handlers.c fixed a corner-case where timeouts occur prematurely if the packet transmission is delayed 5 years ago
net_handlers.h all project headers now use FILE_H guards, system headers use _FILE_H guards 2 years ago
net_io.c fixed XBEE_NO_NET_SERVER config option - no longer performs unnecessary actions without server functionality 2 years ago
net_io.h all project headers now use FILE_H guards, system headers use _FILE_H guards 2 years ago
pkt.c xbee_pktDataKeyGet() and friends now return XBEE_ENOTEXISTS instead of XBEE_EFAILED 5 years ago
pkt.h all project headers now use FILE_H guards, system headers use _FILE_H guards 2 years ago
prepare.c added XBEE_MANUAL_INIT and XBEE_MANUAL_FINI compile options 2 years ago
prepare.h all project headers now use FILE_H guards, system headers use _FILE_H guards 2 years ago
rx.c added apiIdentifier field to xbee_pkt struct 2 years ago
rx.h all project headers now use FILE_H guards, system headers use _FILE_H guards 2 years ago
thread.c single-core systems no longer suffer from delayed callback execution 3 years ago
thread.h all project headers now use FILE_H guards, system headers use _FILE_H guards 2 years ago
tx.c fixed support for XBEE_DISABLE_LOGGING 3 years ago
tx.h all project headers now use FILE_H guards, system headers use _FILE_H guards 2 years ago
ver.c updated project description in all files 6 years ago
xbee.c Fix constness in XBee class 7 months ago
xbee_int.h all project headers now use FILE_H guards, system headers use _FILE_H guards 2 years ago
xbeep.cpp Fix constness in Con and Pkt classes 7 months ago
xsys.c 'clean' compile for OSX 5 years ago
xsys.h all project headers now use FILE_H guards, system headers use _FILE_H guards 2 years ago
xsys_darwin.c fixed previous mods from FILE* to plain file descriptor 3 years ago
xsys_darwin.h all project headers now use FILE_H guards, system headers use _FILE_H guards 2 years ago
xsys_linux.c Default to O_CLOEXEC on for linux. 1 year ago
xsys_linux.h all project headers now use FILE_H guards, system headers use _FILE_H guards 2 years ago

README

Welcome to libxbee v3!

Please note that development for this this project is on going, and the use of
it is free, but please don't hold me responsible for any damage or injuries that
may occur.

Feel free to contact me directly with any queries, bugs, etc:
attie@attie.co.uk
Alternatively, feel free to file an 'issue' on the project site:
hhttps://github.com/attie/libxbee3/issues

####################
### PLEASE NOTE: ###
####################
Digi chose some rather unfortunate (re-)names for thier XBee modules.
To keep backwards compatibility, some modes are not named as intuitavely as
you might expect. Please see the information below to match your module
to the correct libxbee mode.

'xbee1' => XBee Series 1 (802.15.4 / no meshing)
http://goo.gl/10a45
http://sprkfn.com/p8665
http://doc.libxbee.attie.co.uk/images/xbee1.jpg
'xbee2' => XBee Series 2.5 (ZNet / DigiMesh) - formerly 'Series 2'
http://goo.gl/fQbkt
http://sprkfn.com/p8876
http://doc.libxbee.attie.co.uk/images/xbee2.jpg
'xbeeZB' => XBee Series 2 (ZigBee)
http://goo.gl/TJmeQ
http://sprkfn.com/p10414
http://doc.libxbee.attie.co.uk/images/xbeeZB.jpg
'xbee3' => XBee Series 3 (900 MHz)
http://goo.gl/Wdghyq
'xbee5' => XBee Series 5 (868 MHz)
http://goo.gl/66FZI
'xbee6b' => XBee Series 6B (WiFi)
http://goo.gl/gV9XwN


=== Licensing ===
libxbee v3 is licensed using LGPLv3 from v3.0.5 onwards. For more
information on what this means for you, please see COPYING and COPYING.LESSER.


=== Building ===
If you are building libxbee, then there are a number of options avaliable to you.
Initially you should run the following command:
$ make configure
This will retrieve a default 'config.mk' that is suitable for your system. You
should review this file and then run the following command:
$ make all

After the build process has completed, you should find suitable files in ./lib.
E.g: for a Unix-like OS you can expect to find .so and .a files
for Windows you can expect to find a .dll file

It is highly recommended that you don't modify any of the build system.

If you have any issues while building libxbee, please feel free to contact me,
or alternatively, you can file an 'issue' on the project site:
https://github.com/attie/libxbee3/issues


=== Installation ===
To install libxbee simply type (you will require root permissions):
$ sudo make install

This option is not avaliable on all systems (namely Windows).


=== Usage ===
Compile your applications, including "xbee.h" in the relevant source files.
Ensure you link with libxbee (e.g: using 'gcc -lxbee')

If you are compiling the object file directly into your executable instead
of making use of the library, you must include the following link flags. These
flags are also necessary for newer versions of Ubuntu, and possibly others.
-lpthread -lrt


=== Interfacing ===
I have provided the ability to interface with libxbee from a number of languages
other than 'C'. The source, and sample code for these interfaces can be found
in '/interfaces'. Currently the following languages are supported or in
development:
C++ (see /xbeep.cpp and /xbeep.h)
Java


=== Samples ===
I have proveded sample code in the ./sample directory. Hopefully this will help
get you up and running with libxbee. If you would like samples showing a different
aspect of libxbee, then please do not hesitate to get in contact, or file an
'issue' on the project site, and I will get to it ASAP:
https://github.com/attie/libxbee3/issues