Bluetooth LE Profile API document
Bluetooth LE Profile API document Rev.1.00 [May 22, 2020]
Generic Access Service Client

This is the client for the Generic Access Service. More...

Detailed Description

This is the client for the Generic Access Service.

Data Structures

struct  st_ble_gapc_dev_name_t
 Device Name value structure. More...
 
struct  st_ble_gapc_dev_name_attr_hdl_t
 Device Name attribute handle value. More...
 
struct  st_ble_gapc_appearance_attr_hdl_t
 Appearance attribute handle value. More...
 
struct  st_ble_gapc_per_pref_conn_param_t
 Peripheral Preferred Connection Parameters value structure. More...
 
struct  st_ble_gapc_per_pref_conn_param_attr_hdl_t
 Peripheral Preferred Connection Parameters attribute handle value. More...
 
struct  st_ble_gapc_cent_addr_rslv_attr_hdl_t
 Central Address Resolution attribute handle value. More...
 
struct  st_ble_gapc_rslv_priv_addr_only_attr_hdl_t
 Resolvable Private Address Only attribute handle value. More...
 
struct  st_ble_gapc_evt_data_t
 Generic Access client event data. More...
 

Macros

#define BLE_GAPC_DEV_NAME_UUID   (0x2A00)
 
#define BLE_GAPC_DEV_NAME_LEN   (128)
 
#define BLE_GAPC_APPEARANCE_UUID   (0x2A01)
 
#define BLE_GAPC_APPEARANCE_LEN   (2)
 
#define BLE_GAPC_PER_PREF_CONN_PARAM_UUID   (0x2A04)
 
#define BLE_GAPC_PER_PREF_CONN_PARAM_LEN   (8)
 
#define BLE_GAPC_CENT_ADDR_RSLV_UUID   (0x2AA6)
 
#define BLE_GAPC_CENT_ADDR_RSLV_LEN   (1)
 
#define BLE_GAPC_RSLV_PRIV_ADDR_ONLY_UUID   (0x2AC9)
 
#define BLE_GAPC_RSLV_PRIV_ADDR_ONLY_LEN   (1)
 

Enumerations

