zigbee-znet25: XBee ZNet 2.5 (ZigBee) wireless modem communications

[ bsd3, library, network ] [ Propose Tags ] [ Report a vulnerability ]

A protocol library enabling wireless communications via XBee/XBee-PRO (ZibBee) ZNet 2.5 RF modules.

The library performs binary encoding/decoding, on-the-wire framing, and error checking of control and data API frames. In other words the library expects to communicate with an XBee modem that has AP parameter = 2, indicating API frames with HDLC-like escape characters. This mode provides for 8-bit transparent operation and is described in Section 6 of ftp://ftp1.digi.com/support/documentation/90000866_C.pdf.

The library code is 100% pure; nothing here depends on the IO monad and no particular modem device is assumed. The code depends on the cereal package for serialization but is otherwise pretty standard. The test suite is based on QuickCheck properties.


[Skip to Readme]

Flags

Automatic Flags
NameDescriptionDefault
developer

Build in developer mode

Disabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1, 0.1.1.0
Dependencies base (>=4 && <5), bytestring, cereal, MissingH, mtl, transformers [details]
Tested with ghc ==7.0.4
License BSD-3-Clause
Copyright Copyright (c) 2012 David Joyner
Author David Joyner <david@joynerhome.net>
Maintainer David Joyner <david@joynerhome.net>
Category Network
Home page https://github.com/djoyner/zigbee-znet25
Bug tracker https://github.com/djoyner/zigbee-znet25/issues
Source repo head: git clone git://github.com/djoyner/zigbee-znet25
Uploaded by DavidJoyner at 2012-08-02T00:01:22Z
Distributions
Reverse Dependencies 1 direct, 0 indirect [details]
Downloads 1701 total (2 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]

Readme for zigbee-znet25-0.1.1.0

[back to package description]

Overview

This is a Haskell protocol library enabling wireless communications via XBee/XBee-PRO (ZigBee) ZNet 2.5 RF modules.

The library performs binary encoding/decoding, on-the-wire framing, and error checking of control and data "API" frames. In other words the library expects to communicate with an XBee modem that has AP parameter = 2, indicating API frames with HDLC-like escape characters. This mode provides for 8-bit transparent operation and is described in Section 6 of the [XBee ZNet 2.5 Product Manual] (ftp://ftp1.digi.com/support/documentation/90000866_C.pdf).

The library code is 100% pure; nothing here depends on the IO monad and no particular modem device is assumed. The code depends on the cereal package for serialization but is otherwise pretty standard. The test suite is based on QuickCheck properties.

Getting Started

Install with cabal:

  • cabal install zigbee-znet25

Or clone the master git repository:

  • git clone git://github.com/djoyner/zigbee-znet25.git

A sample program is included. I've also used the library to communicate with an Arduino-based temperature and power-usage probe.

Author and Maintainer

David Joyner, david@joynerhome.net