ar.h File Reference

With the Autoread command group, you can control a reader configured for Autoread mode. More...

#include "../typedefs.h"

Go to the source code of this file.

Macros
#define	BRP_AR_ErrNoMessage   BRP_ERR_STATUS(0x0500, 0x01)
	No valid card has been presented to the reader so far. More...
#define	BRP_AR_ErrScriptRuntime   BRP_ERR_STATUS(0x0500, 0x02)
	A runtime error occurred when executing the script. More...
#define	BRP_AR_ErrScriptSyntax   BRP_ERR_STATUS(0x0500, 0x03)
	There's a syntax error in the script code. More...
#define	BRP_AR_ErrScriptNotImplemented   BRP_ERR_STATUS(0x0500, 0x04)
	The script ran the command DefaultAction. More...
#define	BRP_AR_ErrArDisabled   BRP_ERR_STATUS(0x0500, 0x10)
	Autoread is disabled. More...

Functions
brp_errcode	brp_AR_SetMode (brp_protocol protocol, brp_AutoReadMode Mode)
	This command controls Autoread mode at runtime. More...
brp_errcode	brp_AR_GetMessage (brp_protocol protocol, brp_MessageType *MsgType, brp_buf *MsgData, size_t *MsgData_len, brp_mempool *mempool)
	This command checks if a card has been presented to the reader since the last AR.GetMessage execution. More...
brp_errcode	brp_AR_RunScript (brp_protocol protocol, brp_buf Script, size_t Script_len)
	This command runs a BaltechScript. More...

Detailed Description

With the Autoread command group, you can control a reader configured for Autoread mode.

This mode allows the reader to autonomously scan for cards, validate and read them, and interact with the user (e.g. give feedback via beeper/LED or switch a door relay). Besides, the reader buffers data read from the card, so the host application can retrieve it.

For more details on how to implement Autoread, please see our Autoread workflow overview.

Definition in file ar.h.