enum  e_ble_appearance_category_t {
  BLE_GAPC_APPEARANCE_CATEGORY_UNKNOWN = 0,
  BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_PHONE = 64,
  BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_COMPUTER = 128,
  BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_WATCH = 192,
  BLE_GAPC_APPEARANCE_CATEGORY_WATCH_SPORTS_WATCH = 193,
  BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_CLOCK = 256,
  BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_DISPLAY = 320,
  BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_REMOTE_CONTROL = 384,
  BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_EYE_GLASSES = 448,
  BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_TAG = 512,
  BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_KEYRING = 576,
  BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_MEDIA_PLAYER = 640,
  BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_BARCODE_SCANNER = 704,
  BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_THERMOMETER = 768,
  BLE_GAPC_APPEARANCE_CATEGORY_THERMOMETER_EAR = 769,
  BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_HEART_RATE_SENSOR = 832,
  BLE_GAPC_APPEARANCE_CATEGORY_HEART_RATE_SENSOR_HEART_RATE_BELT = 833,
  BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_BLOOD_PRESSURE = 896,
  BLE_GAPC_APPEARANCE_CATEGORY_BLOOD_PRESSURE_ARM = 897,
  BLE_GAPC_APPEARANCE_CATEGORY_BLOOD_PRESSURE_WRIST = 898,
  BLE_GAPC_APPEARANCE_CATEGORY_HUMAN_INTERFACE_DEVICE = 960,
  BLE_GAPC_APPEARANCE_CATEGORY_KEYBOARD = 961,
  BLE_GAPC_APPEARANCE_CATEGORY_MOUSE = 962,
  BLE_GAPC_APPEARANCE_CATEGORY_JOYSTICK = 963,
  BLE_GAPC_APPEARANCE_CATEGORY_GAMEPAD = 964,
  BLE_GAPC_APPEARANCE_CATEGORY_DIGITIZER_TABLET = 965,
  BLE_GAPC_APPEARANCE_CATEGORY_CARD_READER = 966,
  BLE_GAPC_APPEARANCE_CATEGORY_DIGITAL_PEN = 967,
  BLE_GAPC_APPEARANCE_CATEGORY_BARCODE_SCANNER = 968,
  BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_GLUCOSE_METER = 1024,
  BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_RUNNING_WALKING_SENSOR = 1088,
  BLE_GAPC_APPEARANCE_CATEGORY_RUNNING_WALKING_SENSOR_IN_SHOE = 1089,
  BLE_GAPC_APPEARANCE_CATEGORY_RUNNING_WALKING_SENSOR_ON_SHOE = 1090,
  BLE_GAPC_APPEARANCE_CATEGORY_RUNNING_WALKING_SENSOR_ON_HIP = 1091,
  BLE_GAPC_APPEARANCE_CATEGORY_GENERIC__CYCLING = 1152,
  BLE_GAPC_APPEARANCE_CATEGORY_CYCLING_CYCLING_COMPUTER = 1153,
  BLE_GAPC_APPEARANCE_CATEGORY_CYCLING_SPEED_SENSOR = 1154,
  BLE_GAPC_APPEARANCE_CATEGORY_CYCLING_CADENCE_SENSOR = 1155,
  BLE_GAPC_APPEARANCE_CATEGORY_CYCLING_POWER_SENSOR = 1156,
  BLE_GAPC_APPEARANCE_CATEGORY_CYCLING_SPEED_AND_CADENCE_SENSOR = 1157,
  BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_PULSE_OXIMETER = 3136,
  BLE_GAPC_APPEARANCE_CATEGORY_FINGERTIP = 3137,
  BLE_GAPC_APPEARANCE_CATEGORY_WRIST_WORN = 3138,
  BLE_GAPC_APPEARANCE_CATEGORY_GENERIC__WEIGHT_SCALE = 3200,
  BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_OUTDOOR_SPORTS_ACTIVITY = 5184,
  BLE_GAPC_APPEARANCE_CATEGORY_LOCATION_DISPLAY_DEVICE = 5185,
  BLE_GAPC_APPEARANCE_CATEGORY_LOCATION_AND_NAVIGATION_DISPLAY_DEVICE = 5186,
  BLE_GAPC_APPEARANCE_CATEGORY_LOCATION_POD = 5187,
  BLE_GAPC_APPEARANCE_CATEGORY_LOCATION_AND_NAVIGATION_POD = 5188,
  BLE_GAPS_APPEARANCE_CATEGORY_UNKNOWN = 0,
  BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_PHONE = 64,
  BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_COMPUTER = 128,
  BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_WATCH = 192,
  BLE_GAPS_APPEARANCE_CATEGORY_WATCH_SPORTS_WATCH = 193,
  BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_CLOCK = 256,
  BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_DISPLAY = 320,
  BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_REMOTE_CONTROL = 384,
  BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_EYE_GLASSES = 448,
  BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_TAG = 512,
  BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_KEYRING = 576,
  BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_MEDIA_PLAYER = 640,
  BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_BARCODE_SCANNER = 704,
  BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_THERMOMETER = 768,
  BLE_GAPS_APPEARANCE_CATEGORY_THERMOMETER_EAR = 769,
  BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_HEART_RATE_SENSOR = 832,
  BLE_GAPS_APPEARANCE_CATEGORY_HEART_RATE_SENSOR_HEART_RATE_BELT = 833,
  BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_BLOOD_PRESSURE = 896,
  BLE_GAPS_APPEARANCE_CATEGORY_BLOOD_PRESSURE_ARM = 897,
  BLE_GAPS_APPEARANCE_CATEGORY_BLOOD_PRESSURE_WRIST = 898,
  BLE_GAPS_APPEARANCE_CATEGORY_HUMAN_INTERFACE_DEVICE = 960,
  BLE_GAPS_APPEARANCE_CATEGORY_KEYBOARD = 961,
  BLE_GAPS_APPEARANCE_CATEGORY_MOUSE = 962,
  BLE_GAPS_APPEARANCE_CATEGORY_JOYSTICK = 963,
  BLE_GAPS_APPEARANCE_CATEGORY_GAMEPAD = 964,
  BLE_GAPS_APPEARANCE_CATEGORY_DIGITIZER_TABLET = 965,
  BLE_GAPS_APPEARANCE_CATEGORY_CARD_READER = 966,
  BLE_GAPS_APPEARANCE_CATEGORY_DIGITAL_PEN = 967,
  BLE_GAPS_APPEARANCE_CATEGORY_BARCODE_SCANNER = 968,
  BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_GLUCOSE_METER = 1024,
  BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_RUNNING_WALKING_SENSOR = 1088,
  BLE_GAPS_APPEARANCE_CATEGORY_RUNNING_WALKING_SENSOR_IN_SHOE = 1089,
  BLE_GAPS_APPEARANCE_CATEGORY_RUNNING_WALKING_SENSOR_ON_SHOE = 1090,
  BLE_GAPS_APPEARANCE_CATEGORY_RUNNING_WALKING_SENSOR_ON_HIP = 1091,
  BLE_GAPS_APPEARANCE_CATEGORY_GENERIC__CYCLING = 1152,
  BLE_GAPS_APPEARANCE_CATEGORY_CYCLING_CYCLING_COMPUTER = 1153,
  BLE_GAPS_APPEARANCE_CATEGORY_CYCLING_SPEED_SENSOR = 1154,
  BLE_GAPS_APPEARANCE_CATEGORY_CYCLING_CADENCE_SENSOR = 1155,
  BLE_GAPS_APPEARANCE_CATEGORY_CYCLING_POWER_SENSOR = 1156,
  BLE_GAPS_APPEARANCE_CATEGORY_CYCLING_SPEED_AND_CADENCE_SENSOR = 1157,
  BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_PULSE_OXIMETER = 3136,
  BLE_GAPS_APPEARANCE_CATEGORY_FINGERTIP = 3137,
  BLE_GAPS_APPEARANCE_CATEGORY_WRIST_WORN = 3138,
  BLE_GAPS_APPEARANCE_CATEGORY_GENERIC__WEIGHT_SCALE = 3200,
  BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_OUTDOOR_SPORTS_ACTIVITY = 5184,
  BLE_GAPS_APPEARANCE_CATEGORY_LOCATION_DISPLAY_DEVICE = 5185,
  BLE_GAPS_APPEARANCE_CATEGORY_LOCATION_AND_NAVIGATION_DISPLAY_DEVICE = 5186,
  BLE_GAPS_APPEARANCE_CATEGORY_LOCATION_POD = 5187,
  BLE_GAPS_APPEARANCE_CATEGORY_LOCATION_AND_NAVIGATION_POD = 5188
}
 Appearance Category enumeration. More...
 
