Mercury API - Serial Reader interface. More...

#include "tmr_region.h"
#include "tmr_tag_protocol.h"
#include "tmr_serial_transport.h"

Include dependency graph for tmr_serial_reader.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	TM_SR_SerialReader
struct	TMR_AntennaMap
struct	TMR_AntennaMapList
struct	TMR_PortValue
struct	TMR_PortValueList
struct	TMR_SR_AntennaStatusReport
struct	TMR_SR_FrequencyStatusReport
struct	TMR_SR_GEN2_Q
struct	TMR_SR_GEN2_QStatic
struct	TMR_SR_ReaderStatistics
struct	TMR_SR_StatusReport
struct	TMR_SR_TemperatureStatusReport
struct	TMR_SR_UserConfigOp
struct	TMR_SR_VersionInfo
Defines
#define	TMR_SR_MAX_PACKET_SIZE 256
Typedefs
typedef struct TMR_AntennaMap	TMR_AntennaMap
typedef struct TMR_AntennaMapList	TMR_AntennaMapList
typedef struct TMR_PortValue	TMR_PortValue
typedef struct TMR_PortValueList	TMR_PortValueList
typedef struct TMR_SR_AntennaStatusReport	TMR_SR_AntennaStatusReport
typedef struct TMR_SR_FrequencyStatusReport	TMR_SR_FrequencyStatusReport
typedef struct TMR_SR_GEN2_Q	TMR_SR_GEN2_Q
typedef struct TMR_SR_GEN2_QStatic	TMR_SR_GEN2_QStatic
typedef enum TMR_SR_GEN2_QType	TMR_SR_GEN2_QType
typedef enum TMR_SR_PowerMode	TMR_SR_PowerMode
typedef struct TMR_SR_ReaderStatistics	TMR_SR_ReaderStatistics
typedef struct TM_SR_SerialReader	TMR_SR_SerialReader
typedef enum TMR_SR_SetProtocolLicenseOption	TMR_SR_SetProtocolLicenseOption
typedef struct TMR_SR_StatusReport	TMR_SR_StatusReport
typedef enum TMR_SR_StatusType	TMR_SR_StatusType
typedef struct TMR_SR_TemperatureStatusReport	TMR_SR_TemperatureStatusReport
typedef enum TMR_SR_UserConfigCategory	TMR_SR_UserConfigCategory
typedef struct TMR_SR_UserConfigOp	TMR_SR_UserConfigOp
typedef enum TMR_SR_UserConfigOperation	TMR_SR_UserConfigOperation
typedef enum TMR_SR_UserConfigType	TMR_SR_UserConfigType
typedef enum TMR_SR_UserMode	TMR_SR_UserMode
typedef struct TMR_SR_VersionInfo	TMR_SR_VersionInfo
typedef enum TMR_TransportType	TMR_TransportType
Enumerations
enum	TMR_SR_GEN2_QType { TMR_SR_GEN2_Q_MIN = 0, TMR_SR_GEN2_Q_DYNAMIC = 0, TMR_SR_GEN2_Q_STATIC = 1, TMR_SR_GEN2_Q_MAX = TMR_SR_GEN2_Q_STATIC, TMR_SR_GEN2_Q_INVALID = TMR_SR_GEN2_Q_MAX + 1 }
enum	TMR_SR_PowerMode { TMR_SR_POWER_MODE_MIN = 0, TMR_SR_POWER_MODE_FULL = 0, TMR_SR_POWER_MODE_MINSAVE = 1, TMR_SR_POWER_MODE_MEDSAVE = 2, TMR_SR_POWER_MODE_MAXSAVE = 3, TMR_SR_POWER_MODE_SLEEP = 4, TMR_SR_POWER_MODE_MAX = TMR_SR_POWER_MODE_SLEEP, TMR_SR_POWER_MODE_INVALID = TMR_SR_POWER_MODE_MAX + 1 }
enum	TMR_SR_SetProtocolLicenseOption { TMR_SR_SET_LICENSE_KEY = 0x01, TMR_SR_ERASE_LICENSE_KEY = 0x02 }
enum	TMR_SR_StatusType { TMR_SR_STATUS_NONE = 0x0000, TMR_SR_STATUS_FREQUENCY = 0x0002, TMR_SR_STATUS_TEMPERATURE = 0x0004, TMR_SR_STATUS_ANTENNA = 0x0008, TMR_SR_STATUS_ALL = 0x000E, TMR_SR_STATUS_MAX = 4 }
enum	TMR_SR_UserConfigCategory { TMR_SR_ALL = 0x01 }
enum	TMR_SR_UserConfigOperation { TMR_USERCONFIG_SAVE = 0x01, TMR_USERCONFIG_RESTORE = 0x02, TMR_USERCONFIG_VERIFY = 0x03, TMR_USERCONFIG_CLEAR = 0x04, TMR_USERCONFIG_SAVE_WITH_READPLAN = 0x05 }
enum	TMR_SR_UserConfigType { TMR_SR_FIRMWARE_DEFAULT = 0x00, TMR_SR_CUSTOM_CONFIGURATION = 0x01 }
enum	TMR_SR_UserMode { TMR_SR_USER_MODE_MIN = 0, TMR_SR_USER_MODE_UNSPEC = 0, TMR_SR_USER_MODE_PRINTER = 1, TMR_SR_USER_MODE_CONVEYOR = 2, TMR_SR_USER_MODE_PORTAL = 3, TMR_SR_USER_MODE_HANDHELD = 4, TMR_SR_USER_MODE_MAX = TMR_SR_USER_MODE_HANDHELD, TMR_SR_USER_MODE_INVALID = TMR_SR_USER_MODE_MAX + 1 }
enum	TMR_TransportType { TMR_SR_MSG_SOURCE_SERIAL = 0x0000, TMR_SR_MSG_SOURCE_USB = 0x0003, TMR_SR_MSG_SOURCE_UNKNOWN = 0x0004 }
Functions
TMR_Status	TMR_init_UserConfigOp (TMR_SR_UserConfigOp *config, TMR_SR_UserConfigOperation op)
TMR_Status	TMR_SR_connect (struct TMR_Reader *reader)
TMR_Status	TMR_SR_destroy (struct TMR_Reader *reader)
TMR_Status	TMR_SR_executeTagOp (struct TMR_Reader reader, TMR_TagOp tagop, TMR_TagFilter filter, TMR_uint8List data)
TMR_Status	TMR_SR_firmwareLoad (TMR_Reader reader, void cookie, TMR_FirmwareDataProvider provider)
TMR_Status	TMR_SR_getNextTag (struct TMR_Reader reader, TMR_TagReadData read)
TMR_Status	TMR_SR_gpiGet (struct TMR_Reader reader, uint8_t count, TMR_GpioPin state[])
TMR_Status	TMR_SR_gpoSet (struct TMR_Reader *reader, uint8_t count, const TMR_GpioPin state[])
TMR_Status	TMR_SR_hasMoreTags (struct TMR_Reader *reader)
TMR_Status	TMR_SR_killTag (struct TMR_Reader reader, const TMR_TagFilter filter, const TMR_TagAuthentication *auth)
TMR_Status	TMR_SR_lockTag (struct TMR_Reader reader, const TMR_TagFilter filter, TMR_TagLockAction *action)
TMR_Status	TMR_SR_modifyFlash (TMR_Reader *reader, uint8_t sector, uint32_t address, uint32_t password, uint8_t length, const uint8_t data[], uint32_t offset)
TMR_Status	TMR_SR_read (struct TMR_Reader reader, uint32_t timeoutMs, int32_t tagCount)
TMR_Status	TMR_SR_readTagMemBytes (struct TMR_Reader reader, const TMR_TagFilter filter, uint32_t bank, uint32_t address, uint16_t count, uint8_t data[])
TMR_Status	TMR_SR_readTagMemWords (struct TMR_Reader reader, const TMR_TagFilter filter, uint32_t bank, uint32_t address, uint16_t count, uint16_t *data)
TMR_Status	TMR_SR_reboot (struct TMR_Reader *reader)
TMR_Status	TMR_SR_SerialReader_init (TMR_Reader *reader)
TMR_Status	TMR_SR_writeTag (struct TMR_Reader reader, const TMR_TagFilter filter, const TMR_TagData *data)
TMR_Status	TMR_SR_writeTagMemBytes (struct TMR_Reader reader, const TMR_TagFilter filter, uint32_t bank, uint32_t address, uint16_t count, const uint8_t data[])
TMR_Status	TMR_SR_writeTagMemWords (struct TMR_Reader reader, const TMR_TagFilter filter, uint32_t bank, uint32_t address, uint16_t count, const uint16_t data[])

