NimBLE-Arduino

https://h2zero.github.io/NimBLE-Arduino
Admin
A C++ BLE library for ESP32 and nRF51/nRF52 devices using the NimBLE BLE stack, maintaining the...
Tokens:75,815
Snippets:590
Trust Score:8.3
Update:1 week ago
Show doc for...
Tokens:
Raw
### start(uint8_t instId, int duration=0, int maxEvents=0)

Source: https://h2zero.github.io/NimBLE-Arduino/class_nim_b_l_e_ext_advertising-members.html

Starts advertising on a specific instance with optional duration and max events.

```APIDOC
## start(uint8_t instId, int duration=0, int maxEvents=0)

### Description
Starts advertising on a specific instance with optional duration and max events.

### Method
start

### Parameters
- **instId** (uint8_t) - Required - The instance ID.
- **duration** (int) - Optional - Advertising duration in milliseconds. Default is 0 (infinite).
- **maxEvents** (int) - Optional - Maximum number of advertising events. Default is 0 (unlimited).
```

--------------------------------

### NimBLEHIDDevice::startServices

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_h_i_d_device_8h_source.html

Starts the HID device services. Deprecated: services are now started by the server when start() is called.

```APIDOC
## NimBLEHIDDevice::startServices

### Description
Start the HID device services. This function called when all the services have been created.

### Method
`void startServices()`

### Note
Deprecated: Services are now started by the server when start() is called.

```

--------------------------------

### NimBLEAdvertising::start

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_advertising_8h_source.html

Starts advertising.

```APIDOC
## start

### Description
Start advertising.

### Method
bool start(uint32_t duration=0, const NimBLEAddress* dirAddr=nullptr)

### Parameters
- **duration** (uint32_t) - Optional - The duration in milliseconds to advertise. Default is 0 (advertise indefinitely).
- **dirAddr** (const NimBLEAddress*) - Optional - The directed advertising address. Default is nullptr.

### Returns
- **bool** - True if the operation was successful, false otherwise.
```

--------------------------------

### NimBLEExtAdvertising::start

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_ext_advertising_8h_source.html

Starts extended advertising on a given instance.

```APIDOC
## NimBLEExtAdvertising::start

### Description
Starts extended advertising on a given instance.

### Method
start

### Signature
bool start(uint8_t instId, int duration = 0, int maxEvents = 0)

### Parameters
- **instId** (uint8_t) - Required - The advertising instance ID.
- **duration** (int) - Optional - The duration in milliseconds (0 = infinite). Defaults to 0.
- **maxEvents** (int) - Optional - The maximum number of advertising events (0 = no limit). Defaults to 0.

### Returns
- **bool** - True if successful, false otherwise.
```

--------------------------------

### NimBLEAdvertisedDevice::getTXPower

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_advertised_device_8h_source.html

Get the TX Power.

```APIDOC
## NimBLEAdvertisedDevice::getTXPower

### Description
Get the TX Power.

### Method
`int8_t getTXPower() const`

### Returns
- **int8_t** - The TX power value.

```

--------------------------------

### NimBLEScan::start

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_scan_8h_source.html

Starts a BLE scan for the specified duration. Optionally continues scanning or restarts the scan.

```APIDOC
## NimBLEScan::start

### Description
Starts a BLE scan for the specified duration. Optionally continues scanning or restarts the scan.

### Method
`bool start(uint32_t duration, bool isContinue = false, bool restart = true)`

### Parameters
- **duration** (uint32_t) - Required - Scan duration in milliseconds.
- **isContinue** (bool) - Optional - If true, continue scanning without clearing previous results.
- **restart** (bool) - Optional - If true, restart the scan if already scanning.

### Returns
- **bool** - True if the scan started successfully, false otherwise.
```

--------------------------------

### NimBLEExtAdvertisement::getDataSize

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_ext_advertising_8h_source.html

Gets the size of the advertisement data.

```APIDOC
## NimBLEExtAdvertisement::getDataSize

### Description
Gets the size of the advertisement data.

### Method
getDataSize

### Signature
size_t getDataSize() const

### Returns
- **size_t** - The size of the advertisement data in bytes.
```

--------------------------------

### NimBLEAdvertising Class Methods

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_advertising_8h_source.html

Methods for controlling BLE advertising, including start, stop, configuration, and data management.

