bleperiph.h File Reference

**This command group is available in our standard firmware since version 2.13. More...

#include "../typedefs.h"

Go to the source code of this file.

Data Structures
struct	brp_BlePeriph_DefineService_t
struct	brp_BlePeriph_Enable_t
struct	brp_BlePeriph_SetAdvertisingData_t
struct	brp_BlePeriph_WriteCharacteristic_t
struct	brp_BlePeriph_ReadCharacteristic_t
struct	brp_BlePeriph_GetEvents_t
struct	brp_BlePeriph_IsConnected_t
struct	brp_BlePeriph_GetRSSI_t
struct	brp_BlePeriph_CloseConnection_t

Macros
#define	BRP_BlePeriph_ErrNotEnabled   BRP_ERR_STATUS(0x4B00, 0x01)
	The command could not be executed because BLE is currently not brp_BlePeriph_Enable(). More...
#define	BRP_BlePeriph_ErrNotConnected   BRP_ERR_STATUS(0x4B00, 0x02)
	The reader is currently not connected with a BLE central. More...
#define	BRP_BlePeriph_ErrInvalidCharacteristicNdx   BRP_ERR_STATUS(0x4B00, 0x03)
	The given characteristic index is invalid. More...
#define	BRP_BlePeriph_ErrWriteCharacteristic   BRP_ERR_STATUS(0x4B00, 0x04)
	The characteristic value could not be written because the given offset or length exceeds the characteristic size. More...

Functions
brp_errcode	brp_BlePeriph_DefineService (brp_BlePeriph_DefineService_t params)
	This command registers a new BLE service. More...
brp_errcode	brp_BlePeriph_Enable (brp_BlePeriph_Enable_t params)
	This command starts/stops the advertisement of the reader as a BLE Peripheral, so you can respond to connection and other requests. More...
brp_errcode	brp_BlePeriph_SetAdvertisingData (brp_BlePeriph_SetAdvertisingData_t params)
	This command defines the data to be advertised by the reader. More...
brp_errcode	brp_BlePeriph_WriteCharacteristic (brp_BlePeriph_WriteCharacteristic_t params)
	This command changes the value of a characteristic. More...
brp_errcode	brp_BlePeriph_ReadCharacteristic (brp_BlePeriph_ReadCharacteristic_t params)
	This command retrieves the current value of a characteristic. More...
brp_errcode	brp_BlePeriph_GetEvents (brp_BlePeriph_GetEvents_t params)
	This command returns a bitmask of all events that have occurred since the last call of BlePeriph.GetEvents. More...
brp_errcode	brp_BlePeriph_IsConnected (brp_BlePeriph_IsConnected_t params)
	This command is used to check the current connection status. More...
brp_errcode	brp_BlePeriph_GetRSSI (brp_BlePeriph_GetRSSI_t params)
	This command returns the RSSI value of the connected BLE Central. More...
brp_errcode	brp_BlePeriph_CloseConnection (brp_BlePeriph_CloseConnection_t params)
	This command closes the active connection with a BLE Central. More...

Detailed Description

**This command group is available in our standard firmware since version 2.13.

**

With this command group, you can implement your own BLE peripheral protocol, i.e. your own BLE service (with its own characteristics), which will be advertised by the reader.

Before BLE can be activated via brp_BlePeriph_Enable(), you have to define your service via brp_BlePeriph_DefineService(). This will create an internal database of characteristics that can be accessed from the BRP host with the commands brp_BlePeriph_WriteCharacteristic() and brp_BlePeriph_ReadCharacteristic().

As soon as BLE is activated via brp_BlePeriph_Enable() and a BLE Central connects to your reader, it also has access to this internal database of characteristcs. If it connects to the reader, disconnects, or modifies a characteristic, you'll be informed via brp_BlePeriph_GetEvents().

If the BLE peripheral functionality is used in parallel with Mobile ID: It is not possible to use the Mobile ID app and the app to interact with the BLE peripheral on a mobile device simultaneously! If you want to use the BLE peripheral app to interact with the reader, you have to disable the Mobile ID app (e.g. via the Disable app option in Settings ) or vice versa.

Definition in file bleperiph.h.