C API for BALTECH SDK
sys.h File Reference
#include "../typedefs.h"

Go to the source code of this file.

Macros

#define BRP_Sys_ErrCfgFull   BRP_ERR_STATUS(0x0000, 0x01)
 
#define BRP_Sys_ErrCfgAccess   BRP_ERR_STATUS(0x0000, 0x02)
 
#define BRP_Sys_ErrCfgNotFound   BRP_ERR_STATUS(0x0000, 0x03)
 
#define BRP_Sys_ErrInvalidCfgBlock   BRP_ERR_STATUS(0x0000, 0x04)
 
#define BRP_Sys_ErrCfgAccessDenied   BRP_ERR_STATUS(0x0000, 0x05)
 
#define BRP_Sys_ErrRegAccess   BRP_ERR_STATUS(0x0000, 0x06)
 
#define BRP_Sys_ErrInvalidProtocol   BRP_ERR_STATUS(0x0000, 0x07)
 
#define BRP_Sys_ErrNotSupportedByHardware   BRP_ERR_STATUS(0x0000, 0x08)
 
#define BRP_Sys_ErrFactsetRestore   BRP_ERR_STATUS(0x0000, 0x09)
 
#define BRP_Sys_ErrCfgConfigSecurityCode   BRP_ERR_STATUS(0x0000, 0x0A)
 
#define BRP_Sys_ErrCfgVersion   BRP_ERR_STATUS(0x0000, 0x0B)
 
#define BRP_Sys_ErrCfgLoadWrongState   BRP_ERR_STATUS(0x0000, 0x0C)
 
#define BRP_Sys_ErrInvalidFwCrc   BRP_ERR_STATUS(0x0000, 0x7F)
 

Functions

brp_errcode brp_Sys_GetBufferSize (brp_protocol protocol, unsigned *MaxSendSize, unsigned *MaxRecvSize, unsigned *TotalSize)
 
brp_errcode brp_Sys_HFReset (brp_protocol protocol, unsigned OffDuration)
 
brp_errcode brp_Sys_Reset (brp_protocol protocol)
 
brp_errcode brp_Sys_GetInfo (brp_protocol protocol, char **Info, brp_mempool *mempool)
 
brp_errcode brp_Sys_GetBootStatus (brp_protocol protocol, brp_Sys_GetBootStatus_BootStatus *BootStatus)
 
brp_errcode brp_Sys_GetPort (brp_protocol protocol, brp_IoPortBitmask *PortMask)
 
brp_errcode brp_Sys_SetPort (brp_protocol protocol, brp_IoPortBitmask PortMask)
 
brp_errcode brp_Sys_CfgGetValue (brp_protocol protocol, unsigned Key, unsigned Value, brp_buf *Content, size_t *Content_len, brp_mempool *mempool)
 
brp_errcode brp_Sys_CfgSetValue (brp_protocol protocol, unsigned Key, unsigned Value, brp_buf Content, size_t Content_len)
 
brp_errcode brp_Sys_CfgDelValues (brp_protocol protocol, unsigned Key, unsigned Value)
 
brp_errcode brp_Sys_CfgGetKeyList (brp_protocol protocol, unsigned **KeyList, size_t *KeyList_len, brp_mempool *mempool)
 
brp_errcode brp_Sys_CfgGetValueList (brp_protocol protocol, unsigned Key, unsigned **ValueList, size_t *ValueList_len, brp_mempool *mempool)
 
brp_errcode brp_Sys_CfgWriteTlvSector (brp_protocol protocol, brp_buf TlvBlock, size_t TlvBlock_len)
 
brp_errcode brp_Sys_CfgCheck (brp_protocol protocol, unsigned *TotalSize, unsigned *FreeSize)
 
brp_errcode brp_Sys_ConfigPort (brp_protocol protocol, brp_IoPortBitmask InpOutp, brp_IoPortBitmask DefaultState)
 
brp_errcode brp_Sys_SetRegister (brp_protocol protocol, bool ResetRegister, brp_Sys_SetRegister_RegisterAssignments_Entry *RegisterAssignments, size_t RegisterAssignments_len)
 
brp_errcode brp_Sys_GetRegister (brp_protocol protocol, unsigned ID, unsigned *Value)
 
brp_errcode brp_Sys_PowerDown (brp_protocol protocol)
 
brp_errcode brp_Sys_SelectProtocol (brp_protocol protocol, brp_ProtocolID Protocol)
 
brp_errcode brp_Sys_SetCommParam (brp_protocol protocol, brp_Baudrate NewBaudrate, brp_Parity NewParity, unsigned CWT)
 
brp_errcode brp_Sys_CfgLoadBlock (brp_protocol protocol, unsigned Version, brp_buf Data, size_t Data_len)
 
brp_errcode brp_Sys_GetPlatformId (brp_protocol protocol, brp_buf *PlatformId, unsigned *BootloaderId, unsigned *BootloaderMajor, unsigned *BootloaderMinor, unsigned *BootloaderBuild, brp_mempool *mempool)
 
brp_errcode brp_Sys_CfgReset (brp_protocol protocol)
 
brp_errcode brp_Sys_StopProtocol (brp_protocol protocol, brp_ProtocolID Protocol)
 
brp_errcode brp_Sys_CfgGetId (brp_protocol protocol, char **ConfigId, char **ConfigName, brp_mempool *mempool)
 
brp_errcode brp_Sys_CfgGetDeviceSettingsId (brp_protocol protocol, char **ConfigId, char **ConfigName, brp_mempool *mempool)
 
brp_errcode brp_Sys_FactoryResetLegacy (brp_protocol protocol)
 
brp_errcode brp_Sys_GetStatistics (brp_protocol protocol, bool DeleteCounters, brp_Sys_GetStatistics_CounterTuple_Entry **CounterTuple, size_t *CounterTuple_len, brp_mempool *mempool)
 
brp_errcode brp_Sys_GetFeatures (brp_protocol protocol, brp_FeatureID **FeatureList, size_t *FeatureList_len, brp_FeatureID *MaxFeatureID, brp_mempool *mempool)
 
brp_errcode brp_Sys_GetPartNumber (brp_protocol protocol, char **PartNo, char **HwRevNo, brp_mempool *mempool)
 
brp_errcode brp_Sys_CfgLoadPrepare (brp_protocol protocol, brp_AuthReqUpload AuthReq)
 
brp_errcode brp_Sys_CfgLoadFinish (brp_protocol protocol, brp_Sys_CfgLoadFinish_FinalizeAction FinalizeAction)
 
brp_errcode brp_Sys_FactoryReset (brp_protocol protocol, bool PerformReboot)
 
brp_errcode brp_Sys_GetLicenses (brp_protocol protocol, brp_LicenseBitMask *LicenseBitMask)
 
brp_errcode brp_Sys_GetFwCrc (brp_protocol protocol, unsigned *CRC)
 

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.