enum  st_ble_gapc_char_idx_t {
  BLE_GAPC_DEV_NAME_IDX,
  BLE_GAPC_APPEARANCE_IDX,
  BLE_GAPC_PER_PREF_CONN_PARAM_IDX,
  BLE_GAPC_CENT_ADDR_RSLV_IDX,
  BLE_GAPC_RSLV_PRIV_ADDR_ONLY_IDX
}
 Generic Access characteristic ID. More...
 
enum  e_ble_gapc_event_t {
  BLE_GAPC_EVENT_DEV_NAME_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_GAPC_DEV_NAME_IDX, BLE_SERVC_READ_RSP),
  BLE_GAPC_EVENT_DEV_NAME_WRITE_RSP = BLE_SERVC_ATTR_EVENT(BLE_GAPC_DEV_NAME_IDX, BLE_SERVC_WRITE_RSP),
  BLE_GAPC_EVENT_APPEARANCE_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_GAPC_APPEARANCE_IDX, BLE_SERVC_READ_RSP),
  BLE_GAPC_EVENT_PER_PREF_CONN_PARAM_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_GAPC_PER_PREF_CONN_PARAM_IDX, BLE_SERVC_READ_RSP),
  BLE_GAPC_EVENT_CENT_ADDR_RSLV_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_GAPC_CENT_ADDR_RSLV_IDX, BLE_SERVC_READ_RSP),
  BLE_GAPC_EVENT_RSLV_PRIV_ADDR_ONLY_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_GAPC_RSLV_PRIV_ADDR_ONLY_IDX, BLE_SERVC_READ_RSP)
}
 Generic Access client event type. More...
 

Functions

ble_status_t R_BLE_GAPC_ReadDevName (uint16_t conn_hdl)
 Read Device Name characteristic value from the remote GATT database. More...
 
ble_status_t R_BLE_GAPC_WriteDevName (uint16_t conn_hdl, const st_ble_gapc_dev_name_t *p_value)
 Write Device Name characteristic value to remote GATT database. More...
 
void R_BLE_GAPC_GetDevNameAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_gapc_dev_name_attr_hdl_t *p_hdl)
 Get Device Name attribute handles. More...
 
