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

BLE Device Information Service Service: https://developer.bluetooth.org/gatt/services/Pages/ServiceViewer.aspx?u=org.bluetooth.service.device_information.xml Manufacturer Name String Char: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.manufacturer_name_string.xml. More...

#include <DeviceInformationService.h>

Public Member Functions

 DeviceInformationService (BLE &_ble, const char *manufacturersName=nullptr, const char *modelNumber=nullptr, const char *serialNumber=nullptr, const char *hardwareRevision=nullptr, const char *firmwareRevision=nullptr, const char *softwareRevision=nullptr)
 Device Information Service Constructor: copies device-specific information into the BLE stack. More...
 

Protected Attributes

BLEble
 A reference to the BLE instance object to which the services and characteristics will be added. More...
 
GattCharacteristic manufacturersNameStringCharacteristic
 BLE characterising to allow BLE peers access to the manufacturer's name. More...
 
GattCharacteristic modelNumberStringCharacteristic
 BLE characterising to allow BLE peers access to the model number. More...
 
GattCharacteristic serialNumberStringCharacteristic
 BLE characterising to allow BLE peers access to the serial number. More...
 
GattCharacteristic hardwareRevisionStringCharacteristic
 BLE characterising to allow BLE peers access to the hardware revision string. More...
 
GattCharacteristic firmwareRevisionStringCharacteristic
 BLE characterising to allow BLE peers access to the firmware revision string. More...
 
GattCharacteristic softwareRevisionStringCharacteristic
 BLE characterising to allow BLE peers access to the software revision string. More...
 

Detailed Description

Constructor & Destructor Documentation

◆ DeviceInformationService()

DeviceInformationService ( BLE _ble,
const char *  manufacturersName = nullptr,
const char *  modelNumber = nullptr,
const char *  serialNumber = nullptr,
const char *  hardwareRevision = nullptr,
const char *  firmwareRevision = nullptr,
const char *  softwareRevision = nullptr 
)

Device Information Service Constructor: copies device-specific information into the BLE stack.

Parameters
[in]_bleA reference to a BLE object for the underlying controller.
[in]manufacturersNameThe name of the manufacturer of the device.
[in]modelNumberThe model number that is assigned by the device vendor.
[in]serialNumberThe serial number for a particular instance of the device.
[in]hardwareRevisionThe hardware revision for the hardware within the device.
[in]firmwareRevisionThe device's firmware version.
[in]softwareRevisionThe device's software version.

Definition at line 58 of file DeviceInformationService.h.

Field Documentation

◆ ble

BLE& ble
protected

A reference to the BLE instance object to which the services and characteristics will be added.

Definition at line 120 of file DeviceInformationService.h.

◆ manufacturersNameStringCharacteristic

GattCharacteristic manufacturersNameStringCharacteristic
protected

BLE characterising to allow BLE peers access to the manufacturer's name.

Definition at line 124 of file DeviceInformationService.h.

◆ modelNumberStringCharacteristic

GattCharacteristic modelNumberStringCharacteristic
protected

BLE characterising to allow BLE peers access to the model number.

Definition at line 128 of file DeviceInformationService.h.

◆ serialNumberStringCharacteristic

GattCharacteristic serialNumberStringCharacteristic
protected

BLE characterising to allow BLE peers access to the serial number.

Definition at line 132 of file DeviceInformationService.h.

◆ hardwareRevisionStringCharacteristic

GattCharacteristic hardwareRevisionStringCharacteristic
protected

BLE characterising to allow BLE peers access to the hardware revision string.

Definition at line 136 of file DeviceInformationService.h.

◆ firmwareRevisionStringCharacteristic

GattCharacteristic firmwareRevisionStringCharacteristic
protected

BLE characterising to allow BLE peers access to the firmware revision string.

Definition at line 140 of file DeviceInformationService.h.

◆ softwareRevisionStringCharacteristic

GattCharacteristic softwareRevisionStringCharacteristic
protected

BLE characterising to allow BLE peers access to the software revision string.

Definition at line 144 of file DeviceInformationService.h.