```APIDOC
## NimBLEAdvertising Class

### Description
Provides methods to configure and control BLE advertising.

### Methods

#### start

```cpp
bool start(uint32_t duration = 0, const NimBLEAddress* dirAddr = nullptr);
```

- **duration** (uint32_t) - Optional - Advertising duration in milliseconds. Default is 0 (advertise indefinitely).
- **dirAddr** (const NimBLEAddress*) - Optional - Directed advertising address. Default is nullptr.

Starts advertising with optional duration and directed address.

#### setAdvertisingCompleteCallback

```cpp
void setAdvertisingCompleteCallback(advCompleteCB_t callback);
```

- **callback** (advCompleteCB_t) - Required - Callback function invoked when advertising completes.

Sets a callback to be called when advertising stops.

#### stop

```cpp
bool stop();
```

Stops advertising.

#### setConnectableMode

```cpp
bool setConnectableMode(uint8_t mode);
```

- **mode** (uint8_t) - Required - Connectable mode.

Sets the connectable mode.

#### setDiscoverableMode

```cpp
bool setDiscoverableMode(uint8_t mode);
```

- **mode** (uint8_t) - Required - Discoverable mode.

Sets the discoverable mode.

#### reset

```cpp
bool reset();
```

Resets advertising settings to defaults.

#### isAdvertising

```cpp
bool isAdvertising();
```

Returns true if advertising is currently active.

#### setScanFilter

```cpp
void setScanFilter(bool scanRequestWhitelistOnly, bool connectWhitelistOnly);
```

- **scanRequestWhitelistOnly** (bool) - Required - If true, only accept scan requests from whitelist.
- **connectWhitelistOnly** (bool) - Required - If true, only allow connections from whitelist.

Sets scan and connection whitelist filters.

#### enableScanResponse

```cpp
void enableScanResponse(bool enable);
```

- **enable** (bool) - Required - Enable or disable scan response.

Enables or disables scan response.

#### setAdvertisingInterval

```cpp
void setAdvertisingInterval(uint16_t interval);
```

- **interval** (uint16_t) - Required - Advertising interval in 0.625 ms units.

Sets the advertising interval.

#### setMaxInterval

```cpp
void setMaxInterval(uint16_t maxInterval);
```

- **maxInterval** (uint16_t) - Required - Maximum advertising interval in 0.625 ms units.

Sets the maximum advertising interval.

#### setMinInterval

```cpp
void setMinInterval(uint16_t minInterval);
```

- **minInterval** (uint16_t) - Required - Minimum advertising interval in 0.625 ms units.

Sets the minimum advertising interval.

#### setAdvertisementData

```cpp
bool setAdvertisementData(const NimBLEAdvertisementData& advertisementData);
```

- **advertisementData** (const NimBLEAdvertisementData&) - Required - Advertisement data.

Sets the advertisement data.

#### setScanResponseData

```cpp
bool setScanResponseData(const NimBLEAdvertisementData& advertisementData);
```

- **advertisementData** (const NimBLEAdvertisementData&) - Required - Scan response data.

Sets the scan response data.

#### getAdvertisementData

```cpp
const NimBLEAdvertisementData& getAdvertisementData();
```

Returns the current advertisement data.

#### getScanData

```cpp
const NimBLEAdvertisementData& getScanData();
```

Returns the current scan response data.

#### clearData

```cpp
void clearData();
```

Clears all advertisement and scan response data.

#### refreshAdvertisingData

```cpp
bool refreshAdvertisingData();
```

Refreshes the advertising data.

#### addServiceUUID

```cpp
bool addServiceUUID(const NimBLEUUID& serviceUUID);
bool addServiceUUID(const char* serviceUUID);
```

- **serviceUUID** (const NimBLEUUID& or const char*) - Required - Service UUID to add.

Adds a service UUID to the advertisement.

#### removeServiceUUID

```cpp
bool removeServiceUUID(const NimBLEUUID& serviceUUID);
bool removeServiceUUID(const char* serviceUUID);
```

- **serviceUUID** (const NimBLEUUID& or const char*) - Required - Service UUID to remove.

Removes a service UUID from the advertisement.

#### removeServices

```cpp
bool removeServices();
```

Removes all service UUIDs from the advertisement.

#### setAppearance

```cpp
bool setAppearance(uint16_t appearance);
```

- **appearance** (uint16_t) - Required - Appearance value.

Sets the appearance value in the advertisement.
```

--------------------------------

### Function Index: s*

Source: https://h2zero.github.io/NimBLE-Arduino/functions_s.html

A list of all functions starting with 's' in the NimBLE-Arduino library, showing the function name and the class it belongs to.