ble_status_t R_BLE_GAPC_ReadAppearance (uint16_t conn_hdl)
 Read Appearance characteristic value from the remote GATT database. More...
 
void R_BLE_GAPC_GetAppearanceAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_gapc_appearance_attr_hdl_t *p_hdl)
 Get Appearance attribute handles. More...
 
ble_status_t R_BLE_GAPC_ReadPerPrefConnParam (uint16_t conn_hdl)
 Read Peripheral Preferred Connection Parameters characteristic value from the remote GATT database. More...
 
void R_BLE_GAPC_GetPerPrefConnParamAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_gapc_per_pref_conn_param_attr_hdl_t *p_hdl)
 Get Peripheral Preferred Connection Parameters attribute handles. More...
 
ble_status_t R_BLE_GAPC_ReadCentAddrRslv (uint16_t conn_hdl)
 Read Central Address Resolution characteristic value from the remote GATT database. More...
 
void R_BLE_GAPC_GetCentAddrRslvAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_gapc_cent_addr_rslv_attr_hdl_t *p_hdl)
 Get Central Address Resolution attribute handles. More...
 
ble_status_t R_BLE_GAPC_ReadRslvPrivAddrOnly (uint16_t conn_hdl)
 Read Resolvable Private Address Only characteristic value from the remote GATT database. More...
 
void R_BLE_GAPC_GetRslvPrivAddrOnlyAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_gapc_rslv_priv_addr_only_attr_hdl_t *p_hdl)
 Get Resolvable Private Address Only attribute handles. More...
 
ble_status_t R_BLE_GAPC_Init (ble_servc_app_cb_t cb)
 Initialize Generic Access client. More...
 
void R_BLE_GAPC_ServDiscCb (uint16_t conn_hdl, uint8_t serv_idx, uint16_t type, void *p_param)
 Generic Access client discovery callback. More...
 
void R_BLE_GAPC_GetServAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_gatt_hdl_range_t *p_hdl)
 Get Generic Access client attribute handle. More...
 

Enumeration Type Documentation

◆ e_ble_appearance_category_t

Appearance Category enumeration.

Enumerator
BLE_GAPC_APPEARANCE_CATEGORY_UNKNOWN 

Unknown

BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_PHONE 

Generic Phone

BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_COMPUTER 

Generic Computer

BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_WATCH 

Generic Watch

BLE_GAPC_APPEARANCE_CATEGORY_WATCH_SPORTS_WATCH 

Watch: Sports Watch

BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_CLOCK 

Generic Clock

BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_DISPLAY 

Generic Display

BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_REMOTE_CONTROL 

Generic Remote Control

BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_EYE_GLASSES 

Generic Eye-glasses

BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_TAG 

Generic Tag

BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_KEYRING 

Generic Keyring

BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_MEDIA_PLAYER 

Generic Media Player

BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_BARCODE_SCANNER 

Generic Barcode Scanner

BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_THERMOMETER 

Generic Thermometer

BLE_GAPC_APPEARANCE_CATEGORY_THERMOMETER_EAR 

Thermometer Ear

BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_HEART_RATE_SENSOR 

Generic Heart rate Sensor

BLE_GAPC_APPEARANCE_CATEGORY_HEART_RATE_SENSOR_HEART_RATE_BELT 

Heart Rate Sensor Heart Rate Belt

BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_BLOOD_PRESSURE 

Generic Blood Pressure

BLE_GAPC_APPEARANCE_CATEGORY_BLOOD_PRESSURE_ARM 

Blood Pressure: Arm

BLE_GAPC_APPEARANCE_CATEGORY_BLOOD_PRESSURE_WRIST 

Blood Pressure: Wrist

BLE_GAPC_APPEARANCE_CATEGORY_HUMAN_INTERFACE_DEVICE 

Human Interface Device (HID)

BLE_GAPC_APPEARANCE_CATEGORY_KEYBOARD 

Keyboard

BLE_GAPC_APPEARANCE_CATEGORY_MOUSE 

Mouse

BLE_GAPC_APPEARANCE_CATEGORY_JOYSTICK 

Joystick

BLE_GAPC_APPEARANCE_CATEGORY_GAMEPAD 

Gamepad

BLE_GAPC_APPEARANCE_CATEGORY_DIGITIZER_TABLET 

