Bill Schilit / BLE_API

Improve readability with getHandle inline

Fork of BLE_API by Bluetooth Low Energy

public/GattCharacteristicWriteCBParams.h@118:620d28e7a1ba, 2014-09-22 (annotated)

Committer:
Rohit Grover
Date:
Mon Sep 22 10:59:09 2014 +0100
Revision:
118:620d28e7a1ba
Parent:
116:ca826083980e
Child:
251:5d9118449482
Release 0.2.0

=============



Highlights:

  Introducing standard services to simplify applications.

  Add support for over-the-air firmware updates.



Features

~~~~~~~~



- This release introduces 'templates' for common services such as heart-rate,

  battery-level, device-info, UART, device-firmware-update etc. These services

  take the shape of class declarations within header files aggregated under a

  new folder called 'services/'. These service-classes provide a high-level

  API hopefully easing the burden of developing BLE applications. The

  underlying APIs to work with characteristics and services are still

  available to allow greater control if needed. We expect to grow the

  supported services to include all SIG defined BLE profiles.



- WriteCallbackParams now includes the characteristic's value-attribute

  handle; this changes the signature of onDataWritten().



- BLEDevice::onDataWritten() now allows chaining of callbacks--this means that

  it is possible to chain together multiple onDataWritten callbacks

  (potentially from different modules of an application) to receive updates to

  characteristics. Many services, such as DFU and UART add their own

  onDataWritten callbacks behind the scenes to trap interesting events. It is

  also possible to chain callbacks to functions within objects.



- Added the following expectation for GattCharacteristic: If valuePtr ==

  NULL, initialLength == 0, and properties == READ for the value attribute of

  a characteristic, then that particular characteristic may be considered

  optional and dropped while instantiating the service with the underlying BLE

  stack.



- Introducing the typedef GattAttribute::Handle_t to capture Attribute handles.



Bugfixes

~~~~~~~~



None.



Compatibility

~~~~~~~~~~~~~



The signature of onDataWritten() has seen a change; so application programs

using this new version of the BLE API will need minor modifications. Please

refer to sample programs under BLE team page.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Rohit Grover 116:ca826083980e 1 /* mbed Microcontroller Library
Rohit Grover 116:ca826083980e 2 * Copyright (c) 2006-2013 ARM Limited
Rohit Grover 116:ca826083980e 3 *
Rohit Grover 116:ca826083980e 4 * Licensed under the Apache License, Version 2.0 (the "License");
Rohit Grover 116:ca826083980e 5 * you may not use this file except in compliance with the License.
Rohit Grover 116:ca826083980e 6 * You may obtain a copy of the License at
Rohit Grover 116:ca826083980e 7 *
Rohit Grover 116:ca826083980e 8 * http://www.apache.org/licenses/LICENSE-2.0
Rohit Grover 116:ca826083980e 9 *
Rohit Grover 116:ca826083980e 10 * Unless required by applicable law or agreed to in writing, software
Rohit Grover 116:ca826083980e 11 * distributed under the License is distributed on an "AS IS" BASIS,
Rohit Grover 116:ca826083980e 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Rohit Grover 116:ca826083980e 13 * See the License for the specific language governing permissions and
Rohit Grover 116:ca826083980e 14 * limitations under the License.
Rohit Grover 116:ca826083980e 15 */
Rohit Grover 116:ca826083980e 16
Rohit Grover 116:ca826083980e 17 #ifndef __GATT_CHARACTERISTIC_WRITE_CB_PARAMS_H__
Rohit Grover 116:ca826083980e 18 #define __GATT_CHARACTERISTIC_WRITE_CB_PARAMS_H__
Rohit Grover 116:ca826083980e 19
Rohit Grover 116:ca826083980e 20 struct GattCharacteristicWriteCBParams {
Rohit Grover 118:620d28e7a1ba 21 GattAttribute::Handle_t charHandle;
Rohit Grover 116:ca826083980e 22 enum Type {
Rohit Grover 116:ca826083980e 23 GATTS_CHAR_OP_INVALID = 0x00, /**< Invalid Operation. */
Rohit Grover 116:ca826083980e 24 GATTS_CHAR_OP_WRITE_REQ = 0x01, /**< Write Request. */
Rohit Grover 116:ca826083980e 25 GATTS_CHAR_OP_WRITE_CMD = 0x02, /**< Write Command. */
Rohit Grover 116:ca826083980e 26 GATTS_CHAR_OP_SIGN_WRITE_CMD = 0x03, /**< Signed Write Command. */
Rohit Grover 116:ca826083980e 27 GATTS_CHAR_OP_PREP_WRITE_REQ = 0x04, /**< Prepare Write Request. */
Rohit Grover 116:ca826083980e 28 GATTS_CHAR_OP_EXEC_WRITE_REQ_CANCEL = 0x05, /**< Execute Write Request: Cancel all prepared writes. */
Rohit Grover 116:ca826083980e 29 GATTS_CHAR_OP_EXEC_WRITE_REQ_NOW = 0x06, /**< Execute Write Request: Immediately execute all prepared writes. */
Rohit Grover 116:ca826083980e 30 } op; /**< Type of write operation, */
Rohit Grover 116:ca826083980e 31 uint16_t offset; /**< Offset for the write operation. */
Rohit Grover 116:ca826083980e 32 uint16_t len; /**< Length of the incoming data. */
Rohit Grover 116:ca826083980e 33 const uint8_t *data; /**< Incoming data, variable length. */
Rohit Grover 116:ca826083980e 34 };
Rohit Grover 116:ca826083980e 35
Rohit Grover 116:ca826083980e 36 #endif /*__GATT_CHARACTERISTIC_WRITE_CB_PARAMS_H__*/