```APIDOC
## Function Index: s*

### Description
This is an alphabetical index of all functions in the NimBLE-Arduino library whose names begin with the letter 's'. Each entry lists the function name and the class it belongs to.

### Functions
- **secureConnection()** : NimBLEClient
- **sendServiceChangedIndication()** : NimBLEServer
- **setActiveScan()** : NimBLEScan
- **setAddress()** : NimBLEExtAdvertisement
- **setAdvertisementData()** : NimBLEAdvertising
- **setAdvertisingCompleteCallback()** : NimBLEAdvertising
- **setAdvertisingInterval()** : NimBLEAdvertising
- **setAnonymous()** : NimBLEExtAdvertisement
- **setAppearance()** : NimBLEAdvertisementData, NimBLEAdvertising, NimBLEExtAdvertisement
- **setBatteryLevel()** : NimBLEHIDDevice
- **setCallbacks()** : NimBLECharacteristic, NimBLEDescriptor, NimBLEExtAdvertising, NimBLEServer
- **setClientCallbacks()** : NimBLEClient
- **setCompleteServices()** : NimBLEAdvertisementData, NimBLEExtAdvertisement
- **setCompleteServices16()** : NimBLEAdvertisementData, NimBLEExtAdvertisement
- **setCompleteServices32()** : NimBLEAdvertisementData, NimBLEExtAdvertisement
- **setConfig()** : NimBLEClient
- **setConnectable()** : NimBLEExtAdvertisement
- **setConnectableMode()** : NimBLEAdvertising
- **setConnectionParams()** : NimBLEClient
- **setConnectPhy()** : NimBLEClient
- **setConnectRetries()** : NimBLEClient
- **setConnectTimeout()** : NimBLEClient
- **setCount()** : NimBLEEddystoneTLM
- **setCustomGapHandler()** : NimBLEDevice
- **setData()** : NimBLEBeacon, NimBLEEddystoneTLM, NimBLEExtAdvertisement
- **setDataLen()** : NimBLEClient, NimBLEServer
- **setDefaultPhy()** : NimBLEDevice
- **setDescription()** : NimBLE2904
- **setDeviceName()** : NimBLEDevice
- **setDirected()** : NimBLEExtAdvertisement
- **setDirectedPeer()** : NimBLEExtAdvertisement
- **setDiscoverableMode()** : NimBLEAdvertising
- **setDuplicateFilter()** : NimBLEScan
- **setExponent()** : NimBLE2904
- **setFilterPolicy()** : NimBLEScan
- **setFlags()** : NimBLEAdvertisementData, NimBLEExtAdvertisement
- **setFormat()** : NimBLE2904
- **setHidInfo()** : NimBLEHIDDevice
- **setInstanceData()** : NimBLEExtAdvertising
- **setInterval()** : NimBLEScan
- **setLegacyAdvertising()** : NimBLEExtAdvertisement
- **setLimitedOnly()** : NimBLEScan
- **setMajor()** : NimBLEBeacon
- **setManufacturer()** : NimBLEHIDDevice
- **setManufacturerData()** : NimBLEAdvertisementData, NimBLEAdvertising, NimBLEExtAdvertisement
- **setManufacturerId()** : NimBLEBeacon
- **setMaxInterval()** : NimBLEAdvertising, NimBLEExtAdvertisement
- **setMaxResults()** : NimBLEScan
- **setMinInterval()** : NimBLEAdvertising, NimBLEExtAdvertisement
- **setMinor()** : NimBLEBeacon
- **setMTU()** : NimBLEDevice
- **setName()** : NimBLEAdvertisementData, NimBLEAdvertising, NimBLEExtAdvertisement
- **setNamespace()** : NimBLE2904
- **setOwnAddr()** : NimBLEDevice
- **setOwnAddrType()** : NimBLEDevice
- **setPartialServices()** : NimBLEAdvertisementData, NimBLEExtAdvertisement
- **setPartialServices16()** : NimBLEAdvertisementData, NimBLEExtAdvertisement
- **setPartialServices32()** : NimBLEAdvertisementData, NimBLEExtAdvertisement
- **setPeerAddress()** : NimBLEClient
- **setPeriod()** : NimBLEScan
- **setPhy()** : NimBLEScan
- **setPnp()** : NimBLEHIDDevice
- **setPower()** : NimBLEDevice
- **setPreferredParams()** : NimBLEAdvertisementData, NimBLEAdvertising, NimBLEExtAdvertisement
- **setPrimaryChannels()** : NimBLEExtAdvertisement
- **setPrimaryPhy()** : NimBLEExtAdvertisement
- **setProximityUUID()** : NimBLEBeacon
- **setRemoved()** : NimBLELocalAttribute
- **setReportMap()** : NimBLEHIDDevice
- **setScanCallbacks()** : NimBLEScan
- **setScanFilter()** : NimBLEAdvertising, NimBLEExtAdvertisement
- **setScannable()** : NimBLEExtAdvertisement
- **setScanResponseData()** : NimBLEAdvertising, NimBLEExtAdvertising
- **setScanResponseTimeout()** : NimBLEScan
- **setSecondaryPhy()** : NimBLEExtAdvertisement
- **setSecurityAuth()** : NimBLEDevice
- **setSecurityInitKey()** : NimBLEDevice
- **setSecurityIOCap()** : NimBLEDevice
- **setSecurityPasskey()** : NimBLEDevice
- **setSecurityRespKey()** : NimBLEDevice
- **setSelfDelete()** : NimBLEClient
- **setServiceData()** : NimBLEAdvertisementData, NimBLEAdvertising, NimBLEExtAdvertisement
- **setShortName()** : NimBLEAdvertisementData, NimBLEExtAdvertisement
- **setSignalPower()** : NimBLEBeacon
- **setTemp()** : NimBLEEddystoneTLM
- **setTime()** : NimBLEEddystoneTLM
- **setTxPower()** : NimBLEExtAdvertisement
- **setUnit()** : NimBLE2904
- **setURI()** : NimBLEAdvertisementData, NimBLEAdvertising, NimBLEExtAdvertisement
- **setUUID()** : NimBLEEddystoneTLM
- **setValue()** : NimBLEAttValue, NimBLEClient, NimBLERemoteService
- **setVersion()** : NimBLEEddystoneTLM
- **setVolt()** : NimBLEEddystoneTLM
- **setWindow()** : NimBLEScan
- **size()** : NimBLEAttValue
- **start()** : NimBLEAdvertising, NimBLEExtAdvertising, NimBLEScan, NimBLEServer
- **startAdvertising()** : NimBLEDevice, NimBLEServer
- **startSecurity()** : NimBLEDevice
- **startServices()** : NimBLEHIDDevice
- **stop()** : NimBLEAdvertising, NimBLEExtAdvertising, NimBLEScan
- **stopAdvertising()** : NimBLEDevice, NimBLEServer
- **subscribe()** : NimBLERemoteCharacteristic
```

--------------------------------

### begin()

Source: https://h2zero.github.io/NimBLE-Arduino/class_nim_b_l_e_client-members.html

Initializes the NimBLEClient instance.

```APIDOC
## begin()

### Description
Initializes the NimBLEClient instance.

### Method
begin()

### Parameters
None.

### Returns
None.
```

--------------------------------

### NimBLEHIDDevice::getBootOutput

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_h_i_d_device_8h_source.html

Creates a keyboard boot output report characteristic.

```APIDOC
## NimBLEHIDDevice::getBootOutput

### Description
Create a keyboard boot output report characteristic.

### Method
`NimBLECharacteristic* getBootOutput()`

### Returns
- **NimBLECharacteristic*** - Pointer to the boot output report characteristic.

```

--------------------------------

### NimBLEDescriptor::getCharacteristic

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_descriptor_8h_source.html

Gets the characteristic this descriptor belongs to.

```APIDOC
## NimBLEDescriptor::getCharacteristic

### Description
Gets the characteristic this descriptor belongs to.

### Method
getCharacteristic

### Signature
NimBLECharacteristic* getCharacteristic() const

### Returns
- **NimBLECharacteristic*** - The characteristic this descriptor belongs to.

```

--------------------------------

### migrateBondStore: Iterate and migrate all bond entries

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_bond_migration_8h_source.html