Digitizer Tablet

BLE_GAPC_APPEARANCE_CATEGORY_CARD_READER 

Card Reader

BLE_GAPC_APPEARANCE_CATEGORY_DIGITAL_PEN 

Digital Pen

BLE_GAPC_APPEARANCE_CATEGORY_BARCODE_SCANNER 

Barcode Scanner

BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_GLUCOSE_METER 

Generic Glucose Meter

BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_RUNNING_WALKING_SENSOR 

Generic: Running Walking Sensor

BLE_GAPC_APPEARANCE_CATEGORY_RUNNING_WALKING_SENSOR_IN_SHOE 

Running Walking Sensor: In-Shoe

BLE_GAPC_APPEARANCE_CATEGORY_RUNNING_WALKING_SENSOR_ON_SHOE 

Running Walking Sensor: On-Shoe

BLE_GAPC_APPEARANCE_CATEGORY_RUNNING_WALKING_SENSOR_ON_HIP 

Running Walking Sensor: On-Hip

BLE_GAPC_APPEARANCE_CATEGORY_GENERIC__CYCLING 

Generic Cycling

BLE_GAPC_APPEARANCE_CATEGORY_CYCLING_CYCLING_COMPUTER 

Cycling Cycling Computer

BLE_GAPC_APPEARANCE_CATEGORY_CYCLING_SPEED_SENSOR 

Cycling Speed Sensor

BLE_GAPC_APPEARANCE_CATEGORY_CYCLING_CADENCE_SENSOR 

Cycling Cadence Sensor

BLE_GAPC_APPEARANCE_CATEGORY_CYCLING_POWER_SENSOR 

Cycling: Power Sensor

BLE_GAPC_APPEARANCE_CATEGORY_CYCLING_SPEED_AND_CADENCE_SENSOR 

Cycling Speed and Cadence Sensor

BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_PULSE_OXIMETER 

Generic Pulse Oximeter

BLE_GAPC_APPEARANCE_CATEGORY_FINGERTIP 

Fingertip

BLE_GAPC_APPEARANCE_CATEGORY_WRIST_WORN 

Wrist Worn

BLE_GAPC_APPEARANCE_CATEGORY_GENERIC__WEIGHT_SCALE 

Generic Weight Scale

BLE_GAPC_APPEARANCE_CATEGORY_GENERIC_OUTDOOR_SPORTS_ACTIVITY 

Generic Outdoor Sports Activity

BLE_GAPC_APPEARANCE_CATEGORY_LOCATION_DISPLAY_DEVICE 

Location Display Device

BLE_GAPC_APPEARANCE_CATEGORY_LOCATION_AND_NAVIGATION_DISPLAY_DEVICE 

Location and Navigation Display Device

BLE_GAPC_APPEARANCE_CATEGORY_LOCATION_POD 

Location Pod

BLE_GAPC_APPEARANCE_CATEGORY_LOCATION_AND_NAVIGATION_POD 

Location and Navigation Pod

BLE_GAPS_APPEARANCE_CATEGORY_UNKNOWN 

Unknown

BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_PHONE 

Generic Phone

BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_COMPUTER 

Generic Computer

BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_WATCH 

Generic Watch

BLE_GAPS_APPEARANCE_CATEGORY_WATCH_SPORTS_WATCH 

Watch: Sports Watch

BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_CLOCK 

Generic Clock

BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_DISPLAY 

Generic Display

BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_REMOTE_CONTROL 

Generic Remote Control

BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_EYE_GLASSES 

Generic Eye-glasses

BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_TAG 

Generic Tag

BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_KEYRING 

Generic Keyring

BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_MEDIA_PLAYER 

Generic Media Player

BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_BARCODE_SCANNER 

Generic Barcode Scanner

BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_THERMOMETER 

Generic Thermometer

BLE_GAPS_APPEARANCE_CATEGORY_THERMOMETER_EAR 

Thermometer Ear

BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_HEART_RATE_SENSOR 

Generic Heart rate Sensor

BLE_GAPS_APPEARANCE_CATEGORY_HEART_RATE_SENSOR_HEART_RATE_BELT 

Heart Rate Sensor Heart Rate Belt

BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_BLOOD_PRESSURE 

Generic Blood Pressure

BLE_GAPS_APPEARANCE_CATEGORY_BLOOD_PRESSURE_ARM 

