Modules | Macros
Defines
BLE » Generic Access Profile (GAP) » Generic Access Profile (GAP) Management

## Modules
| GAP PHYs (bitmask)
| GAP ADV CHANNEL (bitmask)

## Macros
#define | CO_BIT(pos) (1UL<<(pos))
| Bit operation helper. More...
#define | MAX_ADV_NUM 5
| Maximal advertising instance number. More...
#define | MAX_PER_SYNC_NUM 5
| Maximal periodic syncronization instance number. More...
#define | MAX_BOND_NUM 10
| Maximal bonding number. More...
#define | MAX_WL_NUM 10
| Maximal white list number. More...
#define | MAX_PRD_ADV_NUM 4
| Maximal periodic advertising list number. More...
#define | MAX_KEY_LEN 16
| The key length. More...
#define | INVALID_ADV_IDX 0xFF
| Invalid adv index. More...
#define | BLE_GAP_DEVNAME_DEFAULT "GOODIX_BLE"
| Default device name value. More...
#define | BLE_GAP_DEVNAME_MAX_LEN 248
| Maximal length of device name. More...
#define | BLE_APPEARANCE_UNKNOWN 0
| Unknown. More...
#define | BLE_APPEARANCE_GENERIC_PHONE 64
| Generic Phone. More...
#define | BLE_APPEARANCE_GENERIC_COMPUTER 128
| Generic Computer. More...
#define | BLE_APPEARANCE_GENERIC_WATCH 192
| Generic Watch. More...
#define | BLE_APPEARANCE_WATCH_SPORTS_WATCH 193
| Watch: Sports Watch. More...
#define | BLE_APPEARANCE_GENERIC_CLOCK 256
| Generic Clock. More...
#define | BLE_APPEARANCE_GENERIC_DISPLAY 320
| Generic Display. More...
#define | BLE_APPEARANCE_GENERIC_REMOTE_CONTROL 384
| Generic Remote Control. More...
#define | BLE_APPEARANCE_GENERIC_EYE_GLASSES 448
| Generic Eye-glasses. More...
#define | BLE_APPEARANCE_GENERIC_TAG 512
| Generic Tag. More...
#define | BLE_APPEARANCE_GENERIC_KEYRING 576
| Generic Keyring. More...
#define | BLE_APPEARANCE_GENERIC_MEDIA_PLAYER 640
| Generic Media Player. More...
#define | BLE_APPEARANCE_GENERIC_BARCODE_SCANNER 704
| Generic Barcode Scanner. More...
#define | BLE_APPEARANCE_GENERIC_THERMOMETER 768
| Generic Thermometer. More...
#define | BLE_APPEARANCE_THERMOMETER_EAR 769
| Thermometer: Ear. More...
#define | BLE_APPEARANCE_GENERIC_HEART_RATE_SENSOR 832
| Generic Heart Rate Sensor. More...
#define | BLE_APPEARANCE_HEART_RATE_SENSOR_HEART_RATE_BELT 833
| Heart Rate Sensor: Heart Rate Belt. More...
#define | BLE_APPEARANCE_GENERIC_BLOOD_PRESSURE 896
| Generic Blood Pressure. More...
#define | BLE_APPEARANCE_BLOOD_PRESSURE_ARM 897
| Blood Pressure: Arm. More...
#define | BLE_APPEARANCE_BLOOD_PRESSURE_WRIST 898
| Blood Pressure: Wrist. More...
#define | BLE_APPEARANCE_GENERIC_HID 960
| Human Interface Device (HID). More...
#define | BLE_APPEARANCE_HID_KEYBOARD 961
| Keyboard (HID Subtype). More...
#define | BLE_APPEARANCE_HID_MOUSE 962
| Mouse (HID Subtype). More...
#define | BLE_APPEARANCE_HID_JOYSTICK 963
| Joystick (HID Subtype). More...
#define | BLE_APPEARANCE_HID_GAMEPAD 964
| Gamepad (HID Subtype). More...
#define | BLE_APPEARANCE_HID_DIGITIZERSUBTYPE 965
| Digitizer Tablet (HID Subtype). More...
#define | BLE_APPEARANCE_HID_CARD_READER 966
| Card Reader (HID Subtype). More...
#define | BLE_APPEARANCE_HID_DIGITAL_PEN 967
| Digital Pen (HID Subtype). More...
#define | BLE_APPEARANCE_HID_BARCODE 968
| Barcode Scanner (HID Subtype). More...
#define | BLE_APPEARANCE_GENERIC_GLUCOSE_METER 1024
| Generic Glucose Meter. More...
#define | BLE_APPEARANCE_GENERIC_RUNNING_WALKING_SENSOR 1088
| Generic Running Walking Sensor. More...
#define | BLE_APPEARANCE_RUNNING_WALKING_SENSOR_IN_SHOE 1089
| Running Walking Sensor: In-Shoe. More...
#define | BLE_APPEARANCE_RUNNING_WALKING_SENSOR_ON_SHOE 1090
| Running Walking Sensor: On-Shoe. More...
#define | BLE_APPEARANCE_RUNNING_WALKING_SENSOR_ON_HIP 1091
| Running Walking Sensor: On-Hip. More...
#define | BLE_APPEARANCE_GENERIC_CYCLING 1152
| Generic Cycling. More...
#define | BLE_APPEARANCE_CYCLING_CYCLING_COMPUTER 1153
| Cycling: Cycling Computer. More...
#define | BLE_APPEARANCE_CYCLING_SPEED_SENSOR 1154
| Cycling: Speed Sensor. More...
#define | BLE_APPEARANCE_CYCLING_CADENCE_SENSOR 1155
| Cycling: Cadence Sensor. More...
#define | BLE_APPEARANCE_CYCLING_POWER_SENSOR 1156
| Cycling: Power Sensor. More...
#define | BLE_APPEARANCE_CYCLING_SPEED_CADENCE_SENSOR 1157
| Cycling: Speed and Cadence Sensor. More...
#define | BLE_APPEARANCE_GENERIC_PULSE_OXIMETER 3136
| Generic Pulse Oximeter. More...
#define | BLE_APPEARANCE_PULSE_OXIMETER_FINGERTIP 3137
| Fingertip (Pulse Oximeter subtype). More...
#define | BLE_APPEARANCE_PULSE_OXIMETER_WRIST_WORN 3138
| Wrist Worn(Pulse Oximeter subtype). More...
#define | BLE_APPEARANCE_GENERIC_WEIGHT_SCALE 3200
| Generic Weight Scale. More...
#define | BLE_APPEARANCE_GENERIC_OUTDOOR_SPORTS_ACT 5184
| Generic Outdoor Sports Activity. More...
#define | BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_DISP 5185
| Location Display Device (Outdoor Sports Activity subtype). More...
#define | BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_AND_NAV_DISP 5186
| Location and Navigation Display Device (Outdoor Sports Activity subtype). More...
#define | BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_POD 5187
| Location Pod (Outdoor Sports Activity subtype). More...
#define | BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_AND_NAV_POD 5188
| Location and Navigation Pod (Outdoor Sports Activity subtype). More...