Opens the NVS namespace for bonds, then iterates over bond keys for our security and peer security prefixes. For each key, calls the appropriate migration function based on the target version. Also migrates the local IRK entry when migrating to current.

```cpp
inline bool migrateBondStore(bool toCurrent, uint16_t maxEntries) {
  nvs_handle_t nvsHandle;
  esp_err_t err = nvs_open(kBondNamespace, NVS_READWRITE, &nvsHandle);
  if (err != ESP_OK) {
    ESP_LOGE(kLogTag,
             "Failed to open NVS namespace '%s', err=%d",
             kBondNamespace,
             static_cast<int>(err));
    return false;
  }

  MigrationStats stats{};
  char key[kNvsKeyMaxLen]{};

  for (uint16_t i = 1; i <= maxEntries; ++i) {
    if (!makeBondKey(key, sizeof(key), kOurSecPrefix, i)) {
      nvs_close(nvsHandle);
      return false;
    }

    if (!(toCurrent ? migrateEntryToCurrent(nvsHandle, key, i, &stats)
                    : migrateEntryToV1(nvsHandle, key, &stats))) {
      nvs_close(nvsHandle);
      return false;
    }

    if (!makeBondKey(key, sizeof(key), kPeerSecPrefix, i)) {
      nvs_close(nvsHandle);
      return false;
    }

    if (!(toCurrent ? migrateEntryToCurrent(nvsHandle, key, i, &stats)
                    : migrateEntryToV1(nvsHandle, key, &stats))) {
      nvs_close(nvsHandle);
      return false;
    }
  }

  if (toCurrent) {
    if (!makeBondKey(key, sizeof(key), kLocalIrkPrefix, 1)) {
      nvs_close(nvsHandle);
      return false;
    }

    if (!migrateLocalIrkEntryToCurrent(nvsHandle, key, &stats)) {
      nvs_close(nvsHandle);
      return false;
    }
  }

  nvs_close(nvsHandle);
  return true;
}
```

--------------------------------

### NimBLEUUID::toString

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_u_u_i_d_8h_source.html

Get a string representation of the UUID.

```APIDOC
## NimBLEUUID::toString

### Description
Get a string representation of the UUID.

### Method
`std::string toString() const`

### Returns
- `std::string` - String representation of the UUID.
```

--------------------------------

### NimBLEClient::begin

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_client_8h_source.html

Returns an iterator to the beginning of the service vector.

```APIDOC
## NimBLEClient::begin

### Description
Returns an iterator to the first element in the service vector.

### Method
std::vector<NimBLERemoteService*>::iterator begin()

### Returns
- **std::vector<NimBLERemoteService*>::iterator** - Iterator to the beginning of the service vector.
```

--------------------------------

### NimBLEAdvertising::getAdvertisementData

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_advertising_8h_source.html

Gets the current advertisement data.

```APIDOC
## getAdvertisementData

### Description
Get the current advertisement data.

### Method
const NimBLEAdvertisementData& getAdvertisementData()

### Returns
- **const NimBLEAdvertisementData&** - The current advertisement data.
```

--------------------------------

### getConfig() const

Source: https://h2zero.github.io/NimBLE-Arduino/class_nim_b_l_e_client-members.html

Returns the current configuration of the client.

```APIDOC
## getConfig() const

### Description
Returns the current configuration of the client.

### Method
getConfig() const

### Parameters
None.

### Returns
The current Config object.
```

--------------------------------

### NimBLEAdvertisedDevice::getPayload

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_advertised_device_8h_source.html

Get the payload advertised by the device.

```APIDOC
## NimBLEAdvertisedDevice::getPayload

### Description
Get the payload advertised by the device.

### Method
`const std::vector<uint8_t>& getPayload() const`

### Returns
- **const std::vector<uint8_t>&** - The payload data.

```

--------------------------------

### NimBLEL2CAPServer::createService

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_l2_c_a_p_server_8h_source.html

Creates a new L2CAP connection-oriented channel service with the given PSM and MTU, and associates it with the provided callbacks. Returns a pointer to the created channel.

```APIDOC
## NimBLEL2CAPServer::createService

### Description
Creates a new L2CAP connection-oriented channel (CoC) service with the specified Protocol/Service Multiplexer (PSM) and maximum transmission unit (MTU). The service is associated with the provided callbacks for channel events.

### Method
createService

### Signature
NimBLEL2CAPChannel* createService(const uint16_t psm, const uint16_t mtu, NimBLEL2CAPChannelCallbacks* callbacks)

### Parameters
- **psm** (uint16_t) - Required - The Protocol/Service Multiplexer (PSM) value for the L2CAP service.
- **mtu** (uint16_t) - Required - The maximum transmission unit (MTU) size for the channel.
- **callbacks** (NimBLEL2CAPChannelCallbacks*) - Required - Pointer to the callbacks object for handling channel events.

### Returns
- **NimBLEL2CAPChannel*** - Pointer to the created L2CAP channel, or nullptr on failure.

```

--------------------------------

### NimBLEUUID::getValue

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_u_u_i_d_8h_source.html

Get the uuid value as a byte array.

```APIDOC
## NimBLEUUID::getValue

### Description
Get the uuid value as a byte array.

### Method
`const uint8_t* getValue() const`

### Returns
- `const uint8_t*` - Pointer to the UUID value bytes.
```

--------------------------------

### secureConnection(bool async=false) const

Source: https://h2zero.github.io/NimBLE-Arduino/class_nim_b_l_e_client-members.html

Initiates a secure connection (pairing/bonding) with the connected device.