Blood Pressure: Arm

BLE_GAPS_APPEARANCE_CATEGORY_BLOOD_PRESSURE_WRIST 

Blood Pressure: Wrist

BLE_GAPS_APPEARANCE_CATEGORY_HUMAN_INTERFACE_DEVICE 

Human Interface Device (HID)

BLE_GAPS_APPEARANCE_CATEGORY_KEYBOARD 

Keyboard

BLE_GAPS_APPEARANCE_CATEGORY_MOUSE 

Mouse

BLE_GAPS_APPEARANCE_CATEGORY_JOYSTICK 

Joystick

BLE_GAPS_APPEARANCE_CATEGORY_GAMEPAD 

Gamepad

BLE_GAPS_APPEARANCE_CATEGORY_DIGITIZER_TABLET 

Digitizer Tablet

BLE_GAPS_APPEARANCE_CATEGORY_CARD_READER 

Card Reader

BLE_GAPS_APPEARANCE_CATEGORY_DIGITAL_PEN 

Digital Pen

BLE_GAPS_APPEARANCE_CATEGORY_BARCODE_SCANNER 

Barcode Scanner

BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_GLUCOSE_METER 

Generic Glucose Meter

BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_RUNNING_WALKING_SENSOR 

Generic: Running Walking Sensor

BLE_GAPS_APPEARANCE_CATEGORY_RUNNING_WALKING_SENSOR_IN_SHOE 

Running Walking Sensor: In-Shoe

BLE_GAPS_APPEARANCE_CATEGORY_RUNNING_WALKING_SENSOR_ON_SHOE 

Running Walking Sensor: On-Shoe

BLE_GAPS_APPEARANCE_CATEGORY_RUNNING_WALKING_SENSOR_ON_HIP 

Running Walking Sensor: On-Hip

BLE_GAPS_APPEARANCE_CATEGORY_GENERIC__CYCLING 

Generic Cycling

BLE_GAPS_APPEARANCE_CATEGORY_CYCLING_CYCLING_COMPUTER 

Cycling Cycling Computer

BLE_GAPS_APPEARANCE_CATEGORY_CYCLING_SPEED_SENSOR 

Cycling Speed Sensor

BLE_GAPS_APPEARANCE_CATEGORY_CYCLING_CADENCE_SENSOR 

Cycling Cadence Sensor

BLE_GAPS_APPEARANCE_CATEGORY_CYCLING_POWER_SENSOR 

Cycling: Power Sensor

BLE_GAPS_APPEARANCE_CATEGORY_CYCLING_SPEED_AND_CADENCE_SENSOR 

Cycling Speed and Cadence Sensor

BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_PULSE_OXIMETER 

Generic Pulse Oximeter

BLE_GAPS_APPEARANCE_CATEGORY_FINGERTIP 

Fingertip

BLE_GAPS_APPEARANCE_CATEGORY_WRIST_WORN 

Wrist Worn

BLE_GAPS_APPEARANCE_CATEGORY_GENERIC__WEIGHT_SCALE 

Generic Weight Scale

BLE_GAPS_APPEARANCE_CATEGORY_GENERIC_OUTDOOR_SPORTS_ACTIVITY 

Generic Outdoor Sports Activity

BLE_GAPS_APPEARANCE_CATEGORY_LOCATION_DISPLAY_DEVICE 

Location Display Device

BLE_GAPS_APPEARANCE_CATEGORY_LOCATION_AND_NAVIGATION_DISPLAY_DEVICE 

Location and Navigation Display Device

BLE_GAPS_APPEARANCE_CATEGORY_LOCATION_POD 

Location Pod

BLE_GAPS_APPEARANCE_CATEGORY_LOCATION_AND_NAVIGATION_POD 

Location and Navigation Pod

◆ st_ble_gapc_char_idx_t

Generic Access characteristic ID.

◆ e_ble_gapc_event_t

Generic Access client event type.

Function Documentation

◆ R_BLE_GAPC_ReadDevName()

ble_status_t R_BLE_GAPC_ReadDevName ( uint16_t  conn_hdl)

Read Device Name characteristic value from the remote GATT database.

Parameters
[in]conn_hdlConnection handle.
Returns
ble_status_t

◆ R_BLE_GAPC_WriteDevName()

ble_status_t R_BLE_GAPC_WriteDevName ( uint16_t  conn_hdl,
const st_ble_gapc_dev_name_t p_value 
)

