System.Hardware.MercuryApi

This module 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 module is intended to be imported qualified, e. g.

import qualified System.Hardware.MercuryApi as TMR

Reader

create

Arguments

:: Text

a reader URI, such as tmr:///dev/ttyUSB0 on Linux, tmr:///dev/cu.SLAB_USBtoUART on Mac OS X, or tmr:///COM4 on Windows.

-> IO Reader

Create a new Reader with the specified URI. The reader is not contacted at this point. On Mac OS X, be sure to use the serial device that starts with cu., not the one that starts with tty..

connect :: Reader -> IO ()

Establishes the connection to the reader at the URI specified in the create call. The existence of a reader at the address is verified and the reader is brought into a state appropriate for performing RF operations.

read

Arguments

:: Reader

The reader being operated on

-> Word32

The number of milliseconds to search for tags

-> IO [TagReadData]

Search for tags for a fixed duration. Follows the ReadPlan stored in PARAM_READ_PLAN.

executeTagOp :: Reader -> TagOp -> Maybe TagFilter -> IO ByteString

Directly executes a TagOp command. Operates on the first tag found, with applicable tag filtering. The call returns immediately after finding one tag and operating on it, unless the command timeout expires first. The operation is performed on the antenna specified in the PARAM_TAGOP_ANTENNA parameter. PARAM_TAGOP_PROTOCOL specifies the protocol to be used. Some TagOps return data, while others will just return an empty ByteString.

reboot :: Reader -> IO ()

Reboot the reader

destroy :: Reader -> IO ()

Closes the connection to the reader and releases any resources that have been consumed by the reader structure. Any further operations performed on the reader will fail with ERROR_ALREADY_DESTROYED. On finalization of the Reader, destroy will be called automatically if it has not already been called.

withReader

Arguments

:: Text

a reader URI, such as tmr:///dev/ttyUSB0 on Linux, tmr:///dev/cu.SLAB_USBtoUART on Mac OS X, or tmr:///COM4 on Windows.

-> (Reader -> IO a)

computation to run with Reader

-> IO a

Create a new Reader with the specified URI, pass it to the given computation, and destroy it when the computation exits.

Parameters

Although paramGet and paramSet are very flexible, they only check that the parameter type is correct at runtime. You may prefer to use the functions in System.Hardware.MercuryApi.Params, which ensure the correct type at compile time.

paramList :: Reader -> IO [Param]

Get a list of parameters supported by the reader.

paramGet :: ParamValue a => Reader -> Param -> IO a

Gets the value of a reader parameter. Throws MercuryException with a meStatus of ERROR_INVALID_PARAM_TYPE if the parameter value is not of the correct type (sadly, this is only checked at runtime) or ERROR_UNIMPLEMENTED_PARAM if the parameter has not yet been implemented in the Haskell binding. Can also propagate errors from the C API, such as ERROR_UNSUPPORTED.

paramSet :: ParamValue a => Reader -> Param -> a -> IO ()

Sets the value of a reader parameter. Throws MercuryException with a meStatus of ERROR_INVALID_PARAM_TYPE if the parameter value is not of the correct type (sadly, this is only checked at runtime) or ERROR_UNIMPLEMENTED_PARAM if the parameter has not yet been implemented in the Haskell binding. Can also propagate errors from the C API, such as ERROR_UNSUPPORTED or ERROR_READONLY.

paramSetBasics

Arguments

:: Reader

The reader being operated on

-> Region

The region

-> Int32

Power in centi-dBm

-> [AntennaPort]

Antenna list

-> IO ()

Convenience function to set some of the most essential parameters. The specified Region is written into PARAM_REGION_ID. The specified power level is written into PARAM_RADIO_READPOWER and PARAM_RADIO_WRITEPOWER. The specified antenna list is written into the rpAntennas field of PARAM_READ_PLAN, and the first antenna in the list is written into PARAM_TAGOP_ANTENNA. For the SparkFun Simultaneous RFID Reader, the antenna list should be sparkFunAntennas, and if powering the reader off USB, the power level should be 500 (5 dBm). (Higher power levels can be used with a separate power supply.)

paramSetReadPlanFilter :: Reader -> Maybe TagFilter -> IO ()

Sets the rpFilter field of the PARAM_READ_PLAN parameter, while leaving the rest of the read plan unchanged.

paramSetReadPlanTagop :: Reader -> Maybe TagOp -> IO ()

Sets the rpTagop field of the PARAM_READ_PLAN parameter, while leaving the rest of the read plan unchanged.

Listeners

Transport listeners can be used to monitor the raw serial data going to and from the reader, for debugging purposes. A listener that prints the data to a Handle is available from hexListener or opcodeListener.

addTransportListener

Arguments

:: Reader

The reader to operate on.

-> TransportListener

The listener to call.

-> IO TransportListenerId

A unique identifier which can be used to remove the listener later.

Add a listener to the list of functions that will be called for each message sent to or recieved from the reader.

removeTransportListener

Arguments

:: Reader

The reader to operate on.

-> TransportListenerId

The return value of a call to addTransportListener.

-> IO ()

Remove a listener from the list of functions that will be called for each message sent to or recieved from the reader.

GPIO

The M6e Nano has 4 GPIO pins that can be controlled by software, numbered 1-4. On the SparkFun Simultaneous RFID Reader, GPIO 1 is available on the GPIO1 pin, and GPIOs 2, 3, and 4 are available on the LV2, LV3, and LV4 pins. The GPIO1 pin is 5V, but the LV pins are 3.3V only. To configure GPIOs as inputs or outputs, use PARAM_GPIO_INPUTLIST and PARAM_GPIO_OUTPUTLIST.

gpiGet :: Reader -> IO [GpioPin]

Get the state of all GPI pins.

gpoSet :: Reader -> [GpioPin] -> IO ()

Set the state of some GPO pins.

Firmware

Firmware for the M6e Nano can be obtained here.

firmwareLoad

Arguments

:: Reader

The reader being operated on

-> ByteString

The binary firmware image to install

-> IO ()

Attempts to install firmware on the reader, then restart and reinitialize.

firmwareLoadFile

Arguments

:: Reader

The reader being operated on

-> FilePath

Name of file containing firmware image

-> IO ()

Like firmwareLoad, but loads firmware from a file. (e. g. NanoFW-1.7.1.2.sim)

Utility functions

Listeners

hexListener :: Handle -> IO TransportListener

Given a Handle, returns a TransportListener which prints transport data to that handle in hex. If the handle is a terminal, prints transmitted data in magenta and received data in cyan.

opcodeListener :: Handle -> IO TransportListener

Identical to hexListener, but also prints the opcode of each packet, and a timestamp. (The timestamp is relative to an arbitrary point in time, so is only useful for computing differences between timestamps.)

Data helpers

packBytesIntoWords :: ByteString -> [Word16]

Convert a ByteString into a list of Word16, in big-endian order. Padded with 0 if the number of bytes is odd.

passwordToWords :: GEN2_Password -> [Word16]

Split a password into two 16-bit words, suitable for writing into reserved memory.

mkFilterGen2

Arguments

:: GEN2_Bank

The bank to filter on

-> Word32

The location (in bits) at which to begin comparing the mask

-> ByteString

The mask value to compare with the specified region of tag memory

-> TagFilter

Create a TagFilterGen2 with the most common settings

Parameters

paramName :: Param -> Text

Return the string name (e. g. "/reader/read/plan") corresponding to a Param.

paramID :: Text -> Param

Return the Param corresponding to a string name (e. g. "/reader/read/plan"). Returns PARAM_NONE if no such parameter exists.

paramType :: Param -> ParamType

Indicates the type expected for a given parameter.

paramUnits :: Param -> Maybe Text

For parameters which are expressed in physical units, returns a string describing the units. Returns Nothing for parameters which are not expressed in physical units. This can be useful for displaying in a user interface, for example.

Hex conversion

bytesToHex :: ByteString -> Text

Convert a ByteString, such as a tag EPC, into a hexadecimal string.

bytesToHexWithSpaces :: ByteString -> Text

Like bytesToHex, but with a space between each byte.

hexToBytes :: Text -> Maybe ByteString

Convert a hexadecimal string (without spaces) into a ByteString. The hex string may optionally include a "0x" prefix, which will be ignored. If the input cannot be parsed as a hex string, returns Nothing.

Display

Some functions to format data in a more human-friendly format than show.

displayTimestamp

Arguments

:: MillisecondsSinceEpoch

milliseconds since 1/1/1970 UTC

-> Text

Convert a timestamp into ISO 8601 format in UTC.

displayLocalTimestamp

Arguments

:: MillisecondsSinceEpoch

milliseconds since 1/1/1970 UTC

-> IO Text

Convert a timestamp into ISO 8601 format in the local timezone.

displayData :: ByteString -> [Text]

Format a ByteString as 16 bytes per line, with both hex and ascii on the line.

displayGpio :: [GpioPin] -> [Text]

Convert a list of GpioPin to a human-readable list of lines.

displayTagData :: TagData -> [Text]

Convert a TagData to a human-readable list of lines.

displayTagReadData :: TagReadData -> [Text]

Convert a TagReadData to a human-readable list of lines.

displayParamType :: ParamType -> Text

A textual representation of the Haskell type corresponding to a particular ParamType.

displayRegion :: Region -> Text

Like show for Region, but in lower case and without the REGION_ prefix.

displayRegionDescription :: Region -> Text

A description of the given region, useful for a user interface.

parseRegion :: Text -> Maybe Region

Like readMaybe for Region, but case-insenstive and without the REGION_ prefix.

Constants

apiVersion :: Text

Version number of the Mercury API C library.

sparkFunAntennas :: [AntennaPort]

The constant [1], which is the correct value for rpAntennas when using the SparkFun Simultaneous RFID Reader.

defaultReadPlan :: ReadPlan

The read plan that the reader starts out with by default. This has reasonable settings for most things, except for the antennas, which need to be set. (e. g. set rpAntennas to sparkFunAntennas)

killPasswordAddress :: Word32

Word address of kill password in reserved memory.

accessPasswordAddress :: Word32

Word address of access password in reserved memory.

Types

Opaque types

data Reader

An opaque type which represents a connection to an RFID reader. Note that Reader is not threadsafe, so if you want to use a Reader from more than one thread, you will need to implement your own locking.

class ParamValue a

A class for types which can be used as parameter values.

Minimal complete definition

pType, pGet, pSet

Instances

ParamValue Bool

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: Bool -> ParamType

pGet :: (Ptr () -> IO ()) -> IO Bool

pSet :: Bool -> (Ptr () -> IO ()) -> IO ()

ParamValue Int8

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: Int8 -> ParamType

pGet :: (Ptr () -> IO ()) -> IO Int8

