Lightly modified version of the BLE stack, that doesn't bring up a DFUService by default... as we have our own.

Fork of BLE_API by Bluetooth Low Energy

Embed: (wiki syntax)

« Back to documentation index

DFUService Class Reference

DFUService Class Reference

Device Firmware Update Service. More...

#include <DFUService.h>

Public Types

typedef void(* ResetPrepare_t )(void)
 Signature for the handover callback.

Public Member Functions

 DFUService (BLEDevice &_ble, ResetPrepare_t _handoverCallback=NULL)
 Adds Device Firmware Update service to an existing ble object.
uint16_t getControlHandle (void) const
 get the handle for the value attribute of the control characteristic.
virtual void onDataWritten (const GattCharacteristicWriteCBParams *params)
 This callback allows the DFU service to receive the initial trigger to handover control to the bootloader; but first the application is given a chance to clean up.

Detailed Description

Device Firmware Update Service.

Definition at line 37 of file DFUService.h.


Member Typedef Documentation

typedef void(* ResetPrepare_t)(void)

Signature for the handover callback.

The application may provide such a callback when setting up the DFU service, in which case it will be invoked before handing control over to the bootloader.

Definition at line 44 of file DFUService.h.


Constructor & Destructor Documentation

DFUService ( BLEDevice _ble,
ResetPrepare_t  _handoverCallback = NULL 
)

Adds Device Firmware Update service to an existing ble object.

Parameters:
ref]_ble BLEDevice object for the underlying controller.
[in]_handoverCallbackApplication specific handover callback.

Definition at line 55 of file DFUService.h.


Member Function Documentation

uint16_t getControlHandle ( void   ) const

get the handle for the value attribute of the control characteristic.

Definition at line 85 of file DFUService.h.

virtual void onDataWritten ( const GattCharacteristicWriteCBParams *  params ) [virtual]

This callback allows the DFU service to receive the initial trigger to handover control to the bootloader; but first the application is given a chance to clean up.

Parameters:
[in]paramsInformation about the characterisitc being updated.

Definition at line 97 of file DFUService.h.