Mbed OS Reference
Loading...
Searching...
No Matches
PasskeyAscii Class Reference

Passkey stored as a string of digits. More...

#include <BLETypes.h>

Public Member Functions

 PasskeyAscii ()
 Default to all zeroes. More...
 
 PasskeyAscii (const uint8_t *passkey)
 Initialize a data from a string. More...
 
 PasskeyAscii (passkey_num_t passkey)
 Initialize a data from a number. More...
 
 operator passkey_num_t ()
 Cast to number. More...
 
uint8_t * value ()
 Return the pointer to the buffer holding the string. More...
 

Static Public Member Functions

static uint32_t to_num (const uint8_t *ascii)
 Convert ASCII string of digits into a number. More...
 

Detailed Description

Passkey stored as a string of digits.

Definition at line 244 of file common/BLETypes.h.

Constructor & Destructor Documentation

◆ PasskeyAscii() [1/3]

Default to all zeroes.

Definition at line 252 of file common/BLETypes.h.

◆ PasskeyAscii() [2/3]

PasskeyAscii ( const uint8_t *  passkey)

Initialize a data from a string.

Parameters
[in]passkeyvalue of the data.

Definition at line 261 of file common/BLETypes.h.

◆ PasskeyAscii() [3/3]

Initialize a data from a number.

Parameters
[in]passkeyvalue of the data.

Definition at line 274 of file common/BLETypes.h.

Member Function Documentation

◆ operator passkey_num_t()

operator passkey_num_t ( )

Cast to number.

Definition at line 289 of file common/BLETypes.h.

◆ to_num()

static uint32_t to_num ( const uint8_t *  ascii)
static

Convert ASCII string of digits into a number.

Parameters
[in]asciiASCII string of 6 digits stored as ASCII characters
Returns
Passkey as a number.

Definition at line 298 of file common/BLETypes.h.

◆ value()

uint8_t * value ( )

Return the pointer to the buffer holding the string.

Definition at line 309 of file common/BLETypes.h.