BLE temperature profile using digital DS1820 or analog LM35 sensors
BLE_API_Native/GapAdvertisingParams.h@0:637031152314, 2015-03-07 (annotated)
- Committer:
- gkroussos
- Date:
- Sat Mar 07 16:23:41 2015 +0000
- Revision:
- 0:637031152314
Working version 1.0
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
gkroussos | 0:637031152314 | 1 | /* mbed Microcontroller Library |
gkroussos | 0:637031152314 | 2 | * Copyright (c) 2006-2013 ARM Limited |
gkroussos | 0:637031152314 | 3 | * |
gkroussos | 0:637031152314 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
gkroussos | 0:637031152314 | 5 | * you may not use this file except in compliance with the License. |
gkroussos | 0:637031152314 | 6 | * You may obtain a copy of the License at |
gkroussos | 0:637031152314 | 7 | * |
gkroussos | 0:637031152314 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
gkroussos | 0:637031152314 | 9 | * |
gkroussos | 0:637031152314 | 10 | * Unless required by applicable law or agreed to in writing, software |
gkroussos | 0:637031152314 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
gkroussos | 0:637031152314 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
gkroussos | 0:637031152314 | 13 | * See the License for the specific language governing permissions and |
gkroussos | 0:637031152314 | 14 | * limitations under the License. |
gkroussos | 0:637031152314 | 15 | */ |
gkroussos | 0:637031152314 | 16 | |
gkroussos | 0:637031152314 | 17 | #ifndef __GAP_ADVERTISING_PARAMS_H__ |
gkroussos | 0:637031152314 | 18 | #define __GAP_ADVERTISING_PARAMS_H__ |
gkroussos | 0:637031152314 | 19 | |
gkroussos | 0:637031152314 | 20 | #include "blecommon.h" |
gkroussos | 0:637031152314 | 21 | |
gkroussos | 0:637031152314 | 22 | #define GAP_ADV_PARAMS_INTERVAL_MIN (0x0020) |
gkroussos | 0:637031152314 | 23 | #define GAP_ADV_PARAMS_INTERVAL_MIN_NONCON (0x00A0) |
gkroussos | 0:637031152314 | 24 | #define GAP_ADV_PARAMS_INTERVAL_MAX (0x1000) |
gkroussos | 0:637031152314 | 25 | #define GAP_ADV_PARAMS_TIMEOUT_MAX (0x3FFF) |
gkroussos | 0:637031152314 | 26 | |
gkroussos | 0:637031152314 | 27 | /**************************************************************************/ |
gkroussos | 0:637031152314 | 28 | /*! |
gkroussos | 0:637031152314 | 29 | \brief |
gkroussos | 0:637031152314 | 30 | This class provides a wrapper for the core advertising parameters, |
gkroussos | 0:637031152314 | 31 | including the advertising type (Connectable Undirected, |
gkroussos | 0:637031152314 | 32 | Non Connectable Undirected, etc.), as well as the advertising and |
gkroussos | 0:637031152314 | 33 | timeout intervals. |
gkroussos | 0:637031152314 | 34 | |
gkroussos | 0:637031152314 | 35 | \par |
gkroussos | 0:637031152314 | 36 | See the following for more information on advertising types: |
gkroussos | 0:637031152314 | 37 | |
gkroussos | 0:637031152314 | 38 | \li \c Bluetooth Core Specification 4.0 (Vol. 6), Part B, Section 2.3.1 |
gkroussos | 0:637031152314 | 39 | \li \c Bluetooth Core Specification 4.0 (Vol. 3), Part C, Section 9.3 |
gkroussos | 0:637031152314 | 40 | |
gkroussos | 0:637031152314 | 41 | \par EXAMPLE |
gkroussos | 0:637031152314 | 42 | |
gkroussos | 0:637031152314 | 43 | \code |
gkroussos | 0:637031152314 | 44 | |
gkroussos | 0:637031152314 | 45 | // ToDo |
gkroussos | 0:637031152314 | 46 | |
gkroussos | 0:637031152314 | 47 | \endcode |
gkroussos | 0:637031152314 | 48 | */ |
gkroussos | 0:637031152314 | 49 | /**************************************************************************/ |
gkroussos | 0:637031152314 | 50 | class GapAdvertisingParams |
gkroussos | 0:637031152314 | 51 | { |
gkroussos | 0:637031152314 | 52 | public: |
gkroussos | 0:637031152314 | 53 | /**************************************************************************/ |
gkroussos | 0:637031152314 | 54 | /*! |
gkroussos | 0:637031152314 | 55 | \brief |
gkroussos | 0:637031152314 | 56 | Encapsulates the peripheral advertising modes, which determine how |
gkroussos | 0:637031152314 | 57 | the device appears to other central devices in hearing range |
gkroussos | 0:637031152314 | 58 | |
gkroussos | 0:637031152314 | 59 | \par |
gkroussos | 0:637031152314 | 60 | See the following for more information on advertising types: |
gkroussos | 0:637031152314 | 61 | |
gkroussos | 0:637031152314 | 62 | \li \c Bluetooth Core Specification 4.0 (Vol. 6), Part B, Section 2.3.1 |
gkroussos | 0:637031152314 | 63 | \li \c Bluetooth Core Specification 4.0 (Vol. 3), Part C, Section 9.3 |
gkroussos | 0:637031152314 | 64 | */ |
gkroussos | 0:637031152314 | 65 | /**************************************************************************/ |
gkroussos | 0:637031152314 | 66 | enum AdvertisingType |
gkroussos | 0:637031152314 | 67 | { |
gkroussos | 0:637031152314 | 68 | ADV_CONNECTABLE_UNDIRECTED, /**< Vol 3, Part C, Section 9.3.4 and Vol 6, Part B, Section 2.3.1.1 */ |
gkroussos | 0:637031152314 | 69 | ADV_CONNECTABLE_DIRECTED, /**< Vol 3, Part C, Section 9.3.3 and Vol 6, Part B, Section 2.3.1.2 */ |
gkroussos | 0:637031152314 | 70 | ADV_SCANNABLE_UNDIRECTED, /**< Include support for Scan Response payloads, see Vol 6, Part B, Section 2.3.1.4 */ |
gkroussos | 0:637031152314 | 71 | ADV_NON_CONNECTABLE_UNDIRECTED /**< Vol 3, Part C, Section 9.3.2 and Vol 6, Part B, Section 2.3.1.3 */ |
gkroussos | 0:637031152314 | 72 | }; |
gkroussos | 0:637031152314 | 73 | |
gkroussos | 0:637031152314 | 74 | GapAdvertisingParams(AdvertisingType advType = GapAdvertisingParams::ADV_CONNECTABLE_UNDIRECTED, |
gkroussos | 0:637031152314 | 75 | uint16_t interval = GAP_ADV_PARAMS_INTERVAL_MIN_NONCON, |
gkroussos | 0:637031152314 | 76 | uint16_t timeout = 0); |
gkroussos | 0:637031152314 | 77 | virtual ~GapAdvertisingParams(void); |
gkroussos | 0:637031152314 | 78 | |
gkroussos | 0:637031152314 | 79 | virtual AdvertisingType getAdvertisingType(void); |
gkroussos | 0:637031152314 | 80 | virtual uint16_t getInterval(void); |
gkroussos | 0:637031152314 | 81 | virtual uint16_t getTimeout(void); |
gkroussos | 0:637031152314 | 82 | |
gkroussos | 0:637031152314 | 83 | private: |
gkroussos | 0:637031152314 | 84 | AdvertisingType _advType; |
gkroussos | 0:637031152314 | 85 | uint16_t _interval; |
gkroussos | 0:637031152314 | 86 | uint16_t _timeout; |
gkroussos | 0:637031152314 | 87 | }; |
gkroussos | 0:637031152314 | 88 | |
gkroussos | 0:637031152314 | 89 | #endif |