Bluetooth LE Profile API document
Bluetooth LE Profile API document Rev.1.00 [May 22, 2020]
Device Information Service Server

The Device Information Service exposes manufacturer and/or vendor information about a device. More...

Detailed Description

The Device Information Service exposes manufacturer and/or vendor information about a device.

Data Structures

struct  st_ble_dis_sys_id_t
 System ID value structure. More...
 
struct  st_ble_dis_pnp_id_t
 PnP ID value structure. More...
 

Enumerations

enum  e_ble_dis_pnp_id_vendor_id_source_t {
  BLE_DIS_PNP_ID_VENDOR_ID_SOURCE_BLUETOOTH_SIG_ASSIGNED_COMPANY_IDENTIFIER_VALUE_FROM_THE_ASSIGNED_NUMBERS_DOCUMENT = 1,
  BLE_DIS_PNP_ID_VENDOR_ID_SOURCE_USB_IMPLEMENTER_S_FORUM_ASSIGNED_VENDOR_ID_VALUE = 2
}
 PnP ID Vendor ID Source enumeration. More...
 
enum  st_ble_dis_char_idx_t {
  BLE_DIS_MFR_NAME_IDX,
  BLE_DIS_MODEL_NUM_IDX,
  BLE_DIS_SER_NUM_IDX,
  BLE_DIS_HW_REV_IDX,
  BLE_DIS_FIRM_REV_IDX,
  BLE_DIS_SW_REV_IDX,
  BLE_DIS_SYS_ID_IDX,
  BLE_DIS_REG_CER_DATA_LIST_IDX,
  BLE_DIS_PNP_ID_IDX
}
 Device Information characteristic Index. More...
 
enum  e_ble_dis_event_t {
  BLE_DIS_EVENT_MFR_NAME_READ_REQ = BLE_SERVS_ATTR_EVENT(BLE_DIS_MFR_NAME_IDX, BLE_SERVS_READ_REQ),
  BLE_DIS_EVENT_MODEL_NUM_READ_REQ = BLE_SERVS_ATTR_EVENT(BLE_DIS_MODEL_NUM_IDX, BLE_SERVS_READ_REQ),
  BLE_DIS_EVENT_SER_NUM_READ_REQ = BLE_SERVS_ATTR_EVENT(BLE_DIS_SER_NUM_IDX, BLE_SERVS_READ_REQ),
  BLE_DIS_EVENT_HW_REV_READ_REQ = BLE_SERVS_ATTR_EVENT(BLE_DIS_HW_REV_IDX, BLE_SERVS_READ_REQ),
  BLE_DIS_EVENT_FIRM_REV_READ_REQ = BLE_SERVS_ATTR_EVENT(BLE_DIS_FIRM_REV_IDX, BLE_SERVS_READ_REQ),
  BLE_DIS_EVENT_SW_REV_READ_REQ = BLE_SERVS_ATTR_EVENT(BLE_DIS_SW_REV_IDX, BLE_SERVS_READ_REQ),
  BLE_DIS_EVENT_SYS_ID_READ_REQ = BLE_SERVS_ATTR_EVENT(BLE_DIS_SYS_ID_IDX, BLE_SERVS_READ_REQ),
  BLE_DIS_EVENT_REG_CER_DATA_LIST_READ_REQ = BLE_SERVS_ATTR_EVENT(BLE_DIS_REG_CER_DATA_LIST_IDX, BLE_SERVS_READ_REQ),
  BLE_DIS_EVENT_PNP_ID_READ_REQ = BLE_SERVS_ATTR_EVENT(BLE_DIS_PNP_ID_IDX, BLE_SERVS_READ_REQ)
}
 Device Information event type. More...
 

Functions

ble_status_t R_BLE_DIS_SetMfrName (const st_ble_seq_data_t *p_value)
 Set Manufacturer Name characteristic value to the local GATT database. More...
 
ble_status_t R_BLE_DIS_GetMfrName (st_ble_seq_data_t *p_value)
 Get Manufacturer Name characteristic value from the local GATT database. More...
 
ble_status_t R_BLE_DIS_SetModelNum (const st_ble_seq_data_t *p_value)
 Set Model Number characteristic value to the local GATT database. More...
 
ble_status_t R_BLE_DIS_GetModelNum (st_ble_seq_data_t *p_value)
 Get Model Number characteristic value from the local GATT database. More...
 
ble_status_t R_BLE_DIS_SetSerNum (const st_ble_seq_data_t *p_value)
 Set Serial Number characteristic value to the local GATT database. More...
 
