BLE_API v2.1.3

BLE Authentication Status Definition
BLE Common » BLE Command Definition

## BleAuthenticationStatus
Define BLE authentication status.
typedef uint8_t | BleAuthStatus
#define | AUTH_SUCCESS 0x00
#define | AUTH_ERR_PASSKEY_ENTRY_FAILED 0x01
#define | AUTH_ERR_OOB_NOT_AVAILABLE 0x02
#define | AUTH_ERR_AUTHENTICATION_REQUIREMENTS 0x03
#define | AUTH_ERR_CONFIRM_VALUE_FAILED 0x04
#define | AUTH_ERR_PAIRING_NOT_SUPPORTED 0x05
#define | AUTH_ERR_ENCRYPTION_KEY_SIZE 0x06
#define | AUTH_ERR_COMMAND_NOT_SUPPORTED 0x07
#define | AUTH_ERR_UNSPECIFIED_REASON 0x08
#define | AUTH_ERR_REPEATED_ATTEMPTS 0x09
#define | AUTH_ERR_INVALID_PARAMETERS 0x0A
#define | AUTH_ERR_DHKEY_CHECK_FAILED 0x0B
#define | AUTH_ERR_NUMERIC_COMPARISON_FAILED 0x0C
#define | AUTH_ERR_BR_EDR_PAIRING_IN_PROGRESS 0x0D
#define | AUTH_ERR_CROSS_TRANS_KEY_GEN_NOT_ALLOWED 0x0E
#define | AUTH_ERR_TIMEOUT 0x0F
#define | AUTH_ERR_PIN_OR_KEY_MISSING 0x10

## Detailed Description

BLE authentication status definition.

## Macro Definition Documentation

## ◆ AUTH_ERR_AUTHENTICATION_REQUIREMENTS

#define AUTH_ERR_AUTHENTICATION_REQUIREMENTS 0x03

Error authentication requirement.

## ◆ AUTH_ERR_BR_EDR_PAIRING_IN_PROGRESS

#define AUTH_ERR_BR_EDR_PAIRING_IN_PROGRESS 0x0D

BR/EDR paring in progress.

## ◆ AUTH_ERR_COMMAND_NOT_SUPPORTED

#define AUTH_ERR_COMMAND_NOT_SUPPORTED 0x07

Command not supported.

## ◆ AUTH_ERR_CONFIRM_VALUE_FAILED

#define AUTH_ERR_CONFIRM_VALUE_FAILED 0x04

Confirm value failed.

## ◆ AUTH_ERR_CROSS_TRANS_KEY_GEN_NOT_ALLOWED

#define AUTH_ERR_CROSS_TRANS_KEY_GEN_NOT_ALLOWED 0x0E

BR/EDR Link Key cannot be used for LE keys.

## ◆ AUTH_ERR_DHKEY_CHECK_FAILED

#define AUTH_ERR_DHKEY_CHECK_FAILED 0x0B

DHKey check failed.

## ◆ AUTH_ERR_ENCRYPTION_KEY_SIZE

#define AUTH_ERR_ENCRYPTION_KEY_SIZE 0x06

Encryption key size.

## ◆ AUTH_ERR_INVALID_PARAMETERS

#define AUTH_ERR_INVALID_PARAMETERS 0x0A

Invalid parameters.

## ◆ AUTH_ERR_NUMERIC_COMPARISON_FAILED

#define AUTH_ERR_NUMERIC_COMPARISON_FAILED 0x0C

Numeric comparison failed.

## ◆ AUTH_ERR_OOB_NOT_AVAILABLE

#define AUTH_ERR_OOB_NOT_AVAILABLE 0x02

Out of Band key not available.

## ◆ AUTH_ERR_PAIRING_NOT_SUPPORTED

#define AUTH_ERR_PAIRING_NOT_SUPPORTED 0x05

Pairing not supported.

## ◆ AUTH_ERR_PASSKEY_ENTRY_FAILED

#define AUTH_ERR_PASSKEY_ENTRY_FAILED 0x01

Passkey entry failed.

## ◆ AUTH_ERR_PIN_OR_KEY_MISSING

#define AUTH_ERR_PIN_OR_KEY_MISSING 0x10

Bonding PIN / KEY missing.

## ◆ AUTH_ERR_REPEATED_ATTEMPTS

#define AUTH_ERR_REPEATED_ATTEMPTS 0x09

Too little time has elapsed since last attempt.

## ◆ AUTH_ERR_TIMEOUT

#define AUTH_ERR_TIMEOUT 0x0F

Procedure time out.

## ◆ AUTH_ERR_UNSPECIFIED_REASON

#define AUTH_ERR_UNSPECIFIED_REASON 0x08

Unspecified reason.

## ◆ AUTH_SUCCESS

#define AUTH_SUCCESS 0x00

Success.