Read plans

Classes
struct	TMR_GPITriggerRead
struct	TMR_MultiReadPlan
struct	TMR_ReadPlan
struct	TMR_SimpleReadPlan
struct	TMR_StopOnTagCount
Typedefs
typedef struct TMR_GPITriggerRead	TMR_GPITriggerRead
typedef struct TMR_MultiReadPlan	TMR_MultiReadPlan
typedef struct TMR_ReadPlan	TMR_ReadPlan
typedef enum TMR_ReadPlanType	TMR_ReadPlanType
typedef struct TMR_SimpleReadPlan	TMR_SimpleReadPlan
typedef struct TMR_StopOnTagCount	TMR_StopOnTagCount
typedef struct TMR_StopTrigger	TMR_StopTrigger
typedef struct TMR_TagObservationTrigger	TMR_TagObservationTrigger
Enumerations
enum	TMR_ReadPlanType { TMR_READ_PLAN_TYPE_INVALID, TMR_READ_PLAN_TYPE_SIMPLE, TMR_READ_PLAN_TYPE_MULTI }
Functions
TMR_Status	TMR_GPITR_init_enable (TMR_GPITriggerRead *triggerRead, bool enable)
TMR_Status	TMR_RP_init_multi (TMR_ReadPlan *plan, TMR_ReadPlan **plans, uint8_t planCount, uint32_t weight)
TMR_Status	TMR_RP_init_simple (TMR_ReadPlan *plan, uint8_t antennaCount, uint8_t *antennaList, TMR_TagProtocol protocol, uint32_t weight)
TMR_Status	TMR_RP_set_enableAutonomousRead (TMR_ReadPlan *plan, bool autonomousRead)
TMR_Status	TMR_RP_set_enableTriggerRead (TMR_ReadPlan *plan, TMR_GPITriggerRead *triggerRead)
TMR_Status	TMR_RP_set_filter (TMR_ReadPlan *plan, TMR_TagFilter *filter)
TMR_Status	TMR_RP_set_stopTrigger (TMR_ReadPlan *plan, uint32_t count)
TMR_Status	TMR_RP_set_tagop (TMR_ReadPlan *plan, TMR_TagOp *tagop)
TMR_Status	TMR_RP_set_useFastSearch (TMR_ReadPlan *plan, bool useFastSearch)

---

Detailed Description

A read plan specifies the antennas, protocols, and filters to use for a search (read). Each ReadPlan structure has a numeric weight that controls what fraction of a search is used by that plan when combined in a MultiReadPlan (see below). Read plans are specified for the reader in the /reader/read/plan parameter.

---

Typedef Documentation

typedef struct TMR_GPITriggerRead TMR_GPITriggerRead

Definition at line 60 of file tmr_read_plan.h.

typedef struct TMR_MultiReadPlan TMR_MultiReadPlan

Definition at line 56 of file tmr_read_plan.h.

typedef struct TMR_ReadPlan TMR_ReadPlan

Definition at line 54 of file tmr_read_plan.h.

typedef enum TMR_ReadPlanType TMR_ReadPlanType

The type of a read plan

typedef struct TMR_SimpleReadPlan TMR_SimpleReadPlan

Definition at line 55 of file tmr_read_plan.h.

typedef struct TMR_StopOnTagCount TMR_StopOnTagCount

Definition at line 57 of file tmr_read_plan.h.

typedef struct TMR_StopTrigger TMR_StopTrigger

Definition at line 59 of file tmr_read_plan.h.

typedef struct TMR_TagObservationTrigger TMR_TagObservationTrigger

Definition at line 58 of file tmr_read_plan.h.

---

Enumeration Type Documentation

enum TMR_ReadPlanType

The type of a read plan

Enumerator:

TMR_READ_PLAN_TYPE_INVALID
TMR_READ_PLAN_TYPE_SIMPLE	Simple read plan - one protocol, a set of antennas, an optional tag filter, and an optional tag operation.
TMR_READ_PLAN_TYPE_MULTI	Multi-read plan - a list of read plans (simple or multi).

Definition at line 154 of file tmr_read_plan.h.

---

Function Documentation

TMR_Status TMR_GPITR_init_enable	(	TMR_GPITriggerRead *	triggerRead,
		bool	enable
	)

Initialize a TMR_GPITriggerRead structure with default values.

Parameters:

triggerRead	Pointer to the read plan to initialize.
enable	Option to enable trigger read.

Definition at line 1204 of file tm_reader.c.

TMR_Status TMR_RP_init_multi	(	TMR_ReadPlan *	plan,
		TMR_ReadPlan **	plans,
		uint8_t	planCount,
		uint32_t	weight
	)

Initialize a TMR_ReadPlan structure as a multi-read plan with the provided parameters.

Parameters:

plan	Pointer to the read plan to initialize.
plans	Array of pointers to read plans to include
planCount	Number of elements in array
weight	Weight.

Definition at line 1373 of file tm_reader.c.

TMR_Status TMR_RP_init_simple	(	TMR_ReadPlan *	plan,
		uint8_t	antennaCount,
		uint8_t *	antennaList,
		TMR_TagProtocol	protocol,
		uint32_t	weight
	)

Initialize a TMR_ReadPlan structure as a simple read plan with the provided parameters.

Only the mandatory elements are parameters to this function. The optional elements, filters and tag operations, can be set with TMR_RP_set_filter() and TMR_RP_set_tagop().

Parameters:

plan	Pointer to the read plan to initialize.
antennaCount	Number of antennas in antenna list. A zero-length list requests the reader to use all antennas known to be connected at the time of the read operation.
antennaList	Pointer to antenna numbers.
protocol	Protocol
weight	Weight.

Definition at line 1228 of file tm_reader.c.

TMR_Status TMR_RP_set_enableAutonomousRead	(	TMR_ReadPlan *	plan,
		bool	autonomousRead
	)

Set the autonomous read option of a read plan

Parameters:

plan	Pointer to the read plan
autonomousRead	Option for autonomous read.

Definition at line 1315 of file tm_reader.c.

TMR_Status TMR_RP_set_enableTriggerRead	(	TMR_ReadPlan *	plan,
		TMR_GPITriggerRead *	triggerRead
	)

Set the trigger read option of a read plan

Parameters:

plan	Pointer to the read plan
triggerRead	Pointer for trigger read

Definition at line 1328 of file tm_reader.c.

TMR_Status TMR_RP_set_filter	(	TMR_ReadPlan *	plan,
		TMR_TagFilter *	filter
	)

Set the filter of a simple read plan.

Parameters:

plan	Pointer to the read plan
filter	Pointer to the filter

Definition at line 1279 of file tm_reader.c.

TMR_Status TMR_RP_set_stopTrigger	(	TMR_ReadPlan *	plan,
		uint32_t	nCount
	)

Set the stop on N tags option of a read plan

Parameters:

plan	Pointer to the read plan
nCount	the number of tags user requested to search.

Definition at line 1260 of file tm_reader.c.

TMR_Status TMR_RP_set_tagop	(	TMR_ReadPlan *	plan,
		TMR_TagOp *	tagop
	)

Set the tagop of a simple read plan.

Parameters:

plan	Pointer to the read plan
tagop	Pointer to the tagop

Definition at line 1352 of file tm_reader.c.

TMR_Status TMR_RP_set_useFastSearch	(	TMR_ReadPlan *	plan,
		bool	useFastSearch
	)

Set the fast search option of a read plan

Parameters:

plan	Pointer to the read plan
useFastSearch	Option for FastSearch

Definition at line 1297 of file tm_reader.c.