pSet :: Int8 -> (Ptr () -> IO ()) -> IO ()

ParamValue Int16

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: Int16 -> ParamType

pGet :: (Ptr () -> IO ()) -> IO Int16

pSet :: Int16 -> (Ptr () -> IO ()) -> IO ()

ParamValue Int32

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: Int32 -> ParamType

pGet :: (Ptr () -> IO ()) -> IO Int32

pSet :: Int32 -> (Ptr () -> IO ()) -> IO ()

ParamValue Word8

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: Word8 -> ParamType

pGet :: (Ptr () -> IO ()) -> IO Word8

pSet :: Word8 -> (Ptr () -> IO ()) -> IO ()

ParamValue Word16

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: Word16 -> ParamType

pGet :: (Ptr () -> IO ()) -> IO Word16

pSet :: Word16 -> (Ptr () -> IO ()) -> IO ()

ParamValue Word32

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: Word32 -> ParamType

pGet :: (Ptr () -> IO ()) -> IO Word32

pSet :: Word32 -> (Ptr () -> IO ()) -> IO ()

ParamValue Text

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: Text -> ParamType

pGet :: (Ptr () -> IO ()) -> IO Text

pSet :: Text -> (Ptr () -> IO ()) -> IO ()

ParamValue PowerMode

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: PowerMode -> ParamType

pGet :: (Ptr () -> IO ()) -> IO PowerMode

pSet :: PowerMode -> (Ptr () -> IO ()) -> IO ()

ParamValue GEN2_WriteMode

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: GEN2_WriteMode -> ParamType

pGet :: (Ptr () -> IO ()) -> IO GEN2_WriteMode

pSet :: GEN2_WriteMode -> (Ptr () -> IO ()) -> IO ()

ParamValue TagProtocol

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: TagProtocol -> ParamType

pGet :: (Ptr () -> IO ()) -> IO TagProtocol

pSet :: TagProtocol -> (Ptr () -> IO ()) -> IO ()

ParamValue Region

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: Region -> ParamType

pGet :: (Ptr () -> IO ()) -> IO Region

pSet :: Region -> (Ptr () -> IO ()) -> IO ()

ParamValue ReadPlan

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: ReadPlan -> ParamType

pGet :: (Ptr () -> IO ()) -> IO ReadPlan

pSet :: ReadPlan -> (Ptr () -> IO ()) -> IO ()

ParamValue [Word8]

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: [Word8] -> ParamType

pGet :: (Ptr () -> IO ()) -> IO [Word8]

pSet :: [Word8] -> (Ptr () -> IO ()) -> IO ()

ParamValue [Word32]

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: [Word32] -> ParamType

pGet :: (Ptr () -> IO ()) -> IO [Word32]

pSet :: [Word32] -> (Ptr () -> IO ()) -> IO ()

ParamValue [MetadataFlag]

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: [MetadataFlag] -> ParamType

pGet :: (Ptr () -> IO ()) -> IO [MetadataFlag]

pSet :: [MetadataFlag] -> (Ptr () -> IO ()) -> IO ()

ParamValue [TagProtocol]

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: [TagProtocol] -> ParamType

pGet :: (Ptr () -> IO ()) -> IO [TagProtocol]

pSet :: [TagProtocol] -> (Ptr () -> IO ()) -> IO ()

ParamValue [Region]

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: [Region] -> ParamType

pGet :: (Ptr () -> IO ()) -> IO [Region]

pSet :: [Region] -> (Ptr () -> IO ()) -> IO ()

data TransportListenerId

An opaque type which can be passed to removeTransportListener to remove a transport listener.

Instances

Eq TransportListenerId

Defined in System.Hardware.MercuryApi

Methods

(==) :: TransportListenerId -> TransportListenerId -> Bool

(/=) :: TransportListenerId -> TransportListenerId -> Bool

Typedefs

type TransportListener

Arguments

 = TransportDirection

Direction of data transmission

-> ByteString

Binary data sent or received

-> Word32

Timeout

-> IO ()

A function which can be installed via addTransportListener to be called every time Mercury API sends or receives data on the serial port.

type PinNumber = Word8

A GPIO pin number. On the M6e Nano, these are numbered 1-4.

type AntennaPort = Word8

An antenna number. On the SparkFun Simultaneous RFID Reader, there is a single antenna with the number 1.

type GEN2_Password = Word32

A 32-bit password (access or kill) in the Gen2 protocol.

type MillisecondsSinceEpoch = Word64

milliseconds since 1/1/1970 UTC

Records

data MercuryException

Represents any error that can occur in a MercuryApi call, except for those which can be represented by IOException.

Constructors

MercuryException

Fields

• meStatusType :: StatusType

  general category of error

• meStatus :: Status

  the specific error

• meMessage :: Text

  the error message

• meLocation :: Text

  function where the error occurred

• meParam :: Text

  more information, such as the parameter in paramGet or paramSet

• meUri :: Text

  URI of the reader

Instances

Eq MercuryException

Defined in System.Hardware.MercuryApi

Methods

(==) :: MercuryException -> MercuryException -> Bool

(/=) :: MercuryException -> MercuryException -> Bool

Ord MercuryException

Defined in System.Hardware.MercuryApi

Methods

compare :: MercuryException -> MercuryException -> Ordering

(<) :: MercuryException -> MercuryException -> Bool

(<=) :: MercuryException -> MercuryException -> Bool

(>) :: MercuryException -> MercuryException -> Bool

(>=) :: MercuryException -> MercuryException -> Bool

max :: MercuryException -> MercuryException -> MercuryException

min :: MercuryException -> MercuryException -> MercuryException

Read MercuryException

Defined in System.Hardware.MercuryApi

Methods

readsPrec :: Int -> ReadS MercuryException

readList :: ReadS [MercuryException]

readPrec :: ReadPrec MercuryException

readListPrec :: ReadPrec [MercuryException]

Show MercuryException

Defined in System.Hardware.MercuryApi

Methods

showsPrec :: Int -> MercuryException -> ShowS

show :: MercuryException -> String

showList :: [MercuryException] -> ShowS

Exception MercuryException

Defined in System.Hardware.MercuryApi

Methods

toException :: MercuryException -> SomeException

fromException :: SomeException -> Maybe MercuryException

displayException :: MercuryException -> String

data ReadPlan

A ReadPlan record specifies the antennas, protocols, and filters to use for a search (read).

Currently, only SimpleReadPlan is supported.

Constructors

SimpleReadPlan

Fields

• rpWeight :: !Word32

  The relative weight of this read plan

• rpEnableAutonomousRead :: !Bool

  Option for Autonomous read

• rpAntennas :: ![AntennaPort]

  The list of antennas to read on

• rpProtocol :: !TagProtocol

  The protocol to use for reading

• rpFilter :: !(Maybe TagFilter)

  The filter to apply to reading

• rpTagop :: !(Maybe TagOp)

  The tag operation to apply to each read tag

• rpUseFastSearch :: !Bool

  Option to use the FastSearch

• rpStopOnCount :: !(Maybe Word32)

  Number of tags to be read

• rpTriggerRead :: !(Maybe [Word8])

  The list of GPI ports which should be used to trigger the read

Instances

Eq ReadPlan

Defined in System.Hardware.MercuryApi.Records

Methods

(==) :: ReadPlan -> ReadPlan -> Bool

(/=) :: ReadPlan -> ReadPlan -> Bool

Ord ReadPlan

Defined in System.Hardware.MercuryApi.Records

Methods

compare :: ReadPlan -> ReadPlan -> Ordering

(<) :: ReadPlan -> ReadPlan -> Bool

(<=) :: ReadPlan -> ReadPlan -> Bool

(>) :: ReadPlan -> ReadPlan -> Bool

(>=) :: ReadPlan -> ReadPlan -> Bool

max :: ReadPlan -> ReadPlan -> ReadPlan

min :: ReadPlan -> ReadPlan -> ReadPlan

Read ReadPlan

Defined in System.Hardware.MercuryApi.Records

Methods

readsPrec :: Int -> ReadS ReadPlan

readList :: ReadS [ReadPlan]

readPrec :: ReadPrec ReadPlan

readListPrec :: ReadPrec [ReadPlan]

Show ReadPlan

Defined in System.Hardware.MercuryApi.Records

Methods

showsPrec :: Int -> ReadPlan -> ShowS

show :: ReadPlan -> String

showList :: [ReadPlan] -> ShowS

Storable ReadPlan

Defined in System.Hardware.MercuryApi.Records

Methods

sizeOf :: ReadPlan -> Int

alignment :: ReadPlan -> Int

peekElemOff :: Ptr ReadPlan -> Int -> IO ReadPlan

pokeElemOff :: Ptr ReadPlan -> Int -> ReadPlan -> IO ()

peekByteOff :: Ptr b -> Int -> IO ReadPlan

pokeByteOff :: Ptr b -> Int -> ReadPlan -> IO ()

peek :: Ptr ReadPlan -> IO ReadPlan

poke :: Ptr ReadPlan -> ReadPlan -> IO ()

ParamValue ReadPlan

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: ReadPlan -> ParamType

pGet :: (Ptr () -> IO ()) -> IO ReadPlan

pSet :: ReadPlan -> (Ptr () -> IO ()) -> IO ()

data TagOp

An operation that can be performed on a tag. Can be used as an argument to executeTagOp, or can be embedded into a ReadPlan. (However, on the M6e Nano, only TagOp_GEN2_ReadData may be embedded in a ReadPlan.)

Constructors

TagOp_GEN2_ReadData

Fields

• opBank :: !GEN2_Bank

  Gen2 memory bank to operate on