Detailed Description

Mercury API - Serial Reader interface.

Author:: Nathan Williams

Date:: 10/20/2009

Definition in file tmr_serial_reader.h.

Define Documentation

#define TMR_SR_MAX_PACKET_SIZE 256

Definition at line 37 of file tmr_serial_reader.h.

Typedef Documentation

typedef struct TMR_AntennaMap TMR_AntennaMap

Mapping between an arbitrary "antenna" number and a TX/RX port pair. Not all TX/RX pairings are valid for a device.

typedef struct TMR_AntennaMapList TMR_AntennaMapList

List of antenna mappings

typedef struct TMR_PortValue TMR_PortValue

An antenna port with an associated uint16_t value.

typedef struct TMR_PortValueList TMR_PortValueList

List of TMR_PortValue values

typedef struct TMR_SR_AntennaStatusReport TMR_SR_AntennaStatusReport

Object of this contains antenna status report

typedef struct TMR_SR_FrequencyStatusReport TMR_SR_FrequencyStatusReport

Object of this contains frequency status report

typedef struct TMR_SR_GEN2_Q TMR_SR_GEN2_Q

This represents a Q algorithm on the reader.

typedef struct TMR_SR_GEN2_QStatic TMR_SR_GEN2_QStatic

Configuration of the static-Q algorithm.

