George Roussos / BLE_iBeacon_Exercise

Birkbeck College Mobile and Ubiquitous Computing IoT Lab Exercise 2

Dependencies:   BLE_API_Native_blog

mbed/TARGET_NRF51822/ble_gatt.h@0:e8fdba0ed044, 2015-03-07 (annotated)

Committer:
gkroussos
Date:
Sat Mar 07 16:34:53 2015 +0000
Revision:
0:e8fdba0ed044
MUC IoT Workshop v1.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gkroussos 0:e8fdba0ed044 1 /* Copyright (c) 2012 Nordic Semiconductor. All Rights Reserved.
gkroussos 0:e8fdba0ed044 2 *
gkroussos 0:e8fdba0ed044 3 * The information contained herein is confidential property of Nordic Semiconductor. The use,
gkroussos 0:e8fdba0ed044 4 * copying, transfer or disclosure of such information is prohibited except by express written
gkroussos 0:e8fdba0ed044 5 * agreement with Nordic Semiconductor.
gkroussos 0:e8fdba0ed044 6 *
gkroussos 0:e8fdba0ed044 7 */
gkroussos 0:e8fdba0ed044 8 /**
gkroussos 0:e8fdba0ed044 9 @addtogroup BLE_GATT Generic Attribute Profile (GATT) Common
gkroussos 0:e8fdba0ed044 10 @{
gkroussos 0:e8fdba0ed044 11 @brief Common definitions and prototypes for the GATT interfaces.
gkroussos 0:e8fdba0ed044 12 */
gkroussos 0:e8fdba0ed044 13
gkroussos 0:e8fdba0ed044 14 #ifndef BLE_GATT_H__
gkroussos 0:e8fdba0ed044 15 #define BLE_GATT_H__
gkroussos 0:e8fdba0ed044 16
gkroussos 0:e8fdba0ed044 17 #include "ble_types.h"
gkroussos 0:e8fdba0ed044 18 #include "ble_ranges.h"
gkroussos 0:e8fdba0ed044 19
gkroussos 0:e8fdba0ed044 20
gkroussos 0:e8fdba0ed044 21 /** @addtogroup BLE_GATT_DEFINES Defines
gkroussos 0:e8fdba0ed044 22 * @{ */
gkroussos 0:e8fdba0ed044 23
gkroussos 0:e8fdba0ed044 24 /** @brief Default MTU size. */
gkroussos 0:e8fdba0ed044 25 #define GATT_MTU_SIZE_DEFAULT 23
gkroussos 0:e8fdba0ed044 26
gkroussos 0:e8fdba0ed044 27 /** @brief Only the default MTU size of 23 is currently supported. */
gkroussos 0:e8fdba0ed044 28 #define GATT_RX_MTU 23
gkroussos 0:e8fdba0ed044 29
gkroussos 0:e8fdba0ed044 30
gkroussos 0:e8fdba0ed044 31 /**@brief Invalid Attribute Handle. */
gkroussos 0:e8fdba0ed044 32 #define BLE_GATT_HANDLE_INVALID 0x0000
gkroussos 0:e8fdba0ed044 33
gkroussos 0:e8fdba0ed044 34 /** @defgroup BLE_GATT_TIMEOUT_SOURCES GATT Timeout sources
gkroussos 0:e8fdba0ed044 35 * @{ */
gkroussos 0:e8fdba0ed044 36 #define BLE_GATT_TIMEOUT_SRC_PROTOCOL 0x00 /**< ATT Protocol timeout. */
gkroussos 0:e8fdba0ed044 37 /** @} */
gkroussos 0:e8fdba0ed044 38
gkroussos 0:e8fdba0ed044 39 /** @defgroup BLE_GATT_WRITE_OPS GATT Write operations
gkroussos 0:e8fdba0ed044 40 * @{ */
gkroussos 0:e8fdba0ed044 41 #define BLE_GATT_OP_INVALID 0x00 /**< Invalid Operation. */
gkroussos 0:e8fdba0ed044 42 #define BLE_GATT_OP_WRITE_REQ 0x01 /**< Write Request. */
gkroussos 0:e8fdba0ed044 43 #define BLE_GATT_OP_WRITE_CMD 0x02 /**< Write Command. */
gkroussos 0:e8fdba0ed044 44 #define BLE_GATT_OP_SIGN_WRITE_CMD 0x03 /**< Signed Write Command. */
gkroussos 0:e8fdba0ed044 45 #define BLE_GATT_OP_PREP_WRITE_REQ 0x04 /**< Prepare Write Request. */
gkroussos 0:e8fdba0ed044 46 #define BLE_GATT_OP_EXEC_WRITE_REQ 0x05 /**< Execute Write Request. */
gkroussos 0:e8fdba0ed044 47 /** @} */
gkroussos 0:e8fdba0ed044 48
gkroussos 0:e8fdba0ed044 49 /** @defgroup BLE_GATT_EXEC_WRITE_FLAGS GATT Execute Write flags
gkroussos 0:e8fdba0ed044 50 * @{ */
gkroussos 0:e8fdba0ed044 51 #define BLE_GATT_EXEC_WRITE_FLAG_PREPARED_CANCEL 0x00
gkroussos 0:e8fdba0ed044 52 #define BLE_GATT_EXEC_WRITE_FLAG_PREPARED_WRITE 0x01
gkroussos 0:e8fdba0ed044 53 /** @} */
gkroussos 0:e8fdba0ed044 54
gkroussos 0:e8fdba0ed044 55 /** @defgroup BLE_GATT_HVX_TYPES GATT Handle Value operations
gkroussos 0:e8fdba0ed044 56 * @{ */
gkroussos 0:e8fdba0ed044 57 #define BLE_GATT_HVX_INVALID 0x00 /**< Invalid Operation. */
gkroussos 0:e8fdba0ed044 58 #define BLE_GATT_HVX_NOTIFICATION 0x01 /**< Handle Value Notification. */
gkroussos 0:e8fdba0ed044 59 #define BLE_GATT_HVX_INDICATION 0x02 /**< Handle Value Indication. */
gkroussos 0:e8fdba0ed044 60 /** @} */
gkroussos 0:e8fdba0ed044 61
gkroussos 0:e8fdba0ed044 62 /** @defgroup BLE_GATT_STATUS_CODES GATT Status Codes
gkroussos 0:e8fdba0ed044 63 * @{ */
gkroussos 0:e8fdba0ed044 64 #define BLE_GATT_STATUS_SUCCESS 0x0000 /**< Success. */
gkroussos 0:e8fdba0ed044 65 #define BLE_GATT_STATUS_UNKNOWN 0x0001 /**< Unknown or not applicable status. */
gkroussos 0:e8fdba0ed044 66 #define BLE_GATT_STATUS_ATTERR_INVALID 0x0100 /**< ATT Error: Invalid Error Code. */
gkroussos 0:e8fdba0ed044 67 #define BLE_GATT_STATUS_ATTERR_INVALID_HANDLE 0x0101 /**< ATT Error: Invalid Attribute Handle. */
gkroussos 0:e8fdba0ed044 68 #define BLE_GATT_STATUS_ATTERR_READ_NOT_PERMITTED 0x0102 /**< ATT Error: Read not permitted. */
gkroussos 0:e8fdba0ed044 69 #define BLE_GATT_STATUS_ATTERR_WRITE_NOT_PERMITTED 0x0103 /**< ATT Error: Write not permitted. */
gkroussos 0:e8fdba0ed044 70 #define BLE_GATT_STATUS_ATTERR_INVALID_PDU 0x0104 /**< ATT Error: Used in ATT as Invalid PDU. */
gkroussos 0:e8fdba0ed044 71 #define BLE_GATT_STATUS_ATTERR_INSUF_AUTHENTICATION 0x0105 /**< ATT Error: Authenticated link required. */
gkroussos 0:e8fdba0ed044 72 #define BLE_GATT_STATUS_ATTERR_REQUEST_NOT_SUPPORTED 0x0106 /**< ATT Error: Used in ATT as Request Not Supported. */
gkroussos 0:e8fdba0ed044 73 #define BLE_GATT_STATUS_ATTERR_INVALID_OFFSET 0x0107 /**< ATT Error: Offset specified was past the end of the attribute. */
gkroussos 0:e8fdba0ed044 74 #define BLE_GATT_STATUS_ATTERR_INSUF_AUTHORIZATION 0x0108 /**< ATT Error: Used in ATT as Insufficient Authorisation. */
gkroussos 0:e8fdba0ed044 75 #define BLE_GATT_STATUS_ATTERR_PREPARE_QUEUE_FULL 0x0109 /**< ATT Error: Used in ATT as Prepare Queue Full. */
gkroussos 0:e8fdba0ed044 76 #define BLE_GATT_STATUS_ATTERR_ATTRIBUTE_NOT_FOUND 0x010A /**< ATT Error: Used in ATT as Attribute not found. */
gkroussos 0:e8fdba0ed044 77 #define BLE_GATT_STATUS_ATTERR_ATTRIBUTE_NOT_LONG 0x010B /**< ATT Error: Attribute cannot be read or written using read/write blob requests. */
gkroussos 0:e8fdba0ed044 78 #define BLE_GATT_STATUS_ATTERR_INSUF_ENC_KEY_SIZE 0x010C /**< ATT Error: Encryption key size used is insufficient. */
gkroussos 0:e8fdba0ed044 79 #define BLE_GATT_STATUS_ATTERR_INVALID_ATT_VAL_LENGTH 0x010D /**< ATT Error: Invalid value size. */
gkroussos 0:e8fdba0ed044 80 #define BLE_GATT_STATUS_ATTERR_UNLIKELY_ERROR 0x010E /**< ATT Error: Very unlikely error. */
gkroussos 0:e8fdba0ed044 81 #define BLE_GATT_STATUS_ATTERR_INSUF_ENCRYPTION 0x010F /**< ATT Error: Encrypted link required. */
gkroussos 0:e8fdba0ed044 82 #define BLE_GATT_STATUS_ATTERR_UNSUPPORTED_GROUP_TYPE 0x0110 /**< ATT Error: Attribute type is not a supported grouping attribute. */
gkroussos 0:e8fdba0ed044 83 #define BLE_GATT_STATUS_ATTERR_INSUF_RESOURCES 0x0111 /**< ATT Error: Encrypted link required. */
gkroussos 0:e8fdba0ed044 84 #define BLE_GATT_STATUS_ATTERR_RFU_RANGE1_BEGIN 0x0112 /**< ATT Error: Reserved for Future Use range #1 begin. */
gkroussos 0:e8fdba0ed044 85 #define BLE_GATT_STATUS_ATTERR_RFU_RANGE1_END 0x017F /**< ATT Error: Reserved for Future Use range #1 end. */
gkroussos 0:e8fdba0ed044 86 #define BLE_GATT_STATUS_ATTERR_APP_BEGIN 0x0180 /**< ATT Error: Application range begin. */
gkroussos 0:e8fdba0ed044 87 #define BLE_GATT_STATUS_ATTERR_APP_END 0x019F /**< ATT Error: Application range end. */
gkroussos 0:e8fdba0ed044 88 #define BLE_GATT_STATUS_ATTERR_RFU_RANGE2_BEGIN 0x01A0 /**< ATT Error: Reserved for Future Use range #2 begin. */
gkroussos 0:e8fdba0ed044 89 #define BLE_GATT_STATUS_ATTERR_RFU_RANGE2_END 0x01DF /**< ATT Error: Reserved for Future Use range #2 end. */
gkroussos 0:e8fdba0ed044 90 #define BLE_GATT_STATUS_ATTERR_RFU_RANGE3_BEGIN 0x01E0 /**< ATT Error: Reserved for Future Use range #3 begin. */
gkroussos 0:e8fdba0ed044 91 #define BLE_GATT_STATUS_ATTERR_RFU_RANGE3_END 0x01FC /**< ATT Error: Reserved for Future Use range #3 end. */
gkroussos 0:e8fdba0ed044 92 #define BLE_GATT_STATUS_ATTERR_CPS_CCCD_CONFIG_ERROR 0x01FD /**< ATT Common Profile and Service Error: Client Characteristic Configuration Descriptor improperly configured. */
gkroussos 0:e8fdba0ed044 93 #define BLE_GATT_STATUS_ATTERR_CPS_PROC_ALR_IN_PROG 0x01FE /**< ATT Common Profile and Service Error: Procedure Already in Progress. */
gkroussos 0:e8fdba0ed044 94 #define BLE_GATT_STATUS_ATTERR_CPS_OUT_OF_RANGE 0x01FF /**< ATT Common Profile and Service Error: Out Of Range. */
gkroussos 0:e8fdba0ed044 95 /** @} */
gkroussos 0:e8fdba0ed044 96
gkroussos 0:e8fdba0ed044 97
gkroussos 0:e8fdba0ed044 98 /** @defgroup BLE_GATT_CPF_FORMATS Characteristic Presentation Formats
gkroussos 0:e8fdba0ed044 99 * @note Found at http://developer.bluetooth.org/gatt/descriptors/Pages/DescriptorViewer.aspx?u=org.bluetooth.descriptor.gatt.characteristic_presentation_format.xml
gkroussos 0:e8fdba0ed044 100 * @{ */
gkroussos 0:e8fdba0ed044 101 #define BLE_GATT_CPF_FORMAT_RFU 0x00 /**< Reserved For Future Use. */
gkroussos 0:e8fdba0ed044 102 #define BLE_GATT_CPF_FORMAT_BOOLEAN 0x01 /**< Boolean. */
gkroussos 0:e8fdba0ed044 103 #define BLE_GATT_CPF_FORMAT_2BIT 0x02 /**< Unsigned 2-bit integer. */
gkroussos 0:e8fdba0ed044 104 #define BLE_GATT_CPF_FORMAT_NIBBLE 0x03 /**< Unsigned 4-bit integer. */
gkroussos 0:e8fdba0ed044 105 #define BLE_GATT_CPF_FORMAT_UINT8 0x04 /**< Unsigned 8-bit integer. */
gkroussos 0:e8fdba0ed044 106 #define BLE_GATT_CPF_FORMAT_UINT12 0x05 /**< Unsigned 12-bit integer. */
gkroussos 0:e8fdba0ed044 107 #define BLE_GATT_CPF_FORMAT_UINT16 0x06 /**< Unsigned 16-bit integer. */
gkroussos 0:e8fdba0ed044 108 #define BLE_GATT_CPF_FORMAT_UINT24 0x07 /**< Unsigned 24-bit integer. */
gkroussos 0:e8fdba0ed044 109 #define BLE_GATT_CPF_FORMAT_UINT32 0x08 /**< Unsigned 32-bit integer. */
gkroussos 0:e8fdba0ed044 110 #define BLE_GATT_CPF_FORMAT_UINT48 0x09 /**< Unsigned 48-bit integer. */
gkroussos 0:e8fdba0ed044 111 #define BLE_GATT_CPF_FORMAT_UINT64 0x0A /**< Unsigned 64-bit integer. */
gkroussos 0:e8fdba0ed044 112 #define BLE_GATT_CPF_FORMAT_UINT128 0x0B /**< Unsigned 128-bit integer. */
gkroussos 0:e8fdba0ed044 113 #define BLE_GATT_CPF_FORMAT_SINT8 0x0C /**< Signed 2-bit integer. */
gkroussos 0:e8fdba0ed044 114 #define BLE_GATT_CPF_FORMAT_SINT12 0x0D /**< Signed 12-bit integer. */
gkroussos 0:e8fdba0ed044 115 #define BLE_GATT_CPF_FORMAT_SINT16 0x0E /**< Signed 16-bit integer. */
gkroussos 0:e8fdba0ed044 116 #define BLE_GATT_CPF_FORMAT_SINT24 0x0F /**< Signed 24-bit integer. */
gkroussos 0:e8fdba0ed044 117 #define BLE_GATT_CPF_FORMAT_SINT32 0x10 /**< Signed 32-bit integer. */
gkroussos 0:e8fdba0ed044 118 #define BLE_GATT_CPF_FORMAT_SINT48 0x11 /**< Signed 48-bit integer. */
gkroussos 0:e8fdba0ed044 119 #define BLE_GATT_CPF_FORMAT_SINT64 0x12 /**< Signed 64-bit integer. */
gkroussos 0:e8fdba0ed044 120 #define BLE_GATT_CPF_FORMAT_SINT128 0x13 /**< Signed 128-bit integer. */
gkroussos 0:e8fdba0ed044 121 #define BLE_GATT_CPF_FORMAT_FLOAT32 0x14 /**< IEEE-754 32-bit floating point. */
gkroussos 0:e8fdba0ed044 122 #define BLE_GATT_CPF_FORMAT_FLOAT64 0x15 /**< IEEE-754 64-bit floating point. */
gkroussos 0:e8fdba0ed044 123 #define BLE_GATT_CPF_FORMAT_SFLOAT 0x16 /**< IEEE-11073 16-bit SFLOAT. */
gkroussos 0:e8fdba0ed044 124 #define BLE_GATT_CPF_FORMAT_FLOAT 0x17 /**< IEEE-11073 32-bit FLOAT. */
gkroussos 0:e8fdba0ed044 125 #define BLE_GATT_CPF_FORMAT_DUINT16 0x18 /**< IEEE-20601 format. */
gkroussos 0:e8fdba0ed044 126 #define BLE_GATT_CPF_FORMAT_UTF8S 0x19 /**< UTF-8 string. */
gkroussos 0:e8fdba0ed044 127 #define BLE_GATT_CPF_FORMAT_UTF16S 0x1A /**< UTF-16 string. */
gkroussos 0:e8fdba0ed044 128 #define BLE_GATT_CPF_FORMAT_STRUCT 0x1B /**< Opaque Structure. */
gkroussos 0:e8fdba0ed044 129 /** @} */
gkroussos 0:e8fdba0ed044 130
gkroussos 0:e8fdba0ed044 131 /** @defgroup BLE_GATT_CPF_NAMESPACES GATT Bluetooth Namespaces
gkroussos 0:e8fdba0ed044 132 * @{
gkroussos 0:e8fdba0ed044 133 */
gkroussos 0:e8fdba0ed044 134 #define BLE_GATT_CPF_NAMESPACE_BTSIG 0x01
gkroussos 0:e8fdba0ed044 135 #define BLE_GATT_CPF_NAMESPACE_DESCRIPTION_UNKNOWN 0x0000
gkroussos 0:e8fdba0ed044 136 /** @} */
gkroussos 0:e8fdba0ed044 137
gkroussos 0:e8fdba0ed044 138 /** @} */
gkroussos 0:e8fdba0ed044 139
gkroussos 0:e8fdba0ed044 140 /**@brief GATT Characteristic Properties. */
gkroussos 0:e8fdba0ed044 141 typedef struct
gkroussos 0:e8fdba0ed044 142 {
gkroussos 0:e8fdba0ed044 143 /* Standard properties */
gkroussos 0:e8fdba0ed044 144 uint8_t broadcast :1; /**< Broadcasting of value permitted. */
gkroussos 0:e8fdba0ed044 145 uint8_t read :1; /**< Reading value permitted. */
gkroussos 0:e8fdba0ed044 146 uint8_t write_wo_resp :1; /**< Writing value with Write Command permitted. */
gkroussos 0:e8fdba0ed044 147 uint8_t write :1; /**< Writing value with Write Request permitted. */
gkroussos 0:e8fdba0ed044 148 uint8_t notify :1; /**< Notications of value permitted. */
gkroussos 0:e8fdba0ed044 149 uint8_t indicate :1; /**< Indications of value permitted. */
gkroussos 0:e8fdba0ed044 150 uint8_t auth_signed_wr :1; /**< Writing value with Signed Write Command permitted. */
gkroussos 0:e8fdba0ed044 151 } ble_gatt_char_props_t;
gkroussos 0:e8fdba0ed044 152
gkroussos 0:e8fdba0ed044 153 /**@brief GATT Characteristic Extended Properties. */
gkroussos 0:e8fdba0ed044 154 typedef struct
gkroussos 0:e8fdba0ed044 155 {
gkroussos 0:e8fdba0ed044 156 /* Extended properties */
gkroussos 0:e8fdba0ed044 157 uint8_t reliable_wr :1; /**< Writing value with Queued Write Request permitted. */
gkroussos 0:e8fdba0ed044 158 uint8_t wr_aux :1; /**< Writing the Characteristic User Description permitted. */
gkroussos 0:e8fdba0ed044 159 } ble_gatt_char_ext_props_t;
gkroussos 0:e8fdba0ed044 160
gkroussos 0:e8fdba0ed044 161 #endif // BLE_GATT_H__
gkroussos 0:e8fdba0ed044 162
gkroussos 0:e8fdba0ed044 163 /**
gkroussos 0:e8fdba0ed044 164 @}
gkroussos 0:e8fdba0ed044 165 @}
gkroussos 0:e8fdba0ed044 166 */