```APIDOC
## secureConnection(bool async=false) const

### Description
Initiates a secure connection (pairing/bonding) with the connected device.

### Method
secureConnection(bool async=false) const

### Parameters
- **async** (bool) - Optional - Whether to perform the operation asynchronously. Defaults to false.

### Returns
None.
```

--------------------------------

### NimBLEClient::getConfig

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_client_8h_source.html

Retrieves the current configuration.

```APIDOC
## NimBLEClient::getConfig

### Description
Returns the current configuration of the client.

### Method
Config getConfig() const

### Returns
- **Config** - The current configuration.
```

--------------------------------

### NimBLERemoteValueAttribute::getClient

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_remote_value_attribute_8h_source.html

Gets the client associated with this remote attribute.

```APIDOC
## NimBLERemoteValueAttribute::getClient

### Description
Gets the client associated with this remote attribute.

### Method
getClient

### Signature
virtual NimBLEClient* getClient() const = 0;

### Returns
NimBLEClient* - The client associated with this attribute.

```

--------------------------------

### NimBLELocalAttribute::getRemoved

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_local_attribute_8h_source.html

Gets the removed flag of the local attribute.

```APIDOC
## getRemoved

### Description
Gets the removed flag of the local attribute.

### Method
`uint8_t getRemoved() const`

### Returns
- **uint8_t** - The removed flag value.

### Definition
NimBLELocalAttribute.h:35
```

--------------------------------

### NimBLEClient::getPhy

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_client_8h_source.html

Retrieves the current TX and RX PHYs.

```APIDOC
## NimBLEClient::getPhy

### Description
Retrieves the current TX and RX PHYs for the connection.

### Method
bool getPhy(uint8_t* txPhy, uint8_t* rxPhy)

### Parameters
- **txPhy** (uint8_t*) - Required - Pointer to store the TX PHY.
- **rxPhy** (uint8_t*) - Required - Pointer to store the RX PHY.

### Returns
- **bool** - True if the PHYs were retrieved successfully, false otherwise.
```

--------------------------------

### connect(bool deleteAttributes=true, bool asyncConnect=false, bool exchangeMTU=true)

Source: https://h2zero.github.io/NimBLE-Arduino/class_nim_b_l_e_client-members.html

Connects to a BLE device using the previously set peer address.

```APIDOC
## connect(bool deleteAttributes=true, bool asyncConnect=false, bool exchangeMTU=true)

### Description
Connects to a BLE device using the previously set peer address.

### Method
connect(bool deleteAttributes=true, bool asyncConnect=false, bool exchangeMTU=true)

### Parameters
- **deleteAttributes** (bool) - Optional - Whether to delete existing attributes before connecting. Defaults to true.
- **asyncConnect** (bool) - Optional - Whether to connect asynchronously. Defaults to false.
- **exchangeMTU** (bool) - Optional - Whether to exchange MTU after connection. Defaults to true.

### Returns
None.
```

--------------------------------

### NimBLEAdvertisedDevice::getSecondaryPhy

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_advertised_device_8h_source.html

Get the secondary PHY used by this advertisement.

```APIDOC
## NimBLEAdvertisedDevice::getSecondaryPhy

### Description
Get the primary PHY used by this advertisement.

### Method
`uint8_t getSecondaryPhy() const`

### Returns
- **uint8_t** - The secondary PHY.

```

--------------------------------

### NimBLEAdvertisedDevice::getAddressType

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_advertised_device_8h_source.html

Get the advertised device address type.

```APIDOC
## NimBLEAdvertisedDevice::getAddressType

### Description
Get the advertised device address type.

### Method
`uint8_t getAddressType() const`

### Returns
- **uint8_t** - The address type.

```

--------------------------------

### NimBLEL2CAPChannel::connect

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_l2_c_a_p_channel_8h_source.html

Establishes an L2CAP connection-oriented channel to a remote device using the specified PSM and MTU. Returns a pointer to the new channel instance or nullptr on failure.

```APIDOC
## NimBLEL2CAPChannel::connect

### Description
Establishes an L2CAP connection-oriented channel to a remote device using the specified PSM and MTU. Returns a pointer to the new channel instance or nullptr on failure.

### Method
static NimBLEL2CAPChannel* connect(NimBLEClient* client, uint16_t psm, uint16_t mtu, NimBLEL2CAPChannelCallbacks* callbacks)

### Parameters
- **client** (NimBLEClient*) - Required - The BLE client to use for the connection.
- **psm** (uint16_t) - Required - The Protocol/Service Multiplexer (PSM) value for the channel.
- **mtu** (uint16_t) - Required - The requested maximum transmission unit (MTU) for the channel.
- **callbacks** (NimBLEL2CAPChannelCallbacks*) - Required - Pointer to the callbacks object for channel events.

### Returns
- **NimBLEL2CAPChannel*** - Pointer to the newly created channel, or nullptr on failure.
```

--------------------------------

### NimBLEAdvertisedDevice::getAdvLength

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_advertised_device_8h_source.html

Get the length of the advertisement data in the payload.

```APIDOC
## NimBLEAdvertisedDevice::getAdvLength

### Description
Get the length of the advertisement data in the payload.

### Method
`uint16_t getAdvLength() const`

### Returns
- **uint16_t** - The length of the advertisement data.

```

--------------------------------

### getServices(bool refresh=false)

Source: https://h2zero.github.io/NimBLE-Arduino/class_nim_b_l_e_client-members.html

Returns a list of all discovered services.

```APIDOC
## getServices(bool refresh=false)

### Description
Returns a list of all discovered services.

### Method
getServices(bool refresh=false)

### Parameters
- **refresh** (bool) - Optional - Whether to refresh the service list from the device. Defaults to false.

### Returns
A vector of pointers to NimBLERemoteService objects.
```

--------------------------------