## Detailed Description

## Macro Definition Documentation

## ◆ BLE_APPEARANCE_BLOOD_PRESSURE_ARM

#define BLE_APPEARANCE_BLOOD_PRESSURE_ARM 897

Blood Pressure: Arm.

Definition at line 102 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_BLOOD_PRESSURE_WRIST

#define BLE_APPEARANCE_BLOOD_PRESSURE_WRIST 898

Blood Pressure: Wrist.

Definition at line 103 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_CYCLING_CADENCE_SENSOR

#define BLE_APPEARANCE_CYCLING_CADENCE_SENSOR 1155

Cycling: Cadence Sensor.

Definition at line 121 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_CYCLING_CYCLING_COMPUTER

#define BLE_APPEARANCE_CYCLING_CYCLING_COMPUTER 1153

Cycling: Cycling Computer.

Definition at line 119 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_CYCLING_POWER_SENSOR

#define BLE_APPEARANCE_CYCLING_POWER_SENSOR 1156

Cycling: Power Sensor.

Definition at line 122 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_CYCLING_SPEED_CADENCE_SENSOR

#define BLE_APPEARANCE_CYCLING_SPEED_CADENCE_SENSOR 1157

Cycling: Speed and Cadence Sensor.

Definition at line 123 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_CYCLING_SPEED_SENSOR

#define BLE_APPEARANCE_CYCLING_SPEED_SENSOR 1154

Cycling: Speed Sensor.

Definition at line 120 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_GENERIC_BARCODE_SCANNER

#define BLE_APPEARANCE_GENERIC_BARCODE_SCANNER 704

Generic Barcode Scanner.

Definition at line 96 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_GENERIC_BLOOD_PRESSURE

#define BLE_APPEARANCE_GENERIC_BLOOD_PRESSURE 896

