XDK API  3.6.0
Documentation
Data Structures | Macros | Typedefs | Functions
BleSm.h File Reference
#include "BleTypes.h"
+ Include dependency graph for BleSm.h:

Data Structures

struct  BlePairingInfo
 

Macros

#define BLESM_RANDOMADDRESS_PRIVATE_NOTRESOLVABLE   2
 
#define BLESM_RANDOMADDRESS_PRIVATE_RESOLVABLE   3
 
#define BLESM_RANDOMADDRESS_STATIC   1
 
#define CONNSTATE_AUTHENTICATED   0x10u
 
#define CONNSTATE_BONDED   0x40u
 
#define CONNSTATE_ENCRYPTED   0x20u
 
#define CONNSTATE_NOSECURITY   0x00u
 
#define SMCAP_MITMCAPABLE   0x02
 
#define SMCAP_MITMREQ   0x01
 
#define SMCAP_OOBCAPABLE   0x04
 
#define SMERROR_AUTHENTIFICATIONREQ   0x03
 
#define SMERROR_CONFIRMVALUE   0x04
 
#define SMERROR_ENCRYPTIONKEYSIZE   0x06
 
#define SMERROR_INVALIDCOMMAND   0x07
 
#define SMERROR_OOB   0x02
 
#define SMERROR_PAIRINGNOTSUPPORTED   0x05
 
#define SMERROR_PASSKEYENTRY   0x01
 
#define SMERROR_REPEATEDATTEMPTS   0x09
 
#define SMERROR_UNKNOWREASON   0x08
 

Typedefs

typedef U8 BleLinkSecurityProperties
 
typedef U8 BleSmpRandomAddressType
 
typedef U8 SmErrorCode
 
typedef U8 SmRemoteAuthCapabilities
 

Functions

BleStatus BLESMP_ConfirmPairing (U16 connHandle, U8 accept, U8 bond)
 
BleStatus BLESMP_GenerateAndSetRandomAddress (BleSmpRandomAddressType randomAddressType)
 
BleStatus BLESMP_GetLinkSecurityProperties (U16 connHandle, BleLinkSecurityProperties *bleLinkSecurityProperties)
 
BleStatus BLESMP_InitiatePairing (U16 connHandle, U8 bond)
 
BleStatus BLESMP_IsDeviceBonded (BD_ADDR *addr, BleConnRole role)
 
BleStatus BLESMP_UnBond (BD_ADDR *addr)
 

Macro Definition Documentation

#define BLESM_RANDOMADDRESS_PRIVATE_NOTRESOLVABLE   2
#define BLESM_RANDOMADDRESS_PRIVATE_RESOLVABLE   3
#define BLESM_RANDOMADDRESS_STATIC   1
#define CONNSTATE_AUTHENTICATED   0x10u
#define CONNSTATE_BONDED   0x40u
#define CONNSTATE_ENCRYPTED   0x20u
#define CONNSTATE_NOSECURITY   0x00u
#define SMCAP_MITMCAPABLE   0x02
#define SMCAP_MITMREQ   0x01
#define SMCAP_OOBCAPABLE   0x04
#define SMERROR_AUTHENTIFICATIONREQ   0x03
#define SMERROR_CONFIRMVALUE   0x04
#define SMERROR_ENCRYPTIONKEYSIZE   0x06
#define SMERROR_INVALIDCOMMAND   0x07
#define SMERROR_OOB   0x02
#define SMERROR_PAIRINGNOTSUPPORTED   0x05
#define SMERROR_PASSKEYENTRY   0x01
#define SMERROR_REPEATEDATTEMPTS   0x09
#define SMERROR_UNKNOWREASON   0x08

Typedef Documentation

Definition for the BleLinkSecurityProperties type This type is a bitfield used to describe the link security Properties for a given link. it can be retrieved thanks to the BLESMP_GetLinkSecurityPropertie(...) API

Definition for the BleSmpRandomAddressType type This type is used to define the available Random adresses Types like STATIC, RANDOM RESOLVABLE or RANDOM NOT RESOLVABLE

typedef U8 SmErrorCode

Definition for the SmErrorCode type This type is used to describe the reason of a PAIRING failure, it is reported during BLEEVENT_PAIRING_COMPLETE event when status is BLESTATUS_FAILED in the reason field of the during the BlePairingInfo structure.

Definition for the SmRemoteAuthCapabilities type This type is used to describe the Authencation capabilities of the remote device, it is reported during BLEEVENT_PAIRING_REQUEST event

Function Documentation

BleStatus BLESMP_ConfirmPairing ( U16  connHandle,
U8  accept,
U8  bond 
)
BleStatus BLESMP_GenerateAndSetRandomAddress ( BleSmpRandomAddressType  randomAddressType)
BleStatus BLESMP_GetLinkSecurityProperties ( U16  connHandle,
BleLinkSecurityProperties bleLinkSecurityProperties 
)
BleStatus BLESMP_InitiatePairing ( U16  connHandle,
U8  bond 
)
BleStatus BLESMP_IsDeviceBonded ( BD_ADDR addr,
BleConnRole  role 
)
BleStatus BLESMP_UnBond ( BD_ADDR addr)

All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:41 by doxygen 1.8.8