iOSのBLEコントローラアプリ「RCBController」と接続し、コントローラの操作を取得するサンプルプログラムです。 mbed HRM1017で動作を確認しています。 2014.08.20時点でのBLEライブラリに対応しました。
Fork of BLE_RCBController by
HRM1017/nordic/nrf-sdk/ble/ble_services/ble_srv_common.h@4:ebda47d22091, 2014-08-20 (annotated)
- Committer:
- jksoft
- Date:
- Wed Aug 20 13:41:01 2014 +0000
- Revision:
- 4:ebda47d22091
- Parent:
- nRF51822/nordic/nrf-sdk/ble/ble_services/ble_srv_common.h@1:48f6e08a3ac2
?????????
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
jksoft | 1:48f6e08a3ac2 | 1 | /* Copyright (c) 2012 Nordic Semiconductor. All Rights Reserved. |
jksoft | 1:48f6e08a3ac2 | 2 | * |
jksoft | 1:48f6e08a3ac2 | 3 | * The information contained herein is property of Nordic Semiconductor ASA. |
jksoft | 1:48f6e08a3ac2 | 4 | * Terms and conditions of usage are described in detail in NORDIC |
jksoft | 1:48f6e08a3ac2 | 5 | * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT. |
jksoft | 1:48f6e08a3ac2 | 6 | * |
jksoft | 1:48f6e08a3ac2 | 7 | * Licensees are granted free, non-transferable use of the information. NO |
jksoft | 1:48f6e08a3ac2 | 8 | * WARRANTY of ANY KIND is provided. This heading must NOT be removed from |
jksoft | 1:48f6e08a3ac2 | 9 | * the file. |
jksoft | 1:48f6e08a3ac2 | 10 | * |
jksoft | 1:48f6e08a3ac2 | 11 | */ |
jksoft | 1:48f6e08a3ac2 | 12 | |
jksoft | 1:48f6e08a3ac2 | 13 | /** @file |
jksoft | 1:48f6e08a3ac2 | 14 | * |
jksoft | 1:48f6e08a3ac2 | 15 | * @defgroup ble_sdk_srv_common 'Common service definitions' |
jksoft | 1:48f6e08a3ac2 | 16 | * @{ |
jksoft | 1:48f6e08a3ac2 | 17 | * @ingroup ble_sdk_srv |
jksoft | 1:48f6e08a3ac2 | 18 | * @brief Constants, type definitions and functions that are common to all services. |
jksoft | 1:48f6e08a3ac2 | 19 | */ |
jksoft | 1:48f6e08a3ac2 | 20 | |
jksoft | 1:48f6e08a3ac2 | 21 | #ifndef BLE_SRV_COMMON_H__ |
jksoft | 1:48f6e08a3ac2 | 22 | #define BLE_SRV_COMMON_H__ |
jksoft | 1:48f6e08a3ac2 | 23 | |
jksoft | 1:48f6e08a3ac2 | 24 | #include <stdint.h> |
jksoft | 1:48f6e08a3ac2 | 25 | #include <stdbool.h> |
jksoft | 1:48f6e08a3ac2 | 26 | #include "ble_types.h" |
jksoft | 1:48f6e08a3ac2 | 27 | #include "app_util.h" |
jksoft | 1:48f6e08a3ac2 | 28 | #include "ble_gap.h" |
jksoft | 1:48f6e08a3ac2 | 29 | #include "ble_gatt.h" |
jksoft | 1:48f6e08a3ac2 | 30 | |
jksoft | 1:48f6e08a3ac2 | 31 | /** @defgroup UUID_SERVICES Service UUID definitions |
jksoft | 1:48f6e08a3ac2 | 32 | * @{ */ |
jksoft | 1:48f6e08a3ac2 | 33 | #define BLE_UUID_ALERT_NOTIFICATION_SERVICE 0x1811 /**< Alert Notification service UUID. */ |
jksoft | 1:48f6e08a3ac2 | 34 | #define BLE_UUID_BATTERY_SERVICE 0x180F /**< Battery service UUID. */ |
jksoft | 1:48f6e08a3ac2 | 35 | #define BLE_UUID_BLOOD_PRESSURE_SERVICE 0x1810 /**< Blood Pressure service UUID. */ |
jksoft | 1:48f6e08a3ac2 | 36 | #define BLE_UUID_CURRENT_TIME_SERVICE 0x1805 /**< Current Time service UUID. */ |
jksoft | 1:48f6e08a3ac2 | 37 | #define BLE_UUID_CYCLING_SPEED_AND_CADENCE 0x1816 /**< Cycling Speed and Cadence service UUID. */ |
jksoft | 1:48f6e08a3ac2 | 38 | #define BLE_UUID_DEVICE_INFORMATION_SERVICE 0x180A /**< Device Information service UUID. */ |
jksoft | 1:48f6e08a3ac2 | 39 | #define BLE_UUID_GLUCOSE_SERVICE 0x1808 /**< Glucose service UUID. */ |
jksoft | 1:48f6e08a3ac2 | 40 | #define BLE_UUID_HEALTH_THERMOMETER_SERVICE 0x1809 /**< Health Thermometer service UUID. */ |
jksoft | 1:48f6e08a3ac2 | 41 | #define BLE_UUID_HEART_RATE_SERVICE 0x180D /**< Heart Rate service UUID. */ |
jksoft | 1:48f6e08a3ac2 | 42 | #define BLE_UUID_HUMAN_INTERFACE_DEVICE_SERVICE 0x1812 /**< Human Interface Device service UUID. */ |
jksoft | 1:48f6e08a3ac2 | 43 | #define BLE_UUID_IMMEDIATE_ALERT_SERVICE 0x1802 /**< Immediate Alert service UUID. */ |
jksoft | 1:48f6e08a3ac2 | 44 | #define BLE_UUID_LINK_LOSS_SERVICE 0x1803 /**< Link Loss service UUID. */ |
jksoft | 1:48f6e08a3ac2 | 45 | #define BLE_UUID_NEXT_DST_CHANGE_SERVICE 0x1807 /**< Next Dst Change service UUID. */ |
jksoft | 1:48f6e08a3ac2 | 46 | #define BLE_UUID_PHONE_ALERT_STATUS_SERVICE 0x180E /**< Phone Alert Status service UUID. */ |
jksoft | 1:48f6e08a3ac2 | 47 | #define BLE_UUID_REFERENCE_TIME_UPDATE_SERVICE 0x1806 /**< Reference Time Update service UUID. */ |
jksoft | 1:48f6e08a3ac2 | 48 | #define BLE_UUID_RUNNING_SPEED_AND_CADENCE 0x1814 /**< Running Speed and Cadence service UUID. */ |
jksoft | 1:48f6e08a3ac2 | 49 | #define BLE_UUID_SCAN_PARAMETERS_SERVICE 0x1813 /**< Scan Parameters service UUID. */ |
jksoft | 1:48f6e08a3ac2 | 50 | #define BLE_UUID_TX_POWER_SERVICE 0x1804 /**< TX Power service UUID. */ |
jksoft | 1:48f6e08a3ac2 | 51 | /** @} */ |
jksoft | 1:48f6e08a3ac2 | 52 | |
jksoft | 1:48f6e08a3ac2 | 53 | /** @defgroup UUID_CHARACTERISTICS Characteristic UUID definitions |
jksoft | 1:48f6e08a3ac2 | 54 | * @{ */ |
jksoft | 1:48f6e08a3ac2 | 55 | #define BLE_UUID_BATTERY_LEVEL_STATE_CHAR 0x2A1B /**< Battery Level State characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 56 | #define BLE_UUID_BATTERY_POWER_STATE_CHAR 0x2A1A /**< Battery Power State characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 57 | #define BLE_UUID_REMOVABLE_CHAR 0x2A3A /**< Removable characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 58 | #define BLE_UUID_SERVICE_REQUIRED_CHAR 0x2A3B /**< Service Required characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 59 | #define BLE_UUID_ALERT_CATEGORY_ID_CHAR 0x2A43 /**< Alert Category Id characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 60 | #define BLE_UUID_ALERT_CATEGORY_ID_BIT_MASK_CHAR 0x2A42 /**< Alert Category Id Bit Mask characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 61 | #define BLE_UUID_ALERT_LEVEL_CHAR 0x2A06 /**< Alert Level characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 62 | #define BLE_UUID_ALERT_NOTIFICATION_CONTROL_POINT_CHAR 0x2A44 /**< Alert Notification Control Point characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 63 | #define BLE_UUID_ALERT_STATUS_CHAR 0x2A3F /**< Alert Status characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 64 | #define BLE_UUID_BATTERY_LEVEL_CHAR 0x2A19 /**< Battery Level characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 65 | #define BLE_UUID_BLOOD_PRESSURE_FEATURE_CHAR 0x2A49 /**< Blood Pressure Feature characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 66 | #define BLE_UUID_BLOOD_PRESSURE_MEASUREMENT_CHAR 0x2A35 /**< Blood Pressure Measurement characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 67 | #define BLE_UUID_BODY_SENSOR_LOCATION_CHAR 0x2A38 /**< Body Sensor Location characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 68 | #define BLE_UUID_BOOT_KEYBOARD_INPUT_REPORT_CHAR 0x2A22 /**< Boot Keyboard Input Report characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 69 | #define BLE_UUID_BOOT_KEYBOARD_OUTPUT_REPORT_CHAR 0x2A32 /**< Boot Keyboard Output Report characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 70 | #define BLE_UUID_BOOT_MOUSE_INPUT_REPORT_CHAR 0x2A33 /**< Boot Mouse Input Report characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 71 | #define BLE_UUID_CURRENT_TIME_CHAR 0x2A2B /**< Current Time characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 72 | #define BLE_UUID_DATE_TIME_CHAR 0x2A08 /**< Date Time characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 73 | #define BLE_UUID_DAY_DATE_TIME_CHAR 0x2A0A /**< Day Date Time characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 74 | #define BLE_UUID_DAY_OF_WEEK_CHAR 0x2A09 /**< Day Of Week characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 75 | #define BLE_UUID_DST_OFFSET_CHAR 0x2A0D /**< Dst Offset characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 76 | #define BLE_UUID_EXACT_TIME_256_CHAR 0x2A0C /**< Exact Time 256 characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 77 | #define BLE_UUID_FIRMWARE_REVISION_STRING_CHAR 0x2A26 /**< Firmware Revision String characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 78 | #define BLE_UUID_GLUCOSE_FEATURE_CHAR 0x2A51 /**< Glucose Feature characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 79 | #define BLE_UUID_GLUCOSE_MEASUREMENT_CHAR 0x2A18 /**< Glucose Measurement characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 80 | #define BLE_UUID_GLUCOSE_MEASUREMENT_CONTEXT_CHAR 0x2A34 /**< Glucose Measurement Context characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 81 | #define BLE_UUID_HARDWARE_REVISION_STRING_CHAR 0x2A27 /**< Hardware Revision String characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 82 | #define BLE_UUID_HEART_RATE_CONTROL_POINT_CHAR 0x2A39 /**< Heart Rate Control Point characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 83 | #define BLE_UUID_HEART_RATE_MEASUREMENT_CHAR 0x2A37 /**< Heart Rate Measurement characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 84 | #define BLE_UUID_HID_CONTROL_POINT_CHAR 0x2A4C /**< Hid Control Point characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 85 | #define BLE_UUID_HID_INFORMATION_CHAR 0x2A4A /**< Hid Information characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 86 | #define BLE_UUID_IEEE_REGULATORY_CERTIFICATION_DATA_LIST_CHAR 0x2A2A /**< IEEE Regulatory Certification Data List characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 87 | #define BLE_UUID_INTERMEDIATE_CUFF_PRESSURE_CHAR 0x2A36 /**< Intermediate Cuff Pressure characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 88 | #define BLE_UUID_INTERMEDIATE_TEMPERATURE_CHAR 0x2A1E /**< Intermediate Temperature characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 89 | #define BLE_UUID_LOCAL_TIME_INFORMATION_CHAR 0x2A0F /**< Local Time Information characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 90 | #define BLE_UUID_MANUFACTURER_NAME_STRING_CHAR 0x2A29 /**< Manufacturer Name String characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 91 | #define BLE_UUID_MEASUREMENT_INTERVAL_CHAR 0x2A21 /**< Measurement Interval characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 92 | #define BLE_UUID_MODEL_NUMBER_STRING_CHAR 0x2A24 /**< Model Number String characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 93 | #define BLE_UUID_UNREAD_ALERT_CHAR 0x2A45 /**< Unread Alert characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 94 | #define BLE_UUID_NEW_ALERT_CHAR 0x2A46 /**< New Alert characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 95 | #define BLE_UUID_PNP_ID_CHAR 0x2A50 /**< PNP Id characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 96 | #define BLE_UUID_PROTOCOL_MODE_CHAR 0x2A4E /**< Protocol Mode characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 97 | #define BLE_UUID_RECORD_ACCESS_CONTROL_POINT_CHAR 0x2A52 /**< Record Access Control Point characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 98 | #define BLE_UUID_REFERENCE_TIME_INFORMATION_CHAR 0x2A14 /**< Reference Time Information characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 99 | #define BLE_UUID_REPORT_CHAR 0x2A4D /**< Report characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 100 | #define BLE_UUID_REPORT_MAP_CHAR 0x2A4B /**< Report Map characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 101 | #define BLE_UUID_RINGER_CONTROL_POINT_CHAR 0x2A40 /**< Ringer Control Point characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 102 | #define BLE_UUID_RINGER_SETTING_CHAR 0x2A41 /**< Ringer Setting characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 103 | #define BLE_UUID_SCAN_INTERVAL_WINDOW_CHAR 0x2A4F /**< Scan Interval Window characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 104 | #define BLE_UUID_SCAN_REFRESH_CHAR 0x2A31 /**< Scan Refresh characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 105 | #define BLE_UUID_SERIAL_NUMBER_STRING_CHAR 0x2A25 /**< Serial Number String characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 106 | #define BLE_UUID_SOFTWARE_REVISION_STRING_CHAR 0x2A28 /**< Software Revision String characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 107 | #define BLE_UUID_SUPPORTED_NEW_ALERT_CATEGORY_CHAR 0x2A47 /**< Supported New Alert Category characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 108 | #define BLE_UUID_SUPPORTED_UNREAD_ALERT_CATEGORY_CHAR 0x2A48 /**< Supported Unread Alert Category characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 109 | #define BLE_UUID_SYSTEM_ID_CHAR 0x2A23 /**< System Id characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 110 | #define BLE_UUID_TEMPERATURE_MEASUREMENT_CHAR 0x2A1C /**< Temperature Measurement characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 111 | #define BLE_UUID_TEMPERATURE_TYPE_CHAR 0x2A1D /**< Temperature Type characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 112 | #define BLE_UUID_TIME_ACCURACY_CHAR 0x2A12 /**< Time Accuracy characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 113 | #define BLE_UUID_TIME_SOURCE_CHAR 0x2A13 /**< Time Source characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 114 | #define BLE_UUID_TIME_UPDATE_CONTROL_POINT_CHAR 0x2A16 /**< Time Update Control Point characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 115 | #define BLE_UUID_TIME_UPDATE_STATE_CHAR 0x2A17 /**< Time Update State characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 116 | #define BLE_UUID_TIME_WITH_DST_CHAR 0x2A11 /**< Time With Dst characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 117 | #define BLE_UUID_TIME_ZONE_CHAR 0x2A0E /**< Time Zone characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 118 | #define BLE_UUID_TX_POWER_LEVEL_CHAR 0x2A07 /**< TX Power Level characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 119 | #define BLE_UUID_CSC_FEATURE_CHAR 0x2A5C /**< Cycling Speed and Cadence Feature characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 120 | #define BLE_UUID_CSC_MEASUREMENT_CHAR 0x2A5B /**< Cycling Speed and Cadence Measurement characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 121 | #define BLE_UUID_RSC_FEATURE_CHAR 0x2A54 /**< Running Speed and Cadence Feature characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 122 | #define BLE_UUID_SC_CTRLPT_CHAR 0x2A55 /**< Speed and Cadence Control Point UUID. */ |
jksoft | 1:48f6e08a3ac2 | 123 | #define BLE_UUID_RSC_MEASUREMENT_CHAR 0x2A53 /**< Running Speed and Cadence Measurement characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 124 | #define BLE_UUID_SENSOR_LOCATION_CHAR 0x2A5D /**< Sensor Location characteristic UUID. */ |
jksoft | 1:48f6e08a3ac2 | 125 | /** @} */ |
jksoft | 1:48f6e08a3ac2 | 126 | |
jksoft | 1:48f6e08a3ac2 | 127 | /** @defgroup UUID_CHARACTERISTICS descriptors UUID definitions |
jksoft | 1:48f6e08a3ac2 | 128 | * @{ */ |
jksoft | 1:48f6e08a3ac2 | 129 | #define BLE_UUID_EXTERNAL_REPORT_REF_DESCR 0x2907 /**< External Report Reference descriptor UUID. */ |
jksoft | 1:48f6e08a3ac2 | 130 | #define BLE_UUID_REPORT_REF_DESCR 0x2908 /**< Report Reference descriptor UUID. */ |
jksoft | 1:48f6e08a3ac2 | 131 | /** @} */ |
jksoft | 1:48f6e08a3ac2 | 132 | |
jksoft | 1:48f6e08a3ac2 | 133 | /** @defgroup ALERT_LEVEL_VALUES Definitions for the Alert Level characteristic values |
jksoft | 1:48f6e08a3ac2 | 134 | * @{ */ |
jksoft | 1:48f6e08a3ac2 | 135 | #define BLE_CHAR_ALERT_LEVEL_NO_ALERT 0x00 /**< No Alert. */ |
jksoft | 1:48f6e08a3ac2 | 136 | #define BLE_CHAR_ALERT_LEVEL_MILD_ALERT 0x01 /**< Mild Alert. */ |
jksoft | 1:48f6e08a3ac2 | 137 | #define BLE_CHAR_ALERT_LEVEL_HIGH_ALERT 0x02 /**< High Alert. */ |
jksoft | 1:48f6e08a3ac2 | 138 | /** @} */ |
jksoft | 1:48f6e08a3ac2 | 139 | |
jksoft | 1:48f6e08a3ac2 | 140 | #define BLE_SRV_ENCODED_REPORT_REF_LEN 2 /**< The length of an encoded Report Reference Descriptor. */ |
jksoft | 1:48f6e08a3ac2 | 141 | #define BLE_CCCD_VALUE_LEN 2 /**< The length of a CCCD value. */ |
jksoft | 1:48f6e08a3ac2 | 142 | |
jksoft | 1:48f6e08a3ac2 | 143 | /**@brief Type definition for error handler function which will be called in case of an error in |
jksoft | 1:48f6e08a3ac2 | 144 | * a service or a service library module. */ |
jksoft | 1:48f6e08a3ac2 | 145 | typedef void (*ble_srv_error_handler_t) (uint32_t nrf_error); |
jksoft | 1:48f6e08a3ac2 | 146 | |
jksoft | 1:48f6e08a3ac2 | 147 | /**@brief Value of a Report Reference descriptor. |
jksoft | 1:48f6e08a3ac2 | 148 | * |
jksoft | 1:48f6e08a3ac2 | 149 | * @details This is mapping information which maps the parent characteristic to the Report ID(s) and |
jksoft | 1:48f6e08a3ac2 | 150 | * Report Type(s) defined within a Report Map characteristic. |
jksoft | 1:48f6e08a3ac2 | 151 | */ |
jksoft | 1:48f6e08a3ac2 | 152 | typedef struct |
jksoft | 1:48f6e08a3ac2 | 153 | { |
jksoft | 1:48f6e08a3ac2 | 154 | uint8_t report_id; /**< Non-zero value if these is more than one instance of the same Report Type */ |
jksoft | 1:48f6e08a3ac2 | 155 | uint8_t report_type; /**< Type of Report characteristic (see @ref BLE_SRV_HIDS_REPORT_TYPE) */ |
jksoft | 1:48f6e08a3ac2 | 156 | } ble_srv_report_ref_t; |
jksoft | 1:48f6e08a3ac2 | 157 | |
jksoft | 1:48f6e08a3ac2 | 158 | /**@brief UTF-8 string data type. |
jksoft | 1:48f6e08a3ac2 | 159 | * |
jksoft | 1:48f6e08a3ac2 | 160 | * @note The type can only hold a pointer to the string data (i.e. not the actual data). |
jksoft | 1:48f6e08a3ac2 | 161 | */ |
jksoft | 1:48f6e08a3ac2 | 162 | typedef struct |
jksoft | 1:48f6e08a3ac2 | 163 | { |
jksoft | 1:48f6e08a3ac2 | 164 | uint16_t length; /**< String length. */ |
jksoft | 1:48f6e08a3ac2 | 165 | uint8_t * p_str; /**< String data. */ |
jksoft | 1:48f6e08a3ac2 | 166 | } ble_srv_utf8_str_t; |
jksoft | 1:48f6e08a3ac2 | 167 | |
jksoft | 1:48f6e08a3ac2 | 168 | /**@brief Security settings structure. |
jksoft | 1:48f6e08a3ac2 | 169 | * @details This structure contains the security options needed during initialization of the |
jksoft | 1:48f6e08a3ac2 | 170 | * service. |
jksoft | 1:48f6e08a3ac2 | 171 | */ |
jksoft | 1:48f6e08a3ac2 | 172 | typedef struct |
jksoft | 1:48f6e08a3ac2 | 173 | { |
jksoft | 1:48f6e08a3ac2 | 174 | ble_gap_conn_sec_mode_t read_perm; /**< Read permissions. */ |
jksoft | 1:48f6e08a3ac2 | 175 | ble_gap_conn_sec_mode_t write_perm; /**< Write permissions. */ |
jksoft | 1:48f6e08a3ac2 | 176 | } ble_srv_security_mode_t; |
jksoft | 1:48f6e08a3ac2 | 177 | |
jksoft | 1:48f6e08a3ac2 | 178 | /**@brief Security settings structure. |
jksoft | 1:48f6e08a3ac2 | 179 | * @details This structure contains the security options needed during initialization of the |
jksoft | 1:48f6e08a3ac2 | 180 | * service. It can be used when the charecteristics contains cccd. |
jksoft | 1:48f6e08a3ac2 | 181 | */ |
jksoft | 1:48f6e08a3ac2 | 182 | typedef struct |
jksoft | 1:48f6e08a3ac2 | 183 | { |
jksoft | 1:48f6e08a3ac2 | 184 | ble_gap_conn_sec_mode_t cccd_write_perm; |
jksoft | 1:48f6e08a3ac2 | 185 | ble_gap_conn_sec_mode_t read_perm; /**< Read permissions. */ |
jksoft | 1:48f6e08a3ac2 | 186 | ble_gap_conn_sec_mode_t write_perm; /**< Write permissions. */ |
jksoft | 1:48f6e08a3ac2 | 187 | } ble_srv_cccd_security_mode_t; |
jksoft | 1:48f6e08a3ac2 | 188 | |
jksoft | 1:48f6e08a3ac2 | 189 | /**@brief Function for decoding a CCCD value, and then testing if notification is |
jksoft | 1:48f6e08a3ac2 | 190 | * enabled. |
jksoft | 1:48f6e08a3ac2 | 191 | * |
jksoft | 1:48f6e08a3ac2 | 192 | * @param[in] p_encoded_data Buffer where the encoded CCCD is stored. |
jksoft | 1:48f6e08a3ac2 | 193 | * |
jksoft | 1:48f6e08a3ac2 | 194 | * @return TRUE if notification is enabled, FALSE otherwise. |
jksoft | 1:48f6e08a3ac2 | 195 | */ |
jksoft | 1:48f6e08a3ac2 | 196 | static __INLINE bool ble_srv_is_notification_enabled(uint8_t * p_encoded_data) |
jksoft | 1:48f6e08a3ac2 | 197 | { |
jksoft | 1:48f6e08a3ac2 | 198 | uint16_t cccd_value = uint16_decode(p_encoded_data); |
jksoft | 1:48f6e08a3ac2 | 199 | return ((cccd_value & BLE_GATT_HVX_NOTIFICATION) != 0); |
jksoft | 1:48f6e08a3ac2 | 200 | } |
jksoft | 1:48f6e08a3ac2 | 201 | |
jksoft | 1:48f6e08a3ac2 | 202 | /**@brief Function for decoding a CCCD value, and then testing if indication is |
jksoft | 1:48f6e08a3ac2 | 203 | * enabled. |
jksoft | 1:48f6e08a3ac2 | 204 | * |
jksoft | 1:48f6e08a3ac2 | 205 | * @param[in] p_encoded_data Buffer where the encoded CCCD is stored. |
jksoft | 1:48f6e08a3ac2 | 206 | * |
jksoft | 1:48f6e08a3ac2 | 207 | * @return TRUE if indication is enabled, FALSE otherwise. |
jksoft | 1:48f6e08a3ac2 | 208 | */ |
jksoft | 1:48f6e08a3ac2 | 209 | static __INLINE bool ble_srv_is_indication_enabled(uint8_t * p_encoded_data) |
jksoft | 1:48f6e08a3ac2 | 210 | { |
jksoft | 1:48f6e08a3ac2 | 211 | uint16_t cccd_value = uint16_decode(p_encoded_data); |
jksoft | 1:48f6e08a3ac2 | 212 | return ((cccd_value & BLE_GATT_HVX_INDICATION) != 0); |
jksoft | 1:48f6e08a3ac2 | 213 | } |
jksoft | 1:48f6e08a3ac2 | 214 | |
jksoft | 1:48f6e08a3ac2 | 215 | /**@brief Function for encoding a Report Reference Descriptor. |
jksoft | 1:48f6e08a3ac2 | 216 | * |
jksoft | 1:48f6e08a3ac2 | 217 | * @param[in] p_encoded_buffer The buffer of the encoded data. |
jksoft | 1:48f6e08a3ac2 | 218 | * @param[in] p_report_ref Report Reference value to be encoded. |
jksoft | 1:48f6e08a3ac2 | 219 | * |
jksoft | 1:48f6e08a3ac2 | 220 | * @return Length of the encoded data. |
jksoft | 1:48f6e08a3ac2 | 221 | */ |
jksoft | 1:48f6e08a3ac2 | 222 | uint8_t ble_srv_report_ref_encode(uint8_t * p_encoded_buffer, |
jksoft | 1:48f6e08a3ac2 | 223 | const ble_srv_report_ref_t * p_report_ref); |
jksoft | 1:48f6e08a3ac2 | 224 | |
jksoft | 1:48f6e08a3ac2 | 225 | /**@brief Function for making UTF-8 structure refer to an ASCII string. |
jksoft | 1:48f6e08a3ac2 | 226 | * |
jksoft | 1:48f6e08a3ac2 | 227 | * @param[out] p_utf8 UTF-8 structure to be set. |
jksoft | 1:48f6e08a3ac2 | 228 | * @param[in] p_ascii ASCII string to be referred to. |
jksoft | 1:48f6e08a3ac2 | 229 | */ |
jksoft | 1:48f6e08a3ac2 | 230 | void ble_srv_ascii_to_utf8(ble_srv_utf8_str_t * p_utf8, char * p_ascii); |
jksoft | 1:48f6e08a3ac2 | 231 | |
jksoft | 1:48f6e08a3ac2 | 232 | #endif // BLE_SRV_COMMON_H__ |
jksoft | 1:48f6e08a3ac2 | 233 | |
jksoft | 1:48f6e08a3ac2 | 234 | /** @} */ |