BLE temperature profile using digital DS1820 or analog LM35 sensors
BLE_API_Native/GapAdvertisingParams.cpp@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 | #include <stdio.h> |
gkroussos | 0:637031152314 | 18 | #include <string.h> |
gkroussos | 0:637031152314 | 19 | |
gkroussos | 0:637031152314 | 20 | #include "blecommon.h" |
gkroussos | 0:637031152314 | 21 | #include "GapAdvertisingParams.h" |
gkroussos | 0:637031152314 | 22 | |
gkroussos | 0:637031152314 | 23 | /**************************************************************************/ |
gkroussos | 0:637031152314 | 24 | /*! |
gkroussos | 0:637031152314 | 25 | \brief |
gkroussos | 0:637031152314 | 26 | Instantiates a new GapAdvertisingParams instance |
gkroussos | 0:637031152314 | 27 | |
gkroussos | 0:637031152314 | 28 | \param[in] advType |
gkroussos | 0:637031152314 | 29 | The GAP advertising mode to use for this device. Valid |
gkroussos | 0:637031152314 | 30 | values are defined in AdvertisingType: |
gkroussos | 0:637031152314 | 31 | |
gkroussos | 0:637031152314 | 32 | \par ADV_NON_CONNECTABLE_UNDIRECTED |
gkroussos | 0:637031152314 | 33 | All connections to the peripheral device will be refused. |
gkroussos | 0:637031152314 | 34 | |
gkroussos | 0:637031152314 | 35 | \par ADV_CONNECTABLE_DIRECTED |
gkroussos | 0:637031152314 | 36 | Only connections from a pre-defined central device will be |
gkroussos | 0:637031152314 | 37 | accepted. |
gkroussos | 0:637031152314 | 38 | |
gkroussos | 0:637031152314 | 39 | \par ADV_CONNECTABLE_UNDIRECTED |
gkroussos | 0:637031152314 | 40 | Any central device can connect to this peripheral. |
gkroussos | 0:637031152314 | 41 | |
gkroussos | 0:637031152314 | 42 | \par ADV_SCANNABLE_UNDIRECTED |
gkroussos | 0:637031152314 | 43 | Any central device can connect to this peripheral, and |
gkroussos | 0:637031152314 | 44 | the secondary Scan Response payload will be included or |
gkroussos | 0:637031152314 | 45 | available to central devices. |
gkroussos | 0:637031152314 | 46 | |
gkroussos | 0:637031152314 | 47 | \par |
gkroussos | 0:637031152314 | 48 | See Bluetooth Core Specification 4.0 (Vol. 3), Part C, |
gkroussos | 0:637031152314 | 49 | Section 9.3 and Core Specification 4.0 (Vol. 6), Part B, |
gkroussos | 0:637031152314 | 50 | Section 2.3.1 for further information on GAP connection |
gkroussos | 0:637031152314 | 51 | modes |
gkroussos | 0:637031152314 | 52 | |
gkroussos | 0:637031152314 | 53 | \param[in] interval |
gkroussos | 0:637031152314 | 54 | Advertising interval between 0x0020 and 0x4000 in 0.625ms |
gkroussos | 0:637031152314 | 55 | units (20ms to 10.24s). If using non-connectable mode |
gkroussos | 0:637031152314 | 56 | (ADV_NON_CONNECTABLE_UNDIRECTED) this min value is |
gkroussos | 0:637031152314 | 57 | 0x00A0 (100ms). |
gkroussos | 0:637031152314 | 58 | |
gkroussos | 0:637031152314 | 59 | \par |
gkroussos | 0:637031152314 | 60 | Increasing this value will allow central devices to detect |
gkroussos | 0:637031152314 | 61 | your peripheral faster at the expense of more power being |
gkroussos | 0:637031152314 | 62 | used by the radio due to the higher data transmit rate. |
gkroussos | 0:637031152314 | 63 | |
gkroussos | 0:637031152314 | 64 | \par |
gkroussos | 0:637031152314 | 65 | This field must be set to 0 if connectionMode is equal |
gkroussos | 0:637031152314 | 66 | to ADV_CONNECTABLE_DIRECTED |
gkroussos | 0:637031152314 | 67 | |
gkroussos | 0:637031152314 | 68 | \par |
gkroussos | 0:637031152314 | 69 | See Bluetooth Core Specification, Vol 3., Part C, |
gkroussos | 0:637031152314 | 70 | Appendix A for suggested advertising intervals. |
gkroussos | 0:637031152314 | 71 | |
gkroussos | 0:637031152314 | 72 | \param[in] timeout |
gkroussos | 0:637031152314 | 73 | Advertising timeout between 0x1 and 0x3FFF (1 and 16383) |
gkroussos | 0:637031152314 | 74 | in seconds. Enter 0 to disable the advertising timeout. |
gkroussos | 0:637031152314 | 75 | |
gkroussos | 0:637031152314 | 76 | \par EXAMPLE |
gkroussos | 0:637031152314 | 77 | |
gkroussos | 0:637031152314 | 78 | \code |
gkroussos | 0:637031152314 | 79 | |
gkroussos | 0:637031152314 | 80 | \endcode |
gkroussos | 0:637031152314 | 81 | */ |
gkroussos | 0:637031152314 | 82 | /**************************************************************************/ |
gkroussos | 0:637031152314 | 83 | GapAdvertisingParams::GapAdvertisingParams(AdvertisingType advType, uint16_t interval, uint16_t timeout) |
gkroussos | 0:637031152314 | 84 | { |
gkroussos | 0:637031152314 | 85 | _advType = advType; |
gkroussos | 0:637031152314 | 86 | _interval = interval; |
gkroussos | 0:637031152314 | 87 | _timeout = timeout; |
gkroussos | 0:637031152314 | 88 | |
gkroussos | 0:637031152314 | 89 | /* Interval checks */ |
gkroussos | 0:637031152314 | 90 | if (_advType == ADV_CONNECTABLE_DIRECTED) |
gkroussos | 0:637031152314 | 91 | { |
gkroussos | 0:637031152314 | 92 | /* Interval must be 0 in directed connectable mode */ |
gkroussos | 0:637031152314 | 93 | _interval = 0; |
gkroussos | 0:637031152314 | 94 | } |
gkroussos | 0:637031152314 | 95 | else if (_advType == ADV_NON_CONNECTABLE_UNDIRECTED) |
gkroussos | 0:637031152314 | 96 | { |
gkroussos | 0:637031152314 | 97 | /* Min interval is slightly larger than in other modes */ |
gkroussos | 0:637031152314 | 98 | if (_interval < GAP_ADV_PARAMS_INTERVAL_MIN_NONCON) |
gkroussos | 0:637031152314 | 99 | { |
gkroussos | 0:637031152314 | 100 | _interval = GAP_ADV_PARAMS_INTERVAL_MIN_NONCON; |
gkroussos | 0:637031152314 | 101 | } |
gkroussos | 0:637031152314 | 102 | if (_interval > GAP_ADV_PARAMS_INTERVAL_MAX) |
gkroussos | 0:637031152314 | 103 | { |
gkroussos | 0:637031152314 | 104 | _interval = GAP_ADV_PARAMS_INTERVAL_MAX; |
gkroussos | 0:637031152314 | 105 | } |
gkroussos | 0:637031152314 | 106 | } |
gkroussos | 0:637031152314 | 107 | else |
gkroussos | 0:637031152314 | 108 | { |
gkroussos | 0:637031152314 | 109 | /* Stay within interval limits */ |
gkroussos | 0:637031152314 | 110 | if (_interval < GAP_ADV_PARAMS_INTERVAL_MIN) |
gkroussos | 0:637031152314 | 111 | { |
gkroussos | 0:637031152314 | 112 | _interval = GAP_ADV_PARAMS_INTERVAL_MIN; |
gkroussos | 0:637031152314 | 113 | } |
gkroussos | 0:637031152314 | 114 | if (_interval > GAP_ADV_PARAMS_INTERVAL_MAX) |
gkroussos | 0:637031152314 | 115 | { |
gkroussos | 0:637031152314 | 116 | _interval = GAP_ADV_PARAMS_INTERVAL_MAX; |
gkroussos | 0:637031152314 | 117 | } |
gkroussos | 0:637031152314 | 118 | } |
gkroussos | 0:637031152314 | 119 | |
gkroussos | 0:637031152314 | 120 | /* Timeout checks */ |
gkroussos | 0:637031152314 | 121 | if (timeout) |
gkroussos | 0:637031152314 | 122 | { |
gkroussos | 0:637031152314 | 123 | /* Stay within timeout limits */ |
gkroussos | 0:637031152314 | 124 | if (_timeout > GAP_ADV_PARAMS_TIMEOUT_MAX) |
gkroussos | 0:637031152314 | 125 | { |
gkroussos | 0:637031152314 | 126 | _timeout = GAP_ADV_PARAMS_TIMEOUT_MAX; |
gkroussos | 0:637031152314 | 127 | } |
gkroussos | 0:637031152314 | 128 | } |
gkroussos | 0:637031152314 | 129 | } |
gkroussos | 0:637031152314 | 130 | |
gkroussos | 0:637031152314 | 131 | /**************************************************************************/ |
gkroussos | 0:637031152314 | 132 | /*! |
gkroussos | 0:637031152314 | 133 | Destructor |
gkroussos | 0:637031152314 | 134 | */ |
gkroussos | 0:637031152314 | 135 | /**************************************************************************/ |
gkroussos | 0:637031152314 | 136 | GapAdvertisingParams::~GapAdvertisingParams(void) |
gkroussos | 0:637031152314 | 137 | { |
gkroussos | 0:637031152314 | 138 | } |
gkroussos | 0:637031152314 | 139 | |
gkroussos | 0:637031152314 | 140 | /**************************************************************************/ |
gkroussos | 0:637031152314 | 141 | /*! |
gkroussos | 0:637031152314 | 142 | \brief returns the current Advertising Type value |
gkroussos | 0:637031152314 | 143 | */ |
gkroussos | 0:637031152314 | 144 | /**************************************************************************/ |
gkroussos | 0:637031152314 | 145 | GapAdvertisingParams::AdvertisingType GapAdvertisingParams::getAdvertisingType(void) |
gkroussos | 0:637031152314 | 146 | { |
gkroussos | 0:637031152314 | 147 | return _advType; |
gkroussos | 0:637031152314 | 148 | } |
gkroussos | 0:637031152314 | 149 | |
gkroussos | 0:637031152314 | 150 | /**************************************************************************/ |
gkroussos | 0:637031152314 | 151 | /*! |
gkroussos | 0:637031152314 | 152 | \brief returns the current Advertising Delay (in units of 0.625ms) |
gkroussos | 0:637031152314 | 153 | */ |
gkroussos | 0:637031152314 | 154 | /**************************************************************************/ |
gkroussos | 0:637031152314 | 155 | uint16_t GapAdvertisingParams::getInterval(void) |
gkroussos | 0:637031152314 | 156 | { |
gkroussos | 0:637031152314 | 157 | return _interval; |
gkroussos | 0:637031152314 | 158 | } |
gkroussos | 0:637031152314 | 159 | |
gkroussos | 0:637031152314 | 160 | /**************************************************************************/ |
gkroussos | 0:637031152314 | 161 | /*! |
gkroussos | 0:637031152314 | 162 | \brief returns the current Advertising Timeout (in seconds) |
gkroussos | 0:637031152314 | 163 | */ |
gkroussos | 0:637031152314 | 164 | /**************************************************************************/ |
gkroussos | 0:637031152314 | 165 | uint16_t GapAdvertisingParams::getTimeout(void) |
gkroussos | 0:637031152314 | 166 | { |
gkroussos | 0:637031152314 | 167 | return _timeout; |
gkroussos | 0:637031152314 | 168 | } |