sys.h File Reference

With the Sys command group, you can interact with the reader itself. More...

#include "../typedefs.h"

Go to the source code of this file.

Data Structures
struct	brp_Sys_GetBufferSize_t
struct	brp_Sys_HFReset_t
struct	brp_Sys_Reset_t
struct	brp_Sys_GetInfo_t
struct	brp_Sys_GetBootStatus_t
struct	brp_Sys_CfgGetValue_t
struct	brp_Sys_CfgSetValue_t
struct	brp_Sys_CfgDelValues_t
struct	brp_Sys_CfgGetKeyList_t
struct	brp_Sys_CfgGetValueList_t
struct	brp_Sys_CfgCheck_t
struct	brp_Sys_SelectProtocol_t
struct	brp_Sys_CfgLoadBlock_t
struct	brp_Sys_CfgReset_t
struct	brp_Sys_StopProtocol_t
struct	brp_Sys_SendMessage_t
struct	brp_Sys_CfgGetId_t
struct	brp_Sys_CfgGetDeviceSettingsId_t
struct	brp_Sys_GetStatistics_t
struct	brp_Sys_GetFeatures_t
struct	brp_Sys_GetPartNumber_t
struct	brp_Sys_CfgLoadPrepare_t
struct	brp_Sys_CfgLoadFinish_t
struct	brp_Sys_FactoryReset_t
struct	brp_Sys_GetLicenses_t

Macros
#define	BRP_Sys_ErrCfgFull   BRP_ERR_STATUS(0x0000, 0x01)
	There's not enough space to store the reader's configuration values. More...
#define	BRP_Sys_ErrCfgAccess   BRP_ERR_STATUS(0x0000, 0x02)
	Reading/writing to the internal memory failed. More...
#define	BRP_Sys_ErrCfgNotFound   BRP_ERR_STATUS(0x0000, 0x03)
	The meaning of this status code varies depending on the access mode: More...
#define	BRP_Sys_ErrInvalidCfgBlock   BRP_ERR_STATUS(0x0000, 0x04)
	The format of the configuration file (BEC file) is invalid. More...
#define	BRP_Sys_ErrCfgAccessDenied   BRP_ERR_STATUS(0x0000, 0x05)
	Memory access denied. More...
#define	BRP_Sys_ErrInvalidProtocol   BRP_ERR_STATUS(0x0000, 0x07)
	The selected protocol isn't supported by the current firmware. More...
#define	BRP_Sys_ErrNotSupportedByHardware   BRP_ERR_STATUS(0x0000, 0x08)
	This feature isn't supported by the reader hardware. More...
#define	BRP_Sys_ErrFactsetRestore   BRP_ERR_STATUS(0x0000, 0x09)
	Restoring the reader's factory settings failed. More...

Functions
brp_errcode	brp_Sys_GetBufferSize (brp_Sys_GetBufferSize_t params)
	This command returns the maximum sizes of command and response frames that the reader can send and receive. More...
brp_errcode	brp_Sys_HFReset (brp_Sys_HFReset_t params)
	This command turns the HF antenna off or on. More...
brp_errcode	brp_Sys_Reset (brp_Sys_Reset_t params)
	This command reboots the reader. More...
brp_errcode	brp_Sys_GetInfo (brp_Sys_GetInfo_t params)
	This command retrieves the firmware string of the reader, which holds information about the reader firmware and serial number. More...
brp_errcode	brp_Sys_GetBootStatus (brp_Sys_GetBootStatus_t params)
	This command retrieves the boot status of the reader, i.e. More...
brp_errcode	brp_Sys_CfgGetValue (brp_Sys_CfgGetValue_t params)
	This command retrieves a desired value of the reader's configuration, specified by the Key and Value parameters. More...
brp_errcode	brp_Sys_CfgSetValue (brp_Sys_CfgSetValue_t params)
	This command stores a value in the reader's configuration. More...
brp_errcode	brp_Sys_CfgDelValues (brp_Sys_CfgDelValues_t params)
	This command deletes a key or a value from the reader's configuration. More...
brp_errcode	brp_Sys_CfgGetKeyList (brp_Sys_CfgGetKeyList_t params)
	Retrieves a list of all keys stored in the reader's configuration. More...
brp_errcode	brp_Sys_CfgGetValueList (brp_Sys_CfgGetValueList_t params)
	Returns a list of all configuration values within a specified Key. More...
brp_errcode	brp_Sys_CfgCheck (brp_Sys_CfgCheck_t params)
	This command checks the consistency of the reader's internal configuration. More...
brp_errcode	brp_Sys_SelectProtocol (brp_Sys_SelectProtocol_t params)
	This command starts a host protocol. More...
brp_errcode	brp_Sys_CfgLoadBlock (brp_Sys_CfgLoadBlock_t params)
	This command transfers the configuration from a BEC file into the reader. More...
brp_errcode	brp_Sys_CfgReset (brp_Sys_CfgReset_t params)
	Deletes the complete configuration. More...
brp_errcode	brp_Sys_StopProtocol (brp_Sys_StopProtocol_t params)
	This command stops a host protocol. More...
brp_errcode	brp_Sys_SendMessage (brp_Sys_SendMessage_t params)
	This command sends a message to the host via a certain protocol. More...
brp_errcode	brp_Sys_CfgGetId (brp_Sys_CfgGetId_t params)
	This command returns the identifier of the reader configuration. More...
brp_errcode	brp_Sys_CfgGetDeviceSettingsId (brp_Sys_CfgGetDeviceSettingsId_t params)
	This command retrieves the ID of the reader configuration containing the device settings. More...
brp_errcode	brp_Sys_GetStatistics (brp_Sys_GetStatistics_t params)
	This command retrieves all available statistics counters from the reader's configuration. More...
brp_errcode	brp_Sys_GetFeatures (brp_Sys_GetFeatures_t params)
	This command retrieves the list of features supported by the reader, so you can find out if the reader meets your requirements. More...
brp_errcode	brp_Sys_GetPartNumber (brp_Sys_GetPartNumber_t params)
	This command returns the part number and the hardware revision number of the device. More...
brp_errcode	brp_Sys_CfgLoadPrepare (brp_Sys_CfgLoadPrepare_t params)
	This command initiates the transfer of a BEC file via brp_Sys_CfgLoadBlock(). More...
brp_errcode	brp_Sys_CfgLoadFinish (brp_Sys_CfgLoadFinish_t params)
	This command has to be called after transferring a BEC file with brp_Sys_CfgLoadBlock(). More...
brp_errcode	brp_Sys_FactoryReset (brp_Sys_FactoryReset_t params)
	This command restores the reader's factory settings. More...
brp_errcode	brp_Sys_GetLicenses (brp_Sys_GetLicenses_t params)
	This command retrieves a bit mask of the licenses that are activated in the reader. More...

Detailed Description

With the Sys command group, you can interact with the reader itself.

You can e.g. retrieve reader information, set up its behavior, and control it during runtime.

For a quick overview, please see our list of most important Sys commands.

Definition in file sys.h.