### NimBLEAdvertisedDevice::getTargetAddressCount

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_advertised_device_8h_source.html

Get the number of target addresses in the advertisement.

```APIDOC
## NimBLEAdvertisedDevice::getTargetAddressCount

### Description
Get the number of target addresses.

### Method
`uint8_t getTargetAddressCount() const`

### Returns
- **uint8_t** - The number of target addresses.

```

--------------------------------

### onPassKeyDisplay()

Source: https://h2zero.github.io/NimBLE-Arduino/class_nim_b_l_e_server_callbacks-members.html

Virtual callback invoked to display a passkey. Override to show the passkey to the user.

```APIDOC
## onPassKeyDisplay()

### Description
Virtual callback invoked to display a passkey. Override to show the passkey to the user.

### Method
virtual

### Signature
`void onPassKeyDisplay()`

### Parameters
None.

```

--------------------------------

### NimBLEUUID::getBase

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_u_u_i_d_8h_source.html

Get a pointer to the NimBLE UUID base structure.

```APIDOC
## NimBLEUUID::getBase

### Description
Get a pointer to the NimBLE UUID base structure.

### Method
`const ble_uuid_t* getBase() const`

### Returns
- `const ble_uuid_t*` - Pointer to the underlying NimBLE UUID structure.
```

--------------------------------

### connect(const NimBLEAdvertisedDevice *device, bool deleteAttributes=true, bool asyncConnect=false, bool exchangeMTU=true)

Source: https://h2zero.github.io/NimBLE-Arduino/class_nim_b_l_e_client-members.html

Connects to a BLE device using an advertised device object.

```APIDOC
## connect(const NimBLEAdvertisedDevice *device, bool deleteAttributes=true, bool asyncConnect=false, bool exchangeMTU=true)

### Description
Connects to a BLE device using an advertised device object.

### Method
connect(const NimBLEAdvertisedDevice *device, bool deleteAttributes=true, bool asyncConnect=false, bool exchangeMTU=true)

### Parameters
- **device** (const NimBLEAdvertisedDevice *) - Required - The advertised device to connect to.
- **deleteAttributes** (bool) - Optional - Whether to delete existing attributes before connecting. Defaults to true.
- **asyncConnect** (bool) - Optional - Whether to connect asynchronously. Defaults to false.
- **exchangeMTU** (bool) - Optional - Whether to exchange MTU after connection. Defaults to true.

### Returns
None.
```

--------------------------------

### NimBLEAdvertisedDevice::getScan

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_advertised_device_8h_source.html

Get the scan object that created this advertised device.

```APIDOC
## NimBLEAdvertisedDevice::getScan

### Description
Get the scan object that created this advertised device.

### Method
`NimBLEScan* getScan() const`

### Returns
- **NimBLEScan*** - Pointer to the scan object.

```

--------------------------------

### getConnInfo() const

Source: https://h2zero.github.io/NimBLE-Arduino/class_nim_b_l_e_client-members.html

Returns connection information about the current connection.

```APIDOC
## getConnInfo() const

### Description
Returns connection information about the current connection.

### Method
getConnInfo() const

### Parameters
None.

### Returns
A NimBLEConnInfo object containing connection details.
```

--------------------------------

### NimBLEClient::setConfig

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_client_8h_source.html

Sets the configuration for the client.

```APIDOC
## NimBLEClient::setConfig

### Description
Sets the configuration for the client.

### Method
void setConfig(Config config)

### Parameters
- **config** (Config) - Required - The new configuration.
```

--------------------------------

### NimBLEAdvertisedDevice::getManufacturerDataCount

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_advertised_device_8h_source.html

Get the count of manufacturer data sets in the advertisement.

```APIDOC
## NimBLEAdvertisedDevice::getManufacturerDataCount

### Description
Get the count of manufacturer data sets.

### Method
`uint8_t getManufacturerDataCount() const`

### Returns
- **uint8_t** - The count of manufacturer data sets.

```

--------------------------------

### NimBLEScan::getResults (with duration)

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_scan_8h_source.html

Starts a scan for the specified duration and returns the results.

```APIDOC
## NimBLEScan::getResults (with duration)

### Description
Starts a scan for the specified duration and returns the results.

### Method
`NimBLEScanResults getResults(uint32_t duration, bool is_continue = false)`

### Parameters
- **duration** (uint32_t) - Required - Scan duration in milliseconds.
- **is_continue** (bool) - Optional - If true, continue scanning without clearing previous results.

### Returns
- **NimBLEScanResults** - The scan results.
```

--------------------------------

### NimBLEHIDDevice::getBootInput

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_h_i_d_device_8h_source.html

Retrieves a keyboard boot input report characteristic.

```APIDOC
## NimBLEHIDDevice::getBootInput

### Description
Get a keyboard boot input report characteristic.

### Method
`NimBLECharacteristic* getBootInput()`

### Returns
- **NimBLECharacteristic*** - Pointer to the boot input report characteristic.

```

--------------------------------

### NimBLEExtAdvertisement::getDataLocation

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_ext_advertising_8h_source.html

Gets the location of a specific data type in the advertisement data.

```APIDOC
## NimBLEExtAdvertisement::getDataLocation

### Description
Gets the location of a specific data type in the advertisement data.

### Method
getDataLocation

### Signature
int getDataLocation(uint8_t type) const

### Parameters
- **type** (uint8_t) - Required - The data type to search for.

### Returns
- **int** - The index of the data type in the payload, or -1 if not found.
```

--------------------------------

### NimBLEClient::Config

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_client_8h_source.html

Configuration structure for NimBLEClient behavior.

