The mercury-api package

[Tags:library, mit, program, test]

This package is a Haskell binding to the "Mercury API" C API for ThingMagic RFID readers. It is especially geared toward the SparkFun Simultaneous RFID Reader, which uses ThingMagic's M6e Nano module, but it should work with other ThingMagic readers. (Though currently, only support for serial readers is compiled in.) Most of the function and type names are the same as their counterparts in the C API, with the TMR_ prefix dropped. For more in-depth, language-independent documentation of Mercury API, see Mercury API Programmers Guide.


[Skip to Readme]

Properties

Versions 0.1.0.0, 0.1.0.1
Change log ChangeLog.md
Dependencies ansi-terminal (>=0.6.2.3 && <0.7), base (>=4.6 && <5), bytestring (>=0.10.4 && <0.11), clock (>=0.7.2 && <0.8), hashable (>=1.2.4 && <1.3), mercury-api, optparse-applicative (>=0.13 && <0.15), text (==1.2.*), unordered-containers (>=0.2.7.1 && <0.3) [details]
License MIT
Copyright © Patrick Pelletier, 2017
Author Patrick Pelletier
Maintainer code@funwithsoftware.org
Category Hardware
Home page https://github.com/ppelleti/hs-mercury-api
Bug tracker https://github.com/ppelleti/hs-mercury-api/issues
Source repository head: git clone https://github.com/ppelleti/hs-mercury-api.git
Uploaded Mon Jun 12 00:03:45 UTC 2017 by ppelleti
Distributions NixOS:0.1.0.1
Downloads 75 total (75 in the last 30 days)
Votes
0 []
Status Docs available [build log]
Last success reported on 2017-06-12 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for mercury-api

Readme for mercury-api-0.1.0.1

Latest: Hackage Linux: Build Status Windows: Build status

This package is a Haskell binding to the Mercury API C API for ThingMagic RFID readers. It is especially geared toward the SparkFun Simultaneous RFID Reader, which uses ThingMagic's M6e Nano module, but it should work with other ThingMagic readers. (Though currently, only support for serial readers is compiled in.) Most of the function and type names are the same as their counterparts in the C API, with the TMR_ prefix dropped. For more in-depth, language-independent documentation of Mercury API, see Mercury API Programmers Guide.

This package includes a copy of the Mercury API C library, so no external libraries are necessary. Several small bug fixes have been applied to the included version of the library. (I have submitted these patches upstream, but I don't know if or when they will be included in the official version.) If you need to upgrade to a newer version of Mercury API than the included one, see UPGRADING.md.

The Haskell binding doesn't support background reads. I recommend that you just spawn a new Haskell thread and do foreground reads instead.

Currently, only support for the serial reader is compiled in, but it probably wouldn't be too hard to enable LLRP support. (I don't have any way to test LLRP, however, as the M6e Nano doesn't support it.)

On Mac OS X, be sure to use the serial device that starts with /dev/cu., not the serial device that starts with /dev/tty..

On Windows, you can type wmic path Win32_SerialPort to list the available COM ports.

Only some parameters and some tagops are currently supported in the Haskell binding. (There are a lot of them, and I only implemented the ones I needed.) If you need support for additional parameters or tagops, please file an issue in GitHub and I will add them.

I have tested this package on Linux, Mac OS X, and Windows, using the SparkFun board.

Here is a minimal example which reads tags at maximum power for 1 second, and then prints the results:

{-# LANGUAGE OverloadedStrings #-}

import qualified Data.Text.IO as T
import qualified System.Hardware.MercuryApi as TMR
import qualified System.Hardware.MercuryApi.Params as TMR

main = do
  rdr <- TMR.create "tmr:///dev/ttyUSB0"
  TMR.paramSetTransportTimeout rdr 10000
  TMR.connect rdr
  TMR.paramSetBasics rdr TMR.REGION_NA2 2700 TMR.sparkFunAntennas
  tags <- TMR.read rdr 1000
  putStrLn $ "read " ++ show (length tags) ++ " tags"
  mapM_ T.putStrLn $ concatMap TMR.displayTagReadData tags
  TMR.destroy rdr

Additional examples are available in the examples directory.

Additional resources:

Mercury API in other languages: