BLE temperature profile using digital DS1820 or analog LM35 sensors
Embed:
(wiki syntax)
Show/hide line numbers
ble_gatt.h
00001 /* Copyright (c) 2012 Nordic Semiconductor. All Rights Reserved. 00002 * 00003 * The information contained herein is confidential property of Nordic Semiconductor. The use, 00004 * copying, transfer or disclosure of such information is prohibited except by express written 00005 * agreement with Nordic Semiconductor. 00006 * 00007 */ 00008 /** 00009 @addtogroup BLE_GATT Generic Attribute Profile (GATT) Common 00010 @{ 00011 @brief Common definitions and prototypes for the GATT interfaces. 00012 */ 00013 00014 #ifndef BLE_GATT_H__ 00015 #define BLE_GATT_H__ 00016 00017 #include "nordic_global.h" 00018 #include "ble_types.h" 00019 #include "ble_ranges.h" 00020 00021 00022 /** @addtogroup BLE_GATT_DEFINES Defines 00023 * @{ */ 00024 00025 /** @brief Default MTU size. */ 00026 #define GATT_MTU_SIZE_DEFAULT 23 00027 00028 /** @brief Only the default MTU size of 23 is currently supported. */ 00029 #define GATT_RX_MTU 23 00030 00031 00032 /**@brief Invalid Attribute Handle. */ 00033 #define BLE_GATT_HANDLE_INVALID 0x0000 00034 00035 /** @defgroup BLE_GATT_TIMEOUT_SOURCES GATT Timeout sources 00036 * @{ */ 00037 #define BLE_GATT_TIMEOUT_SRC_PROTOCOL 0x00 /**< ATT Protocol timeout. */ 00038 /** @} */ 00039 00040 /** @defgroup BLE_GATT_WRITE_OPS GATT Write operations 00041 * @{ */ 00042 #define BLE_GATT_OP_INVALID 0x00 /**< Invalid Operation. */ 00043 #define BLE_GATT_OP_WRITE_REQ 0x01 /**< Write Request. */ 00044 #define BLE_GATT_OP_WRITE_CMD 0x02 /**< Write Command. */ 00045 #define BLE_GATT_OP_SIGN_WRITE_CMD 0x03 /**< Signed Write Command. */ 00046 #define BLE_GATT_OP_PREP_WRITE_REQ 0x04 /**< Prepare Write Request. */ 00047 #define BLE_GATT_OP_EXEC_WRITE_REQ 0x05 /**< Execute Write Request. */ 00048 /** @} */ 00049 00050 /** @defgroup BLE_GATT_EXEC_WRITE_FLAGS GATT Execute Write flags 00051 * @{ */ 00052 #define BLE_GATT_EXEC_WRITE_FLAG_PREPARED_CANCEL 0x00 00053 #define BLE_GATT_EXEC_WRITE_FLAG_PREPARED_WRITE 0x01 00054 /** @} */ 00055 00056 /** @defgroup BLE_GATT_HVX_TYPES GATT Handle Value operations 00057 * @{ */ 00058 #define BLE_GATT_HVX_INVALID 0x00 /**< Invalid Operation. */ 00059 #define BLE_GATT_HVX_NOTIFICATION 0x01 /**< Handle Value Notification. */ 00060 #define BLE_GATT_HVX_INDICATION 0x02 /**< Handle Value Indication. */ 00061 /** @} */ 00062 00063 /** @defgroup BLE_GATT_STATUS_CODES GATT Status Codes 00064 * @{ */ 00065 #define BLE_GATT_STATUS_SUCCESS 0x0000 /**< Success. */ 00066 #define BLE_GATT_STATUS_UNKNOWN 0x0001 /**< Unknown or not applicable status. */ 00067 #define BLE_GATT_STATUS_ATTERR_INVALID 0x0100 /**< ATT Error: Invalid Error Code. */ 00068 #define BLE_GATT_STATUS_ATTERR_INVALID_HANDLE 0x0101 /**< ATT Error: Invalid Attribute Handle. */ 00069 #define BLE_GATT_STATUS_ATTERR_READ_NOT_PERMITTED 0x0102 /**< ATT Error: Read not permitted. */ 00070 #define BLE_GATT_STATUS_ATTERR_WRITE_NOT_PERMITTED 0x0103 /**< ATT Error: Write not permitted. */ 00071 #define BLE_GATT_STATUS_ATTERR_INVALID_PDU 0x0104 /**< ATT Error: Used in ATT as Invalid PDU. */ 00072 #define BLE_GATT_STATUS_ATTERR_INSUF_AUTHENTICATION 0x0105 /**< ATT Error: Authenticated link required. */ 00073 #define BLE_GATT_STATUS_ATTERR_REQUEST_NOT_SUPPORTED 0x0106 /**< ATT Error: Used in ATT as Request Not Supported. */ 00074 #define BLE_GATT_STATUS_ATTERR_INVALID_OFFSET 0x0107 /**< ATT Error: Offset specified was past the end of the attribute. */ 00075 #define BLE_GATT_STATUS_ATTERR_INSUF_AUTHORIZATION 0x0108 /**< ATT Error: Used in ATT as Insufficient Authorisation. */ 00076 #define BLE_GATT_STATUS_ATTERR_PREPARE_QUEUE_FULL 0x0109 /**< ATT Error: Used in ATT as Prepare Queue Full. */ 00077 #define BLE_GATT_STATUS_ATTERR_ATTRIBUTE_NOT_FOUND 0x010A /**< ATT Error: Used in ATT as Attribute not found. */ 00078 #define BLE_GATT_STATUS_ATTERR_ATTRIBUTE_NOT_LONG 0x010B /**< ATT Error: Attribute cannot be read or written using read/write blob requests. */ 00079 #define BLE_GATT_STATUS_ATTERR_INSUF_ENC_KEY_SIZE 0x010C /**< ATT Error: Encryption key size used is insufficient. */ 00080 #define BLE_GATT_STATUS_ATTERR_INVALID_ATT_VAL_LENGTH 0x010D /**< ATT Error: Invalid value size. */ 00081 #define BLE_GATT_STATUS_ATTERR_UNLIKELY_ERROR 0x010E /**< ATT Error: Very unlikely error. */ 00082 #define BLE_GATT_STATUS_ATTERR_INSUF_ENCRYPTION 0x010F /**< ATT Error: Encrypted link required. */ 00083 #define BLE_GATT_STATUS_ATTERR_UNSUPPORTED_GROUP_TYPE 0x0110 /**< ATT Error: Attribute type is not a supported grouping attribute. */ 00084 #define BLE_GATT_STATUS_ATTERR_INSUF_RESOURCES 0x0111 /**< ATT Error: Encrypted link required. */ 00085 #define BLE_GATT_STATUS_ATTERR_RFU_RANGE1_BEGIN 0x0112 /**< ATT Error: Reserved for Future Use range #1 begin. */ 00086 #define BLE_GATT_STATUS_ATTERR_RFU_RANGE1_END 0x017F /**< ATT Error: Reserved for Future Use range #1 end. */ 00087 #define BLE_GATT_STATUS_ATTERR_APP_BEGIN 0x0180 /**< ATT Error: Application range begin. */ 00088 #define BLE_GATT_STATUS_ATTERR_APP_END 0x019F /**< ATT Error: Application range end. */ 00089 #define BLE_GATT_STATUS_ATTERR_RFU_RANGE2_BEGIN 0x01A0 /**< ATT Error: Reserved for Future Use range #2 begin. */ 00090 #define BLE_GATT_STATUS_ATTERR_RFU_RANGE2_END 0x01DF /**< ATT Error: Reserved for Future Use range #2 end. */ 00091 #define BLE_GATT_STATUS_ATTERR_RFU_RANGE3_BEGIN 0x01E0 /**< ATT Error: Reserved for Future Use range #3 begin. */ 00092 #define BLE_GATT_STATUS_ATTERR_RFU_RANGE3_END 0x01FC /**< ATT Error: Reserved for Future Use range #3 end. */ 00093 #define BLE_GATT_STATUS_ATTERR_CPS_CCCD_CONFIG_ERROR 0x01FD /**< ATT Common Profile and Service Error: Client Characteristic Configuration Descriptor improperly configured. */ 00094 #define BLE_GATT_STATUS_ATTERR_CPS_PROC_ALR_IN_PROG 0x01FE /**< ATT Common Profile and Service Error: Procedure Already in Progress. */ 00095 #define BLE_GATT_STATUS_ATTERR_CPS_OUT_OF_RANGE 0x01FF /**< ATT Common Profile and Service Error: Out Of Range. */ 00096 /** @} */ 00097 00098 00099 /** @defgroup BLE_GATT_CPF_FORMATS Characteristic Presentation Formats 00100 * @note Found at http://developer.bluetooth.org/gatt/descriptors/Pages/DescriptorViewer.aspx?u=org.bluetooth.descriptor.gatt.characteristic_presentation_format.xml 00101 * @{ */ 00102 #define BLE_GATT_CPF_FORMAT_RFU 0x00 /**< Reserved For Future Use. */ 00103 #define BLE_GATT_CPF_FORMAT_BOOLEAN 0x01 /**< Boolean. */ 00104 #define BLE_GATT_CPF_FORMAT_2BIT 0x02 /**< Unsigned 2-bit integer. */ 00105 #define BLE_GATT_CPF_FORMAT_NIBBLE 0x03 /**< Unsigned 4-bit integer. */ 00106 #define BLE_GATT_CPF_FORMAT_UINT8 0x04 /**< Unsigned 8-bit integer. */ 00107 #define BLE_GATT_CPF_FORMAT_UINT12 0x05 /**< Unsigned 12-bit integer. */ 00108 #define BLE_GATT_CPF_FORMAT_UINT16 0x06 /**< Unsigned 16-bit integer. */ 00109 #define BLE_GATT_CPF_FORMAT_UINT24 0x07 /**< Unsigned 24-bit integer. */ 00110 #define BLE_GATT_CPF_FORMAT_UINT32 0x08 /**< Unsigned 32-bit integer. */ 00111 #define BLE_GATT_CPF_FORMAT_UINT48 0x09 /**< Unsigned 48-bit integer. */ 00112 #define BLE_GATT_CPF_FORMAT_UINT64 0x0A /**< Unsigned 64-bit integer. */ 00113 #define BLE_GATT_CPF_FORMAT_UINT128 0x0B /**< Unsigned 128-bit integer. */ 00114 #define BLE_GATT_CPF_FORMAT_SINT8 0x0C /**< Signed 2-bit integer. */ 00115 #define BLE_GATT_CPF_FORMAT_SINT12 0x0D /**< Signed 12-bit integer. */ 00116 #define BLE_GATT_CPF_FORMAT_SINT16 0x0E /**< Signed 16-bit integer. */ 00117 #define BLE_GATT_CPF_FORMAT_SINT24 0x0F /**< Signed 24-bit integer. */ 00118 #define BLE_GATT_CPF_FORMAT_SINT32 0x10 /**< Signed 32-bit integer. */ 00119 #define BLE_GATT_CPF_FORMAT_SINT48 0x11 /**< Signed 48-bit integer. */ 00120 #define BLE_GATT_CPF_FORMAT_SINT64 0x12 /**< Signed 64-bit integer. */ 00121 #define BLE_GATT_CPF_FORMAT_SINT128 0x13 /**< Signed 128-bit integer. */ 00122 #define BLE_GATT_CPF_FORMAT_FLOAT32 0x14 /**< IEEE-754 32-bit floating point. */ 00123 #define BLE_GATT_CPF_FORMAT_FLOAT64 0x15 /**< IEEE-754 64-bit floating point. */ 00124 #define BLE_GATT_CPF_FORMAT_SFLOAT 0x16 /**< IEEE-11073 16-bit SFLOAT. */ 00125 #define BLE_GATT_CPF_FORMAT_FLOAT 0x17 /**< IEEE-11073 32-bit FLOAT. */ 00126 #define BLE_GATT_CPF_FORMAT_DUINT16 0x18 /**< IEEE-20601 format. */ 00127 #define BLE_GATT_CPF_FORMAT_UTF8S 0x19 /**< UTF-8 string. */ 00128 #define BLE_GATT_CPF_FORMAT_UTF16S 0x1A /**< UTF-16 string. */ 00129 #define BLE_GATT_CPF_FORMAT_STRUCT 0x1B /**< Opaque Structure. */ 00130 /** @} */ 00131 00132 /** @defgroup BLE_GATT_CPF_NAMESPACES GATT Bluetooth Namespaces 00133 * @{ 00134 */ 00135 #define BLE_GATT_CPF_NAMESPACE_BTSIG 0x01 00136 #define BLE_GATT_CPF_NAMESPACE_DESCRIPTION_UNKNOWN 0x0000 00137 /** @} */ 00138 00139 /** @} */ 00140 00141 /**@brief GATT Characteristic Properties. */ 00142 typedef struct 00143 { 00144 /* Standard properties */ 00145 uint8_t broadcast :1; /**< Broadcasting of value permitted. */ 00146 uint8_t read :1; /**< Reading value permitted. */ 00147 uint8_t write_wo_resp :1; /**< Writing value with Write Command permitted. */ 00148 uint8_t write :1; /**< Writing value with Write Request permitted. */ 00149 uint8_t notify :1; /**< Notications of value permitted. */ 00150 uint8_t indicate :1; /**< Indications of value permitted. */ 00151 uint8_t auth_signed_wr :1; /**< Writing value with Signed Write Command permitted. */ 00152 } ble_gatt_char_props_t; 00153 00154 /**@brief GATT Characteristic Extended Properties. */ 00155 typedef struct 00156 { 00157 /* Extended properties */ 00158 uint8_t reliable_wr :1; /**< Writing value with Queued Write Request permitted. */ 00159 uint8_t wr_aux :1; /**< Writing the Characteristic User Description permitted. */ 00160 } ble_gatt_char_ext_props_t; 00161 00162 #endif // BLE_GATT_H__ 00163 00164 /** 00165 @} 00166 @} 00167 */
Generated on Tue Jul 12 2022 15:07:12 by 1.7.2