```APIDOC
## NimBLEClient::Config

### Description
Configuration structure for NimBLEClient behavior, with bitfields for various options.

### Fields
- **deleteCallbacks** (uint8_t) - Delete the callback object when the client is deleted.
- **deleteOnDisconnect** (uint8_t) - Delete the client when disconnected.
- **deleteOnConnectFail** (uint8_t) - Delete the client when a connection attempt fails.
- **asyncConnect** (uint8_t) - Connect asynchronously.
- **exchangeMTU** (uint8_t) - Exchange MTU after connection.
- **connectFailRetries** (uint8_t) - Number of retries for 0x3e (connection establishment) failures.

### Default Constructor
Config() : deleteCallbacks(0), deleteOnDisconnect(0), deleteOnConnectFail(0), asyncConnect(0), exchangeMTU(1), connectFailRetries(2) {}
```

--------------------------------

### NimBLEUUID::bitSize

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_u_u_i_d_8h_source.html

Get the bit size of the UUID, which can be 16, 32, or 128.

```APIDOC
## NimBLEUUID::bitSize

### Description
Get the bit size of the UUID, which can be 16, 32, or 128.

### Method
`uint8_t bitSize() const`

### Returns
- `uint8_t` - The bit size of the UUID (16, 32, or 128).
```

--------------------------------

### discoverAttributes()

Source: https://h2zero.github.io/NimBLE-Arduino/class_nim_b_l_e_client-members.html

Discovers all services, characteristics, and descriptors of the connected device.

```APIDOC
## discoverAttributes()

### Description
Discovers all services, characteristics, and descriptors of the connected device.

### Method
discoverAttributes()

### Parameters
None.

### Returns
None.
```

--------------------------------

### onPassKeyEntry(NimBLEConnInfo &connInfo)

Source: https://h2zero.github.io/NimBLE-Arduino/class_nim_b_l_e_server_callbacks-members.html

Virtual callback invoked when a passkey entry is required. Override to handle passkey entry.

```APIDOC
## onPassKeyEntry(NimBLEConnInfo &connInfo)

### Description
Virtual callback invoked when a passkey entry is required. Override to handle passkey entry.

### Method
virtual

### Signature
`void onPassKeyEntry(NimBLEConnInfo &connInfo)`

### Parameters
- **connInfo** (NimBLEConnInfo&) - Required - Connection information for the peer.

```

--------------------------------

### setConnectionParams(uint16_t minInterval, uint16_t maxInterval, uint16_t latency, uint16_t timeout, uint16_t scanInterval=16, uint16_t scanWindow=16)

Source: https://h2zero.github.io/NimBLE-Arduino/class_nim_b_l_e_client-members.html

Sets the connection parameters for the client.

```APIDOC
## setConnectionParams(uint16_t minInterval, uint16_t maxInterval, uint16_t latency, uint16_t timeout, uint16_t scanInterval=16, uint16_t scanWindow=16)

### Description
Sets the connection parameters for the client.

### Method
setConnectionParams(uint16_t minInterval, uint16_t maxInterval, uint16_t latency, uint16_t timeout, uint16_t scanInterval=16, uint16_t scanWindow=16)

### Parameters
- **minInterval** (uint16_t) - Required - Minimum connection interval in 1.25ms units.
- **maxInterval** (uint16_t) - Required - Maximum connection interval in 1.25ms units.
- **latency** (uint16_t) - Required - Slave latency.
- **timeout** (uint16_t) - Required - Supervision timeout in 10ms units.
- **scanInterval** (uint16_t) - Optional - Scan interval in 0.625ms units. Defaults to 16.
- **scanWindow** (uint16_t) - Optional - Scan window in 0.625ms units. Defaults to 16.

### Returns
None.
```

--------------------------------

### NimBLEBeacon Class

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_beacon_8h_source.html

The NimBLEBeacon class represents a BLE beacon. It provides methods to get and set beacon data, manufacturer ID, major/minor values, proximity UUID, and signal power.

```APIDOC
## NimBLEBeacon Class

### Description
The NimBLEBeacon class represents a BLE beacon. It provides methods to get and set beacon data, manufacturer ID, major/minor values, proximity UUID, and signal power.

### Methods

#### getData
- **Signature**: `const BeaconData& getData()`
- **Description**: Retrieve the data that is being advertised.

#### getMajor
- **Signature**: `uint16_t getMajor()`
- **Description**: Get the major value being advertised.

#### getMinor
- **Signature**: `uint16_t getMinor()`
- **Description**: Get the minor value being advertised.

#### getManufacturerId
- **Signature**: `uint16_t getManufacturerId()`
- **Description**: Get the manufacturer ID being advertised.

#### getProximityUUID
- **Signature**: `NimBLEUUID getProximityUUID()`
- **Description**: Get the proximity UUID being advertised.

#### getSignalPower
- **Signature**: `int8_t getSignalPower()`
- **Description**: Get the signal power being advertised.

#### setData
- **Signature**: `void setData(const uint8_t* data, uint8_t length)`
- **Description**: Set the beacon data.

#### setData
- **Signature**: `void setData(const BeaconData& data)`
- **Description**: Set the beacon data.

#### setMajor
- **Signature**: `void setMajor(uint16_t major)`
- **Description**: Set the major value.

#### setMinor
- **Signature**: `void setMinor(uint16_t minor)`
- **Description**: Set the minor value.

#### setManufacturerId
- **Signature**: `void setManufacturerId(uint16_t manufacturerId)`
- **Description**: Set the manufacturer ID.

#### setProximityUUID
- **Signature**: `void setProximityUUID(const NimBLEUUID& uuid)`
- **Description**: Set the proximity UUID.

#### setSignalPower
- **Signature**: `void setSignalPower(int8_t signalPower)`
- **Description**: Set the signal power.

### Data Structure

#### BeaconData
- **manufacturerId** (uint16_t) - Manufacturer ID.
- **subType** (uint8_t) - Subtype.
- **subTypeLength** (uint8_t) - Subtype length.
- **proximityUUID** (uint8_t[16]) - Proximity UUID.
- **major** (uint16_t) - Major value.
- **minor** (uint16_t) - Minor value.
- **signalPower** (int8_t) - Signal power.

```