typedef enum TMR_SR_GEN2_QType TMR_SR_GEN2_QType

This represents the types of Q algorithms avaliable on the reader.

typedef enum TMR_SR_PowerMode TMR_SR_PowerMode

Defines the values for the parameter /reader/powerMode and the return value and parameter to TMR_SR_cmdGetPowerMode and TMR_SR_cmdSetPowerMode.

typedef struct TMR_SR_ReaderStatistics TMR_SR_ReaderStatistics

This object is returned from TMR_SR_cmdGetReaderStatistics.

typedef struct TM_SR_SerialReader TMR_SR_SerialReader

The serial reader structure.

typedef enum TMR_SR_SetProtocolLicenseOption TMR_SR_SetProtocolLicenseOption

Operation Options for cmdSetProtocolLicenseKey

typedef struct TMR_SR_StatusReport TMR_SR_StatusReport

This object contains the information related to status reports sent by the module during continuous reading

typedef enum TMR_SR_StatusType TMR_SR_StatusType

Status report content flags

typedef struct TMR_SR_TemperatureStatusReport TMR_SR_TemperatureStatusReport

Object of this contains temperature status report.

typedef enum TMR_SR_UserConfigCategory TMR_SR_UserConfigCategory

Congfiguration category for cmdSetUserProfile

typedef struct TMR_SR_UserConfigOp TMR_SR_UserConfigOp

The user profile operation structure

typedef enum TMR_SR_UserConfigOperation TMR_SR_UserConfigOperation

Operation Options for cmdSetUserProfile

typedef enum TMR_SR_UserConfigType TMR_SR_UserConfigType

The configuration type for cmdSetUserProfile

