ScStw/esp-nimble-cpp
2
0
Fork 0
mirror of https://github.com/h2zero/esp-nimble-cpp.git synced 2024-11-23 21:50:55 +01:00
Code Issues Projects Releases Packages Wiki Activity
esp-nimble-cpp/src/NimBLEAdvertising.h

138 lines
4.7 KiB
C
Raw Normal View History

Initial commit.
2020-03-30 01:44:20 +02:00
/*
* NimBLEAdvertising.h
*
* Created: on March 3, 2020
* Author H2zero
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
*
Initial commit.
2020-03-30 01:44:20 +02:00
* Originally:
*
* BLEAdvertising.h
*
* Created on: Jun 21, 2017
* Author: kolban
*/
#ifndef MAIN_BLEADVERTISING_H_
#define MAIN_BLEADVERTISING_H_
#include "sdkconfig.h"
#if defined(CONFIG_BT_ENABLED)
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
#include "nimconfig.h"
#if defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)
Initial commit.
2020-03-30 01:44:20 +02:00
#include "host/ble_gap.h"
Add CMakeLists.txt. Fix compilation in strict enviroments. Fix compliation in IDF v4.0.
2020-04-01 04:16:27 +02:00
/**** FIX COMPILATION ****/
#undef min
#undef max
/**************************/
Initial commit.
2020-03-30 01:44:20 +02:00
#include "NimBLEUUID.h"
#include <vector>
/* COMPATIBILITY - DO NOT USE */
#define ESP_BLE_ADV_FLAG_LIMIT_DISC (0x01 << 0)
#define ESP_BLE_ADV_FLAG_GEN_DISC (0x01 << 1)
#define ESP_BLE_ADV_FLAG_BREDR_NOT_SPT (0x01 << 2)
#define ESP_BLE_ADV_FLAG_DMT_CONTROLLER_SPT (0x01 << 3)
#define ESP_BLE_ADV_FLAG_DMT_HOST_SPT (0x01 << 4)
#define ESP_BLE_ADV_FLAG_NON_LIMIT_DISC (0x00 )
/* ************************* */
/**
* @brief Advertisement data set by the programmer to be published by the %BLE server.
*/
class NimBLEAdvertisementData {
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
// Only a subset of the possible BLE architected advertisement fields are currently exposed. Others will
// be exposed on demand/request or as time permits.
//
Initial commit.
2020-03-30 01:44:20 +02:00
public:
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
void setAppearance(uint16_t appearance);
void setCompleteServices(const NimBLEUUID &uuid);
[NimBLEAdvertisementData] Add setServices methods for multiple UUID's Adds: - setPartialServices16 - setPartialServices32 - setCompleteServices16 - setCompleteServices32 Each takes an input parameter of std::vector<NimBLEUUID> to allow for advertising multiple services with a simple interface.
2021-02-06 21:27:12 +01:00
void setCompleteServices16(const std::vector<NimBLEUUID> &v_uuid);
void setCompleteServices32(const std::vector<NimBLEUUID> &v_uuid);
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
void setFlags(uint8_t);
void setManufacturerData(const std::string &data);
Add complementary methods to NimBLEAdvertising and NimBLEAdvertisementData Previous to this NimBLEAdvertising did not have some functionality that was in NimBLEAdvertisementData. Also NimBLEAdvertisementData was missing functionality that exists in NimBLEAdvertising. This resolves that by adding the missing functions to both classes. Changed: NimBLEAdvertising: Transmission power is no longer advertised by default and can be added to the advertisement by calling ::addTxPower() Added: - NimBLEAdvertising::setName - NimBLEAdvertising::setManufacturerData - NimBLEAdvertising::setURI - NimBLEAdvertising::setServiceData - NimBLEAdvertising::addTxPower - NimBLEAdvertising::reset - NimBLEAdvertisementData::addTxPower - NimBLEAdvertisementData::setPreferredParams - NimBLEAdvertisementData::setURI
2021-02-08 04:33:57 +01:00
void setURI(const std::string &uri);
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
void setName(const std::string &name);
void setPartialServices(const NimBLEUUID &uuid);
[NimBLEAdvertisementData] Add setServices methods for multiple UUID's Adds: - setPartialServices16 - setPartialServices32 - setCompleteServices16 - setCompleteServices32 Each takes an input parameter of std::vector<NimBLEUUID> to allow for advertising multiple services with a simple interface.
2021-02-06 21:27:12 +01:00
void setPartialServices16(const std::vector<NimBLEUUID> &v_uuid);
void setPartialServices32(const std::vector<NimBLEUUID> &v_uuid);
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
void setServiceData(const NimBLEUUID &uuid, const std::string &data);
void setShortName(const std::string &name);
void addData(const std::string &data); // Add data to the payload.
Advertising: Add overloaded method for addData. * Implements addData(char * data, size_t length) as an alternative to passing a std::string.
2020-07-28 05:38:22 +02:00
void addData(char * data, size_t length);
Add complementary methods to NimBLEAdvertising and NimBLEAdvertisementData Previous to this NimBLEAdvertising did not have some functionality that was in NimBLEAdvertisementData. Also NimBLEAdvertisementData was missing functionality that exists in NimBLEAdvertising. This resolves that by adding the missing functions to both classes. Changed: NimBLEAdvertising: Transmission power is no longer advertised by default and can be added to the advertisement by calling ::addTxPower() Added: - NimBLEAdvertising::setName - NimBLEAdvertising::setManufacturerData - NimBLEAdvertising::setURI - NimBLEAdvertising::setServiceData - NimBLEAdvertising::addTxPower - NimBLEAdvertising::reset - NimBLEAdvertisementData::addTxPower - NimBLEAdvertisementData::setPreferredParams - NimBLEAdvertisementData::setURI
2021-02-08 04:33:57 +01:00
void addTxPower();
void setPreferredParams(uint16_t min, uint16_t max);
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
std::string getPayload(); // Retrieve the current advert payload.
Initial commit.
2020-03-30 01:44:20 +02:00
private:
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
friend class NimBLEAdvertising;
[NimBLEAdvertisementData] Add setServices methods for multiple UUID's Adds: - setPartialServices16 - setPartialServices32 - setCompleteServices16 - setCompleteServices32 Each takes an input parameter of std::vector<NimBLEUUID> to allow for advertising multiple services with a simple interface.
2021-02-06 21:27:12 +01:00
void setServices(const bool complete, const uint8_t size,
const std::vector<NimBLEUUID> &v_uuid);
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
std::string m_payload; // The payload of the advertisement.
Initial commit.
2020-03-30 01:44:20 +02:00
}; // NimBLEAdvertisementData
/**
* @brief Perform and manage %BLE advertising.
*
* A %BLE server will want to perform advertising in order to make itself known to %BLE clients.
*/
class NimBLEAdvertising {
public:
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
NimBLEAdvertising();
void addServiceUUID(const NimBLEUUID &serviceUUID);
void addServiceUUID(const char* serviceUUID);
Add feature: remove service (#17) * Get service handles on server start * remove service + indicate service changed * Reset gatt services when no connections active and services changed. * NimBLEServer::createService can now be used any time and will send service changed indication if server was already active. * Add ability to remove advertised serviceUUIDS * Adds addService() method to server to be allow user to re-add a service previously removed * Add destructior to NimBLEServer, NimBLEService and NimBLECharacteristic to release allocated resources.
2020-07-14 05:24:07 +02:00
void removeServiceUUID(const NimBLEUUID &serviceUUID);
Advertising start: add return status, use more verbose logging. Advertising start did not return a value to indicate success/failure, this patch adds that functionality. In addition, more verbose logging of errors from this function are provided with the removal of the related asserts. * Minor code cleanup
2021-01-14 03:48:38 +01:00
bool start(uint32_t duration = 0, void (*advCompleteCB)(NimBLEAdvertising *pAdv) = nullptr);
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
void stop();
void setAppearance(uint16_t appearance);
Add complementary methods to NimBLEAdvertising and NimBLEAdvertisementData Previous to this NimBLEAdvertising did not have some functionality that was in NimBLEAdvertisementData. Also NimBLEAdvertisementData was missing functionality that exists in NimBLEAdvertising. This resolves that by adding the missing functions to both classes. Changed: NimBLEAdvertising: Transmission power is no longer advertised by default and can be added to the advertisement by calling ::addTxPower() Added: - NimBLEAdvertising::setName - NimBLEAdvertising::setManufacturerData - NimBLEAdvertising::setURI - NimBLEAdvertising::setServiceData - NimBLEAdvertising::addTxPower - NimBLEAdvertising::reset - NimBLEAdvertisementData::addTxPower - NimBLEAdvertisementData::setPreferredParams - NimBLEAdvertisementData::setURI
2021-02-08 04:33:57 +01:00
void setName(const std::string &name);
void setManufacturerData(const std::string &data);
void setURI(const std::string &uri);
void setServiceData(const NimBLEUUID &uuid, const std::string &data);
Initial commit.
2020-03-30 01:44:20 +02:00
void setAdvertisementType(uint8_t adv_type);
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
void setMaxInterval(uint16_t maxinterval);
void setMinInterval(uint16_t mininterval);
void setAdvertisementData(NimBLEAdvertisementData& advertisementData);
Update documentation. * typo fix
2020-09-14 04:02:15 +02:00
void setScanFilter(bool scanRequestWhitelistOnly, bool connectWhitelistOnly);
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
void setScanResponseData(NimBLEAdvertisementData& advertisementData);
void setScanResponse(bool);
Re-introduce NimBLEAdvertising::setMin/MaxPreferred. This implements the functionality of the original library min/max preferred connection parameters settings.
2020-12-27 23:25:38 +01:00
void setMinPreferred(uint16_t);
void setMaxPreferred(uint16_t);
Add complementary methods to NimBLEAdvertising and NimBLEAdvertisementData Previous to this NimBLEAdvertising did not have some functionality that was in NimBLEAdvertisementData. Also NimBLEAdvertisementData was missing functionality that exists in NimBLEAdvertising. This resolves that by adding the missing functions to both classes. Changed: NimBLEAdvertising: Transmission power is no longer advertised by default and can be added to the advertisement by calling ::addTxPower() Added: - NimBLEAdvertising::setName - NimBLEAdvertising::setManufacturerData - NimBLEAdvertising::setURI - NimBLEAdvertising::setServiceData - NimBLEAdvertising::addTxPower - NimBLEAdvertising::reset - NimBLEAdvertisementData::addTxPower - NimBLEAdvertisementData::setPreferredParams - NimBLEAdvertisementData::setURI
2021-02-08 04:33:57 +01:00
void addTxPower();
void reset();
Add duration and callback parameter to NimBLEAdvertising::start * Adds functionality to advertise for a set duration, similar to NimBLEScan::start. The first parameter being the duration (in seconds). The second parameter is a pointer to a callback function that is invoked when advertising stops. * NimBLEAdvertising::isAdvertising method added, returns true if advertising is currently active.
2020-09-14 04:36:59 +02:00
void advCompleteCB();
bool isAdvertising();
Initial commit.
2020-03-30 01:44:20 +02:00
private:
friend class NimBLEDevice;
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
Only start scan/advertise when host re-synced if duration was indefinite. Previously when the host reset while scanning (if active prior) it would be restarted automatically. This caused errors for some applications and has been removed since the event invokes the scan ended callback for the app to take action. Instead scanning will now only be restarted if the duration was indefinite and a callback was set for the advertisment events, this use case is less likely to have a scan ended callback. Advertising (if active prior) would be started without regard to it's previous state. This has been corrected to only start advertising again if it was advertising for an idefinite time.
2021-01-13 04:42:19 +01:00
void onHostSync();
Add duration and callback parameter to NimBLEAdvertising::start * Adds functionality to advertise for a set duration, similar to NimBLEScan::start. The first parameter being the duration (in seconds). The second parameter is a pointer to a callback function that is invoked when advertising stops. * NimBLEAdvertising::isAdvertising method added, returns true if advertising is currently active.
2020-09-14 04:36:59 +02:00
static int handleGapEvent(struct ble_gap_event *event, void *arg);
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
Add duration and callback parameter to NimBLEAdvertising::start * Adds functionality to advertise for a set duration, similar to NimBLEScan::start. The first parameter being the duration (in seconds). The second parameter is a pointer to a callback function that is invoked when advertising stops. * NimBLEAdvertising::isAdvertising method added, returns true if advertising is currently active.
2020-09-14 04:36:59 +02:00
ble_hs_adv_fields m_advData;
ble_hs_adv_fields m_scanData;
ble_gap_adv_params m_advParams;
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
std::vector<NimBLEUUID> m_serviceUUIDs;
Add duration and callback parameter to NimBLEAdvertising::start * Adds functionality to advertise for a set duration, similar to NimBLEScan::start. The first parameter being the duration (in seconds). The second parameter is a pointer to a callback function that is invoked when advertising stops. * NimBLEAdvertising::isAdvertising method added, returns true if advertising is currently active.
2020-09-14 04:36:59 +02:00
bool m_customAdvData;
bool m_customScanResponseData;
bool m_scanResp;
bool m_advDataSet;
Re-introduce NimBLEAdvertising::setMin/MaxPreferred. This implements the functionality of the original library min/max preferred connection parameters settings.
2020-12-27 23:25:38 +01:00
void (*m_advCompCB)(NimBLEAdvertising *pAdv);
uint8_t m_slaveItvl[4];
Only start scan/advertise when host re-synced if duration was indefinite. Previously when the host reset while scanning (if active prior) it would be restarted automatically. This caused errors for some applications and has been removed since the event invokes the scan ended callback for the app to take action. Instead scanning will now only be restarted if the duration was indefinite and a callback was set for the advertisment events, this use case is less likely to have a scan ended callback. Advertising (if active prior) would be started without regard to it's previous state. This has been corrected to only start advertising again if it was advertising for an idefinite time.
2021-01-13 04:42:19 +01:00
uint32_t m_duration;
Add complementary methods to NimBLEAdvertising and NimBLEAdvertisementData Previous to this NimBLEAdvertising did not have some functionality that was in NimBLEAdvertisementData. Also NimBLEAdvertisementData was missing functionality that exists in NimBLEAdvertising. This resolves that by adding the missing functions to both classes. Changed: NimBLEAdvertising: Transmission power is no longer advertised by default and can be added to the advertisement by calling ::addTxPower() Added: - NimBLEAdvertising::setName - NimBLEAdvertising::setManufacturerData - NimBLEAdvertising::setURI - NimBLEAdvertising::setServiceData - NimBLEAdvertising::addTxPower - NimBLEAdvertising::reset - NimBLEAdvertisementData::addTxPower - NimBLEAdvertisementData::setPreferredParams - NimBLEAdvertisementData::setURI
2021-02-08 04:33:57 +01:00
std::vector<uint8_t> m_svcData16;
std::vector<uint8_t> m_svcData32;
std::vector<uint8_t> m_svcData128;
std::vector<uint8_t> m_name;
std::vector<uint8_t> m_mfgData;
std::vector<uint8_t> m_uri;
Initial commit.
2020-03-30 01:44:20 +02:00
};
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
#endif // #if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
Initial commit.
2020-03-30 01:44:20 +02:00
#endif /* CONFIG_BT_ENABLED */
Add ==,!= operators to NimBLEAddress, pass parameters by const reference.
2020-05-10 15:21:46 +02:00
#endif /* MAIN_BLEADVERTISING_H_ */
Reference in a new issue Copy permalink