--------------------------------

### onConnect(NimBLEServer *pServer, NimBLEConnInfo &connInfo)

Source: https://h2zero.github.io/NimBLE-Arduino/class_nim_b_l_e_server_callbacks-members.html

Virtual callback invoked when a client connects to the server. Override to handle connection events.

```APIDOC
## onConnect(NimBLEServer *pServer, NimBLEConnInfo &connInfo)

### Description
Virtual callback invoked when a client connects to the server. Override to handle connection events.

### Method
virtual

### Signature
`void onConnect(NimBLEServer *pServer, NimBLEConnInfo &connInfo)`

### Parameters
- **pServer** (NimBLEServer*) - Required - Pointer to the server instance.
- **connInfo** (NimBLEConnInfo&) - Required - Connection information for the connected client.

```

--------------------------------

### NimBLEHIDDevice Class

Source: https://h2zero.github.io/NimBLE-Arduino/_nim_b_l_e_h_i_d_device_8h_source.html

The NimBLEHIDDevice class encapsulates the setup of a BLE HID device. It provides methods to configure the report map, device information, PnP, HID info, battery level, and to access the underlying characteristics and services.

```APIDOC
## NimBLEHIDDevice Class

### Description
The NimBLEHIDDevice class provides a high-level interface for creating BLE HID devices. It simplifies the configuration of HID services, including report maps, device information, and battery level.

### Constructor

#### NimBLEHIDDevice(NimBLEServer* server)
- **server** (NimBLEServer*) - Required - Pointer to the BLE server instance.

### Methods

#### void setReportMap(uint8_t* map, uint16_t length)
- **map** (uint8_t*) - Required - Pointer to the HID report map data.
- **length** (uint16_t) - Required - Length of the report map data.

Sets the HID report map for the device.

#### void startServices() (deprecated)
Deprecated. Services are now started by the server when start() is called. This function is no longer needed and will be removed in a future release.

#### bool setManufacturer(const std::string& name)
- **name** (const std::string&) - Required - Manufacturer name string.

Sets the manufacturer name in the device information service. Returns true on success.

#### void setPnp(uint8_t sig, uint16_t vid, uint16_t pid, uint16_t version)
- **sig** (uint8_t) - Required - PnP signature.
- **vid** (uint16_t) - Required - Vendor ID.
- **pid** (uint16_t) - Required - Product ID.
- **version** (uint16_t) - Required - Product version.

Sets the PnP (Plug and Play) information.

#### void setHidInfo(uint8_t country, uint8_t flags)
- **country** (uint8_t) - Required - Country code.
- **flags** (uint8_t) - Required - HID flags.

Sets the HID information (country code and flags).

#### void setBatteryLevel(uint8_t level, bool notify = false)
- **level** (uint8_t) - Required - Battery level (0-100).
- **notify** (bool) - Optional - Whether to notify the client of the battery level change. Defaults to false.

Sets the battery level and optionally notifies the client.

#### NimBLECharacteristic* getBatteryLevel()
Returns a pointer to the battery level characteristic.

#### NimBLECharacteristic* getReportMap()
Returns a pointer to the report map characteristic.

#### NimBLECharacteristic* getHidControl()
Returns a pointer to the HID control characteristic.

#### NimBLECharacteristic* getInputReport(uint8_t reportId)
- **reportId** (uint8_t) - Required - Report ID.

Returns a pointer to the input report characteristic for the given report ID.

#### NimBLECharacteristic* getOutputReport(uint8_t reportId)
- **reportId** (uint8_t) - Required - Report ID.

Returns a pointer to the output report characteristic for the given report ID.

#### NimBLECharacteristic* getFeatureReport(uint8_t reportId)
- **reportId** (uint8_t) - Required - Report ID.

Returns a pointer to the feature report characteristic for the given report ID.

#### NimBLECharacteristic* getProtocolMode()
Returns a pointer to the protocol mode characteristic.

#### NimBLECharacteristic* getBootInput()
Returns a pointer to the boot input characteristic.

#### NimBLECharacteristic* getBootOutput()
Returns a pointer to the boot output characteristic.

#### NimBLECharacteristic* getPnp()
Returns a pointer to the PnP characteristic.

#### NimBLECharacteristic* getHidInfo()
Returns a pointer to the HID info characteristic.

#### NimBLEService* getDeviceInfoService()
Returns a pointer to the device information service.

#### NimBLEService* getHidService()
Returns a pointer to the HID service.

#### NimBLEService* getBatteryService()
Returns a pointer to the battery service.

### Constants
- **GENERIC_HID** (0x03C0) - Generic HID device type.
- **HID_KEYBOARD** (0x03C1) - Keyboard HID device type.
- **HID_MOUSE** (0x03C2) - Mouse HID device type.
- **HID_JOYSTICK** (0x03C3) - Joystick HID device type.
- **HID_GAMEPAD** (0x03C4) - Gamepad HID device type.
- **HID_TABLET** (0x03C5) - Tablet HID device type.
- **HID_CARD_READER** (0x03C6) - Card reader HID device type.
- **HID_DIGITAL_PEN** (0x03C7) - Digital pen HID device type.
- **HID_BARCODE** (0x03C8) - Barcode scanner HID device type.

### Macro
- **PNPVersionField(MajorVersion, MinorVersion, PatchVersion)** - Constructs a PnP version field from major, minor, and patch version numbers.
```
Tokens:
Raw