typedef enum TMR_SR_UserMode TMR_SR_UserMode

Defines the values for the parameter /reader/userMode and the return value and parameter to TMR_SR_cmdGetUserMode() and TMR_SR_cmdSetUserMode.

typedef struct TMR_SR_VersionInfo TMR_SR_VersionInfo

The version structure returned from cmdVersion().

typedef enum TMR_TransportType TMR_TransportType

Current message TransportType

Enumeration Type Documentation

enum TMR_SR_GEN2_QType

This represents the types of Q algorithms avaliable on the reader.

Enumerator:

TMR_SR_GEN2_Q_MIN
TMR_SR_GEN2_Q_DYNAMIC
TMR_SR_GEN2_Q_STATIC
TMR_SR_GEN2_Q_MAX
TMR_SR_GEN2_Q_INVALID

Definition at line 141 of file tmr_serial_reader.h.

enum TMR_SR_PowerMode

Defines the values for the parameter /reader/powerMode and the return value and parameter to TMR_SR_cmdGetPowerMode and TMR_SR_cmdSetPowerMode.

Enumerator:

TMR_SR_POWER_MODE_MIN
TMR_SR_POWER_MODE_FULL
TMR_SR_POWER_MODE_MINSAVE
TMR_SR_POWER_MODE_MEDSAVE
TMR_SR_POWER_MODE_MAXSAVE
TMR_SR_POWER_MODE_SLEEP
TMR_SR_POWER_MODE_MAX
TMR_SR_POWER_MODE_INVALID

Definition at line 48 of file tmr_serial_reader.h.

enum TMR_SR_SetProtocolLicenseOption

Operation Options for cmdSetProtocolLicenseKey

Enumerator:

TMR_SR_SET_LICENSE_KEY	Set Valid License Key
TMR_SR_ERASE_LICENSE_KEY	Erase License Key

Definition at line 63 of file tmr_serial_reader.h.

enum TMR_SR_StatusType

Status report content flags

Enumerator:

TMR_SR_STATUS_NONE
TMR_SR_STATUS_FREQUENCY
TMR_SR_STATUS_TEMPERATURE
TMR_SR_STATUS_ANTENNA
TMR_SR_STATUS_ALL
TMR_SR_STATUS_MAX

Definition at line 399 of file tmr_serial_reader.h.

enum TMR_SR_UserConfigCategory

Congfiguration category for cmdSetUserProfile

Enumerator:

TMR_SR_ALL

All Configuration

Definition at line 91 of file tmr_serial_reader.h.

enum TMR_SR_UserConfigOperation

Operation Options for cmdSetUserProfile

Enumerator:

TMR_USERCONFIG_SAVE	Save operation
TMR_USERCONFIG_RESTORE	Restore operation
TMR_USERCONFIG_VERIFY	Verify operation
TMR_USERCONFIG_CLEAR	Clear operation
TMR_USERCONFIG_SAVE_WITH_READPLAN	Save read plan configuration

Definition at line 74 of file tmr_serial_reader.h.

enum TMR_SR_UserConfigType

The configuration type for cmdSetUserProfile

Enumerator:

TMR_SR_FIRMWARE_DEFAULT	Firmware default configurations
TMR_SR_CUSTOM_CONFIGURATION	Custom configurations

Definition at line 100 of file tmr_serial_reader.h.

enum TMR_SR_UserMode

Defines the values for the parameter /reader/userMode and the return value and parameter to TMR_SR_cmdGetUserMode() and TMR_SR_cmdSetUserMode.

Enumerator:

TMR_SR_USER_MODE_MIN
TMR_SR_USER_MODE_UNSPEC
TMR_SR_USER_MODE_PRINTER
TMR_SR_USER_MODE_CONVEYOR
TMR_SR_USER_MODE_PORTAL
TMR_SR_USER_MODE_HANDHELD
TMR_SR_USER_MODE_MAX
TMR_SR_USER_MODE_INVALID

