High level Bluetooth Low Energy API and radio abstraction layer
Fork of BLE_API by
GapAdvertisingParams.cpp
- Committer:
- ktownsend
- Date:
- 2013-12-18
- Revision:
- 19:a6f33421746c
- Parent:
- 18:86fe1e247a54
- Child:
- 27:4a83843f04b0
File content as of revision 19:a6f33421746c:
#include <stdio.h> #include <string.h> #include "blecommon.h" #include "GapAdvertisingParams.h" /**************************************************************************/ /*! \brief Instantiates a new GapAdvertisingParams instance \param[in] advType The GAP advertising mode to use for this device. Valid values are defined in AdvertisingType: \par ADV_NON_CONNECTABLE_UNDIRECTED All connections to the peripheral device will be refused. \par ADV_CONNECTABLE_DIRECTED Only connections from a pre-defined central device will be accepted. \par ADV_CONNECTABLE_UNDIRECTED Any central device can connect to this peripheral. \par ADV_SCANNABLE_UNDIRECTED Any central device can connect to this peripheral, and the secondary Scan Response payload will be included or available to central devices. \par See Bluetooth Core Specification 4.0 (Vol. 3), Part C, Section 9.3 and Core Specification 4.0 (Vol. 6), Part B, Section 2.3.1 for further information on GAP connection modes \param[in] interval Advertising interval between 0x0020 and 0x4000 in 0.625ms units (20ms to 10.24s). If using non-connectable mode (ADV_NON_CONNECTABLE_UNDIRECTED) this min value is 0x00A0 (100ms). \par Increasing this value will allow central devices to detect your peripheral faster at the expense of more power being used by the radio due to the higher data transmit rate. \par This field must be set to 0 if connectionMode is equal to ADV_CONNECTABLE_DIRECTED \par See Bluetooth Core Specification, Vol 3., Part C, Appendix A for suggested advertising intervals. \param[in] timeout Advertising timeout between 0x1 and 0x3FFF (1 and 16383) in seconds. Enter 0 to disable the advertising timeout. \par EXAMPLE \code \endcode */ /**************************************************************************/ GapAdvertisingParams::GapAdvertisingParams(AdvertisingType advType, uint16_t interval, uint16_t timeout) { _advType = advType; _interval = interval; _timeout = timeout; /* Interval checks */ if (_advType == ADV_CONNECTABLE_DIRECTED) { /* Interval must be 0 in directed connectable mode */ _interval = 0; } else if (_advType == ADV_NON_CONNECTABLE_UNDIRECTED) { /* Min interval is slightly larger than in other modes */ if (_interval < GAP_ADV_PARAMS_INTERVAL_MIN_NONCON) { _interval = GAP_ADV_PARAMS_INTERVAL_MIN_NONCON; } if (_interval > GAP_ADV_PARAMS_INTERVAL_MAX) { _interval = GAP_ADV_PARAMS_INTERVAL_MAX; } } else { /* Stay within interval limits */ if (_interval < GAP_ADV_PARAMS_INTERVAL_MIN) { _interval = GAP_ADV_PARAMS_INTERVAL_MIN; } if (_interval > GAP_ADV_PARAMS_INTERVAL_MAX) { _interval = GAP_ADV_PARAMS_INTERVAL_MAX; } } /* Timeout checks */ if (timeout) { /* Stay within timeout limits */ if (_timeout > GAP_ADV_PARAMS_TIMEOUT_MAX) { _timeout = GAP_ADV_PARAMS_TIMEOUT_MAX; } } } /**************************************************************************/ /*! Destructor */ /**************************************************************************/ GapAdvertisingParams::~GapAdvertisingParams(void) { } /**************************************************************************/ /*! \brief returns the current Advertising Type value */ /**************************************************************************/ GapAdvertisingParams::AdvertisingType GapAdvertisingParams::getAdvertisingType(void) { return _advType; } /**************************************************************************/ /*! \brief returns the current Advertising Delay (in units of 0.625ms) */ /**************************************************************************/ uint16_t GapAdvertisingParams::getInterval(void) { return _interval; } /**************************************************************************/ /*! \brief returns the current Advertising Timeout (in seconds) */ /**************************************************************************/ uint16_t GapAdvertisingParams::getTimeout(void) { return _timeout; }