ble_status_t R_BLE_DIS_GetSerNum (st_ble_seq_data_t *p_value)
 Get Serial Number characteristic value from the local GATT database. More...
 
ble_status_t R_BLE_DIS_SetHwRev (const st_ble_seq_data_t *p_value)
 Set Hardware Revision characteristic value to the local GATT database. More...
 
ble_status_t R_BLE_DIS_GetHwRev (st_ble_seq_data_t *p_value)
 Get Hardware Revision characteristic value from the local GATT database. More...
 
ble_status_t R_BLE_DIS_SetFirmRev (const st_ble_seq_data_t *p_value)
 Set Firmware Revision characteristic value to the local GATT database. More...
 
ble_status_t R_BLE_DIS_GetFirmRev (st_ble_seq_data_t *p_value)
 Get Firmware Revision characteristic value from the local GATT database. More...
 
ble_status_t R_BLE_DIS_SetSwRev (const st_ble_seq_data_t *p_value)
 Set Software Revision characteristic value to the local GATT database. More...
 
ble_status_t R_BLE_DIS_GetSwRev (st_ble_seq_data_t *p_value)
 Get Software Revision characteristic value from the local GATT database. More...
 
ble_status_t R_BLE_DIS_SetSysId (const st_ble_dis_sys_id_t *p_value)
 Set System ID characteristic value to the local GATT database. More...
 
ble_status_t R_BLE_DIS_GetSysId (st_ble_dis_sys_id_t *p_value)
 Get System ID characteristic value from the local GATT database. More...
 
ble_status_t R_BLE_DIS_SetRegCerDataList (const st_ble_seq_data_t *p_value)
 Set IEEE 11073-20601 Regulatory Certification Data List characteristic value to the local GATT database. More...
 
ble_status_t R_BLE_DIS_GetRegCerDataList (st_ble_seq_data_t *p_value)
 Get IEEE 11073-20601 Regulatory Certification Data List characteristic value from the local GATT database. More...
 
ble_status_t R_BLE_DIS_SetPnpId (const st_ble_dis_pnp_id_t *p_value)
 Set PnP ID characteristic value to the local GATT database. More...
 
ble_status_t R_BLE_DIS_GetPnpId (st_ble_dis_pnp_id_t *p_value)
 Get PnP ID characteristic value from the local GATT database. More...
 
ble_status_t R_BLE_DIS_Init (ble_servs_app_cb_t cb)
 Initialize Device Information service. More...
 

Enumeration Type Documentation

◆ e_ble_dis_pnp_id_vendor_id_source_t

PnP ID Vendor ID Source enumeration.

Enumerator
BLE_DIS_PNP_ID_VENDOR_ID_SOURCE_BLUETOOTH_SIG_ASSIGNED_COMPANY_IDENTIFIER_VALUE_FROM_THE_ASSIGNED_NUMBERS_DOCUMENT 

Bluetooth SIG assigned Company Identifier value from the Assigned Numbers document

BLE_DIS_PNP_ID_VENDOR_ID_SOURCE_USB_IMPLEMENTER_S_FORUM_ASSIGNED_VENDOR_ID_VALUE 

USB Implementer's Forum assigned Vendor ID value

◆ st_ble_dis_char_idx_t

Device Information characteristic Index.

◆ e_ble_dis_event_t

Device Information event type.

Function Documentation

◆ R_BLE_DIS_SetMfrName()

ble_status_t R_BLE_DIS_SetMfrName ( const st_ble_seq_data_t p_value)

Set Manufacturer Name characteristic value to the local GATT database.

Parameters
[in]p_valueCharacteristic value to set.
Returns
ble_status_t

◆ R_BLE_DIS_GetMfrName()

ble_status_t R_BLE_DIS_GetMfrName ( st_ble_seq_data_t p_value)

Get Manufacturer Name characteristic value from the local GATT database.

Parameters
[in]p_valueOutput location for the acquired descriptor value.
Returns
ble_status_t

◆ R_BLE_DIS_SetModelNum()

ble_status_t R_BLE_DIS_SetModelNum ( const st_ble_seq_data_t p_value)

Set Model Number characteristic value to the local GATT database.

Parameters
[in]p_valueCharacteristic value to set.
Returns
ble_status_t

◆ R_BLE_DIS_GetModelNum()

ble_status_t R_BLE_DIS_GetModelNum ( st_ble_seq_data_t p_value)

Get Model Number characteristic value from the local GATT database.

Parameters
[in]p_valueOutput location for the acquired descriptor value.
Returns
ble_status_t

◆ R_BLE_DIS_SetSerNum()