Definition at line 126 of file tmr_serial_reader.h.

enum TMR_TransportType

Current message TransportType

Enumerator:

TMR_SR_MSG_SOURCE_SERIAL
TMR_SR_MSG_SOURCE_USB
TMR_SR_MSG_SOURCE_UNKNOWN

Definition at line 238 of file tmr_serial_reader.h.

Function Documentation

TMR_Status TMR_init_UserConfigOp	(	TMR_SR_UserConfigOp *	config,
		TMR_SR_UserConfigOperation	op
	)

TMR_Status TMR_SR_connect ( struct TMR_Reader * reader )

TMR_Status TMR_SR_destroy ( struct TMR_Reader * reader )

TMR_Status TMR_SR_executeTagOp	(	struct TMR_Reader *	reader,
		TMR_TagOp *	tagop,
		TMR_TagFilter *	filter,
		TMR_uint8List *	data
	)

TMR_Status TMR_SR_firmwareLoad	(	TMR_Reader *	reader,
		void *	cookie,
		TMR_FirmwareDataProvider	provider
	)

TMR_Status TMR_SR_getNextTag	(	struct TMR_Reader *	reader,
		TMR_TagReadData *	read
	)

TMR_Status TMR_SR_gpiGet	(	struct TMR_Reader *	reader,
		uint8_t *	count,
		TMR_GpioPin	state[]
	)

TMR_Status TMR_SR_gpoSet	(	struct TMR_Reader *	reader,
		uint8_t	count,
		const TMR_GpioPin	state[]
	)

TMR_Status TMR_SR_hasMoreTags ( struct TMR_Reader * reader )

TMR_Status TMR_SR_killTag	(	struct TMR_Reader *	reader,
		const TMR_TagFilter *	filter,
		const TMR_TagAuthentication *	auth
	)

TMR_Status TMR_SR_lockTag	(	struct TMR_Reader *	reader,
		const TMR_TagFilter *	filter,
		TMR_TagLockAction *	action
	)

TMR_Status TMR_SR_modifyFlash	(	TMR_Reader *	reader,
		uint8_t	sector,
		uint32_t	address,
		uint32_t	password,
		uint8_t	length,
		const uint8_t	data[],
		uint32_t	offset
	)

TMR_Status TMR_SR_read	(	struct TMR_Reader *	reader,
		uint32_t	timeoutMs,
		int32_t *	tagCount
	)

TMR_Status TMR_SR_readTagMemBytes	(	struct TMR_Reader *	reader,
		const TMR_TagFilter *	filter,
		uint32_t	bank,
		uint32_t	address,
		uint16_t	count,
		uint8_t	data[]
	)

TMR_Status TMR_SR_readTagMemWords	(	struct TMR_Reader *	reader,
		const TMR_TagFilter *	filter,
		uint32_t	bank,
		uint32_t	address,
		uint16_t	count,
		uint16_t *	data
	)

TMR_Status TMR_SR_reboot ( struct TMR_Reader * reader )

TMR_Status TMR_SR_SerialReader_init ( TMR_Reader * reader )

Initialize a serial reader. The reader->u.serialReader.transport structure must be initialized before calling this.

TMR_Status TMR_SR_writeTag	(	struct TMR_Reader *	reader,
		const TMR_TagFilter *	filter,
		const TMR_TagData *	data
	)

TMR_Status TMR_SR_writeTagMemBytes	(	struct TMR_Reader *	reader,
		const TMR_TagFilter *	filter,
		uint32_t	bank,
		uint32_t	address,
		uint16_t	count,
		const uint8_t	data[]
	)

TMR_Status TMR_SR_writeTagMemWords	(	struct TMR_Reader *	reader,
		const TMR_TagFilter *	filter,
		uint32_t	bank,
		uint32_t	address,
		uint16_t	count,
		const uint16_t	data[]
	)

Classes

Defines

Typedefs

Enumerations

Functions

Detailed Description

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation