![]() |
Bluetooth LE Profile API document
Bluetooth LE Profile API document Rev.1.00 [May 22, 2020]
|
This is the client for the Device Information Service. More...
This is the client for the Device Information Service.
Data Structures | |
struct | st_ble_dic_mfr_name_attr_hdl_t |
Manufacturer Name attribute handle value. More... | |
struct | st_ble_dic_model_num_attr_hdl_t |
Model Number attribute handle value. More... | |
struct | st_ble_dic_ser_num_attr_hdl_t |
Serial Number attribute handle value. More... | |
struct | st_ble_dic_hw_rev_attr_hdl_t |
Hardware Revision attribute handle value. More... | |
struct | st_ble_dic_firm_rev_attr_hdl_t |
Firmware Revision attribute handle value. More... | |
struct | st_ble_dic_sw_rev_attr_hdl_t |
Software Revision attribute handle value. More... | |
struct | st_ble_dic_sys_id_t |
System ID value structure. More... | |
struct | st_ble_dic_sys_id_attr_hdl_t |
System ID attribute handle value. More... | |
struct | st_ble_dic_reg_cer_data_list_attr_hdl_t |
IEEE 11073-20601 Regulatory Certification Data List attribute handle value. More... | |
struct | st_ble_dic_pnp_id_t |
PnP ID value structure. More... | |
struct | st_ble_dic_pnp_id_attr_hdl_t |
PnP ID attribute handle value. More... | |
struct | st_ble_dic_evt_data_t |
Device Information client event data. More... | |
Enumerations | |
enum | e_ble_dic_pnp_id_vendor_id_source_t { BLE_DIC_PNP_ID_VENDOR_ID_SOURCE_BLUETOOTH_SIG_ASSIGNED_COMPANY_IDENTIFIER_VALUE_FROM_THE_ASSIGNED_NUMBERS_DOCUMENT = 1, BLE_DIC_PNP_ID_VENDOR_ID_SOURCE_USB_IMPLEMENTER_S_FORUM_ASSIGNED_VENDOR_ID_VALUE = 2 } |
PnP ID Vendor ID Source enumeration. More... | |
enum | st_ble_dic_char_idx_t { BLE_DIC_MFR_NAME_IDX, BLE_DIC_MODEL_NUM_IDX, BLE_DIC_SER_NUM_IDX, BLE_DIC_HW_REV_IDX, BLE_DIC_FIRM_REV_IDX, BLE_DIC_SW_REV_IDX, BLE_DIC_SYS_ID_IDX, BLE_DIC_REG_CER_DATA_LIST_IDX, BLE_DIC_PNP_ID_IDX } |
Device Information characteristic ID. More... | |
enum | e_ble_dic_event_t { BLE_DIC_EVENT_MFR_NAME_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_DIC_MFR_NAME_IDX, BLE_SERVC_READ_RSP), BLE_DIC_EVENT_MODEL_NUM_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_DIC_MODEL_NUM_IDX, BLE_SERVC_READ_RSP), BLE_DIC_EVENT_SER_NUM_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_DIC_SER_NUM_IDX, BLE_SERVC_READ_RSP), BLE_DIC_EVENT_HW_REV_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_DIC_HW_REV_IDX, BLE_SERVC_READ_RSP), BLE_DIC_EVENT_FIRM_REV_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_DIC_FIRM_REV_IDX, BLE_SERVC_READ_RSP), BLE_DIC_EVENT_SW_REV_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_DIC_SW_REV_IDX, BLE_SERVC_READ_RSP), BLE_DIC_EVENT_SYS_ID_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_DIC_SYS_ID_IDX, BLE_SERVC_READ_RSP), BLE_DIC_EVENT_REG_CER_DATA_LIST_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_DIC_REG_CER_DATA_LIST_IDX, BLE_SERVC_READ_RSP), BLE_DIC_EVENT_PNP_ID_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_DIC_PNP_ID_IDX, BLE_SERVC_READ_RSP) } |
Device Information client event type. More... | |
Functions | |
ble_status_t | R_BLE_DIC_ReadMfrName (uint16_t conn_hdl) |
Read Manufacturer Name characteristic value from the remote GATT database. More... | |
void | R_BLE_DIC_GetMfrNameAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_dic_mfr_name_attr_hdl_t *p_hdl) |
Get Manufacturer Name attribute handles. More... | |
ble_status_t | R_BLE_DIC_ReadModelNum (uint16_t conn_hdl) |
Read Model Number characteristic value from the remote GATT database. More... | |
void | R_BLE_DIC_GetModelNumAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_dic_model_num_attr_hdl_t *p_hdl) |
Get Model Number attribute handles. More... | |
ble_status_t | R_BLE_DIC_ReadSerNum (uint16_t conn_hdl) |
Read Serial Number characteristic value from the remote GATT database. More... | |
void | R_BLE_DIC_GetSerNumAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_dic_ser_num_attr_hdl_t *p_hdl) |
Get Serial Number attribute handles. More... | |
ble_status_t | R_BLE_DIC_ReadHwRev (uint16_t conn_hdl) |
Read Hardware Revision characteristic value from the remote GATT database. More... | |
void | R_BLE_DIC_GetHwRevAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_dic_hw_rev_attr_hdl_t *p_hdl) |
Get Hardware Revision attribute handles. More... | |
ble_status_t | R_BLE_DIC_ReadFirmRev (uint16_t conn_hdl) |
Read Firmware Revision characteristic value from the remote GATT database. More... | |
void | R_BLE_DIC_GetFirmRevAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_dic_firm_rev_attr_hdl_t *p_hdl) |
Get Firmware Revision attribute handles. More... | |
ble_status_t | R_BLE_DIC_ReadSwRev (uint16_t conn_hdl) |
Read Software Revision characteristic value from the remote GATT database. More... | |
void | R_BLE_DIC_GetSwRevAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_dic_sw_rev_attr_hdl_t *p_hdl) |
Get Software Revision attribute handles. More... | |
ble_status_t | R_BLE_DIC_ReadSysId (uint16_t conn_hdl) |
Read System ID characteristic value from the remote GATT database. More... | |
void | R_BLE_DIC_GetSysIdAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_dic_sys_id_attr_hdl_t *p_hdl) |
Get System ID attribute handles. More... | |
ble_status_t | R_BLE_DIC_ReadRegCerDataList (uint16_t conn_hdl) |
Read IEEE 11073-20601 Regulatory Certification Data List characteristic value from the remote GATT database. More... | |
void | R_BLE_DIC_GetRegCerDataListAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_dic_reg_cer_data_list_attr_hdl_t *p_hdl) |
Get IEEE 11073-20601 Regulatory Certification Data List attribute handles. More... | |
ble_status_t | R_BLE_DIC_ReadPnpId (uint16_t conn_hdl) |
Read PnP ID characteristic value from the remote GATT database. More... | |
void | R_BLE_DIC_GetPnpIdAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_dic_pnp_id_attr_hdl_t *p_hdl) |
Get PnP ID attribute handles. More... | |
ble_status_t | R_BLE_DIC_Init (ble_servc_app_cb_t cb) |
Initialize Device Information client. More... | |
void | R_BLE_DIC_ServDiscCb (uint16_t conn_hdl, uint8_t serv_idx, uint16_t type, void *p_param) |
Device Information client discovery callback. More... | |
void | R_BLE_DIC_GetServAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_gatt_hdl_range_t *p_hdl) |
Get Device Information client attribute handle. More... | |
PnP ID Vendor ID Source enumeration.
Device Information characteristic ID.
enum e_ble_dic_event_t |
Device Information client event type.
ble_status_t R_BLE_DIC_ReadMfrName | ( | uint16_t | conn_hdl | ) |
Read Manufacturer Name characteristic value from the remote GATT database.
[in] | conn_hdl | Connection handle. |
void R_BLE_DIC_GetMfrNameAttrHdl | ( | const st_ble_dev_addr_t * | p_addr, |
st_ble_dic_mfr_name_attr_hdl_t * | p_hdl | ||
) |
Get Manufacturer Name attribute handles.
[in] | p_addr | Bluetooth device address for the attribute handles. |
[out] | p_hdl | The pointer to store the retrieved attribute handles. |
ble_status_t R_BLE_DIC_ReadModelNum | ( | uint16_t | conn_hdl | ) |
Read Model Number characteristic value from the remote GATT database.
[in] | conn_hdl | Connection handle. |
void R_BLE_DIC_GetModelNumAttrHdl | ( | const st_ble_dev_addr_t * | p_addr, |
st_ble_dic_model_num_attr_hdl_t * | p_hdl | ||
) |
Get Model Number attribute handles.
[in] | p_addr | Bluetooth device address for the attribute handles. |
[out] | p_hdl | The pointer to store the retrieved attribute handles. |
ble_status_t R_BLE_DIC_ReadSerNum | ( | uint16_t | conn_hdl | ) |
Read Serial Number characteristic value from the remote GATT database.
[in] | conn_hdl | Connection handle. |
void R_BLE_DIC_GetSerNumAttrHdl | ( | const st_ble_dev_addr_t * | p_addr, |
st_ble_dic_ser_num_attr_hdl_t * | p_hdl | ||
) |
Get Serial Number attribute handles.
[in] | p_addr | Bluetooth device address for the attribute handles. |
[out] | p_hdl | The pointer to store the retrieved attribute handles. |
ble_status_t R_BLE_DIC_ReadHwRev | ( | uint16_t | conn_hdl | ) |
Read Hardware Revision characteristic value from the remote GATT database.
[in] | conn_hdl | Connection handle. |
void R_BLE_DIC_GetHwRevAttrHdl | ( | const st_ble_dev_addr_t * | p_addr, |
st_ble_dic_hw_rev_attr_hdl_t * | p_hdl | ||
) |
Get Hardware Revision attribute handles.
[in] | p_addr | Bluetooth device address for the attribute handles. |
[out] | p_hdl | The pointer to store the retrieved attribute handles. |
ble_status_t R_BLE_DIC_ReadFirmRev | ( | uint16_t | conn_hdl | ) |
Read Firmware Revision characteristic value from the remote GATT database.
[in] | conn_hdl | Connection handle. |
void R_BLE_DIC_GetFirmRevAttrHdl | ( | const st_ble_dev_addr_t * | p_addr, |
st_ble_dic_firm_rev_attr_hdl_t * | p_hdl | ||
) |
Get Firmware Revision attribute handles.
[in] | p_addr | Bluetooth device address for the attribute handles. |
[out] | p_hdl | The pointer to store the retrieved attribute handles. |
ble_status_t R_BLE_DIC_ReadSwRev | ( | uint16_t | conn_hdl | ) |
Read Software Revision characteristic value from the remote GATT database.
[in] | conn_hdl | Connection handle. |
void R_BLE_DIC_GetSwRevAttrHdl | ( | const st_ble_dev_addr_t * | p_addr, |
st_ble_dic_sw_rev_attr_hdl_t * | p_hdl | ||
) |
Get Software Revision attribute handles.
[in] | p_addr | Bluetooth device address for the attribute handles. |
[out] | p_hdl | The pointer to store the retrieved attribute handles. |
ble_status_t R_BLE_DIC_ReadSysId | ( | uint16_t | conn_hdl | ) |
Read System ID characteristic value from the remote GATT database.
[in] | conn_hdl | Connection handle. |
void R_BLE_DIC_GetSysIdAttrHdl | ( | const st_ble_dev_addr_t * | p_addr, |
st_ble_dic_sys_id_attr_hdl_t * | p_hdl | ||
) |
Get System ID attribute handles.
[in] | p_addr | Bluetooth device address for the attribute handles. |
[out] | p_hdl | The pointer to store the retrieved attribute handles. |
ble_status_t R_BLE_DIC_ReadRegCerDataList | ( | uint16_t | conn_hdl | ) |
Read IEEE 11073-20601 Regulatory Certification Data List characteristic value from the remote GATT database.
[in] | conn_hdl | Connection handle. |
void R_BLE_DIC_GetRegCerDataListAttrHdl | ( | const st_ble_dev_addr_t * | p_addr, |
st_ble_dic_reg_cer_data_list_attr_hdl_t * | p_hdl | ||
) |
Get IEEE 11073-20601 Regulatory Certification Data List attribute handles.
[in] | p_addr | Bluetooth device address for the attribute handles. |
[out] | p_hdl | The pointer to store the retrieved attribute handles. |
ble_status_t R_BLE_DIC_ReadPnpId | ( | uint16_t | conn_hdl | ) |
Read PnP ID characteristic value from the remote GATT database.
[in] | conn_hdl | Connection handle. |
void R_BLE_DIC_GetPnpIdAttrHdl | ( | const st_ble_dev_addr_t * | p_addr, |
st_ble_dic_pnp_id_attr_hdl_t * | p_hdl | ||
) |
Get PnP ID attribute handles.
[in] | p_addr | Bluetooth device address for the attribute handles. |
[out] | p_hdl | The pointer to store the retrieved attribute handles. |
ble_status_t R_BLE_DIC_Init | ( | ble_servc_app_cb_t | cb | ) |
void R_BLE_DIC_ServDiscCb | ( | uint16_t | conn_hdl, |
uint8_t | serv_idx, | ||
uint16_t | type, | ||
void * | p_param | ||
) |
Device Information client discovery callback.
[in] | conn_hdl | Connection handle |
[in] | serv_idx | Service instance index. |
[in] | type | Service discovery event type. |
[in] | p_param | Service discovery event parameter. |
void R_BLE_DIC_GetServAttrHdl | ( | const st_ble_dev_addr_t * | p_addr, |
st_ble_gatt_hdl_range_t * | p_hdl | ||
) |
Get Device Information client attribute handle.
[in] | p_addr | Bluetooth device address for the attribute handles. |
[out] | p_hdl | The pointer to store the retrieved attribute handles. |