Generic Blood Pressure.

Definition at line 101 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_GENERIC_CLOCK

#define BLE_APPEARANCE_GENERIC_CLOCK 256

Generic Clock.

Definition at line 89 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_GENERIC_COMPUTER

#define BLE_APPEARANCE_GENERIC_COMPUTER 128

Generic Computer.

Definition at line 86 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_GENERIC_CYCLING

#define BLE_APPEARANCE_GENERIC_CYCLING 1152

Generic Cycling.

Definition at line 118 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_GENERIC_DISPLAY

#define BLE_APPEARANCE_GENERIC_DISPLAY 320

Generic Display.

Definition at line 90 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_GENERIC_EYE_GLASSES

#define BLE_APPEARANCE_GENERIC_EYE_GLASSES 448

Generic Eye-glasses.

Definition at line 92 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_GENERIC_GLUCOSE_METER

#define BLE_APPEARANCE_GENERIC_GLUCOSE_METER 1024

Generic Glucose Meter.

Definition at line 113 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_GENERIC_HEART_RATE_SENSOR

#define BLE_APPEARANCE_GENERIC_HEART_RATE_SENSOR 832

Generic Heart Rate Sensor.

Definition at line 99 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_GENERIC_HID

#define BLE_APPEARANCE_GENERIC_HID 960

Human Interface Device (HID).

Definition at line 104 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_GENERIC_KEYRING

#define BLE_APPEARANCE_GENERIC_KEYRING 576

Generic Keyring.

Definition at line 94 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_GENERIC_MEDIA_PLAYER

#define BLE_APPEARANCE_GENERIC_MEDIA_PLAYER 640

Generic Media Player.

Definition at line 95 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_GENERIC_OUTDOOR_SPORTS_ACT

#define BLE_APPEARANCE_GENERIC_OUTDOOR_SPORTS_ACT 5184

Generic Outdoor Sports Activity.

Definition at line 128 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_GENERIC_PHONE

#define BLE_APPEARANCE_GENERIC_PHONE 64

Generic Phone.

Definition at line 85 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_GENERIC_PULSE_OXIMETER

#define BLE_APPEARANCE_GENERIC_PULSE_OXIMETER 3136

Generic Pulse Oximeter.

Definition at line 124 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_GENERIC_REMOTE_CONTROL

#define BLE_APPEARANCE_GENERIC_REMOTE_CONTROL 384

Generic Remote Control.

Definition at line 91 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_GENERIC_RUNNING_WALKING_SENSOR

#define BLE_APPEARANCE_GENERIC_RUNNING_WALKING_SENSOR 1088

Generic Running Walking Sensor.

Definition at line 114 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_GENERIC_TAG

#define BLE_APPEARANCE_GENERIC_TAG 512

Generic Tag.

Definition at line 93 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_GENERIC_THERMOMETER

#define BLE_APPEARANCE_GENERIC_THERMOMETER 768

Generic Thermometer.

Definition at line 97 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_GENERIC_WATCH

#define BLE_APPEARANCE_GENERIC_WATCH 192

Generic Watch.

Definition at line 87 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_GENERIC_WEIGHT_SCALE

#define BLE_APPEARANCE_GENERIC_WEIGHT_SCALE 3200

Generic Weight Scale.

Definition at line 127 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_HEART_RATE_SENSOR_HEART_RATE_BELT

#define BLE_APPEARANCE_HEART_RATE_SENSOR_HEART_RATE_BELT 833

Heart Rate Sensor: Heart Rate Belt.

Definition at line 100 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_HID_BARCODE

#define BLE_APPEARANCE_HID_BARCODE 968

Barcode Scanner (HID Subtype).

Definition at line 112 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_HID_CARD_READER

#define BLE_APPEARANCE_HID_CARD_READER 966

Card Reader (HID Subtype).

Definition at line 110 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_HID_DIGITAL_PEN

#define BLE_APPEARANCE_HID_DIGITAL_PEN 967

Digital Pen (HID Subtype).

Definition at line 111 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_HID_DIGITIZERSUBTYPE

#define BLE_APPEARANCE_HID_DIGITIZERSUBTYPE 965

Digitizer Tablet (HID Subtype).

Definition at line 109 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_HID_GAMEPAD

#define BLE_APPEARANCE_HID_GAMEPAD 964

Gamepad (HID Subtype).

Definition at line 108 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_HID_JOYSTICK