ble_status_t R_BLE_DIS_SetSerNum ( const st_ble_seq_data_t p_value)

Set Serial Number characteristic value to the local GATT database.

Parameters
[in]p_valueCharacteristic value to set.
Returns
ble_status_t

◆ R_BLE_DIS_GetSerNum()

ble_status_t R_BLE_DIS_GetSerNum ( st_ble_seq_data_t p_value)

Get Serial Number characteristic value from the local GATT database.

Parameters
[in]p_valueOutput location for the acquired descriptor value.
Returns
ble_status_t

◆ R_BLE_DIS_SetHwRev()

ble_status_t R_BLE_DIS_SetHwRev ( const st_ble_seq_data_t p_value)

Set Hardware Revision characteristic value to the local GATT database.

Parameters
[in]p_valueCharacteristic value to set.
Returns
ble_status_t

◆ R_BLE_DIS_GetHwRev()

ble_status_t R_BLE_DIS_GetHwRev ( st_ble_seq_data_t p_value)

Get Hardware Revision characteristic value from the local GATT database.

Parameters
[in]p_valueOutput location for the acquired descriptor value.
Returns
ble_status_t

◆ R_BLE_DIS_SetFirmRev()

ble_status_t R_BLE_DIS_SetFirmRev ( const st_ble_seq_data_t p_value)

Set Firmware Revision characteristic value to the local GATT database.

Parameters
[in]p_valueCharacteristic value to set.
Returns
ble_status_t

◆ R_BLE_DIS_GetFirmRev()

ble_status_t R_BLE_DIS_GetFirmRev ( st_ble_seq_data_t p_value)

Get Firmware Revision characteristic value from the local GATT database.

Parameters
[in]p_valueOutput location for the acquired descriptor value.
Returns
ble_status_t

◆ R_BLE_DIS_SetSwRev()

ble_status_t R_BLE_DIS_SetSwRev ( const st_ble_seq_data_t p_value)

Set Software Revision characteristic value to the local GATT database.

Parameters
[in]p_valueCharacteristic value to set.
Returns
ble_status_t

◆ R_BLE_DIS_GetSwRev()

ble_status_t R_BLE_DIS_GetSwRev ( st_ble_seq_data_t p_value)

Get Software Revision characteristic value from the local GATT database.

Parameters
[in]p_valueOutput location for the acquired descriptor value.
Returns
ble_status_t

◆ R_BLE_DIS_SetSysId()

ble_status_t R_BLE_DIS_SetSysId ( const st_ble_dis_sys_id_t p_value)

Set System ID characteristic value to the local GATT database.

Parameters
[in]p_valueCharacteristic value to set.
Returns
ble_status_t

◆ R_BLE_DIS_GetSysId()

ble_status_t R_BLE_DIS_GetSysId ( st_ble_dis_sys_id_t p_value)

Get System ID characteristic value from the local GATT database.

Parameters
[in]p_valueOutput location for the acquired descriptor value.
Returns
ble_status_t

◆ R_BLE_DIS_SetRegCerDataList()

ble_status_t R_BLE_DIS_SetRegCerDataList ( const st_ble_seq_data_t p_value)

Set IEEE 11073-20601 Regulatory Certification Data List characteristic value to the local GATT database.

Parameters
[in]p_valueCharacteristic value to set.
Returns
ble_status_t

◆ R_BLE_DIS_GetRegCerDataList()

ble_status_t R_BLE_DIS_GetRegCerDataList ( st_ble_seq_data_t p_value)

Get IEEE 11073-20601 Regulatory Certification Data List characteristic value from the local GATT database.

Parameters
[in]p_valueOutput location for the acquired descriptor value.
Returns
ble_status_t

◆ R_BLE_DIS_SetPnpId()

ble_status_t R_BLE_DIS_SetPnpId ( const st_ble_dis_pnp_id_t p_value)

Set PnP ID characteristic value to the local GATT database.

Parameters
[in]p_valueCharacteristic value to set.
Returns
ble_status_t

◆ R_BLE_DIS_GetPnpId()

ble_status_t R_BLE_DIS_GetPnpId ( st_ble_dis_pnp_id_t p_value)

Get PnP ID characteristic value from the local GATT database.

Parameters
[in]p_valueOutput location for the acquired descriptor value.
Returns
ble_status_t

◆ R_BLE_DIS_Init()

ble_status_t R_BLE_DIS_Init ( ble_servs_app_cb_t  cb)

Initialize Device Information service.

Parameters
[in]cbService callback.
Returns
ble_status_t