Getting Started

I've had quite a few people getting in contact asking for support with the initial setup and configuration of libxbee. As a result, I felt that it would be worthwhile writing this guide. libxbee is very straight forward, once you understand the principals involved.


  1. Is there anything I should know before I dive in?
  2. How do I get the source code?
  3. Can I download compiled binaries?
  4. How do I get it running on my OS?
  5. Which modules should I use?
  6. How should my modules be configured?
  7. Creating connections
  8. Using connections
  9. Advanced connections
  10. Running some samples

Other Resources

How do I get the Source Code?

libxbee is completely Open Source, and is licenced using the Lesser GPL v3 licence as of 9th March 2012 (commit 5ffc186).

The project is hosted on GitHub (here) and there is a Google Group (here).

The source can be acquired from a number of places, including Google Code and GitHub. Use one the following URLs to clone the Git repository:

  • GitHub: here
    • HTTPS:
    • SSH:
  • BitBucket: here
    • HTTPS: https://${USERNAME}
    • SSH:
  • Google Code: Google Code is no longer the recommended source for libxbee, as it is shutting down...

It is also possible to download an archive containing the latest source from GitHub: here