#define BLE_APPEARANCE_HID_JOYSTICK 963

Joystick (HID Subtype).

Definition at line 107 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_HID_KEYBOARD

#define BLE_APPEARANCE_HID_KEYBOARD 961

Keyboard (HID Subtype).

Definition at line 105 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_HID_MOUSE

#define BLE_APPEARANCE_HID_MOUSE 962

Mouse (HID Subtype).

Definition at line 106 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_AND_NAV_DISP

#define BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_AND_NAV_DISP 5186

Location and Navigation Display Device (Outdoor Sports Activity subtype).

Definition at line 130 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_AND_NAV_POD

#define BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_AND_NAV_POD 5188

Location and Navigation Pod (Outdoor Sports Activity subtype).

Definition at line 132 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_DISP

#define BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_DISP 5185

Location Display Device (Outdoor Sports Activity subtype).

Definition at line 129 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_POD

#define BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_POD 5187

Location Pod (Outdoor Sports Activity subtype).

Definition at line 131 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_PULSE_OXIMETER_FINGERTIP

#define BLE_APPEARANCE_PULSE_OXIMETER_FINGERTIP 3137

Fingertip (Pulse Oximeter subtype).

Definition at line 125 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_PULSE_OXIMETER_WRIST_WORN

#define BLE_APPEARANCE_PULSE_OXIMETER_WRIST_WORN 3138

Wrist Worn(Pulse Oximeter subtype).

Definition at line 126 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_RUNNING_WALKING_SENSOR_IN_SHOE

#define BLE_APPEARANCE_RUNNING_WALKING_SENSOR_IN_SHOE 1089

Running Walking Sensor: In-Shoe.

Definition at line 115 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_RUNNING_WALKING_SENSOR_ON_HIP

#define BLE_APPEARANCE_RUNNING_WALKING_SENSOR_ON_HIP 1091

Running Walking Sensor: On-Hip.

Definition at line 117 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_RUNNING_WALKING_SENSOR_ON_SHOE

#define BLE_APPEARANCE_RUNNING_WALKING_SENSOR_ON_SHOE 1090

Running Walking Sensor: On-Shoe.

Definition at line 116 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_THERMOMETER_EAR

#define BLE_APPEARANCE_THERMOMETER_EAR 769

Thermometer: Ear.

Definition at line 98 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_UNKNOWN

#define BLE_APPEARANCE_UNKNOWN 0

Unknown.

Definition at line 84 of file ble_gapm.h.

## ◆ BLE_APPEARANCE_WATCH_SPORTS_WATCH

#define BLE_APPEARANCE_WATCH_SPORTS_WATCH 193

Watch: Sports Watch.

Definition at line 88 of file ble_gapm.h.

## ◆ BLE_GAP_DEVNAME_DEFAULT

#define BLE_GAP_DEVNAME_DEFAULT "GOODIX_BLE"

Default device name value.

Definition at line 81 of file ble_gapm.h.

## ◆ BLE_GAP_DEVNAME_MAX_LEN

#define BLE_GAP_DEVNAME_MAX_LEN 248

Maximal length of device name.

Definition at line 82 of file ble_gapm.h.

## ◆ CO_BIT

#define CO_BIT | ( |  | pos | ) | (1UL<<(pos))

Bit operation helper.

Definition at line 72 of file ble_gapm.h.

## ◆ INVALID_ADV_IDX

#define INVALID_ADV_IDX 0xFF

Invalid adv index.

Definition at line 80 of file ble_gapm.h.

## ◆ MAX_ADV_NUM

#define MAX_ADV_NUM 5

Maximal advertising instance number.

Definition at line 73 of file ble_gapm.h.

## ◆ MAX_BOND_NUM

#define MAX_BOND_NUM 10

Maximal bonding number.

Definition at line 75 of file ble_gapm.h.

## ◆ MAX_KEY_LEN

#define MAX_KEY_LEN 16

The key length.

Definition at line 79 of file ble_gapm.h.

## ◆ MAX_PER_SYNC_NUM

#define MAX_PER_SYNC_NUM 5

Maximal periodic syncronization instance number.

Definition at line 74 of file ble_gapm.h.

## ◆ MAX_PRD_ADV_NUM

#define MAX_PRD_ADV_NUM 4

Maximal periodic advertising list number.

Definition at line 78 of file ble_gapm.h.

## ◆ MAX_WL_NUM

#define MAX_WL_NUM 10

Maximal white list number.

Definition at line 76 of file ble_gapm.h.