George Roussos / BLE_Temperature_Exercise

BLE Temperature Service Mobile and Ubiquitous Computing Module Birkbeck College

Dependencies:   DS1820

BLE_API_Native/GapAdvertisingParams.h@0:dd0fea342ad2, 2015-03-08 (annotated)

Committer:
gkroussos
Date:
Sun Mar 08 19:42:20 2015 +0000
Revision:
0:dd0fea342ad2
BLE Temperature Service ; Mobile and Ubiquitous Computing Module; Birkbeck College

Who changed what in which revision?

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