Write Device Name characteristic value to remote GATT database.

Parameters
[in]conn_hdlConnection handle.
[in]p_valueDevice Name characteristic value to write.
Returns
ble_status_t

◆ R_BLE_GAPC_GetDevNameAttrHdl()

void R_BLE_GAPC_GetDevNameAttrHdl ( const st_ble_dev_addr_t p_addr,
st_ble_gapc_dev_name_attr_hdl_t p_hdl 
)

Get Device Name attribute handles.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.
Returns
ble_status_t

◆ R_BLE_GAPC_ReadAppearance()

ble_status_t R_BLE_GAPC_ReadAppearance ( uint16_t  conn_hdl)

Read Appearance characteristic value from the remote GATT database.

Parameters
[in]conn_hdlConnection handle.
Returns
ble_status_t

◆ R_BLE_GAPC_GetAppearanceAttrHdl()

void R_BLE_GAPC_GetAppearanceAttrHdl ( const st_ble_dev_addr_t p_addr,
st_ble_gapc_appearance_attr_hdl_t p_hdl 
)

Get Appearance attribute handles.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.
Returns
ble_status_t

◆ R_BLE_GAPC_ReadPerPrefConnParam()

ble_status_t R_BLE_GAPC_ReadPerPrefConnParam ( uint16_t  conn_hdl)

Read Peripheral Preferred Connection Parameters characteristic value from the remote GATT database.

Parameters
[in]conn_hdlConnection handle.
Returns
ble_status_t

◆ R_BLE_GAPC_GetPerPrefConnParamAttrHdl()

void R_BLE_GAPC_GetPerPrefConnParamAttrHdl ( const st_ble_dev_addr_t p_addr,
st_ble_gapc_per_pref_conn_param_attr_hdl_t p_hdl 
)

Get Peripheral Preferred Connection Parameters attribute handles.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.
Returns
ble_status_t

◆ R_BLE_GAPC_ReadCentAddrRslv()

ble_status_t R_BLE_GAPC_ReadCentAddrRslv ( uint16_t  conn_hdl)

Read Central Address Resolution characteristic value from the remote GATT database.

Parameters
[in]conn_hdlConnection handle.
Returns
ble_status_t

◆ R_BLE_GAPC_GetCentAddrRslvAttrHdl()

void R_BLE_GAPC_GetCentAddrRslvAttrHdl ( const st_ble_dev_addr_t p_addr,
st_ble_gapc_cent_addr_rslv_attr_hdl_t p_hdl 
)

Get Central Address Resolution attribute handles.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.
Returns
ble_status_t

◆ R_BLE_GAPC_ReadRslvPrivAddrOnly()

ble_status_t R_BLE_GAPC_ReadRslvPrivAddrOnly ( uint16_t  conn_hdl)

Read Resolvable Private Address Only characteristic value from the remote GATT database.

Parameters
[in]conn_hdlConnection handle.
Returns
ble_status_t

◆ R_BLE_GAPC_GetRslvPrivAddrOnlyAttrHdl()

void R_BLE_GAPC_GetRslvPrivAddrOnlyAttrHdl ( const st_ble_dev_addr_t p_addr,
st_ble_gapc_rslv_priv_addr_only_attr_hdl_t p_hdl 
)

Get Resolvable Private Address Only attribute handles.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.
Returns
ble_status_t

◆ R_BLE_GAPC_Init()

ble_status_t R_BLE_GAPC_Init ( ble_servc_app_cb_t  cb)

Initialize Generic Access client.

Parameters
[in]cbClient callback.
Returns
ble_status_t

◆ R_BLE_GAPC_ServDiscCb()

void R_BLE_GAPC_ServDiscCb ( uint16_t  conn_hdl,
uint8_t  serv_idx,
uint16_t  type,
void *  p_param 
)

Generic Access client discovery callback.

Parameters
[in]conn_hdlConnection handle
[in]serv_idxService instance index.
[in]typeService discovery event type.
[in]p_paramService discovery event parameter.
Returns
ble_status_t

◆ R_BLE_GAPC_GetServAttrHdl()

void R_BLE_GAPC_GetServAttrHdl ( const st_ble_dev_addr_t p_addr,
st_ble_gatt_hdl_range_t p_hdl 
)

Get Generic Access client attribute handle.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.