-
-
- Generated by
1.9.1
+ - Generated by 1.9.8
|
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
+ esp-nimble-cpp 2.0.0
+
+ |
+
1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
+ esp-nimble-cpp 2.0.0
+
+ |
+
1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
-
- |
-
1.9.1 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
+ esp-nimble-cpp 2.0.0
+
+ |
+
1.9.8 |
+ esp-nimble-cpp 2.0.0
+
+ |
+
1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
+ esp-nimble-cpp 2.0.0
+
+ |
+
1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
-
- |
-
1.9.1 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
| CNimBLE2904 | Descriptor for Characteristic Presentation Format |
| CNimBLEAddress | A BLE device address |
| CNimBLEAddress | A BLE device address |
| CNimBLEAdvertisedDevice | A representation of a BLE advertised device found by a scan |
| CNimBLEAdvertisedDeviceCallbacks | A callback handler for callbacks associated device scanning |
| CNimBLEAdvertisementData | Advertisement data set by the programmer to be published by the BLE server |
| CNimBLEAdvertising | Perform and manage BLE advertising |
| CNimBLEAdvertisementData | Advertisement data set by the programmer to be published by the BLE server |
| CNimBLEAdvertising | Perform and manage BLE advertising |
| CNimBLEAttribute | A base class for BLE attributes |
| CNimBLEAttValue | A specialized container class to hold BLE attribute values |
| CNimBLEBeacon | Representation of a beacon. See: |
| CNimBLEBeacon | Representation of a beacon. See: |
| CNimBLECharacteristic | The model of a BLE Characteristic |
| CNimBLECharacteristicCallbacks | Callbacks that can be associated with a BLE characteristic to inform of events |
| CNimBLECharacteristicCallbacks | Callbacks that can be associated with a BLE characteristic to inform of events |
| CNimBLEClient | A model of a BLE client |
| CNimBLEClientCallbacks | Callbacks associated with a BLE client |
| CNimBLEClientCallbacks | Callbacks associated with a BLE client |
| CNimBLEConnInfo | Connection information |
| CNimBLEDescriptor | A model of a BLE descriptor |
| CNimBLEDescriptor | A model of a BLE descriptor |
| CNimBLEDescriptorCallbacks | Callbacks that can be associated with a BLE descriptors to inform of events |
| CNimBLEDevice | A model of a BLE Device from which all the BLE roles are created |
| CNimBLEDevice | A model of a BLE Device from which all the BLE roles are created |
| CNimBLEEddystoneTLM | Representation of a beacon. See: |
| CNimBLEEddystoneURL | Representation of a beacon. See: |
| CNimBLEExtAdvertisement | Extended advertisement data |
| CNimBLEExtAdvertising | Extended advertising class |
| CNimBLEExtAdvertisingCallbacks | Callbacks associated with NimBLEExtAdvertising class |
| CNimBLEHIDDevice | A model of a BLE Human Interface Device |
| CNimBLEExtAdvertisement | Extended advertisement data |
| CNimBLEExtAdvertising | Extended advertising class |
| CNimBLEExtAdvertisingCallbacks | Callbacks associated with NimBLEExtAdvertising class |
| CNimBLEHIDDevice | A model of a BLE Human Interface Device |
| CNimBLELocalAttribute | A base class for local BLE attributes |
| CNimBLERemoteCharacteristic | A model of a remote BLE characteristic |
| CNimBLERemoteDescriptor | A model of remote BLE descriptor |
| CNimBLERemoteDescriptor | A model of remote BLE descriptor |
| CNimBLERemoteService | A model of a remote BLE service |
| CNimBLEScan | Perform and manage BLE scans |
| CNimBLEScanResults | A class that contains and operates on the results of a BLE scan |
| CNimBLESecurity | A class to handle BLE security operations. Deprecated - provided for backward compatibility only. |
| CNimBLESecurityCallbacks | Callbacks to handle GAP events related to authorization. Deprecated - provided for backward compatibility only. |
| CNimBLEServer | The model of a BLE server |
| CNimBLEServerCallbacks | Callbacks associated with the operation of a BLE server |
| CNimBLEService | The model of a BLE service |
| CNimBLEScan | Perform and manage BLE scans |
| CNimBLEScanCallbacks | A callback handler for callbacks associated device scanning |
| CNimBLEScanResults | A class that contains and operates on the results of a BLE scan |
| CNimBLEServer | The model of a BLE server |
| CNimBLEServerCallbacks | Callbacks associated with the operation of a BLE server |
| CNimBLEService | The model of a BLE service |
| CNimBLETaskData | A structure to hold data for a task that is waiting for a response |
| CNimBLEUtils | A BLE Utility class with methods for debugging and general purpose use |
| CNimBLEUUID | A model of a BLE UUID |
| CNimBLEUUID | A model of a BLE UUID |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
This is the complete list of members for NimBLE2904, including all inherited members.
| getCharacteristic() | NimBLEDescriptor | |
| getHandle() | NimBLEDescriptor | |
| getLength() | NimBLEDescriptor | |
| getStringValue() | NimBLEDescriptor | |
| getUUID() | NimBLEDescriptor | |
| getValue(time_t *timestamp=nullptr) | NimBLEDescriptor | |
| getValue(time_t *timestamp=nullptr, bool skipSizeCheck=false) | NimBLEDescriptor | inline |
| NimBLEDescriptor(const char *uuid, uint16_t properties, uint16_t max_len, NimBLECharacteristic *pCharacteristic=nullptr) | NimBLEDescriptor | |
| NimBLEDescriptor(NimBLEUUID uuid, uint16_t properties, uint16_t max_len, NimBLECharacteristic *pCharacteristic=nullptr) | NimBLEDescriptor | |
| setCallbacks(NimBLEDescriptorCallbacks *pCallbacks) | NimBLEDescriptor | |
| setDescription(uint16_t) | NimBLE2904 | |
| setExponent(int8_t exponent) | NimBLE2904 | |
| setFormat(uint8_t format) | NimBLE2904 | |
| setNamespace(uint8_t namespace_value) | NimBLE2904 | |
| getCharacteristic() const | NimBLEDescriptor | |
| getHandle() const | NimBLEAttribute | inline |
| getRemoved() const | NimBLELocalAttribute | inline |
| getUUID() const | NimBLEAttribute | inline |
| NimBLEAttribute(const NimBLEUUID &uuid, uint16_t handle) | NimBLEAttribute | inlineprotected |
| NimBLEDescriptor(const char *uuid, uint16_t properties, uint16_t maxLen, NimBLECharacteristic *pCharacteristic=nullptr) | NimBLEDescriptor | |
| NimBLEDescriptor(const NimBLEUUID &uuid, uint16_t properties, uint16_t maxLen, NimBLECharacteristic *pCharacteristic=nullptr) | NimBLEDescriptor | |
| NimBLELocalAttribute(const NimBLEUUID &uuid, uint16_t handle) | NimBLELocalAttribute | inlineprotected |
| setCallbacks(NimBLEDescriptorCallbacks *pCallbacks) | NimBLEDescriptor | |
| setDescription(uint16_t) | NimBLE2904 | |
| setExponent(int8_t exponent) | NimBLE2904 | |
| setFormat(uint8_t format) | NimBLE2904 | |
| setNamespace(uint8_t namespace_value) | NimBLE2904 | |
| setRemoved(uint8_t removed) | NimBLELocalAttribute | inlineprotected |
| setUnit(uint16_t unit) | NimBLE2904 | |
| setValue(const uint8_t *data, size_t size) | NimBLEDescriptor | |
| setValue(const std::vector< uint8_t > &vec) | NimBLEDescriptor | |
| setValue(const T &s) | NimBLEDescriptor | inline |
| toString() | NimBLEDescriptor | |
| ~NimBLEDescriptor() | NimBLEDescriptor | |
| toString() const | NimBLEDescriptor | |
| ~NimBLEAttribute()=default | NimBLEAttribute | protected |
| ~NimBLELocalAttribute()=default | NimBLELocalAttribute | protected |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
Descriptor for Characteristic Presentation Format. More...
+#include <NimBLE2904.h>
Inherits NimBLEDescriptor.
+Public Member Functions
-void | setDescription (uint16_t) | | Set the description. | void | setDescription (uint16_t) | |
-void | setExponent (int8_t exponent) | | Set the exponent. | void | setExponent (int8_t exponent) | |
-void | setFormat (uint8_t format) | | Set the format. | void | setFormat (uint8_t format) | |
-void | setNamespace (uint8_t namespace_value) | | Set the namespace. | void | setNamespace (uint8_t namespace_value) | | void | setUnit (uint16_t unit) | | Set the units for this value. It should be one of the encoded values defined here: https://www.bluetooth.com/specifications/assigned-numbers/units. More... | void | setUnit (uint16_t unit) |  Public Member Functions inherited from NimBLEDescriptor | NimBLEDescriptor (const char *uuid, uint16_t properties, uint16_t max_len, NimBLECharacteristic *pCharacteristic=nullptr) | | Construct a descriptor. More... | | | NimBLEDescriptor (NimBLEUUID uuid, uint16_t properties, uint16_t max_len, NimBLECharacteristic *pCharacteristic=nullptr) | | Construct a descriptor. More... | |
- | ~NimBLEDescriptor () | | NimBLEDescriptor destructor. | | uint16_t | getHandle () | | Get the BLE handle for this descriptor. More... | |
-NimBLEUUID | getUUID () | | Get the UUID of the descriptor. | | std::string | toString () | | Return a string representation of the descriptor. More... | | void | setCallbacks (NimBLEDescriptorCallbacks *pCallbacks) | | Set the callback handlers for this descriptor. More... | | NimBLEDescriptor (const char *uuid, uint16_t properties, uint16_t maxLen, NimBLECharacteristic *pCharacteristic=nullptr) | | Construct a descriptor. | | | NimBLEDescriptor (const NimBLEUUID &uuid, uint16_t properties, uint16_t maxLen, NimBLECharacteristic *pCharacteristic=nullptr) | | Construct a descriptor. | | std::string | toString () const | | Return a string representation of the descriptor. | | void | setCallbacks (NimBLEDescriptorCallbacks *pCallbacks) | | NimBLECharacteristic * | getCharacteristic () | | Get the characteristic this descriptor belongs to. More... | | size_t | getLength () | | Get the length of the value of this descriptor. More... | | NimBLEAttValue | getValue (time_t *timestamp=nullptr) | | Get the value of this descriptor. More... | | std::string | getStringValue () | | Get the value of this descriptor as a string. More... | | void | setValue (const uint8_t *data, size_t size) | | Set the value of the descriptor. More... | | void | setValue (const std::vector< uint8_t > &vec) | | Set the value of the descriptor from a | std::vector<uint8_t>.-. More... | template<typename T > | void | setValue (const T &s) | | Template to set the characteristic value to <type>val. More... | | template<typename T > | T | getValue (time_t *timestamp=nullptr, bool skipSizeCheck=false) | | Template to convert the descriptor data to <type>. More... | | NimBLECharacteristic * | getCharacteristic () const | | Get the characteristic this descriptor belongs to. | | Set the description. | Set the exponent. | Set the format. | Set the namespace. | Set the units for this value. | Set the callback handlers for this descriptor. | |||||||||||||||||||||||||||||||||||||||
Descriptor for Characteristic Presentation Format.
-This is a convenience descriptor for the Characteristic Presentation Format which has a UUID of 0x2904.
- +This is a convenience descriptor for the Characteristic Presentation Format which has a UUID of 0x2904.
| void NimBLE2904::setDescription | +( | +uint16_t | +description | ) | ++ |
Set the description.
+| [in] | description | The description value to set. |
| void NimBLE2904::setExponent | +( | +int8_t | +exponent | ) | ++ |
Set the exponent.
+| [in] | exponent | The exponent value to set. |
| void NimBLE2904::setFormat | +( | +uint8_t | +format | ) | ++ |
Set the format.
+| [in] | format | The format value to set. |
| void NimBLE2904::setNamespace | +( | +uint8_t | +namespace_value | ) | ++ |
Set the namespace.
+| [in] | namespace_value | The namespace value toset. |
Set the units for this value. It should be one of the encoded values defined here: https://www.bluetooth.com/specifications/assigned-numbers/units.
+Set the units for this value.
| [in] | unit | The type of units of this characteristic as defined by assigned numbers. |
| [in] | unit | The type of units of this characteristic as defined by assigned numbers. |
See https://www.bluetooth.com/specifications/assigned-numbers/units
@@ -205,7 +278,7 @@ void 1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
This is the complete list of members for NimBLEAddress, including all inherited members.
| equals(const NimBLEAddress &otherAddress) const | NimBLEAddress | |
| getNative() const | NimBLEAddress | |
| getBase() const | NimBLEAddress | |
| getType() const | NimBLEAddress | |
| NimBLEAddress() | NimBLEAddress | |
| NimBLEAddress(ble_addr_t address) | NimBLEAddress | |
| NimBLEAddress(uint8_t address[6], uint8_t type=BLE_ADDR_PUBLIC) | NimBLEAddress | |
| NimBLEAddress(const std::string &stringAddress, uint8_t type=BLE_ADDR_PUBLIC) | NimBLEAddress | |
| NimBLEAddress(const uint64_t &address, uint8_t type=BLE_ADDR_PUBLIC) | NimBLEAddress | |
| getVal() const | NimBLEAddress | |
| isNrpa() const | NimBLEAddress | |
| isNull() const | NimBLEAddress | |
| isPublic() const | NimBLEAddress | |
| isRpa() const | NimBLEAddress | |
| isStatic() const | NimBLEAddress | |
| NimBLEAddress()=default | NimBLEAddress | |
| NimBLEAddress(const ble_addr_t address) | NimBLEAddress | |
| NimBLEAddress(const uint8_t address[BLE_DEV_ADDR_LEN], uint8_t type) | NimBLEAddress | |
| NimBLEAddress(const std::string &stringAddress, uint8_t type) | NimBLEAddress | |
| NimBLEAddress(const uint64_t &address, uint8_t type) | NimBLEAddress | |
| operator std::string() const | NimBLEAddress | |
| operator uint64_t() const | NimBLEAddress | |
| operator uint64_t() const | NimBLEAddress | |
| operator!=(const NimBLEAddress &rhs) const | NimBLEAddress | |
| operator==(const NimBLEAddress &rhs) const | NimBLEAddress | |
| toString() const | NimBLEAddress | |
| operator==(const NimBLEAddress &rhs) const | NimBLEAddress | |
| reverseByteOrder() | NimBLEAddress | |
| toString() const | NimBLEAddress |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
A BLE device address. More...
+ +#include <NimBLEAddress.h>
Inherits ble_addr_t.
+Public Member Functions
- | NimBLEAddress () | | Create a blank address, i.e. 00:00:00:00:00:00, type 0. | | | NimBLEAddress (ble_addr_t address) | | Create an address from the native NimBLE representation. More... | | | NimBLEAddress (uint8_t address[6], uint8_t type=BLE_ADDR_PUBLIC) | | Constructor for compatibility with bluedroid esp library using native ESP representation. More... | | | NimBLEAddress (const std::string &stringAddress, uint8_t type=BLE_ADDR_PUBLIC) | | Create an address from a hex string. More... | | | NimBLEAddress (const uint64_t &address, uint8_t type=BLE_ADDR_PUBLIC) | | Constructor for address using a hex value. | -Use the same byte order, so use 0xa4c1385def16 for "a4:c1:38:5d:ef:16". More... | bool | equals (const NimBLEAddress &otherAddress) const | | Determine if this address equals another. More... |
+ | NimBLEAddress ()=default | | Create a blank address, i.e. 00:00:00:00:00:00, type 0. | | | NimBLEAddress (const ble_addr_t address) | | Create an address from the native NimBLE representation. | | | NimBLEAddress (const uint8_t address[BLE_DEV_ADDR_LEN], uint8_t type) | | Constructor for compatibility with bluedroid esp library using native ESP representation. | | | NimBLEAddress (const std::string &stringAddress, uint8_t type) | | Create an address from a hex string. | | | NimBLEAddress (const uint64_t &address, uint8_t type) | | Constructor for address using a hex value. | +Use the same byte order, so use 0xa4c1385def16 for "a4:c1:38:5d:ef:16". | bool | isRpa () const | | Determine if this address is a Resolvable Private Address. | | bool | isNrpa () const | | Determine if this address is a Non-Resolvable Private Address. | | bool | isStatic () const | | Determine if this address is a Static Address. | | bool | isPublic () const | | Determine if this address is a Public Address. | | bool | isNull () const | | Determine if this address is a NULL Address. | | bool | equals (const NimBLEAddress &otherAddress) const | | const uint8_t * | getNative () const | | Get the native representation of the address. More... | | std::string | toString () const | | Convert a BLE address to a string. More... | const ble_addr_t * | getBase () const | | Get the NimBLE base struct of the address. | | std::string | toString () const | | uint8_t | getType () const | | Get the address type. More... | uint8_t | getType () const | |
-bool | operator== (const NimBLEAddress &rhs) const | const uint8_t * | getVal () const | | Get the address value. | | const NimBLEAddress & | reverseByteOrder () | | Reverse the byte order of the address. | | |
-bool | operator!= (const NimBLEAddress &rhs) const | | | operator std::string () const | | Convienience operator to convert this address to string representation. More... | | operator std::string () const | |
- | operator uint64_t () const | | Determine if this address equals another. | Convert a BLE address to a string. | Get the address type. | +bool | operator== (const NimBLEAddress &rhs) const | Convenience operator to check if this address is equal to another. | +bool | operator!= (const NimBLEAddress &rhs) const | Convenience operator to check if this address is not equal to another. | Convenience operator to convert this address to string representation. | + | operator uint64_t () const | Convenience operator to convert the native address representation to uint_64. | |||||||||||||||||||||||||||||||||||||
A BLE device address.
Every BLE device has a unique address which can be used to identify it and form connections.
BLE_ADDR_PUBLIC | [in] | address | A uint8_t[6] or esp_bd_addr_t containing the address. |
| [in] | type | The type of the address. |
| [in] | type | The type of the address should be one of:
|
BLE_ADDR_PUBLIC which is 17 characters in length.
-which is 17 characters in length.
| [in] | stringAddress | The hex string representation of the address. |
| [in] | type | The type of the address. |
| [in] | addr | The hex string representation of the address. |
| [in] | type | The type of the address, should be one of:
|
BLE_ADDR_PUBLIC | [in] | address | uint64_t containing the address. |
| [in] | type | The type of the address. |
| [in] | type | The type of the address should be one of:
|
| const uint8_t * NimBLEAddress::getNative | +const ble_addr_t * NimBLEAddress::getBase | ( | ) | const | @@ -327,13 +369,13 @@ Use the same byte order, so use 0xa4c1385def16 for "a4:c1:38:5d:ef:16".
Get the native representation of the address.
-Get the NimBLE base struct of the address.
+| const uint8_t * NimBLEAddress::getVal | +( | +) | +const | +
Get the address value.
+| bool NimBLEAddress::isNrpa | +( | +) | +const | +
Determine if this address is a Non-Resolvable Private Address.
+| bool NimBLEAddress::isNull | +( | +) | +const | +
Determine if this address is a NULL Address.
+| bool NimBLEAddress::isPublic | +( | +) | +const | +
Determine if this address is a Public Address.
+| bool NimBLEAddress::isRpa | +( | +) | +const | +
Determine if this address is a Resolvable Private Address.
+| bool NimBLEAddress::isStatic | +( | +) | +const | +
Determine if this address is a Static Address.
+Convienience operator to convert this address to string representation.
-This allows passing NimBLEAddress to functions that accept std::string and/or or it's methods as a parameter.
+Convenience operator to convert this address to string representation.
+This allows passing NimBLEAddress to functions that accept std::string and/or it's methods as a parameter.
| const NimBLEAddress & NimBLEAddress::reverseByteOrder | +( | +) | ++ |
Reverse the byte order of the address.
+Convert a BLE address to a string.
-A string representation of an address is in the format:
- 1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
This is the complete list of members for NimBLEAdvertisedDevice, including all inherited members.
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
A representation of a BLE advertised device found by a scan. More...
+ +#include <NimBLEAdvertisedDevice.h>
+Public Member Functions
- | NimBLEAdvertisedDevice () | | Constructor. | | NimBLEAddress | getAddress () | | Get the address of the advertising device. More... | | uint8_t | getAdvType () | | Get the advertisement type. More... | | uint16_t | getAppearance () | | Get the appearance. More... | | uint16_t | getAdvInterval () | | Get the advertisement interval. More... | | uint16_t | getMinInterval () | | Get the preferred min connection interval. More... | | uint16_t | getMaxInterval () | | Get the preferred max connection interval. More... | | std::string | getManufacturerData () | | Get the manufacturer data. More... | | std::string | getURI () | | Get the URI from the advertisement. More... | | template<typename T > | T | getManufacturerData (bool skipSizeCheck=false) | | A template to convert the service data to <type>. More... | | std::string | getName () | | Get the advertised name. More... | | int | getRSSI () | | Get the RSSI. More... | | NimBLEScan * | getScan () | | Get the scan object that created this advertised device. More... | | uint8_t | getServiceDataCount () | | Get the count of advertised service data UUIDS. More... | | std::string | getServiceData (uint8_t index=0) | | Get the service data. More... | | std::string | getServiceData (const NimBLEUUID &uuid) | | Get the service data. More... | | template<typename T > | T | getServiceData (uint8_t index=0, bool skipSizeCheck=false) | | A template to convert the service data to | <type>. More... | template<typename T > | T | getServiceData (const NimBLEUUID &uuid, bool skipSizeCheck=false) | | A template to convert the service data to | <type>. More... | NimBLEUUID | getServiceDataUUID (uint8_t index=0) | | Get the UUID of the service data at the index. More... | | NimBLEUUID | getServiceUUID (uint8_t index=0) | | Get the Service UUID. More... | | uint8_t | getServiceUUIDCount () | | Get the number of services advertised. More... | | NimBLEAddress | getTargetAddress (uint8_t index=0) | | Get the target address at the index. More... | | uint8_t | getTargetAddressCount () | | Get the number of target addresses. More... | | int8_t | getTXPower () | | Get the TX Power. More... | | uint8_t * | getPayload () | | Get the payload advertised by the device. More... | | uint8_t | getAdvLength () | | Get the length of the advertisement data in the payload. More... | | size_t | getPayloadLength () | | Get the length of the payload advertised by the device. More... | | uint8_t | getAddressType () | | Get the advertised device address type. More... | | time_t | getTimestamp () | | Get the timeStamp of when the device last advertised. More... | | bool | isAdvertisingService (const NimBLEUUID &uuid) | | Check advertised services for existence of the required UUID. More... | | bool | haveAppearance () | | Does this advertisement have an appearance value? More... | | bool | haveManufacturerData () | | Does this advertisement have manufacturer data? More... | | bool | haveName () | | Does this advertisement have a name value? More... | | bool | haveRSSI () | | Does this advertisement have a signal strength value? More... | | bool | haveServiceData () | | Does this advertisement have a service data value? More... | | bool | haveServiceUUID () | | Does this advertisement have a service UUID value? More... | | bool | haveTXPower () | | Does this advertisement have a transmission power value? More... | | bool | haveConnParams () | | Does this advertisement have preferred connection parameters? More... | | bool | haveAdvInterval () | | Does this advertisement have have the advertising interval? More... | | bool | haveTargetAddress () | | Does the advertisement contain a target address? More... | | bool | haveURI () | | Does this advertisement have a URI? More... | | std::string | toString () | | Create a string representation of this device. More... | | bool | isConnectable () | | Check if this device is advertising as connectable. More... | | bool | isLegacyAdvertisement () | | Check if this advertisement is a legacy or extended type. More... | | uint8_t | getSetId () | | Get the set ID of the extended advertisement. More... | | uint8_t | getPrimaryPhy () | | Get the primary PHY used by this advertisement. More... | | uint8_t | getSecondaryPhy () | | Get the primary PHY used by this advertisement. More... | | uint16_t | getPeriodicInterval () | | Get the periodic interval of the advertisement. More... | | uint8_t | getAdvType () const | | Get the advertisement type. | | uint8_t | getAdvFlags () const | | Get the advertisement flags. | | uint16_t | getAppearance () const | | Get the appearance. | | uint16_t | getAdvInterval () const | | Get the advertisement interval. | | uint16_t | getMinInterval () const | | Get the preferred min connection interval. | | uint16_t | getMaxInterval () const | | Get the preferred max connection interval. | | uint8_t | getManufacturerDataCount () const | | Get the count of manufacturer data sets. | | const NimBLEAddress & | getAddress () const | | Get the address of the advertising device. | | std::string | getManufacturerData (uint8_t index=0) const | | Get the manufacturer data. | | std::string | getURI () const | | Get the URI from the advertisement. | | std::string | getPayloadByType (uint16_t type, uint8_t index=0) const | | Get the data from any type available in the advertisement. | | std::string | getName () const | | Get the advertised name. | | int8_t | getRSSI () const | | Get the RSSI. | | NimBLEScan * | getScan () const | | Get the scan object that created this advertised device. | | uint8_t | getServiceDataCount () const | | Get the count of advertised service data UUIDS. | | std::string | getServiceData (uint8_t index=0) const | | Get the service data. | | std::string | getServiceData (const NimBLEUUID &uuid) const | | Get the service data. | | NimBLEUUID | getServiceDataUUID (uint8_t index=0) const | | Get the UUID of the service data at the index. | | NimBLEUUID | getServiceUUID (uint8_t index=0) const | | Get the Service UUID. | | uint8_t | getServiceUUIDCount () const | | Get the number of services advertised. | | NimBLEAddress | getTargetAddress (uint8_t index=0) const | | Get the target address at the index. | | uint8_t | getTargetAddressCount () const | | Get the number of target addresses. | | int8_t | getTXPower () const | | Get the TX Power. | | uint8_t | getAdvLength () const | | Get the length of the advertisement data in the payload. | | uint8_t | getAddressType () const | | Get the advertised device address type. | | bool | isAdvertisingService (const NimBLEUUID &uuid) const | | Check advertised services for existence of the required UUID. | | bool | haveAppearance () const | | Does this advertisement have an appearance value? | | bool | haveManufacturerData () const | | Does this advertisement have manufacturer data? | | bool | haveName () const | | Does this advertisement have a name value? | | bool | haveServiceData () const | | Does this advertisement have a service data value? | | bool | haveServiceUUID () const | | Does this advertisement have a service UUID value? | | bool | haveTXPower () const | | Does this advertisement have a transmission power value? | | bool | haveConnParams () const | | Does this advertisement have preferred connection parameters? | | bool | haveAdvInterval () const | | Does this advertisement have have the advertising interval? | | bool | haveTargetAddress () const | | Does the advertisement contain a target address? | | bool | haveURI () const | | Does this advertisement have a URI? | | bool | haveType (uint16_t type) const | | Does this advertisement have a adv type | type? | std::string | toString () const | | Create a string representation of this device. | | bool | isConnectable () const | | Check if this device is advertising as connectable. | | bool | isScannable () const | | Check if this device is advertising as scannable. | | bool | isLegacyAdvertisement () const | | Check if this advertisement is a legacy or extended type. | | uint8_t | getSetId () const | | Get the set ID of the extended advertisement. | | uint8_t | getPrimaryPhy () const | | Get the primary PHY used by this advertisement. | | uint8_t | getSecondaryPhy () const | | Get the primary PHY used by this advertisement. | | uint16_t | getPeriodicInterval () const | | Get the periodic interval of the advertisement. | | const std::vector< uint8_t > & | getPayload () const | | Get the payload advertised by the device. | | const std::vector< uint8_t >::const_iterator | begin () const | | Get the begin iterator for the payload. | | const std::vector< uint8_t >::const_iterator | end () const | | Get the end iterator for the payload. | | template<typename T > | T | getManufacturerData (bool skipSizeCheck=false) const | | A template to convert the service data to <type>. | | template<typename T > | T | getServiceData (uint8_t index=0, bool skipSizeCheck=false) const | | A template to convert the service data to | <type>. | template<typename T > | T | getServiceData (const NimBLEUUID &uuid, bool skipSizeCheck=false) const | | A template to convert the service data to | <type>. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
A representation of a BLE advertised device found by a scan.
When we perform a BLE scan, the result will be a set of devices that are advertising. This class provides a model of a detected device.
| NimBLEAddress NimBLEAdvertisedDevice::getAddress | +const std::vector< uint8_t >::const_iterator NimBLEAdvertisedDevice::begin | ( | ) | -+ | const | +
Get the begin iterator for the payload.
+| const std::vector< uint8_t >::const_iterator NimBLEAdvertisedDevice::end | +( | +) | +const | +
Get the end iterator for the payload.
+| const NimBLEAddress & NimBLEAdvertisedDevice::getAddress | +( | +) | +const |
| uint8_t NimBLEAdvertisedDevice::getAdvFlags | +( | +) | +const | +
Get the advertisement flags.
+| std::string NimBLEAdvertisedDevice::getManufacturerData | -( | -) | -- |
Get the manufacturer data.
-false| std::string NimBLEAdvertisedDevice::getManufacturerData | +( | +uint8_t | +index = 0 | ) | +const | +
Get the manufacturer data.
+| [in] | index | The index of the of the manufacturer data set to get. |
| uint8_t NimBLEAdvertisedDevice::getManufacturerDataCount | +( | +) | +const | +
Get the count of manufacturer data sets.
+| uint8_t * NimBLEAdvertisedDevice::getPayload | +const std::vector< uint8_t > & NimBLEAdvertisedDevice::getPayload | ( | ) | -+ | const |
| size_t NimBLEAdvertisedDevice::getPayloadLength | +std::string NimBLEAdvertisedDevice::getPayloadByType | ( | -) | +uint16_t | +type, | +|
| + | uint8_t | +index = 0 |
+ ||||
| + | ) | +const |
Get the length of the payload advertised by the device.
-Get the data from any type available in the advertisement.
+| [in] | type | The advertised data type BLE_HS_ADV_TYPE. |
| [in] | index | The index of the data type. |
type. | int NimBLEAdvertisedDevice::getRSSI | +int8_t NimBLEAdvertisedDevice::getRSSI | ( | ) | -+ | const |
0000| time_t NimBLEAdvertisedDevice::getTimestamp | -( | -) | -- |
Get the timeStamp of when the device last advertised.
-| bool NimBLEAdvertisedDevice::haveRSSI | -( | -) | -- |
Does this advertisement have a signal strength value?
-| bool NimBLEAdvertisedDevice::haveType | +( | +uint16_t | +type | ) | +const | +
Does this advertisement have a adv type type?
type present. | bool NimBLEAdvertisedDevice::isScannable | +( | +) | +const | +
Check if this device is advertising as scannable.
+ 1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
-
- |
-
A callback handler for callbacks associated device scanning. - More...
--Public Member Functions | |
| virtual void | onResult (NimBLEAdvertisedDevice *advertisedDevice)=0 |
| Called when a new scan result is detected. More... | |
A callback handler for callbacks associated device scanning.
-When we are performing a scan as a BLE client, we may wish to know when a new device that is advertising has been found. This class can be sub-classed and registered such that when a scan is performed and a new advertised device has been found, we will be called back to be notified.
-
-
|
- -pure virtual | -
Called when a new scan result is detected.
-As we are scanning, we will find new devices. When found, this call back is invoked with a reference to the device that was found. During any individual scan, a device will only be detected one time.
- - 1.9.1 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
This is the complete list of members for NimBLEAdvertisementData, including all inherited members.
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
Advertisement data set by the programmer to be published by the BLE server. More...
+ +#include <NimBLEAdvertisementData.h>
+Public Member Functionsvoid | setAppearance (uint16_t appearance) | | Set the appearance. More... | | void | setCompleteServices (const NimBLEUUID &uuid) | | Set a single service to advertise as a complete list of services. More... | | void | setCompleteServices16 (const std::vector< NimBLEUUID > &v_uuid) | | Set the complete list of 16 bit services to advertise. More... | | void | setCompleteServices32 (const std::vector< NimBLEUUID > &v_uuid) | | Set the complete list of 32 bit services to advertise. More... | | void | setFlags (uint8_t) | | Set the advertisement flags. More... | | void | setManufacturerData (const std::string &data) | | Set manufacturer specific data. More... | | void | setURI (const std::string &uri) | | Set the URI to advertise. More... | | void | setName (const std::string &name) | | Set the complete name of this device. More... | | void | setPartialServices (const NimBLEUUID &uuid) | | Set a single service to advertise as a partial list of services. More... | | void | setPartialServices16 (const std::vector< NimBLEUUID > &v_uuid) | | Set the partial list of services to advertise. More... | | void | setPartialServices32 (const std::vector< NimBLEUUID > &v_uuid) | | Set the partial list of services to advertise. More... | | void | setServiceData (const NimBLEUUID &uuid, const std::string &data) | | Set the service data (UUID + data) More... | | void | setShortName (const std::string &name) | | Set the short name. More... | | void | addData (const std::string &data) | | Add data to the payload to be advertised. More... | | void | addData (char *data, size_t length) | | Add data to the payload to be advertised. More... | |
-void | addTxPower () | | Adds Tx power level to the advertisement data. | | void | setPreferredParams (uint16_t min, uint16_t max) | | Set the preferred connection interval parameters. More... | | std::string | getPayload () | | Retrieve the payload that is to be advertised. More... | | bool | addData (const uint8_t *data, size_t length) | | Add data to the payload to be advertised. | | bool | addData (const std::vector< uint8_t > &data) | | Add data to the payload to be advertised. | | bool | setAppearance (uint16_t appearance) | | Set the appearance. | | bool | setFlags (uint8_t) | | Set the advertisement flags. | | bool | addTxPower () | | Adds Tx power level to the advertisement data. | | bool | setPreferredParams (uint16_t minInterval, uint16_t maxInterval) | | Set the preferred min and max connection intervals to advertise. | | bool | addServiceUUID (const NimBLEUUID &serviceUUID) | | Add a service uuid to exposed list of services. | | bool | addServiceUUID (const char *serviceUUID) | | Add a service uuid to exposed list of services. | | bool | removeServiceUUID (const NimBLEUUID &serviceUUID) | | Remove a service UUID from the advertisement. | | bool | removeServiceUUID (const char *serviceUUID) | | Remove a service UUID from the advertisement. | |
+bool | removeServices () | | Remove all service UUIDs from the advertisement. | | bool | setManufacturerData (const uint8_t *data, size_t length) | | Set manufacturer specific data. | | bool | setManufacturerData (const std::string &data) | | Set manufacturer specific data. | | bool | setManufacturerData (const std::vector< uint8_t > &data) | | Set manufacturer specific data. | | bool | setURI (const std::string &uri) | | Set the URI to advertise. | | bool | setName (const std::string &name, bool isComplete=true) | | Set the complete name of this device. | | bool | setShortName (const std::string &name) | | Set the short name. | | bool | setCompleteServices (const NimBLEUUID &uuid) | | Set a single service to advertise as a complete list of services. | | bool | setCompleteServices16 (const std::vector< NimBLEUUID > &uuids) | | Set the complete list of 16 bit services to advertise. | | bool | setCompleteServices32 (const std::vector< NimBLEUUID > &uuids) | | Set the complete list of 32 bit services to advertise. | | bool | setPartialServices (const NimBLEUUID &uuid) | | Set a single service to advertise as a partial list of services. | | bool | setPartialServices16 (const std::vector< NimBLEUUID > &uuids) | | Set the partial list of services to advertise. | | bool | setPartialServices32 (const std::vector< NimBLEUUID > &uuids) | | Set the partial list of services to advertise. | | bool | setServiceData (const NimBLEUUID &uuid, const uint8_t *data, size_t length) | | Set the service data advertised for the UUID. | | bool | setServiceData (const NimBLEUUID &uuid, const std::string &data) | | Set the service data (UUID + data) | | bool | setServiceData (const NimBLEUUID &uuid, const std::vector< uint8_t > &data) | | Set the service data advertised for the UUID. | | bool | removeData (uint8_t type) | | Remove data from the advertisement data. | |
+void | clearData () | | Clear the advertisement data for reuse. | | int | getDataLocation (uint8_t type) const | | Get the location of the data in the payload. | | std::string | toString () const | | Get the string representation of the advertisement data. | | std::vector< uint8_t > | getPayload () const | | Retrieve the payload that is to be advertised. | | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Advertisement data set by the programmer to be published by the BLE server.
| void NimBLEAdvertisementData::addData | +bool NimBLEAdvertisementData::addData | ( | -char * | +const std::vector< uint8_t > & | +data | ) | ++ |
Add data to the payload to be advertised.
+| [in] | data | The data to be added to the payload. |
| uint16_t NimBLECharacteristic::getHandle | -( | -) | -- |
Get the handle of the characteristic.
-| size_t NimBLECharacteristic::getSubscribedCount | -( | -) | -- |
Get the number of clients subscribed to the characteristic.
-| NimBLEUUID NimBLECharacteristic::getUUID | -( | -) | -- |
Get the UUID of the characteristic.
-| NimBLEAttValue NimBLECharacteristic::getValue | -( | -time_t * | -timestamp = nullptr | ) | -- |
Retrieve the current value of the characteristic.
-| T NimBLECharacteristic::getValue | -( | -time_t * | -timestamp = nullptr, |
-
| - | - | bool | -skipSizeCheck = false |
-
| - | ) | -- |
Template to convert the characteristic data to <type>.
-| T | The type to convert the data to. |
| [in] | timestamp | (Optional) A pointer to a time_t struct to store the time the value was read. |
| [in] | skipSizeCheck | (Optional) If true it will skip checking if the data size is less than sizeof(<type>). |
sizeof(<type>).Use: getValue<type>(×tamp, skipSizeCheck);
| void NimBLECharacteristic::indicate | -( | -const std::vector< uint8_t > & | -value | ) | -- |
Send an indication.
-| [in] | value | A std::vector<uint8_t> containing the value to send as the notification value. |
-
|
@@ -733,125 +573,19 @@ template<typename T >
Template to send an indication from a class type that has a c_str() and length() method.
-| T | The a reference to a class containing the data to send. |
Template to send a indication with a value from a class that has a c_str() and length() method.
| [in] | value | The <type>value to set. |
Only used if the <type> has a c_str() method.
| void NimBLECharacteristic::indicate | -( | -const uint8_t * | -value, | -
| - | - | size_t | -length | -
| - | ) | -- |
Send an indication.
-| [in] | value | A pointer to the data to send. |
| [in] | length | The length of the data to send. |
| [in] | s | The value to send. |
| [in] | connHandle | Optional, a connection handle to send the notification to. |
| void NimBLECharacteristic::notify | -( | -bool | -is_notification = true | ) | -- |
Send a notification or indication.
-| [in] | is_notification | if true sends a notification, false sends an indication. |
| void NimBLECharacteristic::notify | -( | -const std::vector< uint8_t > & | -value, | -
| - | - | bool | -is_notification = true |
-
| - | ) | -- |
Send a notification or indication.
-| [in] | value | A std::vector<uint8_t> containing the value to send as the notification value. |
| [in] | is_notification | if true sends a notification, false sends an indication. |
| void NimBLECharacteristic::notify | +bool NimBLECharacteristic::indicate | ( | const T & | -value, | +v, |
| - | bool | -is_notification = true |
+ uint16_t | +connHandle = BLE_HS_CONN_HANDLE_NONE |
|
| ) | -+ | const |
Template to send a notification from a class type that has a c_str() and length() method.
-| T | The a reference to a class containing the data to send. |
Template to send an indication with a value from a struct or array.
| [in] | value | The <type>value to set. |
| [in] | is_notification | if true sends a notification, false sends an indication. |
| [in] | v | The value to send. |
| [in] | connHandle | Optional, a connection handle to send the notification to. |
Only used if the <type> has a c_str() method.
<type> size must be evaluatable by sizeof().
+
|
+ +inline | +
Template to send a indication with a value from a class that has a data() and size() method.
+| [in] | v | The value to send. |
| [in] | connHandle | Optional, a connection handle to send the notification to. |
| void NimBLECharacteristic::notify | +bool NimBLECharacteristic::indicate | ( | const uint8_t * | value, | @@ -925,31 +700,273 @@ template<typename T >|
| - | bool | -is_notification = true |
+ uint16_t | +connHandle = BLE_HS_CONN_HANDLE_NONE |
|
| ) | -+ | const |
Send a notification or indication.
+Send an indication.
| [in] | value | A pointer to the data to send. |
| [in] | length | The length of the data to send. |
| [in] | is_notification | if true sends a notification, false sends an indication. |
| [in] | connHandle | Connection handle to send an individual indication, or BLE_HS_CONN_HANDLE_NONE to send the indication to all subscribed clients. |
| bool NimBLECharacteristic::indicate | +( | +uint16_t | +connHandle = BLE_HS_CONN_HANDLE_NONE | ) | +const | +
Send an indication.
+| [in] | connHandle | Connection handle to send an individual indication, or BLE_HS_CONN_HANDLE_NONE to send the indication to all subscribed clients. |
+
|
+ +inline | +
Template to send a notification with a value from a class that has a c_str() and length() method.
+| [in] | s | The value to send. |
| [in] | connHandle | Optional, a connection handle to send the notification to. |
+
|
+ +inline | +
Template to send a notification with a value from a struct or array.
+| [in] | v | The value to send. |
| [in] | connHandle | Optional, a connection handle to send the notification to. |
<type> size must be evaluatable by sizeof().
+
|
+ +inline | +
Template to send a notification with a value from a class that has a data() and size() method.
+| [in] | v | The value to send. |
| [in] | connHandle | Optional, a connection handle to send the notification to. |
| bool NimBLECharacteristic::notify | +( | +const uint8_t * | +value, | +
| + | + | size_t | +length, | +
| + | + | uint16_t | +connHandle = BLE_HS_CONN_HANDLE_NONE |
+
| + | ) | +const | +
Send a notification.
+| [in] | value | A pointer to the data to send. |
| [in] | length | The length of the data to send. |
| [in] | connHandle | Connection handle to send an individual notification, or BLE_HS_CONN_HANDLE_NONE to send the notification to all subscribed clients. |
| bool NimBLECharacteristic::notify | +( | +uint16_t | +connHandle = BLE_HS_CONN_HANDLE_NONE | ) | +const | +
Send a notification.
+| [in] | connHandle | Connection handle to send an individual notification, or BLE_HS_CONN_HANDLE_NONE to send the notification to all subscribed clients. |
| void NimBLECharacteristic::setValue | -( | -const std::vector< uint8_t > & | -vec | ) | -- |
Set the value of the characteristic from a std::vector<uint8_t>.
-.
| [in] | vec | The std::vector<uint8_t> reference to set the characteristic value from. |
-
|
- -inline | -
Template to set the characteristic value to <type>val.
-| [in] | s | The value to set. |
| void NimBLECharacteristic::setValue | -( | -const uint8_t * | -data, | -
| - | - | size_t | -length | -
| - | ) | -- |
Set the value of the characteristic from a data buffer .
-| [in] | data | The data buffer to set for the characteristic. |
| [in] | length | The number of bytes in the data buffer. |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
This is the complete list of members for NimBLECharacteristicCallbacks, including all inherited members.
| onNotify(NimBLECharacteristic *pCharacteristic) | NimBLECharacteristicCallbacks | virtual |
| onRead(NimBLECharacteristic *pCharacteristic) | NimBLECharacteristicCallbacks | virtual |
| onRead(NimBLECharacteristic *pCharacteristic, ble_gap_conn_desc *desc) | NimBLECharacteristicCallbacks | virtual |
| onStatus(NimBLECharacteristic *pCharacteristic, Status s, int code) | NimBLECharacteristicCallbacks | virtual |
| onSubscribe(NimBLECharacteristic *pCharacteristic, ble_gap_conn_desc *desc, uint16_t subValue) | NimBLECharacteristicCallbacks | virtual |
| onWrite(NimBLECharacteristic *pCharacteristic) | NimBLECharacteristicCallbacks | virtual |
| onWrite(NimBLECharacteristic *pCharacteristic, ble_gap_conn_desc *desc) | NimBLECharacteristicCallbacks | virtual |
| Status enum name | NimBLECharacteristicCallbacks | |
| onRead(NimBLECharacteristic *pCharacteristic, NimBLEConnInfo &connInfo) | NimBLECharacteristicCallbacks | virtual |
| onStatus(NimBLECharacteristic *pCharacteristic, int code) | NimBLECharacteristicCallbacks | virtual |
| onSubscribe(NimBLECharacteristic *pCharacteristic, NimBLEConnInfo &connInfo, uint16_t subValue) | NimBLECharacteristicCallbacks | virtual |
| onWrite(NimBLECharacteristic *pCharacteristic, NimBLEConnInfo &connInfo) | NimBLECharacteristicCallbacks | virtual |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
Callbacks that can be associated with a BLE characteristic to inform of events. More...
+ +#include <NimBLECharacteristic.h>
-Public Types | |
| enum | Status |
| An enum to provide the callback the status of the notification/indication, implemented for backward compatibility. More... | |
+Public Member Functionsvirtual void | onRead (NimBLECharacteristic *pCharacteristic) | | Callback function to support a read request. More... | | virtual void | onRead (NimBLECharacteristic *pCharacteristic, ble_gap_conn_desc *desc) | | Callback function to support a read request. More... | | virtual void | onWrite (NimBLECharacteristic *pCharacteristic) | | Callback function to support a write request. More... | | virtual void | onWrite (NimBLECharacteristic *pCharacteristic, ble_gap_conn_desc *desc) | | Callback function to support a write request. More... | | virtual void | onNotify (NimBLECharacteristic *pCharacteristic) | | Callback function to support a Notify request. More... | | virtual void | onStatus (NimBLECharacteristic *pCharacteristic, Status s, int code) | | Callback function to support a Notify/Indicate Status report. More... | | virtual void | onSubscribe (NimBLECharacteristic *pCharacteristic, ble_gap_conn_desc *desc, uint16_t subValue) | | Callback function called when a client changes subscription status. More... | | virtual void | onRead (NimBLECharacteristic *pCharacteristic, NimBLEConnInfo &connInfo) | | Callback function to support a read request. | | virtual void | onWrite (NimBLECharacteristic *pCharacteristic, NimBLEConnInfo &connInfo) | | Callback function to support a write request. | | virtual void | onStatus (NimBLECharacteristic *pCharacteristic, int code) | | Callback function to support a Notify/Indicate Status report. | | virtual void | onSubscribe (NimBLECharacteristic *pCharacteristic, NimBLEConnInfo &connInfo, uint16_t subValue) | | Callback function called when a client changes subscription status. | | |||||||||||||||
Callbacks that can be associated with a BLE characteristic to inform of events.
When a server application creates a BLE characteristic, we may wish to be informed when there is either a read or write request to the characteristic's value. An application can register a sub-classed instance of this class and will be notified when such an event happens.
-| enum NimBLECharacteristicCallbacks::Status | -
An enum to provide the callback the status of the notification/indication, implemented for backward compatibility.
-
-
|
- -virtual | -
Callback function to support a Notify request.
-| [in] | pCharacteristic | The characteristic that is the source of the event. |
-
|
- -virtual | -
Callback function to support a read request.
-| [in] | pCharacteristic | The characteristic that is the source of the event. |
| [in] | pCharacteristic | The characteristic that is the source of the event. |
| [in] | desc | The connection description struct that is associated with the peer that performed the read. |
| [in] | connInfo | A reference to a NimBLEConnInfo instance containing the peer info. |
| [in] | pCharacteristic | The characteristic that is the source of the event. |
| [in] | s | Status of the notification/indication. |
| [in] | code | Additional return code from the NimBLE stack. |
| [in] | code | Status return code from the NimBLE stack. |
The status code for success is 0 for notifications and BLE_HS_EDONE for indications, any other value is an error.
| [in] | pCharacteristic | The characteristic that is the source of the event. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| [in] | desc | The connection description struct that is associated with the client. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| [in] | connInfo | A reference to a NimBLEConnInfo instance containing the peer info. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| [in] | subValue | The subscription status:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
-
|
- -virtual | -
Callback function to support a write request.
-| [in] | pCharacteristic | The characteristic that is the source of the event. |
| [in] | pCharacteristic | The characteristic that is the source of the event. |
| [in] | desc | The connection description struct that is associated with the peer that performed the write. |
| [in] | connInfo | A reference to a NimBLEConnInfo instance containing the peer info. |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
This is the complete list of members for NimBLEClient, including all inherited members.
| begin() | NimBLEClient | |
| connect(NimBLEAdvertisedDevice *device, bool deleteAttributes=true) | NimBLEClient | |
| connect(const NimBLEAddress &address, bool deleteAttributes=true) | NimBLEClient | |
| connect(bool deleteAttributes=true) | NimBLEClient | |
| deleteService(const NimBLEUUID &uuid) | NimBLEClient | |
| deleteServices() | NimBLEClient | |
| disconnect(uint8_t reason=BLE_ERR_REM_USER_CONN_TERM) | NimBLEClient | |
| discoverAttributes() | NimBLEClient | |
| end() | NimBLEClient | |
| getCharacteristic(const uint16_t handle) | NimBLEClient | |
| getConnId() | NimBLEClient | |
| getConnInfo() | NimBLEClient | |
| getLastError() | NimBLEClient | |
| getMTU() | NimBLEClient | |
| getPeerAddress() | NimBLEClient | |
| getRssi() | NimBLEClient | |
| cancelConnect() const | NimBLEClient | |
| connect(const NimBLEAdvertisedDevice *device, bool deleteAttributes=true, bool asyncConnect=false, bool exchangeMTU=true) | NimBLEClient | |
| connect(const NimBLEAddress &address, bool deleteAttributes=true, bool asyncConnect=false, bool exchangeMTU=true) | NimBLEClient | |
| connect(bool deleteAttributes=true, bool asyncConnect=false, bool exchangeMTU=true) | NimBLEClient | |
| deleteService(const NimBLEUUID &uuid) | NimBLEClient | |
| deleteServices() | NimBLEClient | |
| disconnect(uint8_t reason=BLE_ERR_REM_USER_CONN_TERM) | NimBLEClient | |
| discoverAttributes() | NimBLEClient | |
| end() | NimBLEClient | |
| exchangeMTU() | NimBLEClient | |
| getCharacteristic(uint16_t handle) | NimBLEClient | |
| getConfig() const | NimBLEClient | |
| getConnHandle() const | NimBLEClient | |
| getConnInfo() const | NimBLEClient | |
| getLastError() const | NimBLEClient | |
| getMTU() const | NimBLEClient | |
| getPeerAddress() const | NimBLEClient | |
| getPhy(uint8_t *txPhy, uint8_t *rxPhy) | NimBLEClient | |
| getRssi() const | NimBLEClient | |
| getService(const char *uuid) | NimBLEClient | |
| getService(const NimBLEUUID &uuid) | NimBLEClient | |
| getServices(bool refresh=false) | NimBLEClient | |
| getValue(const NimBLEUUID &serviceUUID, const NimBLEUUID &characteristicUUID) | NimBLEClient | |
| isConnected() | NimBLEClient | |
| secureConnection() | NimBLEClient | |
| getService(const NimBLEUUID &uuid) | NimBLEClient | |
| getServices(bool refresh=false) | NimBLEClient | |
| getValue(const NimBLEUUID &serviceUUID, const NimBLEUUID &characteristicUUID) | NimBLEClient | |
| isConnected() const | NimBLEClient | |
| secureConnection(bool async=false) const | NimBLEClient | |
| setClientCallbacks(NimBLEClientCallbacks *pClientCallbacks, bool deleteCallbacks=true) | NimBLEClient | |
| setConnectionParams(uint16_t minInterval, uint16_t maxInterval, uint16_t latency, uint16_t timeout, uint16_t scanInterval=16, uint16_t scanWindow=16) | NimBLEClient | |
| setConnectPhy(uint8_t mask) | NimBLEClient | |
| setConnectTimeout(uint8_t timeout) | NimBLEClient | |
| setDataLen(uint16_t tx_octets) | NimBLEClient | |
| setPeerAddress(const NimBLEAddress &address) | NimBLEClient | |
| setConfig(Config config) | NimBLEClient | |
| setConnectionParams(uint16_t minInterval, uint16_t maxInterval, uint16_t latency, uint16_t timeout, uint16_t scanInterval=16, uint16_t scanWindow=16) | NimBLEClient | |
| setConnectPhy(uint8_t phyMask) | NimBLEClient | |
| setConnectTimeout(uint32_t timeout) | NimBLEClient | |
| setDataLen(uint16_t txOctets) | NimBLEClient | |
| setPeerAddress(const NimBLEAddress &address) | NimBLEClient | |
| setSelfDelete(bool deleteOnDisconnect, bool deleteOnConnectFail) | NimBLEClient | |
| setValue(const NimBLEUUID &serviceUUID, const NimBLEUUID &characteristicUUID, const NimBLEAttValue &value, bool response=false) | NimBLEClient | |
| toString() | NimBLEClient | |
| updateConnParams(uint16_t minInterval, uint16_t maxInterval, uint16_t latency, uint16_t timeout) | NimBLEClient | |
| toString() const | NimBLEClient | |
| updateConnParams(uint16_t minInterval, uint16_t maxInterval, uint16_t latency, uint16_t timeout) | NimBLEClient | |
| updatePhy(uint8_t txPhysMask, uint8_t rxPhysMask, uint16_t phyOptions=0) | NimBLEClient |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
A model of a BLE client. More...
+ +#include <NimBLEClient.h>
+Public Member Functionsbool | connect (NimBLEAdvertisedDevice *device, bool deleteAttributes=true) | | Connect to an advertising device. More... | | bool | connect (const NimBLEAddress &address, bool deleteAttributes=true) | | Connect to the BLE Server. More... | | bool | connect (bool deleteAttributes=true) | | Connect to the BLE Server. More... | | int | disconnect (uint8_t reason=BLE_ERR_REM_USER_CONN_TERM) | | Disconnect from the peer. More... | |
-NimBLEAddress | getPeerAddress () | | Retrieve the address of the peer. | | void | setPeerAddress (const NimBLEAddress &address) | | Set the peer address. More... | | int | getRssi () | | Ask the BLE server for the RSSI value. More... | | std::vector< NimBLERemoteService * > * | getServices (bool refresh=false) | | Get a pointer to the vector of found services. More... | | std::vector< NimBLERemoteService * >::iterator | begin () | | Get iterator to the beginning of the vector of remote service pointers. More... | bool | connect (const NimBLEAdvertisedDevice *device, bool deleteAttributes=true, bool asyncConnect=false, bool exchangeMTU=true) | | Connect to an advertising device. | | bool | connect (const NimBLEAddress &address, bool deleteAttributes=true, bool asyncConnect=false, bool exchangeMTU=true) | | Connect to a BLE Server by address. | | bool | connect (bool deleteAttributes=true, bool asyncConnect=false, bool exchangeMTU=true) | | Connect to the BLE Server using the address of the last connected device, or the address | +passed to the constructor. | bool | disconnect (uint8_t reason=BLE_ERR_REM_USER_CONN_TERM) | | Disconnect from the peer. | | bool | cancelConnect () const | | Cancel an ongoing connection attempt. | | void | setSelfDelete (bool deleteOnDisconnect, bool deleteOnConnectFail) | | Set or unset a flag to delete this client when disconnected or connection failed. | | NimBLEAddress | getPeerAddress () const | | Retrieve the address of the peer. | | bool | setPeerAddress (const NimBLEAddress &address) | | Set the peer address. | | int | getRssi () const | | Ask the BLE server for the RSSI value. | | bool | isConnected () const | | Are we connected to a server? | | void | setClientCallbacks (NimBLEClientCallbacks *pClientCallbacks, bool deleteCallbacks=true) | | Set the callbacks that will be invoked when events are received. | | std::string | toString () const | | Return a string representation of this client. | | uint16_t | getConnHandle () const | | Get the connection handle for this client. | | uint16_t | getMTU () const | | Get the current mtu of this connection. | | bool | exchangeMTU () | | Begin the MTU exchange process with the server. | | bool | secureConnection (bool async=false) const | | Initiate a secure connection (pair/bond) with the server. | +Called automatically when a characteristic or descriptor requires encryption or authentication to access it. | void | setConnectTimeout (uint32_t timeout) | | Set the timeout to wait for connection attempt to complete. | | bool | setDataLen (uint16_t txOctets) | | Request an update of the data packet length. | | bool | discoverAttributes () | | Retrieves the full database of attributes that the peripheral has available. | | NimBLEConnInfo | getConnInfo () const | | Get detailed information about the current peer connection. | | int | getLastError () const | | Get the last error code reported by the NimBLE host. | | bool | updateConnParams (uint16_t minInterval, uint16_t maxInterval, uint16_t latency, uint16_t timeout) | | Update the connection parameters: | | void | setConnectionParams (uint16_t minInterval, uint16_t maxInterval, uint16_t latency, uint16_t timeout, uint16_t scanInterval=16, uint16_t scanWindow=16) | | Set the connection parameters to use when connecting to a server. | | const std::vector< NimBLERemoteService * > & | getServices (bool refresh=false) | | Get a pointer to the vector of found services. | | std::vector< NimBLERemoteService * >::iterator | begin () | | std::vector< NimBLERemoteService * >::iterator | end () | | Get iterator to the end of the vector of remote service pointers. More... | std::vector< NimBLERemoteService * >::iterator | end () | | NimBLERemoteService * | getService (const char *uuid) | | Get the service BLE Remote Service instance corresponding to the uuid. More... | NimBLERemoteCharacteristic * | getCharacteristic (uint16_t handle) | | Get the remote characteristic with the specified handle. | | NimBLERemoteService * | getService (const char *uuid) | | NimBLERemoteService * | getService (const NimBLEUUID &uuid) | | Get the service object corresponding to the uuid. More... | NimBLERemoteService * | getService (const NimBLEUUID &uuid) | |
-void | deleteServices () | | size_t | deleteService (const NimBLEUUID &uuid) | | Delete service by UUID. More... | size_t | deleteService (const NimBLEUUID &uuid) | | NimBLEAttValue | getValue (const NimBLEUUID &serviceUUID, const NimBLEUUID &characteristicUUID) | | Get the value of a specific characteristic associated with a specific service. More... | NimBLEAttValue | getValue (const NimBLEUUID &serviceUUID, const NimBLEUUID &characteristicUUID) | | bool | setValue (const NimBLEUUID &serviceUUID, const NimBLEUUID &characteristicUUID, const NimBLEAttValue &value, bool response=false) | | Set the value of a specific characteristic associated with a specific service. More... | bool | setValue (const NimBLEUUID &serviceUUID, const NimBLEUUID &characteristicUUID, const NimBLEAttValue &value, bool response=false) | | NimBLERemoteCharacteristic * | getCharacteristic (const uint16_t handle) | | Get the remote characteristic with the specified handle. More... | | bool | isConnected () | | Are we connected to a server? More... | | void | setClientCallbacks (NimBLEClientCallbacks *pClientCallbacks, bool deleteCallbacks=true) | | Set the callbacks that will be invoked when events are received. More... | | std::string | toString () | | Return a string representation of this client. More... | | uint16_t | getConnId () | | Get the connection id for this client. More... | | uint16_t | getMTU () | | Get the current mtu of this connection. More... | | bool | secureConnection () | | Initiate a secure connection (pair/bond) with the server. | -Called automatically when a characteristic or descriptor requires encryption or authentication to access it. More... | void | setConnectTimeout (uint8_t timeout) | | Set the timeout to wait for connection attempt to complete. More... | | void | setConnectionParams (uint16_t minInterval, uint16_t maxInterval, uint16_t latency, uint16_t timeout, uint16_t scanInterval=16, uint16_t scanWindow=16) | | Set the connection parameters to use when connecting to a server. More... | | void | updateConnParams (uint16_t minInterval, uint16_t maxInterval, uint16_t latency, uint16_t timeout) | | Update the connection parameters: More... | | void | setDataLen (uint16_t tx_octets) | | Request an update of the data packet length. More... | | bool | discoverAttributes () | | Retrieves the full database of attributes that the peripheral has available. More... | |
-NimBLEConnInfo | getConnInfo () | | Get detailed information about the current peer connection. | | int | getLastError () | | Get the last error code reported by the NimBLE host. More... | | void | setConnectPhy (uint8_t mask) | | Set the PHY types to use when connecting to a server. More... | | void | setConnectPhy (uint8_t phyMask) | | Set the PHY types to use when connecting to a server. | | bool | updatePhy (uint8_t txPhysMask, uint8_t rxPhysMask, uint16_t phyOptions=0) | | Request a change to the PHY used for this peer connection. | | bool | getPhy (uint8_t *txPhy, uint8_t *rxPhy) | | Get the PHY used for this peer connection. | | Config | getConfig () const | | Get a copy of the clients configuration. | | void | setConfig (Config config) | | Set the client configuration options. | | Get iterator to the beginning of the vector of remote service pointers. | Get iterator to the end of the vector of remote service pointers. | Get the service BLE Remote Service instance corresponding to the uuid. | Get the service object corresponding to the uuid. | +void | deleteServices () | Delete all service objects created by this client and clear the vector. | Delete a service by UUID from the local database to free resources. | Get the value of a specific characteristic associated with a specific service. | Set the value of a specific characteristic associated with a specific service. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
A model of a BLE client.
| bool NimBLEClient::cancelConnect | +( | +) | +const | +
Cancel an ongoing connection attempt.
+truetrue, false, true Connect to the BLE Server.
+Connect to the BLE Server using the address of the last connected device, or the address
+passed to the constructor.
| [in] | deleteAttributes | If true this will delete any attribute objects this client may already -have created and clears the vectors after successful connection. |
| [in] | asyncConnect | If true, the connection will be made asynchronously and this function will return immediately. +If false, this function will block until the connection is established or the connection attempt times out. |
| [in] | exchangeMTU | If true, the client will attempt to exchange MTU with the server after connection. +If false, the client will use the default MTU size and the application will need to call exchangeMTU() later. |
true true, false, true Connect to the BLE Server.
+Connect to a BLE Server by address.
| [in] | address | The address of the server. |
| [in] | deleteAttributes | If true this will delete any attribute objects this client may already -have created and clears the vectors after successful connection. |
| [in] | asyncConnect | If true, the connection will be made asynchronously and this function will return immediately. +If false, this function will block until the connection is established or the connection attempt times out. |
| [in] | exchangeMTU | If true, the client will attempt to exchange MTU with the server after connection. +If false, the client will use the default MTU size and the application will need to call exchangeMTU() later. |
true true, false, true | [in] | device | The device to connect to. |
| [in] | deleteAttributes | If true this will delete any attribute objects this client may already -have created and clears the vectors after successful connection. |
| [in] | asyncConnect | If true, the connection will be made asynchronously and this function will return immediately. +If false, this function will block until the connection is established or the connection attempt times out. |
| [in] | exchangeMTU | If true, the client will attempt to exchange MTU with the server after connection. +If false, the client will use the default MTU size and the application will need to call exchangeMTU() later. |
Delete service by UUID.
+Delete a service by UUID from the local database to free resources.
| [in] | uuid | The UUID of the service to be deleted from the local database. |
| [in] | uuid | The UUID of the service to be deleted. |
| int NimBLEClient::disconnect | +bool NimBLEClient::disconnect | ( | uint8_t | reason = BLE_ERR_REM_USER_CONN_TERM | ) | @@ -366,12 +467,12 @@ have created and clears the vectors after successful connection.
| bool NimBLEClient::exchangeMTU | +( | +) | ++ |
Begin the MTU exchange process with the server.
+| uint16_t NimBLEClient::getConnId | +NimBLEClient::Config NimBLEClient::getConfig | ( | ) | -+ | const |
Get the connection id for this client.
-Get a copy of the clients configuration.
+| uint16_t NimBLEClient::getConnHandle | +( | +) | +const | +
Get the connection handle for this client.
+| NimBLEConnInfo NimBLEClient::getConnInfo | +( | +) | +const | +
Get detailed information about the current peer connection.
+| NimBLEAddress NimBLEClient::getPeerAddress | +( | +) | +const | +
Retrieve the address of the peer.
+| bool NimBLEClient::getPhy | +( | +uint8_t * | +txPhy, | +
| + | + | uint8_t * | +rxPhy | +
| + | ) | ++ |
Get the PHY used for this peer connection.
+| [out] | txPhy | The TX PHY. |
| [out] | rxPhy | The RX PHY. |
Ask the BLE server for the RSSI value.
-| std::vector< NimBLERemoteService * > * NimBLEClient::getServices | +const std::vector< NimBLERemoteService * > & NimBLEClient::getServices | ( | bool | refresh = false | ) | @@ -600,8 +819,8 @@ If false the vector will be returned with the currently stored services. - -( | ) | -+ | const |
falseInitiate a secure connection (pair/bond) with the server.
Called automatically when a characteristic or descriptor requires encryption or authentication to access it.
| [in] | async | If true, the connection will be secured asynchronously and this function will return immediately. +If false, this function will block until the connection is secured or the client disconnects. |
If async=false, this function will block and should not be used in a callback.
| void NimBLEClient::setConfig | +( | +NimBLEClient::Config | +config | ) | ++ |
Set the client configuration options.
+| [in] | config | The config options instance to set the client configuration to. |
Set the timeout to wait for connection attempt to complete.
| [in] | time | The number of seconds before timeout. |
| [in] | time | The number of milliseconds before timeout, default is 30 seconds. |
| void NimBLEClient::setDataLen | +bool NimBLEClient::setDataLen | ( | uint16_t | -tx_octets | ) | +txOctets | ) |
Can only be used after a connection has been established.
Sends a data length update request to the server the client is connected to. The Data Length Extension (DLE) allows to increase the Data Channel Payload from 27 bytes to up to 251 bytes. The server needs to support the Bluetooth 4.2 specifications, to be capable of DLE.
| [in] | tx_octets | The preferred number of payload octets to use (Range 0x001B-0x00FB). |
| [in] | txOctets | The preferred number of payload octets to use (Range 0x001B-0x00FB). |
| void NimBLEClient::setPeerAddress | +bool NimBLEClient::setPeerAddress | ( | const NimBLEAddress & | address | ) | @@ -892,11 +1146,49 @@ The available bits are:
| void NimBLEClient::setSelfDelete | +( | +bool | +deleteOnDisconnect, | +
| + | + | bool | +deleteOnConnectFail | +
| + | ) | ++ |
Set or unset a flag to delete this client when disconnected or connection failed.
+| [in] | deleteOnDisconnect | Set the client to self delete when disconnected. |
| [in] | deleteOnConnectFail | Set the client to self delete when a connection attempt fails. |
| void NimBLEClient::updateConnParams | +bool NimBLEClient::updateConnParams | ( | uint16_t | minInterval, | @@ -1019,6 +1311,68 @@ The available bits are:||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| bool NimBLEClient::updatePhy | +( | +uint8_t | +txPhyMask, | +
| + | + | uint8_t | +rxPhyMask, | +
| + | + | uint16_t | +phyOptions = 0 |
+
| + | ) | ++ |
Request a change to the PHY used for this peer connection.
+| [in] | txPhyMask | TX PHY. Can be mask of following:
|
| [in] | rxPhyMask | RX PHY. Can be mask of following:
|
| phyOptions | Additional PHY options. Valid values are:
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
This is the complete list of members for NimBLEClientCallbacks, including all inherited members.
| onAuthenticationComplete(ble_gap_conn_desc *desc) | NimBLEClientCallbacks | virtual |
| onConfirmPIN(uint32_t pin) | NimBLEClientCallbacks | virtual |
| onAuthenticationComplete(NimBLEConnInfo &connInfo) | NimBLEClientCallbacks | virtual |
| onConfirmPasskey(NimBLEConnInfo &connInfo, uint32_t pin) | NimBLEClientCallbacks | virtual |
| onConnect(NimBLEClient *pClient) | NimBLEClientCallbacks | virtual |
| onConnParamsUpdateRequest(NimBLEClient *pClient, const ble_gap_upd_params *params) | NimBLEClientCallbacks | virtual |
| onDisconnect(NimBLEClient *pClient) | NimBLEClientCallbacks | virtual |
| onPassKeyRequest() | NimBLEClientCallbacks | virtual |
| onConnectFail(NimBLEClient *pClient, int reason) | NimBLEClientCallbacks | virtual |
| onConnParamsUpdateRequest(NimBLEClient *pClient, const ble_gap_upd_params *params) | NimBLEClientCallbacks | virtual |
| onDisconnect(NimBLEClient *pClient, int reason) | NimBLEClientCallbacks | virtual |
| onIdentity(NimBLEConnInfo &connInfo) | NimBLEClientCallbacks | virtual |
| onMTUChange(NimBLEClient *pClient, uint16_t MTU) | NimBLEClientCallbacks | virtual |
| onPassKeyEntry(NimBLEConnInfo &connInfo) | NimBLEClientCallbacks | virtual |
| onPhyUpdate(NimBLEClient *pClient, uint8_t txPhy, uint8_t rxPhy) | NimBLEClientCallbacks | virtual |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
Callbacks associated with a BLE client. More...
+ +#include <NimBLEClient.h>
+Public Member Functionsvirtual void | onConnect (NimBLEClient *pClient) | | Called after client connects. More... | virtual void | onConnect (NimBLEClient *pClient) | | virtual void | onDisconnect (NimBLEClient *pClient) | | Called when disconnected from the server. More... | | virtual bool | onConnParamsUpdateRequest (NimBLEClient *pClient, const ble_gap_upd_params *params) | | Called when server requests to update the connection parameters. More... | virtual void | onConnectFail (NimBLEClient *pClient, int reason) | | Called when a connection attempt fails. | | virtual void | onDisconnect (NimBLEClient *pClient, int reason) | | Called when disconnected from the server. | | virtual bool | onConnParamsUpdateRequest (NimBLEClient *pClient, const ble_gap_upd_params *params) | | virtual uint32_t | onPassKeyRequest () | | Called when server requests a passkey for pairing. More... | | virtual void | onAuthenticationComplete (ble_gap_conn_desc *desc) | | Called when the pairing procedure is complete. More... | | virtual bool | onConfirmPIN (uint32_t pin) | | Called when using numeric comparision for pairing. More... | | virtual void | onPassKeyEntry (NimBLEConnInfo &connInfo) | | Called when server requests a passkey for pairing. | | virtual void | onAuthenticationComplete (NimBLEConnInfo &connInfo) | | Called when the pairing procedure is complete. | | virtual void | onConfirmPasskey (NimBLEConnInfo &connInfo, uint32_t pin) | | Called when using numeric comparision for pairing. | | virtual void | onIdentity (NimBLEConnInfo &connInfo) | | Called when the peer identity address is resolved. | | virtual void | onMTUChange (NimBLEClient *pClient, uint16_t MTU) | | Called when the connection MTU changes. | | virtual void | onPhyUpdate (NimBLEClient *pClient, uint8_t txPhy, uint8_t rxPhy) | | Called when the PHY update procedure is complete. | | Called after client connects. | Called when server requests to update the connection parameters. | ||||||||||||||||||||
Callbacks associated with a BLE client.
Called when the pairing procedure is complete.
| [in] | desc | A reference to a NimBLEConnInfo instance containing the peer info. + |
| [in] | connInfo | A reference to a NimBLEConnInfo instance containing the peer info. This can be used to check the status of the connection encryption/pairing. |
| bool NimBLEClientCallbacks::onConfirmPIN | +void NimBLEClientCallbacks::onConfirmPasskey | ( | -uint32_t | -pin | ) | +NimBLEConnInfo & | +connInfo, | +
| + | uint32_t | +pin | +|||||
| + | ) | +
Called when using numeric comparision for pairing.
| [in] | connInfo | A reference to a NimBLEConnInfo instance containing the peer info. |
| [in] | pin | The pin to compare with the server. |
Called after client connects.
| [in] | pClient | A pointer to the calling client object. |
| [in] | pClient | A pointer to the connecting client object. |
+
|
+ +virtual | +
Called when a connection attempt fails.
+| [in] | pClient | A pointer to the connecting client object. |
| [in] | reason | Contains the reason code for the connection failure. |
| [in] | pClient | A pointer to the calling client object. |
| [in] | reason | Contains the reason code for the disconnection. |
| uint32_t NimBLEClientCallbacks::onPassKeyRequest | +void NimBLEClientCallbacks::onIdentity | ( | -) | +NimBLEConnInfo & | +connInfo | ) | ++ |
Called when the peer identity address is resolved.
+| [in] | connInfo | A reference to a NimBLEConnInfo instance with information |
+
|
+ +virtual | +
Called when the connection MTU changes.
+| [in] | pClient | A pointer to the client that the MTU change is associated with. |
| [in] | MTU | The new MTU value. about the peer connection parameters. |
+
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| [in] | connInfo | A reference to a NimBLEConnInfo instance containing the peer info. |
+
|
+ +virtual | +
Called when the PHY update procedure is complete.
+| [in] | pClient | A pointer to the client whose PHY was updated. about the peer connection parameters. |
| [in] | txPhy | The transmit PHY. |
| [in] | rxPhy | The receive PHY. Possible values:
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
This is the complete list of members for NimBLEConnInfo, including all inherited members.
| getAddress() | NimBLEConnInfo | inline |
| getConnHandle() | NimBLEConnInfo | inline |
| getConnInterval() | NimBLEConnInfo | inline |
| getConnLatency() | NimBLEConnInfo | inline |
| getConnTimeout() | NimBLEConnInfo | inline |
| getIdAddress() | NimBLEConnInfo | inline |
| getMTU() | NimBLEConnInfo | inline |
| getSecKeySize() | NimBLEConnInfo | inline |
| isAuthenticated() | NimBLEConnInfo | inline |
| isBonded() | NimBLEConnInfo | inline |
| isEncrypted() | NimBLEConnInfo | inline |
| isMaster() | NimBLEConnInfo | inline |
| isSlave() | NimBLEConnInfo | inline |
| getAddress() const | NimBLEConnInfo | inline |
| getConnHandle() const | NimBLEConnInfo | inline |
| getConnInterval() const | NimBLEConnInfo | inline |
| getConnLatency() const | NimBLEConnInfo | inline |
| getConnTimeout() const | NimBLEConnInfo | inline |
| getIdAddress() const | NimBLEConnInfo | inline |
| getMTU() const | NimBLEConnInfo | inline |
| getSecKeySize() const | NimBLEConnInfo | inline |
| isAuthenticated() const | NimBLEConnInfo | inline |
| isBonded() const | NimBLEConnInfo | inline |
| isEncrypted() const | NimBLEConnInfo | inline |
| isMaster() const | NimBLEConnInfo | inline |
| isSlave() const | NimBLEConnInfo | inline |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
Connection information. More...
+ +#include <NimBLEConnInfo.h>
+Public Member Functions
-NimBLEAddress | getAddress () | | Gets the over-the-air address of the connected peer. | |
-NimBLEAddress | getIdAddress () | | Gets the ID address of the connected peer. | |
-uint16_t | getConnHandle () | | Gets the connection handle of the connected peer. | |
-uint16_t | getConnInterval () | | Gets the connection interval for this connection (in 1.25ms units) | |
-uint16_t | getConnTimeout () | | Gets the supervision timeout for this connection (in 10ms units) | |
-uint16_t | getConnLatency () | | Gets the allowable latency for this connection (unit = number of intervals) | |
-uint16_t | getMTU () | | Gets the maximum transmission unit size for this connection (in bytes) | |
-bool | isMaster () | | Check if we are in the master role in this connection. | |
-bool | isSlave () | | Check if we are in the slave role in this connection. | |
-bool | isBonded () | | Check if we are connected to a bonded peer. | |
-bool | isEncrypted () | | Check if the connection in encrypted. | |
-bool | isAuthenticated () | | Check if the the connection has been authenticated. | |
-uint8_t | getSecKeySize () | | Gets the key size used to encrypt the connection. | |
+NimBLEAddress | getAddress () const | | Gets the over-the-air address of the connected peer. | |
+NimBLEAddress | getIdAddress () const | | Gets the ID address of the connected peer. | |
+uint16_t | getConnHandle () const | | Gets the connection handle (also known as the connection id) of the connected peer. | |
+uint16_t | getConnInterval () const | | Gets the connection interval for this connection (in 1.25ms units) | |
+uint16_t | getConnTimeout () const | | Gets the supervision timeout for this connection (in 10ms units) | |
+uint16_t | getConnLatency () const | | Gets the allowable latency for this connection (unit = number of intervals) | |
+uint16_t | getMTU () const | | Gets the maximum transmission unit size for this connection (in bytes) | |
+bool | isMaster () const | | Check if we are in the master role in this connection. | |
+bool | isSlave () const | | Check if we are in the slave role in this connection. | |
+bool | isBonded () const | | Check if we are connected to a bonded peer. | |
+bool | isEncrypted () const | | Check if the connection in encrypted. | |
+bool | isAuthenticated () const | | Check if the the connection has been authenticated. | |
+uint8_t | getSecKeySize () const | | Gets the key size used to encrypt the connection. | | ||||||||||||||||||||||||||||||
Connection information.
@@ -156,7 +164,7 @@ uint8_t 1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
This is the complete list of members for NimBLEDescriptor, including all inherited members.
| getCharacteristic() | NimBLEDescriptor | |
| getHandle() | NimBLEDescriptor | |
| getLength() | NimBLEDescriptor | |
| getStringValue() | NimBLEDescriptor | |
| getUUID() | NimBLEDescriptor | |
| getValue(time_t *timestamp=nullptr) | NimBLEDescriptor | |
| getValue(time_t *timestamp=nullptr, bool skipSizeCheck=false) | NimBLEDescriptor | inline |
| NimBLEDescriptor(const char *uuid, uint16_t properties, uint16_t max_len, NimBLECharacteristic *pCharacteristic=nullptr) | NimBLEDescriptor | |
| NimBLEDescriptor(NimBLEUUID uuid, uint16_t properties, uint16_t max_len, NimBLECharacteristic *pCharacteristic=nullptr) | NimBLEDescriptor | |
| setCallbacks(NimBLEDescriptorCallbacks *pCallbacks) | NimBLEDescriptor | |
| setValue(const uint8_t *data, size_t size) | NimBLEDescriptor | |
| setValue(const std::vector< uint8_t > &vec) | NimBLEDescriptor | |
| setValue(const T &s) | NimBLEDescriptor | inline |
| toString() | NimBLEDescriptor | |
| ~NimBLEDescriptor() | NimBLEDescriptor | |
| getCharacteristic() const | NimBLEDescriptor | |
| getHandle() const | NimBLEAttribute | inline |
| getRemoved() const | NimBLELocalAttribute | inline |
| getUUID() const | NimBLEAttribute | inline |
| NimBLEAttribute(const NimBLEUUID &uuid, uint16_t handle) | NimBLEAttribute | inlineprotected |
| NimBLEDescriptor(const char *uuid, uint16_t properties, uint16_t maxLen, NimBLECharacteristic *pCharacteristic=nullptr) | NimBLEDescriptor | |
| NimBLEDescriptor(const NimBLEUUID &uuid, uint16_t properties, uint16_t maxLen, NimBLECharacteristic *pCharacteristic=nullptr) | NimBLEDescriptor | |
| NimBLELocalAttribute(const NimBLEUUID &uuid, uint16_t handle) | NimBLELocalAttribute | inlineprotected |
| setCallbacks(NimBLEDescriptorCallbacks *pCallbacks) | NimBLEDescriptor | |
| setRemoved(uint8_t removed) | NimBLELocalAttribute | inlineprotected |
| toString() const | NimBLEDescriptor | |
| ~NimBLEAttribute()=default | NimBLEAttribute | protected |
| ~NimBLELocalAttribute()=default | NimBLELocalAttribute | protected |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
A model of a BLE descriptor. More...
+#include <NimBLEDescriptor.h>
Inherits NimBLELocalValueAttribute.
+Inherited by NimBLE2904.
+Public Member Functions | NimBLEDescriptor (const char *uuid, uint16_t properties, uint16_t max_len, NimBLECharacteristic *pCharacteristic=nullptr) | | Construct a descriptor. More... | | | NimBLEDescriptor (NimBLEUUID uuid, uint16_t properties, uint16_t max_len, NimBLECharacteristic *pCharacteristic=nullptr) | | Construct a descriptor. More... | |
- | ~NimBLEDescriptor () | | NimBLEDescriptor destructor. | | uint16_t | getHandle () | | Get the BLE handle for this descriptor. More... | |
-NimBLEUUID | getUUID () | | Get the UUID of the descriptor. | | std::string | toString () | | Return a string representation of the descriptor. More... | | void | setCallbacks (NimBLEDescriptorCallbacks *pCallbacks) | | Set the callback handlers for this descriptor. More... | | NimBLEDescriptor (const char *uuid, uint16_t properties, uint16_t maxLen, NimBLECharacteristic *pCharacteristic=nullptr) | | Construct a descriptor. | | | NimBLEDescriptor (const NimBLEUUID &uuid, uint16_t properties, uint16_t maxLen, NimBLECharacteristic *pCharacteristic=nullptr) | | Construct a descriptor. | | std::string | toString () const | | Return a string representation of the descriptor. | | void | setCallbacks (NimBLEDescriptorCallbacks *pCallbacks) | | NimBLECharacteristic * | getCharacteristic () | | Get the characteristic this descriptor belongs to. More... | | size_t | getLength () | | Get the length of the value of this descriptor. More... | | NimBLEAttValue | getValue (time_t *timestamp=nullptr) | | Get the value of this descriptor. More... | | std::string | getStringValue () | | Get the value of this descriptor as a string. More... | | void | setValue (const uint8_t *data, size_t size) | | Set the value of the descriptor. More... | | void | setValue (const std::vector< uint8_t > &vec) | | Set the value of the descriptor from a | std::vector<uint8_t>.-. More... | template<typename T > | void | setValue (const T &s) | | Template to set the characteristic value to <type>val. More... | | template<typename T > | T | getValue (time_t *timestamp=nullptr, bool skipSizeCheck=false) | | Template to convert the descriptor data to <type>. More... | | NimBLECharacteristic * | getCharacteristic () const | | Get the characteristic this descriptor belongs to. | | Set the callback handlers for this descriptor. | ||||||||||||||||||||||||||
A model of a BLE descriptor.
| uint16_t NimBLEDescriptor::getHandle | -( | -) | -- |
Get the BLE handle for this descriptor.
-| size_t NimBLEDescriptor::getLength | -( | -) | -- |
Get the length of the value of this descriptor.
-| std::string NimBLEDescriptor::getStringValue | -( | -) | -- |
Get the value of this descriptor as a string.
-| NimBLEAttValue NimBLEDescriptor::getValue | -( | -time_t * | -timestamp = nullptr | ) | -- |
Get the value of this descriptor.
-
-
|
- -inline | -
Template to convert the descriptor data to <type>.
-| T | The type to convert the data to. |
| [in] | timestamp | (Optional) A pointer to a time_t struct to store the time the value was read. |
| [in] | skipSizeCheck | (Optional) If true it will skip checking if the data size is less than sizeof(<type>). |
sizeof(<type>).Use: getValue<type>(×tamp, skipSizeCheck);
| void NimBLEDescriptor::setValue | -( | -const std::vector< uint8_t > & | -vec | ) | -- |
Set the value of the descriptor from a std::vector<uint8_t>.
-.
| [in] | vec | The std::vector<uint8_t> reference to set the descriptor value from. |
-
|
- -inline | -
Template to set the characteristic value to <type>val.
-| [in] | s | The value to set. |
| void NimBLEDescriptor::setValue | -( | -const uint8_t * | -data, | -
| - | - | size_t | -length | -
| - | ) | -- |
Set the value of the descriptor.
-| [in] | data | The data to set for the descriptor. |
| [in] | length | The length of the data in bytes. |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
This is the complete list of members for NimBLEDescriptorCallbacks, including all inherited members.
| onRead(NimBLEDescriptor *pDescriptor) | NimBLEDescriptorCallbacks | virtual |
| onWrite(NimBLEDescriptor *pDescriptor) | NimBLEDescriptorCallbacks | virtual |
| onRead(NimBLEDescriptor *pDescriptor, NimBLEConnInfo &connInfo) | NimBLEDescriptorCallbacks | virtual |
| onWrite(NimBLEDescriptor *pDescriptor, NimBLEConnInfo &connInfo) | NimBLEDescriptorCallbacks | virtual |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
Callbacks that can be associated with a BLE descriptors to inform of events. More...
+ +#include <NimBLEDescriptor.h>
+Public Member Functionsvirtual void | onRead (NimBLEDescriptor *pDescriptor) | | Callback function to support a read request. More... | | virtual void | onWrite (NimBLEDescriptor *pDescriptor) | | Callback function to support a write request. More... | | virtual void | onRead (NimBLEDescriptor *pDescriptor, NimBLEConnInfo &connInfo) | | Callback function to support a read request. | | virtual void | onWrite (NimBLEDescriptor *pDescriptor, NimBLEConnInfo &connInfo) | | Callback function to support a write request. | | ||||||||
Callbacks that can be associated with a BLE descriptors to inform of events.
When a server application creates a BLE descriptor, we may wish to be informed when there is either a read or write request to the descriptors value. An application can register a sub-classed instance of this class and will be notified when such an event happens.
| [in] | pDescriptor | The descriptor that is the source of the event. |
| [in] | connInfo | A reference to a NimBLEConnInfo instance containing the peer info. |
| [in] | pDescriptor | The descriptor that is the source of the event. |
| [in] | connInfo | A reference to a NimBLEConnInfo instance containing the peer info. |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
This is the complete list of members for NimBLEDevice, including all inherited members.
| addIgnored(const NimBLEAddress &address) | NimBLEDevice | static |
| createClient(NimBLEAddress peerAddress=NimBLEAddress("")) | NimBLEDevice | static |
| createClient() | NimBLEDevice | static |
| createClient(const NimBLEAddress &peerAddress) | NimBLEDevice | static |
| createServer() | NimBLEDevice | static |
| deinit(bool clearAll=false) | NimBLEDevice | static |
| deleteAllBonds() | NimBLEDevice | static |
| deleteBond(const NimBLEAddress &address) | NimBLEDevice | static |
| deinit(bool clearAll=false) | NimBLEDevice | static |
| deleteAllBonds() | NimBLEDevice | static |
| deleteBond(const NimBLEAddress &address) | NimBLEDevice | static |
| deleteClient(NimBLEClient *pClient) | NimBLEDevice | static |
| getAddress() | NimBLEDevice | static |
| getAddress() | NimBLEDevice | static |
| getAdvertising() | NimBLEDevice | static |
| getBondedAddress(int index) | NimBLEDevice | static |
| getClientByID(uint16_t conn_id) | NimBLEDevice | static |
| getClientByPeerAddress(const NimBLEAddress &peer_addr) | NimBLEDevice | static |
| getClientList() | NimBLEDevice | static |
| getClientListSize() | NimBLEDevice | static |
| getBondedAddress(int index) | NimBLEDevice | static |
| getClientByHandle(uint16_t connHandle) | NimBLEDevice | static |
| getClientByPeerAddress(const NimBLEAddress &peerAddress) | NimBLEDevice | static |
| getConnectedClients() | NimBLEDevice | static |
| getCreatedClientCount() | NimBLEDevice | static |
| getDisconnectedClient() | NimBLEDevice | static |
| getInitialized() | NimBLEDevice | static |
| getMTU() | NimBLEDevice | static |
| getNumBonds() | NimBLEDevice | static |
| getMTU() | NimBLEDevice | static |
| getNumBonds() | NimBLEDevice | static |
| getPower() | NimBLEDevice | static |
| getScan() | NimBLEDevice | static |
| getSecurityPasskey() | NimBLEDevice | static |
| getSecurityPasskey() | NimBLEDevice | static |
| getServer() | NimBLEDevice | static |
| getWhiteListAddress(size_t index) | NimBLEDevice | static |
| getWhiteListAddress(size_t index) | NimBLEDevice | static |
| getWhiteListCount() | NimBLEDevice | static |
| init(const std::string &deviceName) | NimBLEDevice | static |
| isBonded(const NimBLEAddress &address) | NimBLEDevice | static |
| isIgnored(const NimBLEAddress &address) | NimBLEDevice | static |
| onWhiteList(const NimBLEAddress &address) | NimBLEDevice | static |
| removeIgnored(const NimBLEAddress &address) | NimBLEDevice | static |
| setCustomGapHandler(gap_event_handler handler) | NimBLEDevice | static |
| setDeviceName(const std::string &deviceName) | NimBLEDevice | static |
| setMTU(uint16_t mtu) | NimBLEDevice | static |
| setSecurityAuth(bool bonding, bool mitm, bool sc) | NimBLEDevice | static |
| setSecurityAuth(uint8_t auth_req) | NimBLEDevice | static |
| setSecurityCallbacks(NimBLESecurityCallbacks *pCallbacks) | NimBLEDevice | static |
| setSecurityInitKey(uint8_t init_key) | NimBLEDevice | static |
| setSecurityIOCap(uint8_t iocap) | NimBLEDevice | static |
| setSecurityPasskey(uint32_t pin) | NimBLEDevice | static |
| setSecurityRespKey(uint8_t init_key) | NimBLEDevice | static |
| startAdvertising(uint8_t inst_id, int duration=0, int max_events=0) | NimBLEDevice | static |
| startAdvertising() | NimBLEDevice | static |
| startSecurity(uint16_t conn_id) | NimBLEDevice | static |
| stopAdvertising(uint8_t inst_id) | NimBLEDevice | static |
| host_task(void *param) | NimBLEDevice | static |
| init(const std::string &deviceName) | NimBLEDevice | static |
| injectConfirmPasskey(const NimBLEConnInfo &peerInfo, bool accept) | NimBLEDevice | static |
| injectPassKey(const NimBLEConnInfo &peerInfo, uint32_t pin) | NimBLEDevice | static |
| isBonded(const NimBLEAddress &address) | NimBLEDevice | static |
| isInitialized() | NimBLEDevice | static |
| onReset(int reason) | NimBLEDevice | static |
| onSync(void) | NimBLEDevice | static |
| onWhiteList(const NimBLEAddress &address) | NimBLEDevice | static |
| setCustomGapHandler(gap_event_handler handler) | NimBLEDevice | static |
| setDefaultPhy(uint8_t txPhyMask, uint8_t rxPhyMask) | NimBLEDevice | static |
| setDeviceName(const std::string &deviceName) | NimBLEDevice | static |
| setMTU(uint16_t mtu) | NimBLEDevice | static |
| setOwnAddr(const NimBLEAddress &addr) | NimBLEDevice | static |
| setOwnAddr(const uint8_t *addr) | NimBLEDevice | static |
| setOwnAddrType(uint8_t type) | NimBLEDevice | static |
| setPower(int8_t dbm) | NimBLEDevice | static |
| setSecurityAuth(bool bonding, bool mitm, bool sc) | NimBLEDevice | static |
| setSecurityAuth(uint8_t auth) | NimBLEDevice | static |
| setSecurityInitKey(uint8_t initKey) | NimBLEDevice | static |
| setSecurityIOCap(uint8_t iocap) | NimBLEDevice | static |
| setSecurityPasskey(uint32_t passKey) | NimBLEDevice | static |
| setSecurityRespKey(uint8_t respKey) | NimBLEDevice | static |
| startAdvertising(uint8_t instId, int duration=0, int maxEvents=0) | NimBLEDevice | static |
| startAdvertising(uint32_t duration=0) | NimBLEDevice | static |
| startSecurity(uint16_t connHandle, int *rcPtr=nullptr) | NimBLEDevice | static |
| stopAdvertising(uint8_t instId) | NimBLEDevice | static |
| stopAdvertising() | NimBLEDevice | static |
| toString() | NimBLEDevice | static |
| toString() | NimBLEDevice | static |
| whiteListAdd(const NimBLEAddress &address) | NimBLEDevice | static |
| whiteListRemove(const NimBLEAddress &address) | NimBLEDevice | static |
| whiteListRemove(const NimBLEAddress &address) | NimBLEDevice | static |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
A model of a BLE Device from which all the BLE roles are created. More...
+ +#include <NimBLEDevice.h>
+Static Public Member Functionsstatic void | init (const std::string &deviceName) | | Initialize the BLE environment. More... | | static void | deinit (bool clearAll=false) | | Shutdown the NimBLE stack/controller. More... | | static void | setDeviceName (const std::string &deviceName) | | Set the BLEDevice's name. More... | | static bool | getInitialized () | | Check if the initialization is complete. More... | | static NimBLEAddress | getAddress () | | Get our device address. More... | static bool | init (const std::string &deviceName) | | Initialize the BLE environment. | | static bool | deinit (bool clearAll=false) | | Shutdown the NimBLE stack/controller. | | static bool | setDeviceName (const std::string &deviceName) | | Set the BLEDevice name. | | static bool | isInitialized () | | Check if the initialization is complete. | | static NimBLEAddress | getAddress () | | static std::string | toString () | | Return a string representation of the address of this device. More... | static std::string | toString () | | static bool | whiteListAdd (const NimBLEAddress &address) | | Add a peer address to the whitelist. More... | static bool | whiteListAdd (const NimBLEAddress &address) | | static bool | whiteListRemove (const NimBLEAddress &address) | | Remove a peer address from the whitelist. More... | static bool | whiteListRemove (const NimBLEAddress &address) | | static bool | onWhiteList (const NimBLEAddress &address) | | Checks if a peer device is whitelisted. More... | static bool | onWhiteList (const NimBLEAddress &address) | | static size_t | getWhiteListCount () | | Gets the count of addresses in the whitelist. More... | static size_t | getWhiteListCount () | | static NimBLEAddress | getWhiteListAddress (size_t index) | | Gets the address at the vector index. More... | static NimBLEAddress | getWhiteListAddress (size_t index) | | static NimBLEScan * | getScan () | | Retrieve the Scan object that we use for scanning. More... | | static NimBLEServer * | createServer () | | Create a new instance of a server. More... | | static NimBLEServer * | getServer () | | Get the instance of the server. More... | | static void | setCustomGapHandler (gap_event_handler handler) | | Set a custom callback for gap events. More... | | static void | setSecurityAuth (bool bonding, bool mitm, bool sc) | | Set the authorization mode for this device. More... | static bool | setOwnAddrType (uint8_t type) | | Sets the address type to use. | | static bool | setOwnAddr (const NimBLEAddress &addr) | | Set the device address to use. | | static bool | setOwnAddr (const uint8_t *addr) | | Set the device address to use. | | static bool | setCustomGapHandler (gap_event_handler handler) | | Set a custom callback for gap events. | | static void | setSecurityAuth (bool bonding, bool mitm, bool sc) | | static void | setSecurityAuth (uint8_t auth_req) | | Set the authorization mode for this device. More... | | static void | setSecurityIOCap (uint8_t iocap) | | Set the Input/Output capabilities of this device. More... | static void | setSecurityAuth (uint8_t auth) | | Set the authorization mode for this device. | | static void | setSecurityIOCap (uint8_t iocap) | | static void | setSecurityInitKey (uint8_t init_key) | | If we are the initiator of the security procedure this sets the keys we will distribute. More... | | static void | setSecurityRespKey (uint8_t init_key) | | Set the keys we are willing to accept during pairing. More... | | static void | setSecurityPasskey (uint32_t pin) | | Set the passkey the server will ask for when pairing. More... | | static uint32_t | getSecurityPasskey () | | Get the current passkey used for pairing. More... | static void | setSecurityInitKey (uint8_t initKey) | | If we are the initiator of the security procedure this sets the keys we will distribute. | | static void | setSecurityRespKey (uint8_t respKey) | | Set the keys we are willing to accept during pairing. | | static void | setSecurityPasskey (uint32_t passKey) | | Set the passkey the server will ask for when pairing. | | static uint32_t | getSecurityPasskey () | | static void | setSecurityCallbacks (NimBLESecurityCallbacks *pCallbacks) | | Set callbacks that will be used to handle encryption negotiation events and authentication events. More... | | static int | startSecurity (uint16_t conn_id) | | Start the connection securing and authorization for this connection. More... | | static int | setMTU (uint16_t mtu) | | Setup local mtu that will be used to negotiate mtu during request from client peer. More... | | static uint16_t | getMTU () | | Get local MTU value set. More... | static bool | startSecurity (uint16_t connHandle, int *rcPtr=nullptr) | | Start the connection securing and authorization for this connection. | | static bool | setMTU (uint16_t mtu) | | Setup local mtu that will be used to negotiate mtu during request from client peer. | | static uint16_t | getMTU () | | static bool | isIgnored (const NimBLEAddress &address) | | Check if the device address is on our ignore list. More... | | static void | addIgnored (const NimBLEAddress &address) | | Add a device to the ignore list. More... | | static void | removeIgnored (const NimBLEAddress &address) | | Remove a device from the ignore list. More... | | static NimBLEExtAdvertising * | getAdvertising () | | Get the instance of the advertising object. More... | static void | onReset (int reason) | | Host reset, we pass the message so we don't make calls until re-synced. | |
+static void | onSync (void) | | Host synced with controller, all clear to make calls to the stack. | |
+static void | host_task (void *param) | | The main host task. | | static int | getPower () | | Get the transmission power. | | static bool | setPower (int8_t dbm) | | Set the transmission power. | | static bool | setDefaultPhy (uint8_t txPhyMask, uint8_t rxPhyMask) | | Set the preferred default phy to use for connections. | | static NimBLEScan * | getScan () | | Retrieve the Scan object that we use for scanning. | | static NimBLEServer * | createServer () | | Create an instance of a server. | | static NimBLEServer * | getServer () | | Get the instance of the server. | | static bool | injectConfirmPasskey (const NimBLEConnInfo &peerInfo, bool accept) | | Inject the provided numeric comparison response into the Security Manager. | | static bool | injectPassKey (const NimBLEConnInfo &peerInfo, uint32_t pin) | | Inject the provided passkey into the Security Manager. | | static NimBLEExtAdvertising * | getAdvertising () | | static bool | startAdvertising (uint8_t inst_id, int duration=0, int max_events=0) | | Convenience function to begin advertising. More... | | static bool | stopAdvertising (uint8_t inst_id) | | Convenience function to stop advertising a data set. More... | | static bool | stopAdvertising () | | Convenience function to stop all advertising. More... | static bool | startAdvertising (uint8_t instId, int duration=0, int maxEvents=0) | | Convenience function to begin advertising. | | static bool | stopAdvertising (uint8_t instId) | | Convenience function to stop advertising a data set. | | static bool | stopAdvertising () | | static bool | startAdvertising () | | Convenience function to begin advertising. More... | | static NimBLEClient * | createClient (NimBLEAddress peerAddress=NimBLEAddress("")) | | Creates a new client object and maintains a list of all client objects each client can connect to 1 peripheral device. More... | | static bool | deleteClient (NimBLEClient *pClient) | static bool | startAdvertising (uint32_t duration=0) | | Convenience function to begin advertising. | | static NimBLEClient * | createClient () | | Creates a new client object, each client can connect to 1 peripheral device. | | static NimBLEClient * | createClient (const NimBLEAddress &peerAddress) | | Creates a new client object, each client can connect to 1 peripheral device. | | | Delete the client object and remove it from the list. | -Checks if it is connected or trying to connect and disconnects/stops it first. More... | Get our device address. | Return a string representation of the address of this device. | Add a peer address to the whitelist. | Remove a peer address from the whitelist. | Checks if a peer device is whitelisted. | Gets the count of addresses in the whitelist. | Gets the address at the vector index. | Set the authorization mode for this device. | Set the Input/Output capabilities of this device. | Get the current passkey used for pairing. | Get local MTU value set. | Get the instance of the extended advertising object. | Convenience function to stop all advertising. | static bool | deleteClient (NimBLEClient *pClient) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| static NimBLEClient * | getClientByID (uint16_t conn_id) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Get a reference to a client by connection ID. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| static NimBLEClient * | getClientByPeerAddress (const NimBLEAddress &peer_addr) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Get a reference to a client by peer address. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| static NimBLEClient * | getDisconnectedClient () | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Finds the first disconnected client in the list. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| static NimBLEClient * | getClientByHandle (uint16_t connHandle) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Get a reference to a client by connection handle. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| static NimBLEClient * | getClientByPeerAddress (const NimBLEAddress &peerAddress) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Get a reference to a client by peer address. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| static NimBLEClient * | getDisconnectedClient () | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Finds the first disconnected client available. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| static size_t | getClientListSize () | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Get the number of created client objects. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| static std::list< NimBLEClient * > * | getClientList () | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Get the list of created client objects. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| static bool | deleteBond (const NimBLEAddress &address) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Deletes a peer bond. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| static size_t | getCreatedClientCount () | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Get the number of created client objects. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| static std::vector< NimBLEClient * > | getConnectedClients () | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Get a list of connected clients. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| static bool | deleteBond (const NimBLEAddress &address) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Deletes a peer bond. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| -static int | getNumBonds () | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| +static int | getNumBonds () | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Gets the number of bonded peers stored. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| static bool | isBonded (const NimBLEAddress &address) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Checks if a peer device is bonded. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| static bool | isBonded (const NimBLEAddress &address) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Checks if a peer device is bonded. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| -static void | deleteAllBonds () | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Deletes all bonding information. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| static NimBLEAddress | getBondedAddress (int index) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Get the address of a bonded peer device by index. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| static bool | deleteAllBonds () | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Deletes all bonding information. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| static NimBLEAddress | getBondedAddress (int index) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Get the address of a bonded peer device by index. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
A model of a BLE Device from which all the BLE roles are created.
-
|
- -static | -
Add a device to the ignore list.
-| [in] | address | The address of the device we want to ignore. |
NimBLEAddress("")Creates a new client object and maintains a list of all client objects each client can connect to 1 peripheral device.
-| [in] | peerAddress | An optional peer address that is copied to the new client object, allows for calling NimBLEClient::connect(bool) without a device or address parameter. |
Creates a new client object, each client can connect to 1 peripheral device.
+
+
|
+ +static | +
Creates a new client object, each client can connect to 1 peripheral device.
+| [in] | peerAddress | A peer address reference that is copied to the new client object, allows for calling NimBLEClient::connect(bool) without a device or address parameter. |
Create a new instance of a server.
-Create an instance of a server.
+| void NimBLEDevice::deinit | +bool NimBLEDevice::deinit | ( | bool | clearAll = false | ) | @@ -364,16 +391,44 @@ static voidShutdown the NimBLE stack/controller.
◆ deleteBond()+ +◆ deleteAllBonds()+ +
+
+
+
+
+
+
+Deletes all bonding information. +
◆ deleteBond()
@@ -403,12 +458,12 @@ static void |
-
◆ deleteClient()+ +◆ deleteClient()
@@ -442,8 +497,8 @@ Checks if it is connected or trying to connect and disconnects/stops it first. <
◆ getAddress()+ +◆ getAddress()
@@ -466,12 +521,12 @@ Checks if it is connected or trying to connect and disconnects/stops it first. <
Get our device address. -
◆ getAdvertising()+ +◆ getAdvertising()
@@ -493,13 +548,16 @@ Checks if it is connected or trying to connect and disconnects/stops it first. <
|
Get the instance of the advertising object.
-Get the instance of the extended advertising object.
+Get the instance of the advertising object.
+| NimBLEClient * NimBLEDevice::getClientByID | +NimBLEClient * NimBLEDevice::getClientByHandle | ( | uint16_t | -conn_id | ) | +connHandle | ) |
Get a reference to a client by connection ID.
+Get a reference to a client by connection handle.
| [in] | conn_id | The client connection ID to search for. |
| [in] | connHandle | The client connection handle to search for. |
Get a reference to a client by peer address.
| [in] | peer_addr | The address of the peer to search for. |
| [in] | addr | The address of the peer to search for. |
| std::list< NimBLEClient * > * NimBLEDevice::getClientList | +std::vector< NimBLEClient * > NimBLEDevice::getConnectedClients | ( | ) | @@ -626,13 +684,13 @@ Checks if it is connected or trying to connect and disconnects/stops it first. < |
Get the list of created client objects.
-Get a list of connected clients.
+| size_t NimBLEDevice::getClientListSize | +size_t NimBLEDevice::getCreatedClientCount | ( | ) | @@ -659,8 +717,8 @@ Checks if it is connected or trying to connect and disconnects/stops it first. < - - |
Finds the first disconnected client in the list.
-Finds the first disconnected client available.
+
-
|
- -static | -
Check if the initialization is complete.
-
+
|
+ +static | +
Get the transmission power.
+Get the instance of the server.
-| void NimBLEDevice::init | +bool NimBLEDevice::init | ( | const std::string & | deviceName | ) | @@ -924,8 +982,99 @@ Checks if it is connected or trying to connect and disconnects/stops it first. < - -
+
|
+ +static | +
Inject the provided numeric comparison response into the Security Manager.
+| [in] | peerInfo | Connection information for the peer. |
| [in] | accept | Whether the user confirmed or declined the comparison. |
+
|
+ +static | +
Inject the provided passkey into the Security Manager.
+| [in] | peerInfo | Connection information for the peer. |
| [in] | passkey | The 6-digit passkey to inject. |
| bool NimBLEDevice::isIgnored | +bool NimBLEDevice::isInitialized | ( | -const NimBLEAddress & | -address | ) | +) |
Check if the device address is on our ignore list.
-| [in] | address | The address to look for. |
Check if the initialization is complete.
+
+
|
+ +static | +
Host reset, we pass the message so we don't make calls until re-synced.
+| [in] | reason | The reason code for the reset. |
| void NimBLEDevice::removeIgnored | -( | -const NimBLEAddress & | -address | ) | -- |
Remove a device from the ignore list.
-| [in] | address | The address of the device we want to remove from the list. |
-
◆ setDeviceName()+ +◆ setDefaultPhy()
@@ -1107,7 +1250,65 @@ Checks if it is connected or trying to connect and disconnects/stops it first. <
|
+
+static |
+ |
Set the preferred default phy to use for connections.
+| [in] | txPhyMask | TX PHY. Can be mask of following:
|
| [in] | rxPhyMask | RX PHY. Can be mask of following:
|
+
-
-
-Set the BLEDevice's name. +Set the BLEDevice name.
◆ setMTU()+ +◆ setMTU()
@@ -1141,7 +1342,7 @@ Checks if it is connected or trying to connect and disconnects/stops it first. <
|
◆ setSecurityAuth() [1/2]+ +◆ setOwnAddr() [1/2]+ +
+
+
+
+
+
+
+Set the device address to use. +
To use the address generated the address type must be set to random with ◆ setOwnAddr() [2/2]+ +
+
+
+
+
+
+
+Set the device address to use. +
To use the address generated the address type must be set to random with ◆ setOwnAddrType()+ +
+
+
+
+
+
+
+Sets the address type to use. +
◆ setPower()+ +
+
+
+
+
+
+
+Set the transmission power. +
◆ setSecurityAuth() [1/2]
@@ -1220,8 +1569,8 @@ Checks if it is connected or trying to connect and disconnects/stops it first. <
◆ setSecurityAuth() [2/2]+ +◆ setSecurityAuth() [2/2]
@@ -1261,43 +1610,8 @@ The available bits are defined as:
◆ setSecurityCallbacks()- -
-
-
-
-
-
-
-Set callbacks that will be used to handle encryption negotiation events and authentication events. -
◆ setSecurityInitKey()+ +◆ setSecurityInitKey()
@@ -1309,7 +1623,7 @@ The available bits are defined as: void NimBLEDevice::setSecurityInitKey |
( |
uint8_t |
- init_key | ) |
+ initKey | ) |
| |
If we are the initiator of the security procedure this sets the keys we will distribute.
| init_key | A bitmap indicating which keys to distribute during pairing. + |
| initKey | A bitmap indicating which keys to distribute during pairing. The available bits are defined as:
|
Set the passkey the server will ask for when pairing.
| [in] | pin | The passkey to use. |
| [in] | passkey | The passkey to use. |
Set the keys we are willing to accept during pairing.
| resp_key | A bitmap indicating which keys to accept during pairing. The available bits are defined as:
respKey | A bitmap indicating which keys to accept during pairing. The available bits are defined as: | |
Convenience function to begin advertising.
+| [in] | duration | The duration in milliseconds to advertise for, default = forever. |
0 0 Convenience function to begin advertising.
| [in] | inst_id | The extended advertisement instance ID to start. |
| [in] | instId | The extended advertisement instance ID to start. |
| [in] | duration | How long to advertise for in milliseconds, 0 = forever (default). |
| [in] | max_events | Maximum number of advertisement events to send, 0 = no limit (default). |
| [in] | maxEvents | Maximum number of advertisement events to send, 0 = no limit (default). |
| int NimBLEDevice::startSecurity | +bool NimBLEDevice::startSecurity | ( | uint16_t | -conn_id | ) | +connHandle, | +
| + | int * | +rcPtr = nullptr |
+ ||||
| + | ) | +
Start the connection securing and authorization for this connection.
| conn_id | The connection id of the peer device. |
| connHandle | The connection handle of the peer device. |
| rcPtr | Optional pointer to pass the return code to the caller. |
Convenience function to stop advertising a data set.
| [in] | inst_id | The extended advertisement instance ID to stop advertising. |
| [in] | instId | The extended advertisement instance ID to stop advertising. |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
This is the complete list of members for NimBLEEddystoneTLM, including all inherited members.
| getCount() | NimBLEEddystoneTLM | |
| getData() | NimBLEEddystoneTLM | |
| getTemp() | NimBLEEddystoneTLM | |
| getTime() | NimBLEEddystoneTLM | |
| getData() | NimBLEEddystoneTLM | |
| getTemp() | NimBLEEddystoneTLM | |
| getTime() | NimBLEEddystoneTLM | |
| getUUID() | NimBLEEddystoneTLM | |
| getVersion() | NimBLEEddystoneTLM | |
| getVersion() | NimBLEEddystoneTLM | |
| getVolt() | NimBLEEddystoneTLM | |
| NimBLEEddystoneTLM() | NimBLEEddystoneTLM | |
| setCount(uint32_t advCount) | NimBLEEddystoneTLM | |
| setData(const std::string &data) | NimBLEEddystoneTLM | |
| setTemp(float temp) | NimBLEEddystoneTLM | |
| setTime(uint32_t tmil) | NimBLEEddystoneTLM | |
| setCount(uint32_t advCount) | NimBLEEddystoneTLM | |
| setData(const uint8_t *data, uint8_t length) | NimBLEEddystoneTLM | |
| setData(const BeaconData &data) | NimBLEEddystoneTLM | |
| setTemp(int16_t temp) | NimBLEEddystoneTLM | |
| setTime(uint32_t tmil) | NimBLEEddystoneTLM | |
| setUUID(const NimBLEUUID &l_uuid) | NimBLEEddystoneTLM | |
| setVersion(uint8_t version) | NimBLEEddystoneTLM | |
| setVersion(uint8_t version) | NimBLEEddystoneTLM | |
| setVolt(uint16_t volt) | NimBLEEddystoneTLM | |
| toString() | NimBLEEddystoneTLM | |
| toString() | NimBLEEddystoneTLM |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
Representation of a beacon. See: More...
+ +#include <NimBLEEddystoneTLM.h>
+Public Member Functions
- | NimBLEEddystoneTLM () | | Construct a default EddystoneTLM beacon object. | | std::string | getData () | | Retrieve the data that is being advertised. More... | | NimBLEUUID | getUUID () | | Get the UUID being advertised. More... | const BeaconData | getData () | | Retrieve the data that is being advertised. | | NimBLEUUID | getUUID () | | uint8_t | getVersion () | | Get the version being advertised. More... | uint8_t | getVersion () | | uint16_t | getVolt () | | Get the battery voltage. More... | uint16_t | getVolt () | | float | getTemp () | | Get the temperature being advertised. More... | | uint32_t | getCount () | | Get the count of advertisements sent. More... | int16_t | getTemp () | | Get the temperature being advertised. | | uint32_t | getCount () | | uint32_t | getTime () | | Get the advertisement time. More... | uint32_t | getTime () | | std::string | toString () | | Get a string representation of the beacon. More... | std::string | toString () | | void | setData (const std::string &data) | | Set the raw data for the beacon advertisement. More... | | void | setUUID (const NimBLEUUID &l_uuid) | | Set the UUID to advertise. More... | void | setData (const uint8_t *data, uint8_t length) | | Set the raw data for the beacon advertisement. | | void | setData (const BeaconData &data) | | Set the raw data for the beacon advertisement. | | void | setUUID (const NimBLEUUID &l_uuid) | | void | setVersion (uint8_t version) | | Set the version to advertise. More... | void | setVersion (uint8_t version) | | void | setVolt (uint16_t volt) | | Set the battery voltage to advertise. More... | void | setVolt (uint16_t volt) | | void | setTemp (float temp) | | Set the temperature to advertise. More... | | void | setCount (uint32_t advCount) | | Set the advertisement count. More... | void | setTemp (int16_t temp) | | Set the temperature to advertise. | | void | setCount (uint32_t advCount) | | void | setTime (uint32_t tmil) | | Set the advertisement time. More... | void | setTime (uint32_t tmil) | | Get the UUID being advertised. | Get the version being advertised. | Get the battery voltage. | Get the count of advertisements sent. | Get the advertisement time. | Get a string representation of the beacon. | Set the UUID to advertise. | Set the version to advertise. | Set the battery voltage to advertise. | Set the advertisement count. | Set the advertisement time. | ||||||||||||||||||||||||||||||||||||
| std::string NimBLEEddystoneTLM::getData | +const NimBLEEddystoneTLM::BeaconData NimBLEEddystoneTLM::getData | ( | ) | @@ -191,14 +198,14 @@ Public Member Functions | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| float NimBLEEddystoneTLM::getTemp | +int16_t NimBLEEddystoneTLM::getTemp | ( | ) | @@ -211,8 +218,8 @@ Public Member Functions | ||
| void NimBLEEddystoneTLM::setData | ( | -const std::string & | +const BeaconData & | data | ) |
| void NimBLEEddystoneTLM::setData | +( | +const uint8_t * | +data, | +
| + | + | uint8_t | +length | +
| + | ) | ++ |
Set the raw data for the beacon advertisement.
+| [in] | data | A pointer to the data to advertise. |
| [in] | length | The length of the data. |
Set the temperature to advertise.
| [in] | temp | The temperature value. |
| [in] | temp | The temperature value in 8.8 fixed point format. |
Set the UUID to advertise.
| [in] | l_uuid | The UUID. |
| [in] | uuid | The UUID. |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
-
- |
-
This is the complete list of members for NimBLEEddystoneURL, including all inherited members.
-| getData() | NimBLEEddystoneURL | |
| getDecodedURL() | NimBLEEddystoneURL | |
| getPower() | NimBLEEddystoneURL | |
| getURL() | NimBLEEddystoneURL | |
| getUUID() | NimBLEEddystoneURL | |
| NimBLEEddystoneURL() | NimBLEEddystoneURL | |
| setData(const std::string &data) | NimBLEEddystoneURL | |
| setPower(int8_t advertisedTxPower) | NimBLEEddystoneURL | |
| setURL(const std::string &url) | NimBLEEddystoneURL | |
| setUUID(const NimBLEUUID &l_uuid) | NimBLEEddystoneURL |
1.9.1 |
- esp-nimble-cpp
- 1.4.1
-
- |
-
Representation of a beacon. See: - More...
--Public Member Functions | |
| - | NimBLEEddystoneURL () |
| Construct a default EddystoneURL beacon object. | |
| std::string | getData () |
| Retrieve the data that is being advertised. More... | |
| NimBLEUUID | getUUID () |
| Get the UUID being advertised. More... | |
| int8_t | getPower () |
| Get the transmit power being advertised. More... | |
| std::string | getURL () |
| Get the raw URL being advertised. More... | |
| std::string | getDecodedURL () |
| Get the full URL being advertised. More... | |
| void | setData (const std::string &data) |
| Set the raw data for the beacon advertisement. More... | |
| void | setUUID (const NimBLEUUID &l_uuid) |
| Set the UUID to advertise. More... | |
| void | setPower (int8_t advertisedTxPower) |
| Set the transmit power to advertise. More... | |
| void | setURL (const std::string &url) |
| Set the URL to advertise. More... | |
Representation of a beacon. See:
- -| std::string NimBLEEddystoneURL::getData | -( | -) | -- |
Retrieve the data that is being advertised.
-| std::string NimBLEEddystoneURL::getDecodedURL | -( | -) | -- |
Get the full URL being advertised.
-| int8_t NimBLEEddystoneURL::getPower | -( | -) | -- |
Get the transmit power being advertised.
-| std::string NimBLEEddystoneURL::getURL | -( | -) | -- |
Get the raw URL being advertised.
-| NimBLEUUID NimBLEEddystoneURL::getUUID | -( | -) | -- |
Get the UUID being advertised.
-| void NimBLEEddystoneURL::setData | -( | -const std::string & | -data | ) | -- |
Set the raw data for the beacon advertisement.
-| [in] | data | The raw data to advertise. |
| void NimBLEEddystoneURL::setPower | -( | -int8_t | -advertisedTxPower | ) | -- |
Set the transmit power to advertise.
-| [in] | advertisedTxPower | The transmit power level. |
| void NimBLEEddystoneURL::setURL | -( | -const std::string & | -url | ) | -- |
Set the URL to advertise.
-| [in] | url | The URL. |
| void NimBLEEddystoneURL::setUUID | -( | -const NimBLEUUID & | -l_uuid | ) | -- |
Set the UUID to advertise.
-| [in] | l_uuid | The UUID. |
1.9.1 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
This is the complete list of members for NimBLEExtAdvertisement, including all inherited members.
| addData(const std::string &data) | NimBLEExtAdvertisement | |
| addData(const uint8_t *data, size_t length) | NimBLEExtAdvertisement | |
| addData(const uint8_t *data, size_t length) | NimBLEExtAdvertisement | |
| addData(const std::string &data) | NimBLEExtAdvertisement | |
| addServiceUUID(const NimBLEUUID &serviceUUID) | NimBLEExtAdvertisement | |
| addServiceUUID(const char *serviceUUID) | NimBLEExtAdvertisement | |
| addTxPower() | NimBLEExtAdvertisement | |
| clearData() | NimBLEExtAdvertisement | |
| clearData() | NimBLEExtAdvertisement | |
| enableScanRequestCallback(bool enable) | NimBLEExtAdvertisement | |
| getDataSize() | NimBLEExtAdvertisement | |
| NimBLEExtAdvertisement(uint8_t priPhy=BLE_HCI_LE_PHY_1M, uint8_t secPhy=BLE_HCI_LE_PHY_1M) | NimBLEExtAdvertisement | |
| setAddress(const NimBLEAddress &addr) | NimBLEExtAdvertisement | |
| setAnonymous(bool val) | NimBLEExtAdvertisement | |
| setAppearance(uint16_t appearance) | NimBLEExtAdvertisement | |
| setCompleteServices(const NimBLEUUID &uuid) | NimBLEExtAdvertisement | |
| setCompleteServices16(const std::vector< NimBLEUUID > &v_uuid) | NimBLEExtAdvertisement | |
| setCompleteServices32(const std::vector< NimBLEUUID > &v_uuid) | NimBLEExtAdvertisement | |
| setConnectable(bool val) | NimBLEExtAdvertisement | |
| setData(const uint8_t *data, size_t length) | NimBLEExtAdvertisement | |
| setDirected(bool val, bool high_duty=true) | NimBLEExtAdvertisement | |
| setDirectedPeer(const NimBLEAddress &addr) | NimBLEExtAdvertisement | |
| setFlags(uint8_t flag) | NimBLEExtAdvertisement | |
| setLegacyAdvertising(bool val) | NimBLEExtAdvertisement | |
| setManufacturerData(const std::string &data) | NimBLEExtAdvertisement | |
| setMaxInterval(uint32_t maxinterval) | NimBLEExtAdvertisement | |
| setMinInterval(uint32_t mininterval) | NimBLEExtAdvertisement | |
| setName(const std::string &name) | NimBLEExtAdvertisement | |
| setPartialServices(const NimBLEUUID &uuid) | NimBLEExtAdvertisement | |
| setPartialServices16(const std::vector< NimBLEUUID > &v_uuid) | NimBLEExtAdvertisement | |
| setPartialServices32(const std::vector< NimBLEUUID > &v_uuid) | NimBLEExtAdvertisement | |
| setPreferredParams(uint16_t min, uint16_t max) | NimBLEExtAdvertisement | |
| setPrimaryChannels(bool ch37, bool ch38, bool ch39) | NimBLEExtAdvertisement | |
| setPrimaryPhy(uint8_t phy) | NimBLEExtAdvertisement | |
| setScanFilter(bool scanRequestWhitelistOnly, bool connectWhitelistOnly) | NimBLEExtAdvertisement | |
| setScannable(bool val) | NimBLEExtAdvertisement | |
| setSecondaryPhy(uint8_t phy) | NimBLEExtAdvertisement | |
| setServiceData(const NimBLEUUID &uuid, const std::string &data) | NimBLEExtAdvertisement | |
| setShortName(const std::string &name) | NimBLEExtAdvertisement | |
| setTxPower(int8_t dbm) | NimBLEExtAdvertisement | |
| setURI(const std::string &uri) | NimBLEExtAdvertisement | |
| getDataLocation(uint8_t type) const | NimBLEExtAdvertisement | |
| getDataSize() const | NimBLEExtAdvertisement | |
| NimBLEExtAdvertisement(uint8_t priPhy=BLE_HCI_LE_PHY_1M, uint8_t secPhy=BLE_HCI_LE_PHY_1M) | NimBLEExtAdvertisement | |
| removeData(uint8_t type) | NimBLEExtAdvertisement | |
| removeServices() | NimBLEExtAdvertisement | |
| removeServiceUUID(const NimBLEUUID &serviceUUID) | NimBLEExtAdvertisement | |
| removeServiceUUID(const char *serviceUUID) | NimBLEExtAdvertisement | |
| setAddress(const NimBLEAddress &addr) | NimBLEExtAdvertisement | |
| setAnonymous(bool enable) | NimBLEExtAdvertisement | |
| setAppearance(uint16_t appearance) | NimBLEExtAdvertisement | |
| setCompleteServices(const NimBLEUUID &uuid) | NimBLEExtAdvertisement | |
| setCompleteServices16(const std::vector< NimBLEUUID > &uuids) | NimBLEExtAdvertisement | |
| setCompleteServices32(const std::vector< NimBLEUUID > &uuids) | NimBLEExtAdvertisement | |
| setConnectable(bool enable) | NimBLEExtAdvertisement | |
| setData(const uint8_t *data, size_t length) | NimBLEExtAdvertisement | |
| setDirected(bool enable, bool high_duty=true) | NimBLEExtAdvertisement | |
| setDirectedPeer(const NimBLEAddress &addr) | NimBLEExtAdvertisement | |
| setFlags(uint8_t flag) | NimBLEExtAdvertisement | |
| setLegacyAdvertising(bool enable) | NimBLEExtAdvertisement | |
| setManufacturerData(const uint8_t *data, size_t length) | NimBLEExtAdvertisement | |
| setManufacturerData(const std::string &data) | NimBLEExtAdvertisement | |
| setManufacturerData(const std::vector< uint8_t > &data) | NimBLEExtAdvertisement | |
| setMaxInterval(uint32_t maxinterval) | NimBLEExtAdvertisement | |
| setMinInterval(uint32_t mininterval) | NimBLEExtAdvertisement | |
| setName(const std::string &name, bool isComplete=true) | NimBLEExtAdvertisement | |
| setPartialServices(const NimBLEUUID &uuid) | NimBLEExtAdvertisement | |
| setPartialServices16(const std::vector< NimBLEUUID > &uuids) | NimBLEExtAdvertisement | |
| setPartialServices32(const std::vector< NimBLEUUID > &uuids) | NimBLEExtAdvertisement | |
| setPreferredParams(uint16_t min, uint16_t max) | NimBLEExtAdvertisement | |
| setPrimaryChannels(bool ch37, bool ch38, bool ch39) | NimBLEExtAdvertisement | |
| setPrimaryPhy(uint8_t phy) | NimBLEExtAdvertisement | |
| setScanFilter(bool scanRequestWhitelistOnly, bool connectWhitelistOnly) | NimBLEExtAdvertisement | |
| setScannable(bool enable) | NimBLEExtAdvertisement | |
| setSecondaryPhy(uint8_t phy) | NimBLEExtAdvertisement | |
| setServiceData(const NimBLEUUID &uuid, const uint8_t *data, size_t length) | NimBLEExtAdvertisement | |
| setServiceData(const NimBLEUUID &uuid, const std::string &data) | NimBLEExtAdvertisement | |
| setServiceData(const NimBLEUUID &uuid, const std::vector< uint8_t > &data) | NimBLEExtAdvertisement | |
| setShortName(const std::string &name) | NimBLEExtAdvertisement | |
| setTxPower(int8_t dbm) | NimBLEExtAdvertisement | |
| setURI(const std::string &uri) | NimBLEExtAdvertisement | |
| toString() const | NimBLEExtAdvertisement |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
Extended advertisement data. More...
+ +#include <NimBLEExtAdvertising.h>
+Public Member Functions | NimBLEExtAdvertisement (uint8_t priPhy=BLE_HCI_LE_PHY_1M, uint8_t secPhy=BLE_HCI_LE_PHY_1M) | | Construct a BLE extended advertisement. More... | | NimBLEExtAdvertisement (uint8_t priPhy=BLE_HCI_LE_PHY_1M, uint8_t secPhy=BLE_HCI_LE_PHY_1M) | | void | setAppearance (uint16_t appearance) | | Set the appearance. More... | | void | setCompleteServices (const NimBLEUUID &uuid) | | Set a single service to advertise as a complete list of services. More... | | void | setCompleteServices16 (const std::vector< NimBLEUUID > &v_uuid) | | Set the complete list of 16 bit services to advertise. More... | | void | setCompleteServices32 (const std::vector< NimBLEUUID > &v_uuid) | | Set the complete list of 32 bit services to advertise. More... | | void | setFlags (uint8_t flag) | | Set the advertisement flags. More... | | void | setManufacturerData (const std::string &data) | | Set manufacturer specific data. More... | | void | setURI (const std::string &uri) | | Set the URI to advertise. More... | | void | setName (const std::string &name) | | Set the complete name of this device. More... | | void | setPartialServices (const NimBLEUUID &uuid) | | Set a single service to advertise as a partial list of services. More... | | void | setPartialServices16 (const std::vector< NimBLEUUID > &v_uuid) | | Set the partial list of services to advertise. More... | | void | setPartialServices32 (const std::vector< NimBLEUUID > &v_uuid) | | Set the partial list of services to advertise. More... | | void | setServiceData (const NimBLEUUID &uuid, const std::string &data) | | Set the service data (UUID + data) More... | | void | setShortName (const std::string &name) | | Set the short name. More... | | void | setData (const uint8_t *data, size_t length) | | Set the advertisement data. More... | | void | addData (const std::string &data) | | Add data to the payload to be advertised. More... | | void | addData (const uint8_t *data, size_t length) | | Add data to the payload to be advertised. More... | |
-void | addTxPower () | bool | setAppearance (uint16_t appearance) | | Set the appearance. | | bool | addServiceUUID (const NimBLEUUID &serviceUUID) | | Add a service uuid to exposed list of services. | | bool | addServiceUUID (const char *serviceUUID) | | Add a service uuid to exposed list of services. | | bool | removeServiceUUID (const NimBLEUUID &serviceUUID) | | Remove a service UUID from the advertisement. | | bool | removeServiceUUID (const char *serviceUUID) | | Remove a service UUID from the advertisement. | |
+bool | removeServices () | | Remove all service UUIDs from the advertisement. | | bool | setCompleteServices (const NimBLEUUID &uuid) | | Set a single service to advertise as a complete list of services. | | bool | setCompleteServices16 (const std::vector< NimBLEUUID > &uuids) | | Set the complete list of 16 bit services to advertise. | | bool | setCompleteServices32 (const std::vector< NimBLEUUID > &uuids) | | Set the complete list of 32 bit services to advertise. | | bool | setFlags (uint8_t flag) | | Set the advertisement flags. | | bool | setManufacturerData (const uint8_t *data, size_t length) | | Set manufacturer specific data. | | bool | setManufacturerData (const std::string &data) | | Set manufacturer specific data. | | bool | setManufacturerData (const std::vector< uint8_t > &data) | | Set manufacturer specific data. | | bool | setURI (const std::string &uri) | | Set the URI to advertise. | | bool | setName (const std::string &name, bool isComplete=true) | | Set the complete name of this device. | | bool | setPartialServices (const NimBLEUUID &uuid) | | Set a single service to advertise as a partial list of services. | | bool | setPartialServices16 (const std::vector< NimBLEUUID > &uuids) | | Set the partial list of services to advertise. | | bool | setPartialServices32 (const std::vector< NimBLEUUID > &uuids) | | Set the partial list of services to advertise. | | bool | setServiceData (const NimBLEUUID &uuid, const uint8_t *data, size_t length) | | Set the service data advertised for the UUID. | | bool | setServiceData (const NimBLEUUID &uuid, const std::string &data) | | Set the service data (UUID + data) | | bool | setServiceData (const NimBLEUUID &uuid, const std::vector< uint8_t > &data) | | Set the service data advertised for the UUID. | | bool | setShortName (const std::string &name) | | Set the short name. | | bool | setData (const uint8_t *data, size_t length) | | Set the advertisement data. | | bool | addData (const uint8_t *data, size_t length) | | Add data to the payload to be advertised. | | bool | addData (const std::string &data) | | Add data to the payload to be advertised. | | bool | setPreferredParams (uint16_t min, uint16_t max) | | Set the preferred min and max connection intervals to advertise. | | | void | setPreferredParams (uint16_t min, uint16_t max) | | Set the preferred connection interval parameters. More... | | void | setLegacyAdvertising (bool val) | | Sets wether the advertisement should use legacy (BLE 4.0, 31 bytes max) advertising. More... | | void | setConnectable (bool val) | | Sets wether this advertisement should advertise as a connectable device. More... | | void | setScannable (bool val) | | Sets wether the advertisement has scan response data available. More... | | void | setMinInterval (uint32_t mininterval) | | Set the minimum advertising interval. More... | void | setLegacyAdvertising (bool enable) | | Sets wether the advertisement should use legacy (BLE 4.0, 31 bytes max) advertising. | | void | setConnectable (bool enable) | | Sets wether this advertisement should advertise as a connectable device. | | void | setScannable (bool enable) | | Sets wether the advertisement has scan response data available. | | void | setMinInterval (uint32_t mininterval) | | void | setMaxInterval (uint32_t maxinterval) | | Set the maximum advertising interval. More... | void | setMaxInterval (uint32_t maxinterval) | | void | setPrimaryPhy (uint8_t phy) | | Set the primary advertising PHY to use. More... | void | setPrimaryPhy (uint8_t phy) | | void | setSecondaryPhy (uint8_t phy) | | Set the secondary advertising PHY to use. More... | void | setSecondaryPhy (uint8_t phy) | | void | setScanFilter (bool scanRequestWhitelistOnly, bool connectWhitelistOnly) | | Set the filtering for the scan filter. More... | void | setScanFilter (bool scanRequestWhitelistOnly, bool connectWhitelistOnly) | | void | setDirectedPeer (const NimBLEAddress &addr) | | Sets the peer to directly advertise to. More... | void | setDirectedPeer (const NimBLEAddress &addr) | | void | setDirected (bool val, bool high_duty=true) | | Enable or disable direct advertisements to the peer set with | NimBLEExtAdvertisement::setDirectedPeer More... | void | setAnonymous (bool val) | | Sets whether the advertisement should be anonymous. More... | | void | setPrimaryChannels (bool ch37, bool ch38, bool ch39) | | Sets The primary channels to advertise on. More... | void | setDirected (bool enable, bool high_duty=true) | | Enable or disable direct advertisements to the peer set with | NimBLEExtAdvertisement::setDirectedPeer | void | setAnonymous (bool enable) | | Sets whether the advertisement should be anonymous. | | void | setPrimaryChannels (bool ch37, bool ch38, bool ch39) | | void | setTxPower (int8_t dbm) | | Sets the transmission power level for this advertisement. More... | void | setTxPower (int8_t dbm) | | void | setAddress (const NimBLEAddress &addr) | | Set the address to use for this advertisement. More... | void | setAddress (const NimBLEAddress &addr) | | void | enableScanRequestCallback (bool enable) | | Sets whether the scan response request callback should be called. More... | void | enableScanRequestCallback (bool enable) | | void | clearData () | | Clears the data stored in this instance, does not change settings. More... | void | clearData () | |
-size_t | getDataSize () | | Get the size of the current data. | | int | getDataLocation (uint8_t type) const | | Get the location of the data in the payload. | | bool | removeData (uint8_t type) | | Remove data from the advertisement data. | |
+size_t | getDataSize () const | | Get the size of the current data. | | std::string | toString () const | | Get the string representation of the advertisement data. | | Construct a BLE extended advertisement. | +void | addTxPower () | Adds Tx power level to the advertisement data. | Set the minimum advertising interval. | Set the maximum advertising interval. | Set the primary advertising PHY to use. | Set the secondary advertising PHY to use. | Set the filtering for the scan filter. | Sets the peer to directly advertise to. | Sets The primary channels to advertise on. | Sets the transmission power level for this advertisement. | Set the address to use for this advertisement. | Sets whether the scan response request callback should be called. | Clears the data stored in this instance, does not change settings. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Extended advertisement data.
| void NimBLEExtAdvertisement::addData | +bool NimBLEExtAdvertisement::addData | ( | const std::string & | data | ) | @@ -279,17 +324,18 @@ size_t◆ addData() [2/2]+ +◆ addData() [2/2]
|
|
-◆ setAppearance()+ +◆ setAppearance()
-
Does the characteristic support writing with no response? -
Does the characteristic support writing without a response? +
◆ deleteDescriptor()+ +◆ canWriteSigned()+ +
+
+
+
+
+
+
+Does the characteristic support signed writing? +
◆ deleteDescriptor()
@@ -357,7 +334,7 @@ Public Member Functions | ( | const NimBLEUUID & | uuid | ) | -+ | const | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Delete the descriptors in the descriptor vector.
-We maintain a vector called m_descriptorVector that contains pointers to NimBLERemoteDescriptors object references. Since we allocated these in this class, we are also responsible for deleting them. This method does just that.
+We maintain a vector called m_vDescriptors that contains pointers to NimBLERemoteDescriptors object references. Since we allocated these in this class, we are also responsible for deleting them. This method does just that.
| uint16_t NimBLERemoteCharacteristic::getDefHandle | -( | -) | -- |
Get the handle for this characteristics definition.
-| std::vector< NimBLERemoteDescriptor * > * NimBLERemoteCharacteristic::getDescriptors | +const std::vector< NimBLERemoteDescriptor * > & NimBLERemoteCharacteristic::getDescriptors | ( | bool | refresh = false | ) | -+ | const |
| uint16_t NimBLERemoteCharacteristic::getHandle | +const NimBLERemoteService * NimBLERemoteCharacteristic::getRemoteService | ( | ) | -- |
Get the handle for this characteristic.
-| NimBLERemoteService * NimBLERemoteCharacteristic::getRemoteService | -( | -) | -+ | const |
| NimBLEUUID NimBLERemoteCharacteristic::getUUID | +bool NimBLERemoteCharacteristic::hasExtendedProps | ( | ) | -+ | const |
Get the UUID for this characteristic.
-Does the characteristic support extended properties?
+| NimBLEAttValue NimBLERemoteCharacteristic::getValue | -( | -time_t * | -timestamp = nullptr | ) | -- |
Get the value of the remote characteristic.
-| [in] | timestamp | A pointer to a time_t struct to store the time the value was read. |
-
|
- -inline | -
Template to convert the remote characteristic data to <type>.
-| T | The type to convert the data to. |
| [in] | timestamp | A pointer to a time_t struct to store the time the value was read. |
| [in] | skipSizeCheck | If true it will skip checking if the data size is less than sizeof(<type>). |
sizeof(<type>).Use: getValue<type>(×tamp, skipSizeCheck);
| float NimBLERemoteCharacteristic::readFloat | -( | -) | -- |
Read a float value.
-| uint16_t NimBLERemoteCharacteristic::readUInt16 | -( | -) | -- |
Read an unsigned 16 bit value.
-| uint32_t NimBLERemoteCharacteristic::readUInt32 | -( | -) | -- |
Read an unsigned 32 bit value.
-| uint8_t NimBLERemoteCharacteristic::readUInt8 | -( | -) | -- |
| NimBLEAttValue NimBLERemoteCharacteristic::readValue | -( | -time_t * | -timestamp = nullptr | ) | -- |
Read the value of the remote characteristic.
-| [in] | timestamp | A pointer to a time_t struct to store the time the value was read. |
-
|
- -inline | -
Template to convert the remote characteristic data to <type>.
-| T | The type to convert the data to. |
| [in] | timestamp | A pointer to a time_t struct to store the time the value was read. |
| [in] | skipSizeCheck | If true it will skip checking if the data size is less than sizeof(<type>). |
sizeof(<type>).Use: readValue<type>(×tamp, skipSizeCheck);
| bool NimBLERemoteCharacteristic::registerForNotify | -( | -notify_callback | -notifyCallback, | -
| - | - | bool | -notifications = true, |
-
| - | - | bool | -response = true |
-
| - | ) | -- |
backward-compatibility method for subscribe/unsubscribe notifications/indications
-| [in] | notifyCallback | A callback to be invoked for a notification. If NULL is provided then we will unregister for notifications. |
| [in] | notifications | If true, register for notifications, false register for indications. |
| [in] | response | If true, require a write response from the descriptor write operation. |
nullptr, false true falsetrue| bool NimBLERemoteCharacteristic::writeValue | -( | -const char * | -char_s, | -
| - | - | bool | -response = false |
-
| - | ) | -- |
Write a new value to the remote characteristic from a const char*.
-| [in] | char_s | A character string to write to the remote characteristic. |
| [in] | response | Whether we require a response from the write. |
| bool NimBLERemoteCharacteristic::writeValue | -( | -const std::vector< uint8_t > & | -vec, | -
| - | - | bool | -response = false |
-
| - | ) | -- |
Write a new value to the remote characteristic from a std::vector<uint8_t>.
-| [in] | vec | A std::vector<uint8_t> value to write to the remote characteristic. |
| [in] | response | Whether we require a response from the write. |
-
|
- -inline | -
Template to set the remote characteristic value to <type>val.
-| [in] | s | The value to write. |
| [in] | response | True == request write response. |
Only used for non-arrays and types without a c_str() method.
-
|
- -inline | -
Template to set the remote characteristic value to <type>val.
-| [in] | s | The value to write. |
| [in] | response | True == request write response. |
Only used if the <type> has a c_str() method.
| bool NimBLERemoteCharacteristic::writeValue | -( | -const uint8_t * | -data, | -
| - | - | size_t | -length, | -
| - | - | bool | -response = false |
-
| - | ) | -- |
Write a new value to the remote characteristic from a data buffer.
-| [in] | data | A pointer to a data buffer. |
| [in] | length | The length of the data in the data buffer. |
| [in] | response | Whether we require a response from the write. |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
This is the complete list of members for NimBLERemoteDescriptor, including all inherited members.
| getHandle() | NimBLERemoteDescriptor | |
| getRemoteCharacteristic() | NimBLERemoteDescriptor | |
| getUUID() | NimBLERemoteDescriptor | |
| readUInt16() __attribute__((deprecated("Use template readValue<uint16_t>()"))) | NimBLERemoteDescriptor | |
| readUInt32() __attribute__((deprecated("Use template readValue<uint32_t>()"))) | NimBLERemoteDescriptor | |
| readUInt8() __attribute__((deprecated("Use template readValue<uint8_t>()"))) | NimBLERemoteDescriptor | |
| readValue() | NimBLERemoteDescriptor | |
| readValue(bool skipSizeCheck=false) | NimBLERemoteDescriptor | inline |
| toString(void) | NimBLERemoteDescriptor | |
| writeValue(const uint8_t *data, size_t length, bool response=false) | NimBLERemoteDescriptor | |
| writeValue(const std::vector< uint8_t > &v, bool response=false) | NimBLERemoteDescriptor | |
| writeValue(const char *s, bool response=false) | NimBLERemoteDescriptor | |
| writeValue(const T &s, bool response=false) | NimBLERemoteDescriptor | inline |
| writeValue(const T &s, bool response=false) | NimBLERemoteDescriptor | inline |
| getHandle() const | NimBLEAttribute | inline |
| getRemoteCharacteristic() const | NimBLERemoteDescriptor | |
| getUUID() const | NimBLEAttribute | inline |
| NimBLEAttribute(const NimBLEUUID &uuid, uint16_t handle) | NimBLEAttribute | inlineprotected |
| toString(void) const | NimBLERemoteDescriptor | |
| ~NimBLEAttribute()=default | NimBLEAttribute | protected |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
A model of remote BLE descriptor. More...
+ +#include <NimBLERemoteDescriptor.h>
Inherits NimBLERemoteValueAttribute.
+Public Member Functionsuint16_t | getHandle () | | Retrieve the handle associated with this remote descriptor. More... | | NimBLERemoteCharacteristic * | getRemoteCharacteristic () | | Get the characteristic that owns this descriptor. More... | | NimBLEUUID | getUUID () | | Retrieve the UUID associated this remote descriptor. More... | | NimBLEAttValue | readValue () | | Read the value of the remote descriptor. More... | | uint8_t | readUInt8 () __attribute__((deprecated("Use template readValue<uint8_t>()"))) | | Read a byte value. More... | | uint16_t | readUInt16 () __attribute__((deprecated("Use template readValue<uint16_t>()"))) | | Read an unsigned 16 bit value. More... | | uint32_t | readUInt32 () __attribute__((deprecated("Use template readValue<uint32_t>()"))) | | Read an unsigned 32 bit value. More... | | std::string | toString (void) | | Return a string representation of this Remote Descriptor. More... | | bool | writeValue (const uint8_t *data, size_t length, bool response=false) | | Write a new value to a remote descriptor. More... | | bool | writeValue (const std::vector< uint8_t > &v, bool response=false) | | Write a new value to a remote descriptor from a std::vector<uint8_t>. More... | | bool | writeValue (const char *s, bool response=false) | | Write a new value to the remote descriptor from a const char*. More... | | template<typename T > | bool | writeValue (const T &s, bool response=false) | | Template to set the remote descriptor value to <type>val. More... | | template<typename T > | bool | writeValue (const T &s, bool response=false) | | Template to set the remote descriptor value to <type>val. More... | | template<typename T > | T | readValue (bool skipSizeCheck=false) | | Template to convert the remote descriptor data to <type>. More... | | NimBLERemoteCharacteristic * | getRemoteCharacteristic () const | | Get the characteristic that owns this descriptor. | | std::string | toString (void) const | | Return a string representation of this Remote Descriptor. | | |||||||||||||||||||||||
A model of remote BLE descriptor.
| uint16_t NimBLERemoteDescriptor::getHandle | -( | -) | -- |
Retrieve the handle associated with this remote descriptor.
-| NimBLEUUID NimBLERemoteDescriptor::getUUID | -( | -) | -- |
Retrieve the UUID associated this remote descriptor.
-| uint16_t NimBLERemoteDescriptor::readUInt16 | -( | -) | -- |
Read an unsigned 16 bit value.
-| uint32_t NimBLERemoteDescriptor::readUInt32 | -( | -) | -- |
Read an unsigned 32 bit value.
-| uint8_t NimBLERemoteDescriptor::readUInt8 | -( | -) | -- |
| NimBLEAttValue NimBLERemoteDescriptor::readValue | -( | -) | -- |
Read the value of the remote descriptor.
-
-
|
- -inline | -
Template to convert the remote descriptor data to <type>.
-| T | The type to convert the data to. |
| [in] | skipSizeCheck | If true it will skip checking if the data size is less than sizeof(<type>). |
sizeof(<type>).Use: readValue<type>(skipSizeCheck);
Return a string representation of this Remote Descriptor.
| bool NimBLERemoteDescriptor::writeValue | -( | -const char * | -char_s, | -
| - | - | bool | -response = false |
-
| - | ) | -- |
Write a new value to the remote descriptor from a const char*.
-| [in] | char_s | A character string to write to the remote descriptor. |
| [in] | response | Whether we require a response from the write. |
| bool NimBLERemoteDescriptor::writeValue | -( | -const std::vector< uint8_t > & | -vec, | -
| - | - | bool | -response = false |
-
| - | ) | -- |
Write a new value to a remote descriptor from a std::vector<uint8_t>.
-| [in] | vec | A std::vector<uint8_t> value to write to the remote descriptor. |
| [in] | response | Whether we require a response from the write. |
-
|
- -inline | -
Template to set the remote descriptor value to <type>val.
-| [in] | s | The value to write. |
| [in] | response | True == request write response. |
Only used for non-arrays and types without a c_str() method.
-
|
- -inline | -
Template to set the remote descriptor value to <type>val.
-| [in] | s | The value to write. |
| [in] | response | True == request write response. |
Only used if the <type> has a c_str() method.
| bool NimBLERemoteDescriptor::writeValue | -( | -const uint8_t * | -data, | -
| - | - | size_t | -length, | -
| - | - | bool | -response = false |
-
| - | ) | -- |
Write a new value to a remote descriptor.
-| [in] | data | The data to send to the remote descriptor. |
| [in] | length | The length of the data to send. |
| [in] | response | True if we expect a write response. |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
This is the complete list of members for NimBLERemoteService, including all inherited members.
| begin() | NimBLERemoteService | |
| deleteCharacteristic(const NimBLEUUID &uuid) | NimBLERemoteService | |
| deleteCharacteristics() | NimBLERemoteService | |
| end() | NimBLERemoteService | |
| getCharacteristic(const char *uuid) | NimBLERemoteService | |
| getCharacteristic(const NimBLEUUID &uuid) | NimBLERemoteService | |
| getCharacteristics(bool refresh=false) | NimBLERemoteService | |
| getClient(void) | NimBLERemoteService | |
| getUUID(void) | NimBLERemoteService | |
| getValue(const NimBLEUUID &characteristicUuid) | NimBLERemoteService | |
| setValue(const NimBLEUUID &characteristicUuid, const std::string &value) | NimBLERemoteService | |
| toString(void) | NimBLERemoteService | |
| ~NimBLERemoteService() | NimBLERemoteService | virtual |
| begin() const | NimBLERemoteService | |
| deleteCharacteristic(const NimBLEUUID &uuid) const | NimBLERemoteService | |
| deleteCharacteristics() const | NimBLERemoteService | |
| end() const | NimBLERemoteService | |
| getCharacteristic(const char *uuid) const | NimBLERemoteService | |
| getCharacteristic(const NimBLEUUID &uuid) const | NimBLERemoteService | |
| getCharacteristics(bool refresh=false) const | NimBLERemoteService | |
| getClient(void) const | NimBLERemoteService | |
| getHandle() const | NimBLEAttribute | inline |
| getUUID() const | NimBLEAttribute | inline |
| getValue(const NimBLEUUID &characteristicUuid) const | NimBLERemoteService | |
| NimBLEAttribute(const NimBLEUUID &uuid, uint16_t handle) | NimBLEAttribute | inlineprotected |
| setValue(const NimBLEUUID &characteristicUuid, const NimBLEAttValue &value) const | NimBLERemoteService | |
| toString(void) const | NimBLERemoteService | |
| ~NimBLEAttribute()=default | NimBLEAttribute | protected |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
A model of a remote BLE service. More...
+ +#include <NimBLERemoteService.h>
Inherits NimBLEAttribute.
+Public Member Functions
-virtual | ~NimBLERemoteService () | | When deleting the service make sure we delete all characteristics and descriptors. | | std::vector< NimBLERemoteCharacteristic * >::iterator | begin () | | Get iterator to the beginning of the vector of remote characteristic pointers. More... | | std::vector< NimBLERemoteCharacteristic * >::iterator | end () | | Get iterator to the end of the vector of remote characteristic pointers. More... | | NimBLERemoteCharacteristic * | getCharacteristic (const char *uuid) | | Get the remote characteristic object for the characteristic UUID. More... | | NimBLERemoteCharacteristic * | getCharacteristic (const NimBLEUUID &uuid) | | Get the characteristic object for the UUID. More... | | void | deleteCharacteristics () | | Delete the characteristics in the characteristics vector. More... | | size_t | deleteCharacteristic (const NimBLEUUID &uuid) | | Delete characteristic by UUID. More... | | NimBLEClient * | getClient (void) | | Get the client associated with this service. More... | |
-NimBLEUUID | getUUID (void) | | Get the service UUID. | | std::string | getValue (const NimBLEUUID &characteristicUuid) | | Read the value of a characteristic associated with this service. More... | | bool | setValue (const NimBLEUUID &characteristicUuid, const std::string &value) | | Set the value of a characteristic. More... | | std::string | toString (void) | | Create a string representation of this remote service. More... | | std::vector< NimBLERemoteCharacteristic * > * | getCharacteristics (bool refresh=false) | | Get a pointer to the vector of found characteristics. More... | | NimBLERemoteCharacteristic * | getCharacteristic (const char *uuid) const | | Get the remote characteristic object for the characteristic UUID. | | NimBLERemoteCharacteristic * | getCharacteristic (const NimBLEUUID &uuid) const | | Get the characteristic object for the UUID. | | void | deleteCharacteristics () const | | Delete the characteristics in the characteristics vector. | | size_t | deleteCharacteristic (const NimBLEUUID &uuid) const | | Delete characteristic by UUID. | | NimBLEClient * | getClient (void) const | | Get the client associated with this service. | | NimBLEAttValue | getValue (const NimBLEUUID &characteristicUuid) const | | Read the value of a characteristic associated with this service. | | bool | setValue (const NimBLEUUID &characteristicUuid, const NimBLEAttValue &value) const | | Set the value of a characteristic. | | std::string | toString (void) const | | Create a string representation of this remote service. | | const std::vector< NimBLERemoteCharacteristic * > & | getCharacteristics (bool refresh=false) const | | Get a pointer to the vector of found characteristics. | | std::vector< NimBLERemoteCharacteristic * >::iterator | begin () const | | Get iterator to the beginning of the vector of remote characteristic pointers. | | std::vector< NimBLERemoteCharacteristic * >::iterator | end () const | | Get iterator to the end of the vector of remote characteristic pointers. | | Public Member Functions inherited from NimBLEAttributeconst NimBLEUUID & | getUUID () const | | Get the UUID of the attribute. | |
+uint16_t | getHandle () const | | Get the handle of the attribute. | | | |||||||||||||||||||||||||||||||
+Additional Inherited Members | |
| Protected Member Functions inherited from NimBLEAttribute | |
| NimBLEAttribute (const NimBLEUUID &uuid, uint16_t handle) | |
| Construct a new NimBLEAttribute object. | |
| + | ~NimBLEAttribute ()=default |
| Destroy the NimBLEAttribute object. | |
A model of a remote BLE service.
| std::vector< NimBLERemoteCharacteristic * > * NimBLERemoteService::getCharacteristics | +const std::vector< NimBLERemoteCharacteristic * > & NimBLERemoteService::getCharacteristics | ( | bool | refresh = false | ) | -+ | const |
| std::string NimBLERemoteService::getValue | +NimBLEAttValue NimBLERemoteService::getValue | ( | const NimBLEUUID & | -characteristicUuid | ) | -+ | uuid | ) | +const |
| [in] | characteristicUuid | The characteristic to read. |
| [in] | uuid | The characteristic to read. |
| [in] | characteristicUuid | The characteristic to set. |
| [in] | uuid | The characteristic UUID to set. |
| [in] | value | The value to set. |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
This is the complete list of members for NimBLEScan, including all inherited members.
| clearDuplicateCache() | NimBLEScan | |
| clearResults() | NimBLEScan | |
| erase(const NimBLEAddress &address) | NimBLEScan | |
| getResults() | NimBLEScan | |
| isScanning() | NimBLEScan | |
| setActiveScan(bool active) | NimBLEScan | |
| setAdvertisedDeviceCallbacks(NimBLEAdvertisedDeviceCallbacks *pAdvertisedDeviceCallbacks, bool wantDuplicates=false) | NimBLEScan | |
| setDuplicateFilter(bool enabled) | NimBLEScan | |
| clearResults() | NimBLEScan | |
| erase(const NimBLEAddress &address) | NimBLEScan | |
| erase(const NimBLEAdvertisedDevice *device) | NimBLEScan | |
| getResults() | NimBLEScan | |
| getResults(uint32_t duration, bool is_continue=false) | NimBLEScan | |
| isScanning() | NimBLEScan | |
| setActiveScan(bool active) | NimBLEScan | |
| setDuplicateFilter(uint8_t enabled) | NimBLEScan | |
| setFilterPolicy(uint8_t filter) | NimBLEScan | |
| setInterval(uint16_t intervalMSecs) | NimBLEScan | |
| setInterval(uint16_t intervalMs) | NimBLEScan | |
| setLimitedOnly(bool enabled) | NimBLEScan | |
| setMaxResults(uint8_t maxResults) | NimBLEScan | |
| setWindow(uint16_t windowMSecs) | NimBLEScan | |
| start(uint32_t duration, void(*scanCompleteCB)(NimBLEScanResults), bool is_continue=false) | NimBLEScan | |
| start(uint32_t duration, bool is_continue=false) | NimBLEScan | |
| stop() | NimBLEScan | |
| setMaxResults(uint8_t maxResults) | NimBLEScan | |
| setPeriod(uint32_t periodMs) | NimBLEScan | |
| setPhy(Phy phyMask) | NimBLEScan | |
| setScanCallbacks(NimBLEScanCallbacks *pScanCallbacks, bool wantDuplicates=false) | NimBLEScan | |
| setWindow(uint16_t windowMs) | NimBLEScan | |
| start(uint32_t duration, bool isContinue=false, bool restart=true) | NimBLEScan | |
| stop() | NimBLEScan |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
Perform and manage BLE scans. More...
+ +#include <NimBLEScan.h>
+Public Member Functionsbool | start (uint32_t duration, void(*scanCompleteCB)(NimBLEScanResults), bool is_continue=false) | | Start scanning. More... | | NimBLEScanResults | start (uint32_t duration, bool is_continue=false) | | Start scanning and block until scanning has been completed. More... | | bool | isScanning () | | Get the status of the scanner. More... | bool | start (uint32_t duration, bool isContinue=false, bool restart=true) | | Start scanning. | | bool | isScanning () | | void | setAdvertisedDeviceCallbacks (NimBLEAdvertisedDeviceCallbacks *pAdvertisedDeviceCallbacks, bool wantDuplicates=false) | | Set the call backs to be invoked. More... | | void | setActiveScan (bool active) | | Should we perform an active or passive scan? The default is a passive scan. An active scan means that we will request a scan response. More... | void | setScanCallbacks (NimBLEScanCallbacks *pScanCallbacks, bool wantDuplicates=false) | | Set the call backs to be invoked. | | void | setActiveScan (bool active) | | void | setInterval (uint16_t intervalMSecs) | | Set the interval to scan. More... | | void | setWindow (uint16_t windowMSecs) | | Set the window to actively scan. More... | | void | setDuplicateFilter (bool enabled) | | Set whether or not the BLE controller should only report results from devices it has not already seen. More... | | void | setLimitedOnly (bool enabled) | | Set whether or not the BLE controller only report scan results from devices advertising in limited discovery mode, i.e. directed advertising. More... | void | setInterval (uint16_t intervalMs) | | Set the interval to scan. | | void | setWindow (uint16_t windowMs) | | Set the window to actively scan. | | void | setDuplicateFilter (uint8_t enabled) | | Set whether or not the BLE controller should only report results from devices it has not already seen. | | void | setLimitedOnly (bool enabled) | | void | setFilterPolicy (uint8_t filter) | | Sets the scan filter policy. More... | void | setFilterPolicy (uint8_t filter) | |
-void | clearDuplicateCache () | | Clears the duplicate scan filter cache. | | bool | stop () | | Stop an in progress scan. More... | bool | stop () | |
-void | clearResults () | | Clear the results of the scan. |
+void | clearResults () | | NimBLEScanResults | getResults () | | Get the results of the scan. More... | NimBLEScanResults | getResults () | | void | setMaxResults (uint8_t maxResults) | | Sets the max number of results to store. More... | NimBLEScanResults | getResults (uint32_t duration, bool is_continue=false) | | Start scanning and block until scanning has been completed. | | void | setMaxResults (uint8_t maxResults) | | void | erase (const NimBLEAddress &address) | | Delete peer device from the scan results vector. More... | void | erase (const NimBLEAddress &address) | | void | erase (const NimBLEAdvertisedDevice *device) | | Delete peer device from the scan results vector. | | void | setPhy (Phy phyMask) | | Set the PHYs to scan. | | void | setPeriod (uint32_t periodMs) | | Set the extended scanning period. | | Get the status of the scanner. | Should we perform an active or passive scan? The default is a passive scan. An active scan means that we will request a scan response. | Set whether or not the BLE controller only reports scan results from devices advertising in limited discovery mode. | Sets the scan filter policy. | Stop an in progress scan. | Clear the stored results of the scan. | Get the results of the scan. | Sets the max number of results to store. | Delete peer device from the scan results vector. | ||||||||||||||||||||||||||||||||||||||
Perform and manage BLE scans.
Scanning is associated with a BLE client that is attempting to locate BLE servers.
| [in] | address | The address of the device to delete from the results. |
| [in] | address | The address of the device to delete from the results. |
After disconnecting, it may be required in the case we were connected to a device without a public address.
- -| void NimBLEScan::erase | +( | +const NimBLEAdvertisedDevice * | +device | ) | ++ |
Delete peer device from the scan results vector.
+| [in] | device | The device to delete from the results. |
| NimBLEScanResults NimBLEScan::getResults | +( | +uint32_t | +duration, | +
| + | + | bool | +is_continue = false |
+
| + | ) | ++ |
Start scanning and block until scanning has been completed.
+| [in] | duration | The duration in milliseconds for which to scan. |
| [in] | is_continue | Set to true to save previous scan results, false to clear them. |
| void NimBLEScan::setAdvertisedDeviceCallbacks | -( | -NimBLEAdvertisedDeviceCallbacks * | -pAdvertisedDeviceCallbacks, | -
| - | - | bool | -wantDuplicates = false |
-
| - | ) | -- |
Set the call backs to be invoked.
-| [in] | pAdvertisedDeviceCallbacks | Call backs to be invoked. |
| [in] | wantDuplicates | True if we wish to be called back with duplicates. Default is false. |
| [in] | enabled | If true, scanned devices will only be reported once. |
| [in] | enabled | If set to 1 (true), scanned devices will only be reported once. If set to 0 duplicates will be reported each time they are seen. If using extended scanning this can be set to 2 which will reset the duplicate filter at the end of each scan period if the scan period is set. |
The controller has a limited buffer and will start reporting duplicate devices once the limit is reached.
+| [in] | intervalMSecs | The scan interval (how often) in milliseconds. |
| [in] | intervalMs | The scan interval in milliseconds. |
The interval is the time between the start of two consecutive scan windows. When a new interval starts the controller changes the channel it's scanning on.
- -Set whether or not the BLE controller only report scan results from devices advertising in limited discovery mode, i.e. directed advertising.
+Set whether or not the BLE controller only reports scan results from devices advertising in limited discovery mode.
| [in] | enabled | If true, only limited discovery devices will be in scan results. |
-◆ setMaxResults()+ +◆ setMaxResults()
@@ -422,49 +462,80 @@ void |
-◆ setWindow()+ +◆ setPeriod()
-
+Set the window to actively scan. +Set the extended scanning period.
The period is the time between the start of two consecutive scan periods. This works as a timer to restart scanning at the specified amount of time in periodMs.
◆ setPhy()+ +
+
-
-
+
+
+
Set the PHYs to scan. +
◆ start() [1/2]+ +◆ setScanCallbacks()
@@ -179,18 +187,18 @@ void |
-◆ getDevice() [1/2]+ +◆ getDevice() [1/2]
@@ -206,26 +214,26 @@ void |
-◆ getDevice() [2/2]+ +◆ getDevice() [2/2]
- Return the specified device at the given index. The index should be between 0 and getCount()-1. +Return the specified device at the given index. The index should be between 0 and getCount()-1.
|
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-NimBLESecurity Class Reference
-
-
-A class to handle BLE security operations. Deprecated - provided for backward compatibility only. - More... -
Detailed Description-A class to handle BLE security operations. Deprecated - provided for backward compatibility only. -
Member Function Documentation- -◆ setAuthenticationMode()- -
-
-
-
-
-
-
-Set requested authentication mode. -
◆ setCapability()- -
-
-
-
-
-
-
-Set our device IO capability to let end user perform authorization either by displaying or entering generated 6-digit pin code or use "just works". -
◆ setInitEncryptionKey()- -
-
-
-
-
-
-
-Sets the keys we will distribute during encryption. -
◆ setKeySize()- -
-
-
-
-
-
-
◆ setRespEncryptionKey()- -
-
-
-
-
-
-
-Sets the keys we will accept during encryption. -
◆ setStaticPIN()- -
-
-
-
-
-
-Sets a static PIN used to authenticate/encrypt the connection. -
-
-
-
diff --git a/class_nim_b_l_e_security.js b/class_nim_b_l_e_security.js
deleted file mode 100644
index 5b59ec9..0000000
--- a/class_nim_b_l_e_security.js
+++ /dev/null
@@ -1,9 +0,0 @@
-var class_nim_b_l_e_security =
-[
- [ "setAuthenticationMode", "class_nim_b_l_e_security.html#a5cf0d3672a16f557032bcbf39a9e22f2", null ],
- [ "setCapability", "class_nim_b_l_e_security.html#a1bb7902d5ceffaca86bd7638a74e35e3", null ],
- [ "setInitEncryptionKey", "class_nim_b_l_e_security.html#adfc3caa3e1a5aedc3be5c0f1dc5c99ac", null ],
- [ "setKeySize", "class_nim_b_l_e_security.html#ab2be50284a325ec8937abdab0baafd4b", null ],
- [ "setRespEncryptionKey", "class_nim_b_l_e_security.html#aac8434faa02a6813b7efd87224e04714", null ],
- [ "setStaticPIN", "class_nim_b_l_e_security.html#a0bb1535e1b0d48566c17f681b7539f82", null ]
-];
\ No newline at end of file
diff --git a/class_nim_b_l_e_security_callbacks.html b/class_nim_b_l_e_security_callbacks.html
deleted file mode 100644
index 3a55e6f..0000000
--- a/class_nim_b_l_e_security_callbacks.html
+++ /dev/null
@@ -1,254 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-NimBLESecurityCallbacks Class Referenceabstract
-
-
-Callbacks to handle GAP events related to authorization. Deprecated - provided for backward compatibility only. - More... -
Detailed Description-Callbacks to handle GAP events related to authorization. Deprecated - provided for backward compatibility only. -
Member Function Documentation- -◆ onConfirmPIN()- -
-
-
-
-
-
-
-Called when using numeric comparison for authentication. -
◆ onPassKeyNotify()- -
-
-
-
-
-
-
-Provide us 6-digits code to perform authentication. It requires that our device is capable to display this code to end user. -
◆ onPassKeyRequest()- -
-
-
-
-
-
-
-Its request from peer device to input authentication pin code displayed on peer device. It requires that our device is capable to input 6-digits code by end user. -
◆ onSecurityRequest()- -
-
-
-
-
-
-Here we can make decision if we want to let negotiate authorization with peer device or not. -
-
-
-
diff --git a/class_nim_b_l_e_security_callbacks.js b/class_nim_b_l_e_security_callbacks.js
deleted file mode 100644
index af6cb09..0000000
--- a/class_nim_b_l_e_security_callbacks.js
+++ /dev/null
@@ -1,8 +0,0 @@
-var class_nim_b_l_e_security_callbacks =
-[
- [ "onAuthenticationComplete", "class_nim_b_l_e_security_callbacks.html#a22a8079906070a13583daafd1521a125", null ],
- [ "onConfirmPIN", "class_nim_b_l_e_security_callbacks.html#a2ce6a03693a43a55e51598d8b2654a92", null ],
- [ "onPassKeyNotify", "class_nim_b_l_e_security_callbacks.html#aa984ec6f29741b49bdd7dbfde60177be", null ],
- [ "onPassKeyRequest", "class_nim_b_l_e_security_callbacks.html#a1cfc9c48c02aece1736f9070dc6ff90f", null ],
- [ "onSecurityRequest", "class_nim_b_l_e_security_callbacks.html#a620de166c3fe26027871d18535839cdd", null ]
-];
\ No newline at end of file
diff --git a/class_nim_b_l_e_server-members.html b/class_nim_b_l_e_server-members.html
index 12df42d..0f220ad 100644
--- a/class_nim_b_l_e_server-members.html
+++ b/class_nim_b_l_e_server-members.html
@@ -1,9 +1,9 @@
-
+
-
-
+
+
-
+
+
+
+
+
+
+Loading...
+Searching...
+No Matches
+
-
-
+ NimBLEServer Member List NimBLEServer Member List This is the complete list of members for NimBLEServer, including all inherited members.
-
+
+
+
+
+
+
+Loading...
+Searching...
+No Matches
+
-
-
+ NimBLEServer Class Reference NimBLEServer Class Reference The model of a BLE server. More... + +
Detailed DescriptionThe model of a BLE server. Member Function Documentation- -◆ addService()+ +◆ addService()
@@ -198,12 +223,12 @@ or created and later added to services list.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Set the server to automatically start advertising when a client disconnects.
| [in] | aod | true == advertise, false == don't advertise. |
| [in] | enable | true == advertise, false == don't advertise. |
| int NimBLEServer::disconnect | +bool NimBLEServer::disconnect | ( | -uint16_t | -connId, | +const NimBLEConnInfo & | +connInfo, |
| @@ -303,7 +328,7 @@ or created and later added to services list. | ||||||
| ) | -+ | const |
Disconnect the specified client with optional reason.
| [in] | connId | Connection Id of the client to disconnect. |
| [in] | connInfo | Connection of the client to disconnect. |
| [in] | reason | code for disconnecting. |
| bool NimBLEServer::disconnect | +( | +uint16_t | +connHandle, | +
| + | + | uint8_t | +reason = BLE_ERR_REM_USER_CONN_TERM |
+
| + | ) | +const | +
Disconnect the specified client with optional reason.
+| [in] | connHandle | Connection handle of the client to disconnect. |
| [in] | reason | code for disconnecting. |
Retrieve the advertising object that can be used to advertise the existence of the server.
-| size_t NimBLEServer::getConnectedCount | +NimBLEClient * NimBLEServer::getClient | +( | +const NimBLEConnInfo & | +connInfo | ) | ++ |
Create a client instance from the NimBLEConnInfo reference.
+| [in] | connInfo | The connection info to create a client instance from. |
| NimBLEClient * NimBLEServer::getClient | +( | +uint16_t | +connHandle | ) | ++ |
Create a client instance from the connection handle.
+| [in] | connHandle | The connection handle to create a client instance from. |
| uint8_t NimBLEServer::getConnectedCount | ( | ) | -+ | const |
| NimBLEConnInfo NimBLEServer::getPeerIDInfo | +std::vector< uint16_t > NimBLEServer::getPeerDevices | ( | -uint16_t | -id | ) | -+ | ) | +const |
Get the connection information of a connected peer by connection ID.
-| [in] | id | The connection id of the peer. |
Get a vector of the connected client handles.
+| NimBLEConnInfo NimBLEServer::getPeerInfoByHandle | +( | +uint16_t | +connHandle | ) | +const | +
Get the connection information of a connected peer by connection handle.
+| [in] | connHandle | The connection handle of the peer. |
Get the MTU of the client.
-Get the MTU value of a client connection.
+| [in] | connHandle | The connection handle of the client to get the MTU value for. |
| bool NimBLEServer::getPhy | +( | +uint16_t | +connHandle, | +
| + | + | uint8_t * | +txPhy, | +
| + | + | uint8_t * | +rxPhy | +
| + | ) | ++ |
Get the PHY used for a peer connection.
+| [in] | connHandle | the connection handle to the get the PHY for. |
| [out] | txPhy | The TX PHY. |
| [out] | rxPhy | The RX PHY. |
Can only be used after a connection has been established.
Sends a data length update request to the peer. The Data Length Extension (DLE) allows to increase the Data Channel Payload from 27 bytes to up to 251 bytes. The peer needs to support the Bluetooth 4.2 specifications, to be capable of DLE.
| [in] | conn_handle | The connection handle of the peer to send the request to. |
| [in] | tx_octets | The preferred number of payload octets to use (Range 0x001B-0x00FB). |
| [in] | connHandle | The connection handle of the peer to send the request to. |
| [in] | octets | The preferred number of payload octets to use (Range 0x001B-0x00FB). |
| bool NimBLEServer::startAdvertising | +void NimBLEServer::start | ( | ) | @@ -697,14 +892,41 @@ Advertising will need to be restarted by the user after calling this as we must |
Start the GATT server.
+Required to be called after setup of all services and characteristics / descriptors for the NimBLE host to register them.
+ +| bool NimBLEServer::startAdvertising | +( | +uint32_t | +duration = 0 | ) | +const | +
Start advertising.
+| [in] | duration | The duration in milliseconds to advertise for, default = forever. |
Start the server advertising its existence. This is a convenience function and is equivalent to retrieving the advertising object and invoking start upon it.
0 0 Start advertising.
| [in] | inst_id | The extended advertisement instance ID to start. |
| [in] | instId | The extended advertisement instance ID to start. |
| [in] | duration | How long to advertise for in milliseconds, 0 = forever (default). |
| [in] | max_events | Maximum number of advertisement events to send, 0 = no limit (default). |
| [in] | maxEvents | Maximum number of advertisement events to send, 0 = no limit (default). |
Convenience function to stop advertising a data set.
| [in] | inst_id | The extended advertisement instance ID to stop advertising. |
| [in] | instId | The extended advertisement instance ID to stop advertising. |
| [in] | conn_handle | The connection handle of the peer to send the request to. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| [in] | connHandle | The connection handle of the peer to send the request to. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| [in] | minInterval | The minimum connection interval in 1.25ms units. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| [in] | maxInterval | The maximum connection interval in 1.25ms units. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| [in] | latency | The number of packets allowed to skip (extends max interval). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| bool NimBLEServer::updatePhy | +( | +uint16_t | +connHandle, | +
| + | + | uint8_t | +txPhyMask, | +
| + | + | uint8_t | +rxPhyMask, | +
| + | + | uint16_t | +phyOptions | +
| + | ) | ++ |
Request an update to the PHY used for a peer connection.
+| [in] | connHandle | the connection handle to the update the PHY for. |
| [in] | txPhyMask | TX PHY. Can be mask of following:
|
| [in] | rxPhyMask | RX PHY. Can be mask of following:
|
| phyOptions | Additional PHY options. Valid values are:
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
This is the complete list of members for NimBLEServerCallbacks, including all inherited members.
| onAuthenticationComplete(ble_gap_conn_desc *desc) | NimBLEServerCallbacks | virtual |
| onConfirmPIN(uint32_t pin) | NimBLEServerCallbacks | virtual |
| onConnect(NimBLEServer *pServer) | NimBLEServerCallbacks | virtual |
| onConnect(NimBLEServer *pServer, ble_gap_conn_desc *desc) | NimBLEServerCallbacks | virtual |
| onDisconnect(NimBLEServer *pServer) | NimBLEServerCallbacks | virtual |
| onDisconnect(NimBLEServer *pServer, ble_gap_conn_desc *desc) | NimBLEServerCallbacks | virtual |
| onMTUChange(uint16_t MTU, ble_gap_conn_desc *desc) | NimBLEServerCallbacks | virtual |
| onPassKeyRequest() | NimBLEServerCallbacks | virtual |
| onAuthenticationComplete(NimBLEConnInfo &connInfo) | NimBLEServerCallbacks | virtual |
| onConfirmPassKey(NimBLEConnInfo &connInfo, uint32_t pin) | NimBLEServerCallbacks | virtual |
| onConnect(NimBLEServer *pServer, NimBLEConnInfo &connInfo) | NimBLEServerCallbacks | virtual |
| onConnParamsUpdate(NimBLEConnInfo &connInfo) | NimBLEServerCallbacks | virtual |
| onDisconnect(NimBLEServer *pServer, NimBLEConnInfo &connInfo, int reason) | NimBLEServerCallbacks | virtual |
| onIdentity(NimBLEConnInfo &connInfo) | NimBLEServerCallbacks | virtual |
| onMTUChange(uint16_t MTU, NimBLEConnInfo &connInfo) | NimBLEServerCallbacks | virtual |
| onPassKeyDisplay() | NimBLEServerCallbacks | virtual |
| onPhyUpdate(NimBLEConnInfo &connInfo, uint8_t txPhy, uint8_t rxPhy) | NimBLEServerCallbacks | virtual |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
Callbacks associated with the operation of a BLE server. More...
+ +#include <NimBLEServer.h>
+Public Member Functionsvirtual void | onConnect (NimBLEServer *pServer) | | Handle a client connection. This is called when a client connects. More... | | virtual void | onConnect (NimBLEServer *pServer, ble_gap_conn_desc *desc) | | Handle a client connection. This is called when a client connects. More... | | virtual void | onDisconnect (NimBLEServer *pServer) | | Handle a client disconnection. This is called when a client disconnects. More... | | virtual void | onDisconnect (NimBLEServer *pServer, ble_gap_conn_desc *desc) | | Handle a client disconnection. This is called when a client discconnects. More... | | virtual void | onMTUChange (uint16_t MTU, ble_gap_conn_desc *desc) | | Called when the connection MTU changes. More... | | virtual uint32_t | onPassKeyRequest () | | Called when a client requests a passkey for pairing. More... | | virtual void | onAuthenticationComplete (ble_gap_conn_desc *desc) | | Called when the pairing procedure is complete. More... | | virtual bool | onConfirmPIN (uint32_t pin) | | Called when using numeric comparision for pairing. More... | | virtual void | onConnect (NimBLEServer *pServer, NimBLEConnInfo &connInfo) | | Handle a client connection. This is called when a client connects. | | virtual void | onDisconnect (NimBLEServer *pServer, NimBLEConnInfo &connInfo, int reason) | | Handle a client disconnection. This is called when a client disconnects. | | virtual void | onMTUChange (uint16_t MTU, NimBLEConnInfo &connInfo) | | Called when the connection MTU changes. | | virtual uint32_t | onPassKeyDisplay () | | Called when a client requests a passkey for pairing (display). | | virtual void | onConfirmPassKey (NimBLEConnInfo &connInfo, uint32_t pin) | | Called when using numeric comparision for pairing. | | virtual void | onAuthenticationComplete (NimBLEConnInfo &connInfo) | | Called when the pairing procedure is complete. | | virtual void | onIdentity (NimBLEConnInfo &connInfo) | | Called when the peer identity address is resolved. | | virtual void | onConnParamsUpdate (NimBLEConnInfo &connInfo) | | Called when connection parameters are updated following a request to update via NimBLEServer::updateConnParams. | | virtual void | onPhyUpdate (NimBLEConnInfo &connInfo, uint8_t txPhy, uint8_t rxPhy) | | Called when the PHY update procedure is complete. | | |||||||||||||||||||||
Callbacks associated with the operation of a BLE server.
Called when the pairing procedure is complete.
| [in] | desc | A pointer to the struct containing the connection information. -This can be used to check the status of the connection encryption/pairing. |
| [in] | connInfo | A reference to a NimBLEConnInfo instance with information about the peer connection parameters. |
| bool NimBLEServerCallbacks::onConfirmPIN | +void NimBLEServerCallbacks::onConfirmPassKey | ( | -uint32_t | -pin | ) | +NimBLEConnInfo & | +connInfo, | +
| + | uint32_t | +pin | +|||||
| + | ) | +
Called when using numeric comparision for pairing.
| [in] | connInfo | A reference to a NimBLEConnInfo instance with information Should be passed back to NimBLEDevice::injectConfirmPasskey |
| [in] | pin | The pin to compare with the client. |
-
|
- -virtual | -
Handle a client connection. This is called when a client connects.
-| [in] | pServer | A pointer to the BLE server that received the client connection. |
Default callback handlers
- -| [in] | pServer | A pointer to the BLE server that received the client connection. |
| [in] | desc | A pointer to the connection description structure containig information about the connection parameters. |
| [in] | connInfo | A reference to a NimBLEConnInfo instance with information. about the peer connection parameters. |
Default callback handlers
- -| void NimBLEServerCallbacks::onDisconnect | +void NimBLEServerCallbacks::onConnParamsUpdate | ( | -NimBLEServer * | -pServer | ) | +NimBLEConnInfo & | +connInfo | ) |
Handle a client disconnection. This is called when a client disconnects.
+Called when connection parameters are updated following a request to update via NimBLEServer::updateConnParams.
| [in] | pServer | A reference to the BLE server that received the existing client disconnection. |
| [in] | connInfo | A reference to a NimBLEConnInfo instance containing the updated connection parameters. |
Handle a client disconnection. This is called when a client discconnects.
+Handle a client disconnection. This is called when a client disconnects.
| [in] | pServer | A pointer to the BLE server that received the client disconnection. |
| [in] | desc | A pointer to the connection description structure containing information about the connection. |
| [in] | connInfo | A reference to a NimBLEConnInfo instance with information about the peer connection parameters. |
| [in] | reason | The reason code for the disconnection. |
+
|
+ +virtual | +
Called when the peer identity address is resolved.
+| [in] | connInfo | A reference to a NimBLEConnInfo instance with information |
| [in] | MTU | The new MTU value. |
| [in] | desc | A pointer to the connection description structure containing information about the connection. |
| [in] | connInfo | A reference to a NimBLEConnInfo instance with information about the peer connection parameters. |
| uint32_t NimBLEServerCallbacks::onPassKeyRequest | +uint32_t NimBLEServerCallbacks::onPassKeyDisplay | ( | ) | @@ -420,9 +447,66 @@ This can be used to check the status of the connection encryption/pairing. |
Called when a client requests a passkey for pairing.
+Called when a client requests a passkey for pairing (display).
+
|
+ +virtual | +
Called when the PHY update procedure is complete.
+| [in] | connInfo | A reference to a NimBLEConnInfo instance with information about the peer connection parameters. |
| [in] | txPhy | The transmit PHY. |
| [in] | rxPhy | The receive PHY. Possible values:
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
This is the complete list of members for NimBLEService, including all inherited members.
| addCharacteristic(NimBLECharacteristic *pCharacteristic) | NimBLEService | |
| createCharacteristic(const char *uuid, uint32_t properties=NIMBLE_PROPERTY::READ|NIMBLE_PROPERTY::WRITE, uint16_t max_len=BLE_ATT_ATTR_MAX_LEN) | NimBLEService | |
| createCharacteristic(const char *uuid, uint32_t properties=NIMBLE_PROPERTY::READ|NIMBLE_PROPERTY::WRITE, uint16_t max_len=BLE_ATT_ATTR_MAX_LEN) | NimBLEService | |
| createCharacteristic(const NimBLEUUID &uuid, uint32_t properties=NIMBLE_PROPERTY::READ|NIMBLE_PROPERTY::WRITE, uint16_t max_len=BLE_ATT_ATTR_MAX_LEN) | NimBLEService | |
| dump() | NimBLEService | |
| getCharacteristic(const char *uuid, uint16_t instanceId=0) | NimBLEService | |
| getCharacteristic(const NimBLEUUID &uuid, uint16_t instanceId=0) | NimBLEService | |
| getCharacteristicByHandle(uint16_t handle) | NimBLEService | |
| getCharacteristics() | NimBLEService | |
| getCharacteristics(const char *uuid) | NimBLEService | |
| getCharacteristics(const NimBLEUUID &uuid) | NimBLEService | |
| getHandle() | NimBLEService | |
| getServer() | NimBLEService | |
| getUUID() | NimBLEService | |
| NimBLEService(const char *uuid) | NimBLEService | |
| dump() const | NimBLEService | |
| getCharacteristic(const char *uuid, uint16_t instanceId=0) const | NimBLEService | |
| getCharacteristic(const NimBLEUUID &uuid, uint16_t instanceId=0) const | NimBLEService | |
| getCharacteristicByHandle(uint16_t handle) const | NimBLEService | |
| getCharacteristics() const | NimBLEService | |
| getCharacteristics(const char *uuid) const | NimBLEService | |
| getCharacteristics(const NimBLEUUID &uuid) const | NimBLEService | |
| getHandle() const | NimBLEAttribute | inline |
| getRemoved() const | NimBLELocalAttribute | inline |
| getServer() const | NimBLEService | |
| getUUID() const | NimBLEAttribute | inline |
| isStarted() const | NimBLEService | |
| NimBLEAttribute(const NimBLEUUID &uuid, uint16_t handle) | NimBLEAttribute | inlineprotected |
| NimBLELocalAttribute(const NimBLEUUID &uuid, uint16_t handle) | NimBLELocalAttribute | inlineprotected |
| NimBLEService(const char *uuid) | NimBLEService | |
| NimBLEService(const NimBLEUUID &uuid) | NimBLEService | |
| removeCharacteristic(NimBLECharacteristic *pCharacteristic, bool deleteChr=false) | NimBLEService | |
| start() | NimBLEService | |
| toString() | NimBLEService | |
| removeCharacteristic(NimBLECharacteristic *pCharacteristic, bool deleteChr=false) | NimBLEService | |
| setRemoved(uint8_t removed) | NimBLELocalAttribute | inlineprotected |
| start() | NimBLEService | |
| toString() const | NimBLEService | |
| ~NimBLEAttribute()=default | NimBLEAttribute | protected |
| ~NimBLELocalAttribute()=default | NimBLELocalAttribute | protected |
| ~NimBLEService() | NimBLEService |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
The model of a BLE service. More...
+ +#include <NimBLEService.h>
Inherits NimBLELocalAttribute.
+Public Member Functions | NimBLEService (const char *uuid) | | Construct an instance of the NimBLEService. More... | | NimBLEService (const char *uuid) | | | NimBLEService (const NimBLEUUID &uuid) | | Construct an instance of the BLEService. More... | | NimBLEService (const NimBLEUUID &uuid) | | NimBLEServer * | getServer () | | Get the BLE server associated with this service. More... | | NimBLEUUID | getUUID () | | Get the UUID of the service. More... | | uint16_t | getHandle () | | Get the handle associated with this service. More... | | std::string | toString () | | Return a string representation of this service. A service is defined by: More... | | void | dump () | | Dump details of this BLE GATT service. More... | | bool | start () | | Builds the database of characteristics/descriptors for the service and registers it with the NimBLE stack. More... |
+ | ~NimBLEService () | | Destructor, make sure we release the resources allocated for the service. | | NimBLEServer * | getServer () const | | Get the BLE server associated with this service. | | std::string | toString () const | | Return a string representation of this service. A service is defined by: | |
+void | dump () const | | Dump details of this BLE GATT service. | | bool | isStarted () const | | Checks if the service has been started. | | bool | start () | | NimBLECharacteristic * | createCharacteristic (const char *uuid, uint32_t properties=NIMBLE_PROPERTY::READ|NIMBLE_PROPERTY::WRITE, uint16_t max_len=BLE_ATT_ATTR_MAX_LEN) | | Create a new BLE Characteristic associated with this service. More... | NimBLECharacteristic * | createCharacteristic (const char *uuid, uint32_t properties=NIMBLE_PROPERTY::READ|NIMBLE_PROPERTY::WRITE, uint16_t max_len=BLE_ATT_ATTR_MAX_LEN) | | NimBLECharacteristic * | createCharacteristic (const NimBLEUUID &uuid, uint32_t properties=NIMBLE_PROPERTY::READ|NIMBLE_PROPERTY::WRITE, uint16_t max_len=BLE_ATT_ATTR_MAX_LEN) | | Create a new BLE Characteristic associated with this service. More... | NimBLECharacteristic * | createCharacteristic (const NimBLEUUID &uuid, uint32_t properties=NIMBLE_PROPERTY::READ|NIMBLE_PROPERTY::WRITE, uint16_t max_len=BLE_ATT_ATTR_MAX_LEN) | | void | addCharacteristic (NimBLECharacteristic *pCharacteristic) | | Add a characteristic to the service. More... | void | addCharacteristic (NimBLECharacteristic *pCharacteristic) | | void | removeCharacteristic (NimBLECharacteristic *pCharacteristic, bool deleteChr=false) | | Remove a characteristic from the service. More... | void | removeCharacteristic (NimBLECharacteristic *pCharacteristic, bool deleteChr=false) | | NimBLECharacteristic * | getCharacteristic (const char *uuid, uint16_t instanceId=0) | | Get a pointer to the characteristic object with the specified UUID. More... | | NimBLECharacteristic * | getCharacteristic (const NimBLEUUID &uuid, uint16_t instanceId=0) | | Get a pointer to the characteristic object with the specified UUID. More... | | NimBLECharacteristic * | getCharacteristicByHandle (uint16_t handle) | | Get a pointer to the characteristic object with the specified handle. More... | | std::vector< NimBLECharacteristic * > | getCharacteristics () | | std::vector< NimBLECharacteristic * > | getCharacteristics (const char *uuid) | | std::vector< NimBLECharacteristic * > | getCharacteristics (const NimBLEUUID &uuid) | | NimBLECharacteristic * | getCharacteristic (const char *uuid, uint16_t instanceId=0) const | | Get a pointer to the characteristic object with the specified UUID. | | NimBLECharacteristic * | getCharacteristic (const NimBLEUUID &uuid, uint16_t instanceId=0) const | | Get a pointer to the characteristic object with the specified UUID. | | NimBLECharacteristic * | getCharacteristicByHandle (uint16_t handle) const | | Get a pointer to the characteristic object with the specified handle. | | const std::vector< NimBLECharacteristic * > & | getCharacteristics () const | | std::vector< NimBLECharacteristic * > | getCharacteristics (const char *uuid) const | | std::vector< NimBLECharacteristic * > | getCharacteristics (const NimBLEUUID &uuid) const | | Public Member Functions inherited from NimBLELocalAttributeuint8_t | getRemoved () const | | Get the removed flag. | | Public Member Functions inherited from NimBLEAttributeconst NimBLEUUID & | getUUID () const | | Get the UUID of the attribute. | |
+uint16_t | getHandle () const | | Get the handle of the attribute. | | | Construct an instance of the NimBLEService. | Construct an instance of the BLEService. | Builds the database of characteristics/descriptors for the service and registers it with the NimBLE stack. | Create a new BLE Characteristic associated with this service. | Create a new BLE Characteristic associated with this service. | Add a characteristic to the service. | Remove a characteristic from the service. | ||||||||||||||||||||||||||||||||||||||||||||||
+Additional Inherited Members | |
| Protected Member Functions inherited from NimBLELocalAttribute | |
| + | NimBLELocalAttribute (const NimBLEUUID &uuid, uint16_t handle) |
| Construct a local attribute. | |
| + | ~NimBLELocalAttribute ()=default |
| Destroy the local attribute. | |
| void | setRemoved (uint8_t removed) |
| Set the removed flag. | |
| Protected Member Functions inherited from NimBLEAttribute | |
| NimBLEAttribute (const NimBLEUUID &uuid, uint16_t handle) | |
| Construct a new NimBLEAttribute object. | |
| + | ~NimBLEAttribute ()=default |
| Destroy the NimBLEAttribute object. | |
The model of a BLE service.
Add a characteristic to the service.
| [in] | pCharacteristic | A pointer to the characteristic instance to add to the service. |
| [in] | pChar | A pointer to the characteristic instance to add to the service. |
| void NimBLEService::dump | -( | -) | -- |
Dump details of this BLE GATT service.
-0 0 | [in] | uuid | The UUID of the characteristic. |
| instanceId | The index of the characteristic to return (used when multiple characteristics have the same UUID). | |
| idx | The index of the characteristic to return (used when multiple characteristics have the same UUID). |
0 0 | [in] | uuid | The UUID of the characteristic. |
| instanceId | The index of the characteristic to return (used when multiple characteristics have the same UUID). | |
| idx | The index of the characteristic to return (used when multiple characteristics have the same UUID). |
| std::vector< NimBLECharacteristic * > NimBLEService::getCharacteristics | +const std::vector< NimBLECharacteristic * > & NimBLEService::getCharacteristics | ( | ) | -+ | const |
| uint16_t NimBLEService::getHandle | -( | -) | -- |
Get the handle associated with this service.
-| NimBLEUUID NimBLEService::getUUID | +bool NimBLEService::isStarted | ( | -void | ) | -+ | const |
Get the UUID of the service.
-Checks if the service has been started.
+Remove a characteristic from the service.
| [in] | pCharacteristic | A pointer to the characteristic instance to remove from the service. |
| [in] | pChar | A pointer to the characteristic instance to remove from the service. |
| [in] | deleteChr | If true it will delete the characteristic instance and free it's resources. |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
This is the complete list of members for NimBLEUUID, including all inherited members.
| bitSize() const | NimBLEUUID | |
| equals(const NimBLEUUID &uuid) const | NimBLEUUID | |
| equals(const NimBLEUUID &uuid) const | NimBLEUUID | |
| fromString(const std::string &uuid) | NimBLEUUID | static |
| getNative() const | NimBLEUUID | |
| NimBLEUUID(const std::string &uuid) | NimBLEUUID | |
| NimBLEUUID(uint16_t uuid) | NimBLEUUID | |
| NimBLEUUID(uint32_t uuid) | NimBLEUUID | |
| NimBLEUUID(const ble_uuid128_t *uuid) | NimBLEUUID | |
| NimBLEUUID(const uint8_t *pData, size_t size, bool msbFirst) | NimBLEUUID | |
| NimBLEUUID(uint32_t first, uint16_t second, uint16_t third, uint64_t fourth) | NimBLEUUID | |
| NimBLEUUID() | NimBLEUUID | |
| operator std::string() const | NimBLEUUID | |
| getBase() const | NimBLEUUID | |
| getValue() const | NimBLEUUID | |
| NimBLEUUID()=default | NimBLEUUID | |
| NimBLEUUID(const ble_uuid_any_t &uuid) | NimBLEUUID | |
| NimBLEUUID(const std::string &uuid) | NimBLEUUID | |
| NimBLEUUID(uint16_t uuid) | NimBLEUUID | |
| NimBLEUUID(uint32_t uuid) | NimBLEUUID | |
| NimBLEUUID(const ble_uuid128_t *uuid) | NimBLEUUID | |
| NimBLEUUID(const uint8_t *pData, size_t size) | NimBLEUUID | |
| NimBLEUUID(uint32_t first, uint16_t second, uint16_t third, uint64_t fourth) | NimBLEUUID | |
| operator std::string() const | NimBLEUUID | |
| operator!=(const NimBLEUUID &rhs) const | NimBLEUUID | |
| operator==(const NimBLEUUID &rhs) const | NimBLEUUID | |
| to128() | NimBLEUUID | |
| to16() | NimBLEUUID | |
| toString() const | NimBLEUUID | |
| operator==(const NimBLEUUID &rhs) const | NimBLEUUID | |
| reverseByteOrder() | NimBLEUUID | |
| to128() | NimBLEUUID | |
| to16() | NimBLEUUID | |
| toString() const | NimBLEUUID |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
A model of a BLE UUID. More...
+ +#include <NimBLEUUID.h>
+Public Member Functions | NimBLEUUID (const std::string &uuid) | | Create a UUID from a string. More... |
+ | NimBLEUUID ()=default | | Created a blank UUID. | | | NimBLEUUID (const ble_uuid_any_t &uuid) | | Create a UUID from the native UUID. | | | NimBLEUUID (const std::string &uuid) | | | NimBLEUUID (uint16_t uuid) | | Create a UUID from the 16bit value. More... | | NimBLEUUID (uint16_t uuid) | | | NimBLEUUID (uint32_t uuid) | | Create a UUID from the 32bit value. More... | | NimBLEUUID (uint32_t uuid) | | | NimBLEUUID (const ble_uuid128_t *uuid) | | Create a UUID from the native UUID. More... | | NimBLEUUID (const ble_uuid128_t *uuid) | | | NimBLEUUID (const uint8_t *pData, size_t size, bool msbFirst) | | Create a UUID from 2, 4, 16 bytes of memory. More... | | | NimBLEUUID (uint32_t first, uint16_t second, uint16_t third, uint64_t fourth) | | Create a UUID from the 128bit value using hex parts instead of string, instead of NimBLEUUID("ebe0ccb0-7a0a-4b0c-8a1a-6ff2997da3a6"), it becomes NimBLEUUID(0xebe0ccb0, 0x7a0a, 0x4b0c, 0x8a1a6ff2997da3a6) More... | | NimBLEUUID (const uint8_t *pData, size_t size) | | Create a UUID from 2, 4, 16 bytes of memory. | | | NimBLEUUID (uint32_t first, uint16_t second, uint16_t third, uint64_t fourth) | |
- | NimBLEUUID () | | Creates an empty UUID. | | uint8_t | bitSize () const | | Get the number of bits in this uuid. More... | uint8_t | bitSize () const | | bool | equals (const NimBLEUUID &uuid) const | | Compare a UUID against this UUID. More... | const uint8_t * | getValue () const | | Get the uuid value. | | const ble_uuid_t * | getBase () const | | Get a pointer to the NimBLE UUID base structure. | | bool | equals (const NimBLEUUID &uuid) const | | const ble_uuid_any_t * | getNative () const | | Get the native UUID value. More... | | const NimBLEUUID & | to128 () | | Convert a UUID to its 128 bit representation. More... | | const NimBLEUUID & | to16 () | | Convert 128 bit UUID to its 16 bit representation. More... | | std::string | toString () const | | Get a string representation of the UUID. More... | std::string | toString () const | |
-bool | operator== (const NimBLEUUID &rhs) const | const NimBLEUUID & | to128 () | | Convert a UUID to its 128 bit representation. | | const NimBLEUUID & | to16 () | | Convert 128 bit UUID to its 16 bit representation. | | const NimBLEUUID & | reverseByteOrder () | | Reverse the byte order of the UUID. | | |
-bool | operator!= (const NimBLEUUID &rhs) const | | | operator std::string () const | | Convenience operator to convert this UUID to string representation. More... | | operator std::string () const | | Create a UUID from a string. | Create a UUID from the 16bit value. | Create a UUID from the 32bit value. | Create a UUID from the native UUID. | Create a UUID from the 128bit value using hex parts instead of string, instead of NimBLEUUID("ebe0ccb0-7a0a-4b0c-8a1a-6ff2997da3a6"), it becomes NimBLEUUID(0xebe0ccb0, 0x7a0a, 0x4b0c, 0x8a1a6ff2997da3a6) | Get the bit size of the UUID, 16, 32 or 128. | Compare a UUID against this UUID. | Get a string representation of the UUID. | +bool | operator== (const NimBLEUUID &rhs) const | Convenience operator to check if this UUID is equal to another. | +bool | operator!= (const NimBLEUUID &rhs) const | Convenience operator to check if this UUID is not equal to another. | Convenience operator to convert this UUID to string representation. | |||||||||||||||||||||||||||||||||||||||
+Static Public Member Functionsstatic NimBLEUUID | fromString (const std::string &uuid) | | static NimBLEUUID | fromString (const std::string &uuid) | |||||
A model of a BLE UUID.
| NimBLEUUID::NimBLEUUID | +( | +const ble_uuid_any_t & | +uuid | ) | ++ |
Create a UUID from the native UUID.
+| [in] | uuid | The native UUID. |
| [in] | pData | The pointer to the start of the UUID. |
| [in] | size | The size of the data. |
| [in] | msbFirst | Is the MSB first in pData memory? |
Get the number of bits in this uuid.
-Get the bit size of the UUID, 16, 32 or 128.
+| const ble_uuid_any_t * NimBLEUUID::getNative | +const ble_uuid_t * NimBLEUUID::getBase | ( | ) | const | @@ -456,13 +492,35 @@ Static Public Member Functions
Get the native UUID value.
-Get a pointer to the NimBLE UUID base structure.
+| const uint8_t * NimBLEUUID::getValue | +( | +) | +const | +
Get the uuid value.
+bitSize() before accessing. | const NimBLEUUID & NimBLEUUID::reverseByteOrder | +( | +) | ++ |
Reverse the byte order of the UUID.
+This is useful when comparing UUIDs or when the advertisement data is reversed.
+ +Get a string representation of the UUID.
The format of a string is: 01234567 8901 2345 6789 012345678901 0000180d-0000-1000-8000-00805f9b34fb 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
This is the complete list of members for NimBLEUtils, including all inherited members.
| advTypeToString(uint8_t advType) | NimBLEUtils | static |
| buildHexData(uint8_t *target, const uint8_t *source, uint8_t length) | NimBLEUtils | static |
| checkConnParams(ble_gap_conn_params *params) | NimBLEUtils | static |
| dumpGapEvent(ble_gap_event *event, void *arg) | NimBLEUtils | static |
| dataToHexString(const uint8_t *source, uint8_t length) | NimBLEUtils | static |
| gapEventToString(uint8_t eventType) | NimBLEUtils | static |
| returnCodeToString(int rc) | NimBLEUtils | static |
| generateAddr(bool nrpa) | NimBLEUtils | static |
| returnCodeToString(int rc) | NimBLEUtils | static |
| taskRelease(const NimBLETaskData &taskData, int rc=0) | NimBLEUtils | static |
| taskWait(const NimBLETaskData &taskData, uint32_t timeout) | NimBLEUtils | static |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
A BLE Utility class with methods for debugging and general purpose use. More...
+ +#include <NimBLEUtils.h>
+Static Public Member Functionsstatic void | dumpGapEvent (ble_gap_event *event, void *arg) | | Utility function to log the gap event info. More... | | static const char * | gapEventToString (uint8_t eventType) | | Convert a GAP event type to a string representation. More... | static const char * | gapEventToString (uint8_t eventType) | | static char * | buildHexData (uint8_t *target, const uint8_t *source, uint8_t length) | | Create a hex representation of data. More... | | static const char * | advTypeToString (uint8_t advType) | | Convert the advertising type flag to a string. More... | static std::string | dataToHexString (const uint8_t *source, uint8_t length) | | Create a hexadecimal string representation of the input data. | | static const char * | advTypeToString (uint8_t advType) | | static const char * | returnCodeToString (int rc) | | Converts a return code from the NimBLE stack to a text string. More... | static const char * | returnCodeToString (int rc) | | static int | checkConnParams (ble_gap_conn_params *params) | | A function for checking validity of connection parameters. More... | | static NimBLEAddress | generateAddr (bool nrpa) | | Generate a random BLE address. | | static bool | taskWait (const NimBLETaskData &taskData, uint32_t timeout) | | Blocks the calling task until released or timeout. | | static void | taskRelease (const NimBLETaskData &taskData, int rc=0) | | Release a task. | | Convert a GAP event type to a string representation. | Convert the advertising type flag to a string. | Converts a return code from the NimBLE stack to a text string. | |||||||||||||||||
A BLE Utility class with methods for debugging and general purpose use.
| char * NimBLEUtils::buildHexData | +std::string NimBLEUtils::dataToHexString | ( | -uint8_t * | -target, | -
| - | const uint8_t * | source, |
Create a hex representation of data.
+Create a hexadecimal string representation of the input data.
| [in] | target | Where to write the hex string. If this is null, we malloc storage. |
| [in] | source | The start of the binary data. |
| [in] | length | The length of the data to convert. |
-
|
- -static | -
A function for checking validity of connection parameters.
-| [in] | params | A pointer to the structure containing the parameters to check. |
-
|
- -static | -
Utility function to log the gap event info.
-| [in] | event | A pointer to the gap event structure. |
| [in] | arg | Unused. |
+
|
+ +static | +
Generate a random BLE address.
+| [in] | nrpa | True to generate a non-resolvable private address, false to generate a random static address |
+
|
+ +static | +
Release a task.
+| [in] | taskData | A pointer to the task data structure. |
| [in] | flags | A return value to set in the task data structure. |
+
|
+ +static | +
Blocks the calling task until released or timeout.
+| [in] | taskData | A pointer to the task data structure. |
| [in] | timeout | The time to wait in milliseconds. |
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
1.9.1 1.9.8 |
- esp-nimble-cpp
- 1.4.1
+
+ |
esp-nimble-cpp 2.0.0
|
+Filesfile | nimconfig.h [code] | | HIDKeyboardTypes.h | | | HIDTypes.h | | | NimBLE2904.h | | | NimBLEAddress.h | | | NimBLEAdvertisedDevice.h | | | NimBLEAdvertisementData.h | | | NimBLEAdvertising.h | | | NimBLEAttribute.h | | | NimBLEAttValue.h | | | NimBLEBeacon.h | | | NimBLECharacteristic.h | | | NimBLEClient.h | | | NimBLEConnInfo.h | | | NimBLEDescriptor.h | | | NimBLEDevice.h | | | NimBLEEddystoneTLM.h | | | NimBLEExtAdvertising.h | | | NimBLEHIDDevice.h | | | NimBLELocalAttribute.h | | | NimBLELocalValueAttribute.h | | | NimBLELog.h | | | NimBLERemoteCharacteristic.h | | | NimBLERemoteDescriptor.h | | | NimBLERemoteService.h | | | NimBLERemoteValueAttribute.h | | | NimBLEScan.h | | | NimBLEServer.h | | | NimBLEService.h | | | NimBLEUtils.h | | | NimBLEUUID.h | | | nimconfig.h | ||||||||||||||||||||||||||||||||||||
1.9.1 1.9.8