esp-nimble-cpp 2.3.1
Loading...
Searching...
No Matches
NimBLEUtils.h
1/*
2 * Copyright 2020-2025 Ryan Powell <ryan@nable-embedded.io> and
3 * esp-nimble-cpp, NimBLE-Arduino contributors.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18#ifndef NIMBLE_CPP_UTILS_H_
19#define NIMBLE_CPP_UTILS_H_
20
21#include "nimconfig.h"
22#if CONFIG_BT_ENABLED
23
24# include <string>
25
26class NimBLEAddress;
27
34 NimBLETaskData(void* pInstance = nullptr, int flags = 0, void* buf = nullptr);
36 void* m_pInstance{nullptr};
37 mutable int m_flags{0};
38 void* m_pBuf{nullptr};
39
40 private:
41 mutable void* m_pHandle{nullptr}; // semaphore or task handle
42 friend class NimBLEUtils;
43};
44
49 public:
50 static const char* gapEventToString(uint8_t eventType);
51 static std::string dataToHexString(const uint8_t* source, uint8_t length);
52 static const char* advTypeToString(uint8_t advType);
53 static const char* returnCodeToString(int rc);
54 static NimBLEAddress generateAddr(bool nrpa);
55 static bool taskWait(const NimBLETaskData& taskData, uint32_t timeout);
56 static void taskRelease(const NimBLETaskData& taskData, int rc = 0);
57};
58
59#endif // CONFIG_BT_ENABLED
60#endif // NIMBLE_CPP_UTILS_H_
A BLE device address.
Definition NimBLEAddress.h:42
A BLE Utility class with methods for debugging and general purpose use.
Definition NimBLEUtils.h:48
static std::string dataToHexString(const uint8_t *source, uint8_t length)
Create a hexadecimal string representation of the input data.
Definition NimBLEUtils.cpp:550
static bool taskWait(const NimBLETaskData &taskData, uint32_t timeout)
Blocks the calling task until released or timeout.
Definition NimBLEUtils.cpp:92
static NimBLEAddress generateAddr(bool nrpa)
Generate a random BLE address.
Definition NimBLEUtils.cpp:569
static const char * advTypeToString(uint8_t advType)
Convert the advertising type flag to a string.
Definition NimBLEUtils.cpp:430
static void taskRelease(const NimBLETaskData &taskData, int rc=0)
Release a task.
Definition NimBLEUtils.cpp:119
static const char * returnCodeToString(int rc)
Converts a return code from the NimBLE stack to a text string.
Definition NimBLEUtils.cpp:135
static const char * gapEventToString(uint8_t eventType)
Convert a GAP event type to a string representation.
Definition NimBLEUtils.cpp:457
A structure to hold data for a task that is waiting for a response.
Definition NimBLEUtils.h:33
~NimBLETaskData()
Destructor.
Definition NimBLEUtils.cpp:77