• opExtraBanks :: ![GEN2_Bank]

  Additional Gen2 memory banks to read from (seems buggy, though; I've had strange results with it)

• opWordAddress :: !Word32

  Word address to start at

• opLen :: !Word8

  Number of words to read

TagOp_GEN2_WriteTag

Fields

• opEpc :: !TagData

  Tag EPC

TagOp_GEN2_WriteData

Fields

• opBank :: !GEN2_Bank

  Gen2 memory bank to operate on

• opWordAddress :: !Word32

  Word address to start at

• opData :: ![Word16]

  Data to write

TagOp_GEN2_Lock

Fields

• opMask :: ![GEN2_LockBits]

  Bitmask indicating which lock bits to change

• opAction :: ![GEN2_LockBits]

  New values of each bit specified in the mask

• opAccessPassword :: !GEN2_Password

  Access Password to use to lock the tag

TagOp_GEN2_Kill

Fields

• opPassword :: !GEN2_Password

  Kill password to use to kill the tag

TagOp_GEN2_BlockWrite

Fields

• opBank :: !GEN2_Bank

  Gen2 memory bank to operate on

• opWordPtr :: !Word32

  The word address to start at

• opData :: ![Word16]

  Data to write

TagOp_GEN2_BlockErase

Fields

• opBank :: !GEN2_Bank

  Gen2 memory bank to operate on

• opWordPtr :: !Word32

  The word address to start at

• opWordCount :: !Word8

  Number of words to erase

TagOp_GEN2_BlockPermaLock

Fields

• opBank :: !GEN2_Bank

  Gen2 memory bank to operate on

• opBlockPtr :: !Word32

  The starting word address to lock

• opReadWrite :: !ReadWrite

  Read lock status or write it?

Instances

Eq TagOp

Defined in System.Hardware.MercuryApi.Records

Methods

(==) :: TagOp -> TagOp -> Bool

(/=) :: TagOp -> TagOp -> Bool

Ord TagOp

Defined in System.Hardware.MercuryApi.Records

Methods

compare :: TagOp -> TagOp -> Ordering

(<) :: TagOp -> TagOp -> Bool

(<=) :: TagOp -> TagOp -> Bool

(>) :: TagOp -> TagOp -> Bool

(>=) :: TagOp -> TagOp -> Bool

max :: TagOp -> TagOp -> TagOp

min :: TagOp -> TagOp -> TagOp

Read TagOp

Defined in System.Hardware.MercuryApi.Records

Methods

readsPrec :: Int -> ReadS TagOp

readList :: ReadS [TagOp]

readPrec :: ReadPrec TagOp

readListPrec :: ReadPrec [TagOp]

Show TagOp

Defined in System.Hardware.MercuryApi.Records

Methods

showsPrec :: Int -> TagOp -> ShowS

show :: TagOp -> String

showList :: [TagOp] -> ShowS

Storable TagOp

Defined in System.Hardware.MercuryApi.Records

Methods

sizeOf :: TagOp -> Int

alignment :: TagOp -> Int

peekElemOff :: Ptr TagOp -> Int -> IO TagOp

pokeElemOff :: Ptr TagOp -> Int -> TagOp -> IO ()

peekByteOff :: Ptr b -> Int -> IO TagOp

pokeByteOff :: Ptr b -> Int -> TagOp -> IO ()

peek :: Ptr TagOp -> IO TagOp

poke :: Ptr TagOp -> TagOp -> IO ()

data TagFilter

Filter on EPC data, or on Gen2-specific information.

Constructors

TagFilterEPC TagData

TagFilterGen2

Fields

• tfInvert :: !Bool

  Whether to invert the selection (deselect tags that meet the comparison)

• tfFilterOn :: !FilterOn

  The memory bank in which to compare the mask

• tfBitPointer :: !Word32

  The location (in bits) at which to begin comparing the mask

• tfMaskBitLength :: !Word16

  The length (in bits) of the mask

• tfMask :: !ByteString

  The mask value to compare with the specified region of tag memory, MSB first

Instances

Eq TagFilter

Defined in System.Hardware.MercuryApi.Records

Methods

(==) :: TagFilter -> TagFilter -> Bool

(/=) :: TagFilter -> TagFilter -> Bool

Ord TagFilter

Defined in System.Hardware.MercuryApi.Records

Methods

compare :: TagFilter -> TagFilter -> Ordering

(<) :: TagFilter -> TagFilter -> Bool

(<=) :: TagFilter -> TagFilter -> Bool

(>) :: TagFilter -> TagFilter -> Bool

(>=) :: TagFilter -> TagFilter -> Bool

max :: TagFilter -> TagFilter -> TagFilter

min :: TagFilter -> TagFilter -> TagFilter

Read TagFilter

Defined in System.Hardware.MercuryApi.Records

Methods

readsPrec :: Int -> ReadS TagFilter

readList :: ReadS [TagFilter]

readPrec :: ReadPrec TagFilter

readListPrec :: ReadPrec [TagFilter]

Show TagFilter

Defined in System.Hardware.MercuryApi.Records

Methods

showsPrec :: Int -> TagFilter -> ShowS

show :: TagFilter -> String

showList :: [TagFilter] -> ShowS

Storable TagFilter

Defined in System.Hardware.MercuryApi.Records

Methods

sizeOf :: TagFilter -> Int

alignment :: TagFilter -> Int

peekElemOff :: Ptr TagFilter -> Int -> IO TagFilter

pokeElemOff :: Ptr TagFilter -> Int -> TagFilter -> IO ()

peekByteOff :: Ptr b -> Int -> IO TagFilter

pokeByteOff :: Ptr b -> Int -> TagFilter -> IO ()

peek :: Ptr TagFilter -> IO TagFilter

poke :: Ptr TagFilter -> TagFilter -> IO ()

data FilterOn

Filter on EPC length, or on a Gen2 bank.

Constructors

FilterOnBank GEN2_Bank

FilterOnEpcLength

Instances

Eq FilterOn

Defined in System.Hardware.MercuryApi.Records

Methods

(==) :: FilterOn -> FilterOn -> Bool

(/=) :: FilterOn -> FilterOn -> Bool

Ord FilterOn

Defined in System.Hardware.MercuryApi.Records

Methods

compare :: FilterOn -> FilterOn -> Ordering

(<) :: FilterOn -> FilterOn -> Bool

(<=) :: FilterOn -> FilterOn -> Bool

(>) :: FilterOn -> FilterOn -> Bool

(>=) :: FilterOn -> FilterOn -> Bool

max :: FilterOn -> FilterOn -> FilterOn

min :: FilterOn -> FilterOn -> FilterOn

Read FilterOn

Defined in System.Hardware.MercuryApi.Records

Methods

readsPrec :: Int -> ReadS FilterOn

readList :: ReadS [FilterOn]

readPrec :: ReadPrec FilterOn

readListPrec :: ReadPrec [FilterOn]

Show FilterOn

Defined in System.Hardware.MercuryApi.Records

Methods

showsPrec :: Int -> FilterOn -> ShowS

show :: FilterOn -> String

showList :: [FilterOn] -> ShowS

Storable FilterOn

Defined in System.Hardware.MercuryApi.Records

Methods

sizeOf :: FilterOn -> Int

alignment :: FilterOn -> Int

peekElemOff :: Ptr FilterOn -> Int -> IO FilterOn

pokeElemOff :: Ptr FilterOn -> Int -> FilterOn -> IO ()

peekByteOff :: Ptr b -> Int -> IO FilterOn

pokeByteOff :: Ptr b -> Int -> FilterOn -> IO ()

peek :: Ptr FilterOn -> IO FilterOn

poke :: Ptr FilterOn -> FilterOn -> IO ()

data TagReadData

A record to represent a read of an RFID tag. Provides access to the metadata of the read event, such as the time of the read, the antenna that read the tag, and the number of times the tag was seen by the air protocol.

Constructors

TagReadData

Fields

• trTag :: !TagData

  The tag that was read

• trMetadataFlags :: ![MetadataFlag]

  The set of metadata items below that are valid

• trPhase :: !Word16

  Tag response phase

• trAntenna :: !AntennaPort

  Antenna where the tag was read

• trGpio :: ![GpioPin]

  State of GPIO pins at the moment of the tag read

• trReadCount :: !Word32

  Number of times the tag was read

• trRssi :: !Int32

  Strength of the signal received from the tag

• trFrequency :: !Word32

  RF carrier frequency the tag was read with

• trTimestamp :: !MillisecondsSinceEpoch

  Absolute time of the read, in milliseconds since 1/1/1970 UTC

• trData :: !ByteString

  Data read from the tag

• trEpcMemData :: !ByteString

  Read EPC bank data bytes (Only if GEN2_BANK_EPC is present in opExtraBanks)

• trTidMemData :: !ByteString

  Read TID bank data bytes (Only if GEN2_BANK_TID is present in opExtraBanks)

• trUserMemData :: !ByteString

  Read USER bank data bytes (Only if GEN2_BANK_USER is present in opExtraBanks)

• trReservedMemData :: !ByteString

  Read RESERVED bank data bytes (Only if GEN2_BANK_RESERVED is present in opExtraBanks)

Instances

Eq TagReadData

Defined in System.Hardware.MercuryApi.Records

Methods

(==) :: TagReadData -> TagReadData -> Bool

(/=) :: TagReadData -> TagReadData -> Bool

Ord TagReadData

Defined in System.Hardware.MercuryApi.Records

Methods

compare :: TagReadData -> TagReadData -> Ordering

(<) :: TagReadData -> TagReadData -> Bool

(<=) :: TagReadData -> TagReadData -> Bool

(>) :: TagReadData -> TagReadData -> Bool

(>=) :: TagReadData -> TagReadData -> Bool

max :: TagReadData -> TagReadData -> TagReadData

min :: TagReadData -> TagReadData -> TagReadData

Read TagReadData

Defined in System.Hardware.MercuryApi.Records

Methods

readsPrec :: Int -> ReadS TagReadData

readList :: ReadS [TagReadData]

readPrec :: ReadPrec TagReadData

readListPrec :: ReadPrec [TagReadData]

Show TagReadData

Defined in System.Hardware.MercuryApi.Records

Methods

showsPrec :: Int -> TagReadData -> ShowS

show :: TagReadData -> String

showList :: [TagReadData] -> ShowS

Storable TagReadData

Defined in System.Hardware.MercuryApi.Records

Methods

sizeOf :: TagReadData -> Int

alignment :: TagReadData -> Int

peekElemOff :: Ptr TagReadData -> Int -> IO TagReadData

pokeElemOff :: Ptr TagReadData -> Int -> TagReadData -> IO ()

peekByteOff :: Ptr b -> Int -> IO TagReadData

pokeByteOff :: Ptr b -> Int -> TagReadData -> IO ()

peek :: Ptr TagReadData -> IO TagReadData

poke :: Ptr TagReadData -> TagReadData -> IO ()

data GpioPin

The identity and state of a single GPIO pin.

Constructors

GpioPin

Fields

• gpId :: !PinNumber

  The ID number of the pin.

• gpHigh :: !Bool

  Whether the pin is in the high state.

• gpOutput :: !Bool

  The direction of the pin

Instances

Eq GpioPin

Defined in System.Hardware.MercuryApi.Records

Methods

(==) :: GpioPin -> GpioPin -> Bool

(/=) :: GpioPin -> GpioPin -> Bool

Ord GpioPin

Defined in System.Hardware.MercuryApi.Records

Methods

compare :: GpioPin -> GpioPin -> Ordering

(<) :: GpioPin -> GpioPin -> Bool

(<=) :: GpioPin -> GpioPin -> Bool

(>) :: GpioPin -> GpioPin -> Bool

(>=) :: GpioPin -> GpioPin -> Bool

max :: GpioPin -> GpioPin -> GpioPin

min :: GpioPin -> GpioPin -> GpioPin

Read GpioPin

Defined in System.Hardware.MercuryApi.Records

Methods

readsPrec :: Int -> ReadS GpioPin

readList :: ReadS [GpioPin]

readPrec :: ReadPrec GpioPin

readListPrec :: ReadPrec [GpioPin]

Show GpioPin

Defined in System.Hardware.MercuryApi.Records

Methods

showsPrec :: Int -> GpioPin -> ShowS

show :: GpioPin -> String

showList :: [GpioPin] -> ShowS

Storable GpioPin

Defined in System.Hardware.MercuryApi.Records

Methods

sizeOf :: GpioPin -> Int

alignment :: GpioPin -> Int

peekElemOff :: Ptr GpioPin -> Int -> IO GpioPin

pokeElemOff :: Ptr GpioPin -> Int -> GpioPin -> IO ()

peekByteOff :: Ptr b -> Int -> IO GpioPin

pokeByteOff :: Ptr b -> Int -> GpioPin -> IO ()

peek :: Ptr GpioPin -> IO GpioPin

poke :: Ptr GpioPin -> GpioPin -> IO ()

data TagData

A record to represent RFID tags.

Constructors

TagData

Fields

• tdEpc :: !ByteString

  Tag EPC

• tdProtocol :: !TagProtocol

  Protocol of the tag

• tdCrc :: !Word16

  Tag CRC

• tdGen2 :: !(Maybe GEN2_TagData)

  Gen2-specific tag information

Instances

Eq TagData

Defined in System.Hardware.MercuryApi.Records

Methods

(==) :: TagData -> TagData -> Bool

(/=) :: TagData -> TagData -> Bool

Ord TagData

Defined in System.Hardware.MercuryApi.Records

Methods

compare :: TagData -> TagData -> Ordering

(<) :: TagData -> TagData -> Bool

(<=) :: TagData -> TagData -> Bool

(>) :: TagData -> TagData -> Bool

(>=) :: TagData -> TagData -> Bool

max :: TagData -> TagData -> TagData

min :: TagData -> TagData -> TagData

Read TagData

Defined in System.Hardware.MercuryApi.Records

Methods

readsPrec :: Int -> ReadS TagData

readList :: ReadS [TagData]

readPrec :: ReadPrec TagData

readListPrec :: ReadPrec [TagData]

Show TagData

Defined in System.Hardware.MercuryApi.Records

Methods

showsPrec :: Int -> TagData -> ShowS

show :: TagData -> String

showList :: [TagData] -> ShowS

Storable TagData

Defined in System.Hardware.MercuryApi.Records

Methods

sizeOf :: TagData -> Int

alignment :: TagData -> Int

peekElemOff :: Ptr TagData -> Int -> IO TagData

pokeElemOff :: Ptr TagData -> Int -> TagData -> IO ()

peekByteOff :: Ptr b -> Int -> IO TagData

pokeByteOff :: Ptr b -> Int -> TagData -> IO ()

peek :: Ptr TagData -> IO TagData

poke :: Ptr TagData -> TagData -> IO ()

newtype GEN2_TagData

Gen2-specific per-tag data

Constructors

GEN2_TagData

Fields

• g2Pc :: ByteString

  Tag PC

Instances

Eq GEN2_TagData

Defined in System.Hardware.MercuryApi.Records

Methods

(==) :: GEN2_TagData -> GEN2_TagData -> Bool

(/=) :: GEN2_TagData -> GEN2_TagData -> Bool

Ord GEN2_TagData

Defined in System.Hardware.MercuryApi.Records

Methods

compare :: GEN2_TagData -> GEN2_TagData -> Ordering

(<) :: GEN2_TagData -> GEN2_TagData -> Bool

(<=) :: GEN2_TagData -> GEN2_TagData -> Bool

(>) :: GEN2_TagData -> GEN2_TagData -> Bool

(>=) :: GEN2_TagData -> GEN2_TagData -> Bool

max :: GEN2_TagData -> GEN2_TagData -> GEN2_TagData

min :: GEN2_TagData -> GEN2_TagData -> GEN2_TagData

Read GEN2_TagData

Defined in System.Hardware.MercuryApi.Records

Methods

readsPrec :: Int -> ReadS GEN2_TagData

readList :: ReadS [GEN2_TagData]

readPrec :: ReadPrec GEN2_TagData

readListPrec :: ReadPrec [GEN2_TagData]

Show GEN2_TagData

Defined in System.Hardware.MercuryApi.Records

Methods

showsPrec :: Int -> GEN2_TagData -> ShowS

show :: GEN2_TagData -> String

showList :: [GEN2_TagData] -> ShowS

Storable GEN2_TagData

Defined in System.Hardware.MercuryApi.Records

Methods

sizeOf :: GEN2_TagData -> Int

alignment :: GEN2_TagData -> Int

peekElemOff :: Ptr GEN2_TagData -> Int -> IO GEN2_TagData

pokeElemOff :: Ptr GEN2_TagData -> Int -> GEN2_TagData -> IO ()

peekByteOff :: Ptr b -> Int -> IO GEN2_TagData

pokeByteOff :: Ptr b -> Int -> GEN2_TagData -> IO ()

peek :: Ptr GEN2_TagData -> IO GEN2_TagData

poke :: Ptr GEN2_TagData -> GEN2_TagData -> IO ()

data ReadWrite

Indicates whether to read or write the lock bits in TagOp_GEN2_BlockPermaLock.

Constructors

Read !Int

number of words of lock bits to read

Write ![Word16]

lock bits to write

Instances

Eq ReadWrite

Defined in System.Hardware.MercuryApi.Records

Methods

(==) :: ReadWrite -> ReadWrite -> Bool

(/=) :: ReadWrite -> ReadWrite -> Bool

Ord ReadWrite

Defined in System.Hardware.MercuryApi.Records

Methods

compare :: ReadWrite -> ReadWrite -> Ordering

(<) :: ReadWrite -> ReadWrite -> Bool

(<=) :: ReadWrite -> ReadWrite -> Bool

(>) :: ReadWrite -> ReadWrite -> Bool

(>=) :: ReadWrite -> ReadWrite -> Bool

max :: ReadWrite -> ReadWrite -> ReadWrite

min :: ReadWrite -> ReadWrite -> ReadWrite

Read ReadWrite

Defined in System.Hardware.MercuryApi.Records

Methods

readsPrec :: Int -> ReadS ReadWrite

readList :: ReadS [ReadWrite]

readPrec :: ReadPrec ReadWrite

readListPrec :: ReadPrec [ReadWrite]

Show ReadWrite

Defined in System.Hardware.MercuryApi.Records

Methods

showsPrec :: Int -> ReadWrite -> ShowS

show :: ReadWrite -> String

showList :: [ReadWrite] -> ShowS

Enums

data StatusType

Indicates a general category of error.

Constructors

SUCCESS_TYPE

ERROR_TYPE_COMM

ERROR_TYPE_CODE

ERROR_TYPE_MISC

ERROR_TYPE_LLRP

ERROR_TYPE_BINDING

An error which originates from the Haskell binding, not the underlying C library.

ERROR_TYPE_UNKNOWN

Not a recognized status type

Instances

Bounded StatusType

Defined in System.Hardware.MercuryApi.Enums

Methods

minBound :: StatusType

maxBound :: StatusType

Enum StatusType

Defined in System.Hardware.MercuryApi.Enums

Methods

succ :: StatusType -> StatusType

pred :: StatusType -> StatusType

toEnum :: Int -> StatusType

fromEnum :: StatusType -> Int

enumFrom :: StatusType -> [StatusType]

enumFromThen :: StatusType -> StatusType -> [StatusType]

enumFromTo :: StatusType -> StatusType -> [StatusType]

enumFromThenTo :: StatusType -> StatusType -> StatusType -> [StatusType]

Eq StatusType

Defined in System.Hardware.MercuryApi.Enums

Methods

(==) :: StatusType -> StatusType -> Bool

(/=) :: StatusType -> StatusType -> Bool

Ord StatusType

Defined in System.Hardware.MercuryApi.Enums

Methods

compare :: StatusType -> StatusType -> Ordering

(<) :: StatusType -> StatusType -> Bool

(<=) :: StatusType -> StatusType -> Bool

(>) :: StatusType -> StatusType -> Bool

(>=) :: StatusType -> StatusType -> Bool

max :: StatusType -> StatusType -> StatusType

min :: StatusType -> StatusType -> StatusType

Read StatusType

Defined in System.Hardware.MercuryApi.Enums

Methods

readsPrec :: Int -> ReadS StatusType

readList :: ReadS [StatusType]

readPrec :: ReadPrec StatusType

readListPrec :: ReadPrec [StatusType]

Show StatusType

Defined in System.Hardware.MercuryApi.Enums

Methods

showsPrec :: Int -> StatusType -> ShowS

show :: StatusType -> String

showList :: [StatusType] -> ShowS

data Status

A specific error encountered by the C API or the Haskell binding.

Constructors

SUCCESS

Success! (Never thrown in an exception)

ERROR_MSG_WRONG_NUMBER_OF_DATA

Invalid number of arguments

ERROR_INVALID_OPCODE

Command opcode not recognized.

ERROR_UNIMPLEMENTED_OPCODE

Command opcode recognized, but is not supported.

ERROR_MSG_POWER_TOO_HIGH

Requested power setting is above the allowed maximum.

ERROR_MSG_INVALID_FREQ_RECEIVED

Requested frequency is outside the allowed range.

ERROR_MSG_INVALID_PARAMETER_VALUE

Parameter value is outside the allowed range.

ERROR_MSG_POWER_TOO_LOW

Requested power setting is below the allowed minimum.

ERROR_UNIMPLEMENTED_FEATURE

Command not supported.

ERROR_INVALID_BAUD_RATE

Requested serial speed is not supported.

ERROR_INVALID_REGION

Region is not supported.

ERROR_INVALID_LICENSE_KEY

License key code is invalid

ERROR_BL_INVALID_IMAGE_CRC

Firmware is corrupt: Checksum doesn't match content.

ERROR_BL_INVALID_APP_END_ADDR

Serial protocol status code for this exception.

ERROR_FLASH_BAD_ERASE_PASSWORD

Internal reader error. Contact support.

ERROR_FLASH_BAD_WRITE_PASSWORD

Internal reader error. Contact support.

ERROR_FLASH_UNDEFINED_SECTOR

Internal reader error. Contact support.

ERROR_FLASH_ILLEGAL_SECTOR

Internal reader error. Contact support.

ERROR_FLASH_WRITE_TO_NON_ERASED_AREA

Internal reader error. Contact support.

ERROR_FLASH_WRITE_TO_ILLEGAL_SECTOR

Internal reader error. Contact support.

ERROR_FLASH_VERIFY_FAILED

Internal reader error. Contact support.

ERROR_NO_TAGS_FOUND

Reader was asked to find tags, but none were detected.

ERROR_NO_PROTOCOL_DEFINED

RFID protocol has not been configured.

ERROR_INVALID_PROTOCOL_SPECIFIED

Requested RFID protocol is not recognized.

ERROR_WRITE_PASSED_LOCK_FAILED

Lock failed after write operation

ERROR_PROTOCOL_NO_DATA_READ

Tag data was requested, but could not be read.

ERROR_AFE_NOT_ON

AFE not on - reader not sufficiently configured

ERROR_PROTOCOL_WRITE_FAILED

Write to tag failed.

ERROR_NOT_IMPLEMENTED_FOR_THIS_PROTOCOL

Command is not supported in the current RFID protocol.

ERROR_PROTOCOL_INVALID_WRITE_DATA

Data does not conform to protocol standards.

ERROR_PROTOCOL_INVALID_ADDRESS

Requested data address is outside the valid range.

ERROR_GENERAL_TAG_ERROR

Unknown error during RFID operation.

ERROR_DATA_TOO_LARGE

Read Tag Data was asked for more data than it supports.

ERROR_PROTOCOL_INVALID_KILL_PASSWORD

Incorrect password was provided to Kill Tag.

ERROR_PROTOCOL_KILL_FAILED

Kill failed for unknown reason.

ERROR_PROTOCOL_BIT_DECODING_FAILED

Internal reader error. Contact support.

ERROR_PROTOCOL_INVALID_EPC

Internal reader error. Contact support.

ERROR_PROTOCOL_INVALID_NUM_DATA

Internal reader error. Contact support.

ERROR_GEN2_PROTOCOL_OTHER_ERROR

Internal reader error. Contact support.

ERROR_GEN2_PROTOCOL_MEMORY_OVERRUN_BAD_PC

Internal reader error. Contact support.

ERROR_GEN2_PROTOCOL_MEMORY_LOCKED

Internal reader error. Contact support.

ERROR_GEN2_PROTOCOL_V2_AUTHEN_FAILED

Authentication failed with specified key.

ERROR_GEN2_PROTOCOL_V2_UNTRACE_FAILED

Untrace operation failed.

ERROR_GEN2_PROTOCOL_INSUFFICIENT_POWER

Internal reader error. Contact support.

ERROR_GEN2_PROTOCOL_NON_SPECIFIC_ERROR

Internal reader error. Contact support.

ERROR_GEN2_PROTOCOL_UNKNOWN_ERROR

Internal reader error. Contact support.

ERROR_AHAL_INVALID_FREQ

A command was received to set a frequency outside the specified range.

ERROR_AHAL_CHANNEL_OCCUPIED

With LBT enabled an attempt was made to set the frequency to an occupied channel.

ERROR_AHAL_TRANSMITTER_ON

Checking antenna status while CW is on is not allowed.

ERROR_ANTENNA_NOT_CONNECTED

Antenna not detected during pre-transmit safety test.

ERROR_TEMPERATURE_EXCEED_LIMITS

Reader temperature outside safe range.

ERROR_HIGH_RETURN_LOSS

Excess power detected at transmitter port, usually due to antenna tuning mismatch.

ERROR_INVALID_ANTENNA_CONFIG

Invalid antenna configuration

ERROR_TAG_ID_BUFFER_NOT_ENOUGH_TAGS_AVAILABLE

Asked for more tags than were available in the buffer.

ERROR_TAG_ID_BUFFER_FULL

Too many tags are in buffer. Remove some with Get Tag ID Buffer or Clear Tag ID Buffer.

ERROR_TAG_ID_BUFFER_REPEATED_TAG_ID

Internal error -- reader is trying to insert a duplicate tag record. Contact support.

ERROR_TAG_ID_BUFFER_NUM_TAG_TOO_LARGE

Asked for tags than a single transaction can handle.

ERROR_TAG_ID_BUFFER_AUTH_REQUEST

Blocked response to get additional data from host.

ERROR_SYSTEM_UNKNOWN_ERROR

Internal reader error. Contact support.

ERROR_TM_ASSERT_FAILED

Internal reader error. Contact support.

ERROR_TIMEOUT

Timeout

ERROR_NO_HOST

No matching host found

ERROR_LLRP

LLRP error

ERROR_PARSE

Error parsing device response

ERROR_DEVICE_RESET

Device was reset externally

ERROR_CRC_ERROR

CRC Error

ERROR_INVALID

Invalid argument

ERROR_UNIMPLEMENTED

Unimplemented operation

ERROR_UNSUPPORTED

Unsupported operation

ERROR_NO_ANTENNA

No antenna or invalid antenna

ERROR_READONLY

Value is read-only

ERROR_TOO_BIG

Value too big

ERROR_NO_THREADS

Thread initialization failed

ERROR_NO_TAGS

No tags to be retrieved

ERROR_NOT_FOUND

Key not found

ERROR_FIRMWARE_FORMAT

Size or format of firmware image is incorrect

ERROR_TRYAGAIN

Temporary error, try again

ERROR_OUT_OF_MEMORY

Out of memory

ERROR_INVALID_WRITE_MODE

Invalid write mode

ERROR_ILLEGAL_VALUE

Illegal value

ERROR_END_OF_READING

ERROR_UNSUPPORTED_READER_TYPE

Unsupported reader type

ERROR_BUFFER_OVERFLOW

Buffer overflow

ERROR_LOADSAVE_CONFIG

ERROR_AUTOREAD_ENABLED

Autonomous mode is enabled on reader. Please disable it

ERROR_FIRMWARE_UPDATE_ON_AUTOREAD

Firmware update is successful. Autonomous mode is already enabled on reader

ERROR_TIMESTAMP_NULL

Timestamp cannot be null

ERROR_LLRP_GETTYPEREGISTRY

LLRP Reader GetTypeRegistry Failed

ERROR_LLRP_CONNECTIONFAILED

LLRP Reader Connection attempt is failed

ERROR_LLRP_SENDIO_ERROR

LLRP Reader Send Messages failed

ERROR_LLRP_RECEIVEIO_ERROR

LLRP Reader Receive Messages failed

ERROR_LLRP_RECEIVE_TIMEOUT

LLRP Reader Receive Messages Timeout

ERROR_LLRP_MSG_PARSE_ERROR

Error parsing LLRP message

ERROR_LLRP_ALREADY_CONNECTED

Already connected to reader

ERROR_LLRP_INVALID_RFMODE

Specified RF Mode operation is not supported

ERROR_LLRP_UNDEFINED_VALUE

Undefined Value

ERROR_LLRP_READER_ERROR

LLRP reader unknown error

ERROR_LLRP_READER_CONNECTION_LOST

LLRP reader connection lost

ERROR_LLRP_CLIENT_CONNECTION_EXISTS

LLRP Reader Connection attempt is failed, A Client initiated connection already exists

ERROR_ALREADY_DESTROYED

Attempt to use reader after it was destroyed.

ERROR_INVALID_PARAM_TYPE

The parameter value was not of the type expected.

ERROR_UNIMPLEMENTED_PARAM

The given parameter is not yet implemented in the Haskell binding.

ERROR_UNKNOWN Word32

C API returned an unrecognized status code

Instances

Eq Status

Defined in System.Hardware.MercuryApi.Enums

Methods

(==) :: Status -> Status -> Bool

(/=) :: Status -> Status -> Bool

Ord Status

Defined in System.Hardware.MercuryApi.Enums

Methods

compare :: Status -> Status -> Ordering

(<) :: Status -> Status -> Bool

(<=) :: Status -> Status -> Bool

(>) :: Status -> Status -> Bool

(>=) :: Status -> Status -> Bool

max :: Status -> Status -> Status

min :: Status -> Status -> Status

Read Status

Defined in System.Hardware.MercuryApi.Enums

Methods

readsPrec :: Int -> ReadS Status

readList :: ReadS [Status]

readPrec :: ReadPrec Status

readListPrec :: ReadPrec [Status]

Show Status

Defined in System.Hardware.MercuryApi.Enums

Methods

showsPrec :: Int -> Status -> ShowS

show :: Status -> String

showList :: [Status] -> ShowS

data Param

Reader parameters which you can get and set. The names are the same as the names of the enum in the C API. (Unfortunately, these do not correspond to the "path"-style names in any systematic way.) Each parameter is listed with its "path", and the Haskell type which is used to store it. Some parameters are also listed with the physical units the parameter is in. Not all parameters are implemented in the Haskell binding. Please file a Github issue if there is a parameter you need which is not implemented.

Constructors

PARAM_NONE

No such parameter - used as a return value from paramID.

PARAM_BAUDRATE

/reader/baudRate Word32

PARAM_COMMANDTIMEOUT

/reader/commandTimeout Word32 (milliseconds)

PARAM_CURRENTTIME

/reader/currentTime (Not yet implemented)

PARAM_READER_DESCRIPTION

/reader/description Text

PARAM_EXTENDEDEPC

/reader/extendedEpc Bool

PARAM_READER_HOSTNAME

/reader/hostname Text

PARAM_LICENSE_KEY

/reader/licenseKey [Word8]

PARAM_LICENSED_FEATURES

/reader/licensedFeatures [Word8]

PARAM_METADATAFLAG

/reader/metadataflags [MetadataFlag]

PARAM_POWERMODE

/reader/powerMode PowerMode

PARAM_PROBEBAUDRATES

/reader/probeBaudRates [Word32]

PARAM_READER_STATISTICS

/reader/statistics (Not yet implemented)

PARAM_READER_STATS

/reader/stats (Not yet implemented)

PARAM_TRANSPORTTIMEOUT

/reader/transportTimeout Word32 (milliseconds)

PARAM_URI

/reader/uri Text (read-only)

PARAM_USER_CONFIG

/reader/userConfig (Not yet implemented)

PARAM_USERMODE

/reader/userMode (Not yet implemented)

PARAM_ANTENNA_CHECKPORT

/reader/antenna/checkPort Bool

PARAM_ANTENNA_CONNECTEDPORTLIST

/reader/antenna/connectedPortList [Word8], or typedef 'System.Hardware.MercuryApi.AntennaPort'

PARAM_ANTENNA_PORTLIST

/reader/antenna/portList [Word8], or typedef 'System.Hardware.MercuryApi.AntennaPort'

PARAM_ANTENNA_PORTSWITCHGPOS

/reader/antenna/portSwitchGpos [Word8], or typedef [PinNumber]

PARAM_ANTENNA_RETURNLOSS

/reader/antenna/returnLoss (Not yet implemented)

PARAM_ANTENNA_SETTLINGTIMELIST

/reader/antenna/settlingTimeList (Not yet implemented)

PARAM_ANTENNA_TXRXMAP

/reader/antenna/txRxMap (Not yet implemented)

PARAM_GEN2_BLF

/reader/gen2/BLF (Not yet implemented)

PARAM_GEN2_ACCESSPASSWORD

/reader/gen2/accessPassword Word32, or typedef GEN2_Password

PARAM_GEN2_BAP

/reader/gen2/bap (Not yet implemented)

PARAM_GEN2_PROTOCOLEXTENSION

/reader/gen2/protocolExtension (Not yet implemented)

PARAM_GEN2_Q

/reader/gen2/q (Not yet implemented)

PARAM_GEN2_SESSION

/reader/gen2/session (Not yet implemented)

PARAM_GEN2_TAGENCODING

/reader/gen2/tagEncoding (Not yet implemented)

PARAM_GEN2_TARGET

/reader/gen2/target (Not yet implemented)

PARAM_GEN2_TARI

/reader/gen2/tari (Not yet implemented)

PARAM_READER_WRITE_EARLY_EXIT

/reader/gen2/writeEarlyExit Bool

PARAM_GEN2_WRITEMODE

/reader/gen2/writeMode GEN2_WriteMode

PARAM_READER_WRITE_REPLY_TIMEOUT

/reader/gen2/writeReplyTimeout Word16 (microseconds)

PARAM_GPIO_INPUTLIST

/reader/gpio/inputList [Word8], or typedef [PinNumber]

PARAM_GPIO_OUTPUTLIST

/reader/gpio/outputList [Word8], or typedef [PinNumber]

PARAM_ISO180006B_BLF

/reader/iso180006b/BLF (Not yet implemented)

PARAM_ISO180006B_DELIMITER

/reader/iso180006b/delimiter (Not yet implemented)

PARAM_ISO180006B_MODULATION_DEPTH

/reader/iso180006b/modulationDepth (Not yet implemented)

PARAM_RADIO_ENABLEPOWERSAVE

/reader/radio/enablePowerSave Bool

PARAM_RADIO_ENABLESJC

/reader/radio/enableSJC Bool

PARAM_RADIO_PORTREADPOWERLIST

/reader/radio/portReadPowerList (Not yet implemented)

PARAM_RADIO_PORTWRITEPOWERLIST

/reader/radio/portWritePowerList (Not yet implemented)

PARAM_RADIO_POWERMAX

/reader/radio/powerMax Int16 (centi-dBm, read-only)

PARAM_RADIO_POWERMIN

/reader/radio/powerMin Int16 (centi-dBm, read-only)

PARAM_RADIO_READPOWER

/reader/radio/readPower Int32 (centi-dBm)

PARAM_RADIO_TEMPERATURE

/reader/radio/temperature Int8 (degrees C, read-only)

PARAM_RADIO_WRITEPOWER

/reader/radio/writePower Int32 (centi-dBm)

PARAM_READ_ASYNCOFFTIME

/reader/read/asyncOffTime Word32 (milliseconds)

PARAM_READ_ASYNCONTIME

/reader/read/asyncOnTime Word32 (milliseconds)

PARAM_READ_PLAN

/reader/read/plan ReadPlan

PARAM_REGION_HOPTABLE

/reader/region/hopTable 'Word32'

PARAM_REGION_HOPTIME

/reader/region/hopTime Word32 (milliseconds)

PARAM_REGION_ID

/reader/region/id Region

PARAM_REGION_SUPPORTEDREGIONS

/reader/region/supportedRegions 'Region'

PARAM_REGION_LBT_ENABLE

/reader/region/lbt/enable Bool

PARAM_READER_STATS_ENABLE

/reader/stats/enable (Not yet implemented)

PARAM_STATUS_ENABLE_ANTENNAREPORT

/reader/status/antennaEnable Bool

PARAM_STATUS_ENABLE_FREQUENCYREPORT

/reader/status/frequencyEnable Bool

PARAM_STATUS_ENABLE_TEMPERATUREREPORT

/reader/status/temperatureEnable Bool

PARAM_TAGREADDATA_ENABLEREADFILTER

/reader/tagReadData/enableReadFilter Bool

PARAM_TAGREADDATA_READFILTERTIMEOUT

/reader/tagReadData/readFilterTimeout Int32

PARAM_TAGREADDATA_RECORDHIGHESTRSSI

/reader/tagReadData/recordHighestRssi Bool

PARAM_TAGREADDATA_REPORTRSSIINDBM

/reader/tagReadData/reportRssiInDbm Bool

PARAM_TAGREADATA_TAGOPFAILURECOUNT

/reader/tagReadData/tagopFailures Word16 (read-only)

PARAM_TAGREADATA_TAGOPSUCCESSCOUNT

/reader/tagReadData/tagopSuccesses Word16 (read-only)

PARAM_TAGREADDATA_UNIQUEBYANTENNA

/reader/tagReadData/uniqueByAntenna Bool

PARAM_TAGREADDATA_UNIQUEBYDATA

/reader/tagReadData/uniqueByData Bool

PARAM_TAGREADDATA_UNIQUEBYPROTOCOL

/reader/tagReadData/uniqueByProtocol Bool

PARAM_TAGOP_ANTENNA

/reader/tagop/antenna Word8, or typedef AntennaPort

PARAM_TAGOP_PROTOCOL

/reader/tagop/protocol TagProtocol

PARAM_TRIGGER_READ_GPI

/reader/trigger/read/Gpi [Word8], or typedef [PinNumber]

PARAM_VERSION_HARDWARE

/reader/version/hardware Text (read-only)

PARAM_VERSION_MODEL

/reader/version/model Text (read-only)

PARAM_PRODUCT_GROUP

/reader/version/productGroup Text (read-only)

PARAM_PRODUCT_GROUP_ID

/reader/version/productGroupID Word16 (read-only)

PARAM_PRODUCT_ID

/reader/version/productID Word16 (read-only)

PARAM_VERSION_SERIAL

/reader/version/serial Text

PARAM_VERSION_SOFTWARE

/reader/version/software Text (read-only)

PARAM_VERSION_SUPPORTEDPROTOCOLS

/reader/version/supportedProtocols 'TagProtocol'

PARAM_SELECTED_PROTOCOLS

Instances

Bounded Param

Defined in System.Hardware.MercuryApi.Enums

Methods

minBound :: Param

maxBound :: Param

Enum Param

Defined in System.Hardware.MercuryApi.Enums

Methods

succ :: Param -> Param

pred :: Param -> Param

toEnum :: Int -> Param

fromEnum :: Param -> Int

enumFrom :: Param -> [Param]

enumFromThen :: Param -> Param -> [Param]

enumFromTo :: Param -> Param -> [Param]

enumFromThenTo :: Param -> Param -> Param -> [Param]

Eq Param

Defined in System.Hardware.MercuryApi.Enums

Methods

(==) :: Param -> Param -> Bool

(/=) :: Param -> Param -> Bool

Ord Param

Defined in System.Hardware.MercuryApi.Enums

Methods

compare :: Param -> Param -> Ordering

(<) :: Param -> Param -> Bool

(<=) :: Param -> Param -> Bool

(>) :: Param -> Param -> Bool

(>=) :: Param -> Param -> Bool

max :: Param -> Param -> Param

min :: Param -> Param -> Param

Read Param

Defined in System.Hardware.MercuryApi.Enums

Methods

readsPrec :: Int -> ReadS Param

readList :: ReadS [Param]

readPrec :: ReadPrec Param

readListPrec :: ReadPrec [Param]

Show Param

Defined in System.Hardware.MercuryApi.Enums

Methods

showsPrec :: Int -> Param -> ShowS

show :: Param -> String

showList :: [Param] -> ShowS

Hashable Param

Defined in System.Hardware.MercuryApi.Enums

Methods

hashWithSalt :: Int -> Param -> Int

hash :: Param -> Int

data ParamType

The Haskell data type expected for a particular parameter.

Constructors

ParamTypeBool

ParamTypeGEN2_WriteMode

ParamTypeInt16

ParamTypeInt32

ParamTypeInt8

ParamTypeMetadataFlagList

ParamTypePowerMode

ParamTypeReadPlan

ParamTypeRegion

ParamTypeRegionList

ParamTypeTagProtocol

ParamTypeTagProtocolList

ParamTypeText

ParamTypeWord16

ParamTypeWord32

ParamTypeWord32List

ParamTypeWord8

ParamTypeWord8List

ParamTypeUnimplemented

Instances

Bounded ParamType

Defined in System.Hardware.MercuryApi.Enums

Methods

minBound :: ParamType

maxBound :: ParamType

Enum ParamType

Defined in System.Hardware.MercuryApi.Enums

Methods

succ :: ParamType -> ParamType

pred :: ParamType -> ParamType

toEnum :: Int -> ParamType

fromEnum :: ParamType -> Int

enumFrom :: ParamType -> [ParamType]

enumFromThen :: ParamType -> ParamType -> [ParamType]

enumFromTo :: ParamType -> ParamType -> [ParamType]

enumFromThenTo :: ParamType -> ParamType -> ParamType -> [ParamType]

Eq ParamType

Defined in System.Hardware.MercuryApi.Enums

Methods

(==) :: ParamType -> ParamType -> Bool

(/=) :: ParamType -> ParamType -> Bool

Ord ParamType

Defined in System.Hardware.MercuryApi.Enums

Methods

compare :: ParamType -> ParamType -> Ordering

(<) :: ParamType -> ParamType -> Bool

(<=) :: ParamType -> ParamType -> Bool

(>) :: ParamType -> ParamType -> Bool

(>=) :: ParamType -> ParamType -> Bool

max :: ParamType -> ParamType -> ParamType

min :: ParamType -> ParamType -> ParamType

Read ParamType

Defined in System.Hardware.MercuryApi.Enums

Methods

readsPrec :: Int -> ReadS ParamType

readList :: ReadS [ParamType]

readPrec :: ReadPrec ParamType

readListPrec :: ReadPrec [ParamType]

Show ParamType

Defined in System.Hardware.MercuryApi.Enums

Methods

showsPrec :: Int -> ParamType -> ShowS

show :: ParamType -> String

showList :: [ParamType] -> ShowS

data Region

RFID regulatory regions

Constructors

REGION_NONE

Unspecified region

REGION_NA

North America

REGION_EU

European Union

REGION_KR

Korea

REGION_IN

India

REGION_JP

Japan

REGION_PRC

People's Republic of China

REGION_EU2

European Union 2

REGION_EU3

European Union 3

REGION_KR2

Korea 2

REGION_PRC2

People's Republic of China(840MHZ)

REGION_AU

Australia

REGION_NZ

New Zealand !!EXPERIMENTAL!!

REGION_NA2

Reduced FCC region

REGION_NA3

5MHZ FCC band

REGION_IS

Israel

REGION_OPEN

Open

Instances

Bounded Region

Defined in System.Hardware.MercuryApi.Enums

Methods

minBound :: Region

maxBound :: Region

Enum Region

Defined in System.Hardware.MercuryApi.Enums

Methods

succ :: Region -> Region

pred :: Region -> Region

toEnum :: Int -> Region

fromEnum :: Region -> Int

enumFrom :: Region -> [Region]

enumFromThen :: Region -> Region -> [Region]

enumFromTo :: Region -> Region -> [Region]

enumFromThenTo :: Region -> Region -> Region -> [Region]

Eq Region

Defined in System.Hardware.MercuryApi.Enums

Methods

(==) :: Region -> Region -> Bool

(/=) :: Region -> Region -> Bool

Ord Region

Defined in System.Hardware.MercuryApi.Enums

Methods

compare :: Region -> Region -> Ordering

(<) :: Region -> Region -> Bool

(<=) :: Region -> Region -> Bool

(>) :: Region -> Region -> Bool

(>=) :: Region -> Region -> Bool

max :: Region -> Region -> Region

min :: Region -> Region -> Region

Read Region

Defined in System.Hardware.MercuryApi.Enums

Methods

readsPrec :: Int -> ReadS Region

readList :: ReadS [Region]

readPrec :: ReadPrec Region

readListPrec :: ReadPrec [Region]

Show Region

Defined in System.Hardware.MercuryApi.Enums

Methods

showsPrec :: Int -> Region -> ShowS

show :: Region -> String

showList :: [Region] -> ShowS

ParamValue Region

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: Region -> ParamType

pGet :: (Ptr () -> IO ()) -> IO Region

pSet :: Region -> (Ptr () -> IO ()) -> IO ()

ParamValue [Region]

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: [Region] -> ParamType

pGet :: (Ptr () -> IO ()) -> IO [Region]

pSet :: [Region] -> (Ptr () -> IO ()) -> IO ()

data TagProtocol

The protocol used by an RFID tag. Only TAG_PROTOCOL_GEN2 is supported by the M6e Nano, and therefore the Haskell binding currently only supports that protocol.

Constructors

TAG_PROTOCOL_NONE

TAG_PROTOCOL_ISO180006B

TAG_PROTOCOL_GEN2

TAG_PROTOCOL_ISO180006B_UCODE

TAG_PROTOCOL_IPX64

TAG_PROTOCOL_IPX256

TAG_PROTOCOL_ATA

Instances

Bounded TagProtocol

Defined in System.Hardware.MercuryApi.Enums

Methods

minBound :: TagProtocol

maxBound :: TagProtocol

Enum TagProtocol

Defined in System.Hardware.MercuryApi.Enums

Methods

succ :: TagProtocol -> TagProtocol

pred :: TagProtocol -> TagProtocol

toEnum :: Int -> TagProtocol

fromEnum :: TagProtocol -> Int

enumFrom :: TagProtocol -> [TagProtocol]

enumFromThen :: TagProtocol -> TagProtocol -> [TagProtocol]

enumFromTo :: TagProtocol -> TagProtocol -> [TagProtocol]

enumFromThenTo :: TagProtocol -> TagProtocol -> TagProtocol -> [TagProtocol]

Eq TagProtocol

Defined in System.Hardware.MercuryApi.Enums

Methods

(==) :: TagProtocol -> TagProtocol -> Bool

(/=) :: TagProtocol -> TagProtocol -> Bool

Ord TagProtocol

Defined in System.Hardware.MercuryApi.Enums

Methods

compare :: TagProtocol -> TagProtocol -> Ordering

(<) :: TagProtocol -> TagProtocol -> Bool

(<=) :: TagProtocol -> TagProtocol -> Bool

(>) :: TagProtocol -> TagProtocol -> Bool

(>=) :: TagProtocol -> TagProtocol -> Bool

max :: TagProtocol -> TagProtocol -> TagProtocol

min :: TagProtocol -> TagProtocol -> TagProtocol

Read TagProtocol

Defined in System.Hardware.MercuryApi.Enums

Methods

readsPrec :: Int -> ReadS TagProtocol

readList :: ReadS [TagProtocol]

readPrec :: ReadPrec TagProtocol

readListPrec :: ReadPrec [TagProtocol]

Show TagProtocol

Defined in System.Hardware.MercuryApi.Enums

Methods

showsPrec :: Int -> TagProtocol -> ShowS

show :: TagProtocol -> String

showList :: [TagProtocol] -> ShowS

ParamValue TagProtocol

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: TagProtocol -> ParamType

pGet :: (Ptr () -> IO ()) -> IO TagProtocol

pSet :: TagProtocol -> (Ptr () -> IO ()) -> IO ()

ParamValue [TagProtocol]

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: [TagProtocol] -> ParamType

pGet :: (Ptr () -> IO ()) -> IO [TagProtocol]

pSet :: [TagProtocol] -> (Ptr () -> IO ()) -> IO ()

data MetadataFlag

Various metadata parameters which can be requested in PARAM_METADATAFLAG.

Constructors

METADATA_FLAG_READCOUNT

METADATA_FLAG_RSSI

METADATA_FLAG_ANTENNAID

METADATA_FLAG_FREQUENCY

METADATA_FLAG_TIMESTAMP

METADATA_FLAG_PHASE

METADATA_FLAG_PROTOCOL

METADATA_FLAG_DATA

METADATA_FLAG_GPIO_STATUS

Instances

Bounded MetadataFlag

Defined in System.Hardware.MercuryApi.Enums

Methods

minBound :: MetadataFlag

maxBound :: MetadataFlag

Enum MetadataFlag

Defined in System.Hardware.MercuryApi.Enums

Methods

succ :: MetadataFlag -> MetadataFlag

pred :: MetadataFlag -> MetadataFlag

toEnum :: Int -> MetadataFlag

fromEnum :: MetadataFlag -> Int

enumFrom :: MetadataFlag -> [MetadataFlag]

enumFromThen :: MetadataFlag -> MetadataFlag -> [MetadataFlag]

enumFromTo :: MetadataFlag -> MetadataFlag -> [MetadataFlag]

enumFromThenTo :: MetadataFlag -> MetadataFlag -> MetadataFlag -> [MetadataFlag]

Eq MetadataFlag

Defined in System.Hardware.MercuryApi.Enums

Methods

(==) :: MetadataFlag -> MetadataFlag -> Bool

(/=) :: MetadataFlag -> MetadataFlag -> Bool

Ord MetadataFlag

Defined in System.Hardware.MercuryApi.Enums

Methods

compare :: MetadataFlag -> MetadataFlag -> Ordering

(<) :: MetadataFlag -> MetadataFlag -> Bool

(<=) :: MetadataFlag -> MetadataFlag -> Bool

(>) :: MetadataFlag -> MetadataFlag -> Bool

(>=) :: MetadataFlag -> MetadataFlag -> Bool

max :: MetadataFlag -> MetadataFlag -> MetadataFlag

min :: MetadataFlag -> MetadataFlag -> MetadataFlag

Read MetadataFlag

Defined in System.Hardware.MercuryApi.Enums

Methods

readsPrec :: Int -> ReadS MetadataFlag

readList :: ReadS [MetadataFlag]

readPrec :: ReadPrec MetadataFlag

readListPrec :: ReadPrec [MetadataFlag]

Show MetadataFlag

Defined in System.Hardware.MercuryApi.Enums

Methods

showsPrec :: Int -> MetadataFlag -> ShowS

show :: MetadataFlag -> String

showList :: [MetadataFlag] -> ShowS

ParamValue [MetadataFlag]

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: [MetadataFlag] -> ParamType

pGet :: (Ptr () -> IO ()) -> IO [MetadataFlag]

pSet :: [MetadataFlag] -> (Ptr () -> IO ()) -> IO ()

data GEN2_Bank

Gen2 memory banks

Constructors

GEN2_BANK_RESERVED

Reserved bank (kill and access passwords)

GEN2_BANK_EPC

EPC memory bank

GEN2_BANK_TID

TID memory bank

GEN2_BANK_USER

User memory bank

Instances

Bounded GEN2_Bank

Defined in System.Hardware.MercuryApi.Enums

Methods

minBound :: GEN2_Bank

maxBound :: GEN2_Bank

Enum GEN2_Bank

Defined in System.Hardware.MercuryApi.Enums

Methods

succ :: GEN2_Bank -> GEN2_Bank

pred :: GEN2_Bank -> GEN2_Bank

toEnum :: Int -> GEN2_Bank

fromEnum :: GEN2_Bank -> Int

enumFrom :: GEN2_Bank -> [GEN2_Bank]

enumFromThen :: GEN2_Bank -> GEN2_Bank -> [GEN2_Bank]

enumFromTo :: GEN2_Bank -> GEN2_Bank -> [GEN2_Bank]

enumFromThenTo :: GEN2_Bank -> GEN2_Bank -> GEN2_Bank -> [GEN2_Bank]

Eq GEN2_Bank

Defined in System.Hardware.MercuryApi.Enums

Methods

(==) :: GEN2_Bank -> GEN2_Bank -> Bool

(/=) :: GEN2_Bank -> GEN2_Bank -> Bool

Ord GEN2_Bank

Defined in System.Hardware.MercuryApi.Enums

Methods

compare :: GEN2_Bank -> GEN2_Bank -> Ordering

(<) :: GEN2_Bank -> GEN2_Bank -> Bool

(<=) :: GEN2_Bank -> GEN2_Bank -> Bool

(>) :: GEN2_Bank -> GEN2_Bank -> Bool

(>=) :: GEN2_Bank -> GEN2_Bank -> Bool

max :: GEN2_Bank -> GEN2_Bank -> GEN2_Bank

min :: GEN2_Bank -> GEN2_Bank -> GEN2_Bank

Read GEN2_Bank

Defined in System.Hardware.MercuryApi.Enums

Methods

readsPrec :: Int -> ReadS GEN2_Bank

readList :: ReadS [GEN2_Bank]

readPrec :: ReadPrec GEN2_Bank

readListPrec :: ReadPrec [GEN2_Bank]

Show GEN2_Bank

Defined in System.Hardware.MercuryApi.Enums

Methods

showsPrec :: Int -> GEN2_Bank -> ShowS

show :: GEN2_Bank -> String

showList :: [GEN2_Bank] -> ShowS

data GEN2_LockBits

Memory lock bits

Constructors

GEN2_LOCK_BITS_USER_PERM

User memory bank lock permalock bit

GEN2_LOCK_BITS_USER

User memory bank lock bit

GEN2_LOCK_BITS_TID_PERM

TID memory bank lock permalock bit

GEN2_LOCK_BITS_TID

TID memory bank lock bit

GEN2_LOCK_BITS_EPC_PERM

EPC memory bank lock permalock bit

GEN2_LOCK_BITS_EPC

EPC memory bank lock bit

GEN2_LOCK_BITS_ACCESS_PERM

Access password lock permalock bit

GEN2_LOCK_BITS_ACCESS

Access password lock bit

GEN2_LOCK_BITS_KILL_PERM

Kill password lock permalock bit

GEN2_LOCK_BITS_KILL

Kill password lock bit

Instances

Bounded GEN2_LockBits

Defined in System.Hardware.MercuryApi.Enums

Methods

minBound :: GEN2_LockBits

maxBound :: GEN2_LockBits

Enum GEN2_LockBits

Defined in System.Hardware.MercuryApi.Enums

Methods

succ :: GEN2_LockBits -> GEN2_LockBits

pred :: GEN2_LockBits -> GEN2_LockBits

toEnum :: Int -> GEN2_LockBits

fromEnum :: GEN2_LockBits -> Int

enumFrom :: GEN2_LockBits -> [GEN2_LockBits]

enumFromThen :: GEN2_LockBits -> GEN2_LockBits -> [GEN2_LockBits]

enumFromTo :: GEN2_LockBits -> GEN2_LockBits -> [GEN2_LockBits]

enumFromThenTo :: GEN2_LockBits -> GEN2_LockBits -> GEN2_LockBits -> [GEN2_LockBits]

Eq GEN2_LockBits

Defined in System.Hardware.MercuryApi.Enums

Methods

(==) :: GEN2_LockBits -> GEN2_LockBits -> Bool

(/=) :: GEN2_LockBits -> GEN2_LockBits -> Bool

Ord GEN2_LockBits

Defined in System.Hardware.MercuryApi.Enums

Methods

compare :: GEN2_LockBits -> GEN2_LockBits -> Ordering

(<) :: GEN2_LockBits -> GEN2_LockBits -> Bool

(<=) :: GEN2_LockBits -> GEN2_LockBits -> Bool

(>) :: GEN2_LockBits -> GEN2_LockBits -> Bool

(>=) :: GEN2_LockBits -> GEN2_LockBits -> Bool

max :: GEN2_LockBits -> GEN2_LockBits -> GEN2_LockBits

min :: GEN2_LockBits -> GEN2_LockBits -> GEN2_LockBits

Read GEN2_LockBits

Defined in System.Hardware.MercuryApi.Enums

Methods

readsPrec :: Int -> ReadS GEN2_LockBits

readList :: ReadS [GEN2_LockBits]

readPrec :: ReadPrec GEN2_LockBits

readListPrec :: ReadPrec [GEN2_LockBits]

Show GEN2_LockBits

Defined in System.Hardware.MercuryApi.Enums

Methods

showsPrec :: Int -> GEN2_LockBits -> ShowS

show :: GEN2_LockBits -> String

showList :: [GEN2_LockBits] -> ShowS

data GEN2_WriteMode

Whether to use word write or block write for TagOp_GEN2_WriteData.

Constructors

GEN2_WORD_ONLY

GEN2_BLOCK_ONLY

GEN2_BLOCK_FALLBACK

Instances

Bounded GEN2_WriteMode

Defined in System.Hardware.MercuryApi.Enums

Methods

minBound :: GEN2_WriteMode

maxBound :: GEN2_WriteMode

Enum GEN2_WriteMode

Defined in System.Hardware.MercuryApi.Enums

Methods

succ :: GEN2_WriteMode -> GEN2_WriteMode

pred :: GEN2_WriteMode -> GEN2_WriteMode

toEnum :: Int -> GEN2_WriteMode

fromEnum :: GEN2_WriteMode -> Int

enumFrom :: GEN2_WriteMode -> [GEN2_WriteMode]

enumFromThen :: GEN2_WriteMode -> GEN2_WriteMode -> [GEN2_WriteMode]

enumFromTo :: GEN2_WriteMode -> GEN2_WriteMode -> [GEN2_WriteMode]

enumFromThenTo :: GEN2_WriteMode -> GEN2_WriteMode -> GEN2_WriteMode -> [GEN2_WriteMode]

Eq GEN2_WriteMode

Defined in System.Hardware.MercuryApi.Enums

Methods

(==) :: GEN2_WriteMode -> GEN2_WriteMode -> Bool

(/=) :: GEN2_WriteMode -> GEN2_WriteMode -> Bool

Ord GEN2_WriteMode

Defined in System.Hardware.MercuryApi.Enums

Methods

compare :: GEN2_WriteMode -> GEN2_WriteMode -> Ordering

(<) :: GEN2_WriteMode -> GEN2_WriteMode -> Bool

(<=) :: GEN2_WriteMode -> GEN2_WriteMode -> Bool

(>) :: GEN2_WriteMode -> GEN2_WriteMode -> Bool

(>=) :: GEN2_WriteMode -> GEN2_WriteMode -> Bool

max :: GEN2_WriteMode -> GEN2_WriteMode -> GEN2_WriteMode

min :: GEN2_WriteMode -> GEN2_WriteMode -> GEN2_WriteMode

Read GEN2_WriteMode

Defined in System.Hardware.MercuryApi.Enums

Methods

readsPrec :: Int -> ReadS GEN2_WriteMode

readList :: ReadS [GEN2_WriteMode]

readPrec :: ReadPrec GEN2_WriteMode

readListPrec :: ReadPrec [GEN2_WriteMode]

Show GEN2_WriteMode

Defined in System.Hardware.MercuryApi.Enums

Methods

showsPrec :: Int -> GEN2_WriteMode -> ShowS

show :: GEN2_WriteMode -> String

showList :: [GEN2_WriteMode] -> ShowS

ParamValue GEN2_WriteMode

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: GEN2_WriteMode -> ParamType

pGet :: (Ptr () -> IO ()) -> IO GEN2_WriteMode

pSet :: GEN2_WriteMode -> (Ptr () -> IO ()) -> IO ()

data PowerMode

Value for parameter PARAM_POWERMODE. On the M6e Nano, POWER_MODE_MINSAVE, POWER_MODE_MEDSAVE, and POWER_MODE_MAXSAVE are all the same.

Constructors

POWER_MODE_FULL

POWER_MODE_MINSAVE

POWER_MODE_MEDSAVE

POWER_MODE_MAXSAVE

POWER_MODE_SLEEP

Instances

Bounded PowerMode

Defined in System.Hardware.MercuryApi.Enums

Methods

minBound :: PowerMode

maxBound :: PowerMode

Enum PowerMode

Defined in System.Hardware.MercuryApi.Enums

Methods

succ :: PowerMode -> PowerMode

pred :: PowerMode -> PowerMode

toEnum :: Int -> PowerMode

fromEnum :: PowerMode -> Int

enumFrom :: PowerMode -> [PowerMode]

enumFromThen :: PowerMode -> PowerMode -> [PowerMode]

enumFromTo :: PowerMode -> PowerMode -> [PowerMode]

enumFromThenTo :: PowerMode -> PowerMode -> PowerMode -> [PowerMode]

Eq PowerMode

Defined in System.Hardware.MercuryApi.Enums

Methods

(==) :: PowerMode -> PowerMode -> Bool

(/=) :: PowerMode -> PowerMode -> Bool

Ord PowerMode

Defined in System.Hardware.MercuryApi.Enums

Methods

compare :: PowerMode -> PowerMode -> Ordering

(<) :: PowerMode -> PowerMode -> Bool

(<=) :: PowerMode -> PowerMode -> Bool

(>) :: PowerMode -> PowerMode -> Bool

(>=) :: PowerMode -> PowerMode -> Bool

max :: PowerMode -> PowerMode -> PowerMode

min :: PowerMode -> PowerMode -> PowerMode

Read PowerMode

Defined in System.Hardware.MercuryApi.Enums

Methods

readsPrec :: Int -> ReadS PowerMode

readList :: ReadS [PowerMode]

readPrec :: ReadPrec PowerMode

readListPrec :: ReadPrec [PowerMode]

Show PowerMode

Defined in System.Hardware.MercuryApi.Enums

Methods

showsPrec :: Int -> PowerMode -> ShowS

show :: PowerMode -> String

showList :: [PowerMode] -> ShowS

ParamValue PowerMode

Defined in System.Hardware.MercuryApi.ParamValue

Methods

pType :: PowerMode -> ParamType

pGet :: (Ptr () -> IO ()) -> IO PowerMode

pSet :: PowerMode -> (Ptr () -> IO ()) -> IO ()

data TransportDirection

The direction of data travel. Passed to TransportListener.

Constructors

Rx

Receive

Tx

Transmit

Instances

Bounded TransportDirection

Defined in System.Hardware.MercuryApi

Methods

minBound :: TransportDirection

maxBound :: TransportDirection

Enum TransportDirection

Defined in System.Hardware.MercuryApi

Methods

succ :: TransportDirection -> TransportDirection

pred :: TransportDirection -> TransportDirection

toEnum :: Int -> TransportDirection

fromEnum :: TransportDirection -> Int

enumFrom :: TransportDirection -> [TransportDirection]

enumFromThen :: TransportDirection -> TransportDirection -> [TransportDirection]

enumFromTo :: TransportDirection -> TransportDirection -> [TransportDirection]

enumFromThenTo :: TransportDirection -> TransportDirection -> TransportDirection -> [TransportDirection]

Eq TransportDirection

Defined in System.Hardware.MercuryApi

Methods

(==) :: TransportDirection -> TransportDirection -> Bool

(/=) :: TransportDirection -> TransportDirection -> Bool

Ord TransportDirection

Defined in System.Hardware.MercuryApi

Methods

compare :: TransportDirection -> TransportDirection -> Ordering

(<) :: TransportDirection -> TransportDirection -> Bool

(<=) :: TransportDirection -> TransportDirection -> Bool

(>) :: TransportDirection -> TransportDirection -> Bool

(>=) :: TransportDirection -> TransportDirection -> Bool

max :: TransportDirection -> TransportDirection -> TransportDirection

min :: TransportDirection -> TransportDirection -> TransportDirection

Read TransportDirection

Defined in System.Hardware.MercuryApi

Methods

readsPrec :: Int -> ReadS TransportDirection

readList :: ReadS [TransportDirection]

readPrec :: ReadPrec TransportDirection

readListPrec :: ReadPrec [TransportDirection]

Show TransportDirection

Defined in System.Hardware.MercuryApi

Methods

showsPrec :: Int -> TransportDirection -> ShowS

show :: TransportDirection -> String

showList :: [TransportDirection] -> ShowS