ble.h

Go to the documentation of this file.

 
#pragma once
 
#include "fl/stl/json.h"
#include "fl/stl/has_include.h"
#include "fl/stl/function.h"
#include "fl/stl/optional.h"
#include "fl/stl/noexcept.h"
#include "fl/stl/pair.h"
 
// BLE requires either ESP32 + IDF 5+ + NimBLE headers, or an RP2350W build
// that selected Arduino-Pico's BTstack menu.
#if defined(FL_IS_ESP32) && defined(FL_IS_IDF_5_OR_HIGHER) \
    && FL_HAS_INCLUDE(<nimble/nimble_port.h>)
#define FL_BLE_AVAILABLE 1
#elif defined(FL_IS_RP2350) && defined(ENABLE_BLE) && ENABLE_BLE \
    && FL_HAS_INCLUDE(<BTstackLib.h>)
#define FL_BLE_AVAILABLE 1
#else
#define FL_BLE_AVAILABLE 0
#endif
 
namespace fl {
namespace net {
namespace ble {
 
// GATT UUIDs for FastLED BLE service (string form, used by validation/diagnostics)
#define FL_BLE_SERVICE_UUID "12345678-1234-1234-1234-123456789abc"
#define FL_BLE_CHAR_RX_UUID "12345678-1234-1234-1234-123456789ab0"
#define FL_BLE_CHAR_TX_UUID "12345678-1234-1234-1234-123456789ab1"
 
#if FL_BLE_AVAILABLE
// NimBLE BLE_UUID128_INIT takes bytes in LITTLE-ENDIAN order.
// UUID "12345678-1234-1234-1234-123456789abc" in BE byte order is:
//   12 34 56 78  12 34  12 34  12 34  12 34 56 78 9a bc
// Reversed (LE) for BLE_UUID128_INIT:
//   bc 9a 78 56 34 12 34 12 34 12 34 12 78 56 34 12
#define FL_BLE_SERVICE_UUID_INIT \
    0xbc, 0x9a, 0x78, 0x56, 0x34, 0x12, 0x34, 0x12, \
    0x34, 0x12, 0x34, 0x12, 0x78, 0x56, 0x34, 0x12
 
#define FL_BLE_CHAR_RX_UUID_INIT \
    0xb0, 0x9a, 0x78, 0x56, 0x34, 0x12, 0x34, 0x12, \
    0x34, 0x12, 0x34, 0x12, 0x78, 0x56, 0x34, 0x12
 
#define FL_BLE_CHAR_TX_UUID_INIT \
    0xb1, 0x9a, 0x78, 0x56, 0x34, 0x12, 0x34, 0x12, \
    0x34, 0x12, 0x34, 0x12, 0x78, 0x56, 0x34, 0x12
#endif // FL_BLE_AVAILABLE

struct StatusInfo {
    bool connected = false;
    int connectedCount = 0;
    bool txCharExists = false;
    int txValueLen = 0;
    int ringHead = 0;
    int ringTail = 0;
};

struct TransportState;

TransportState* createTransport(const char* deviceName) FL_NO_EXCEPT;

void destroyTransport(TransportState* state) FL_NO_EXCEPT;

StatusInfo queryStatus(const TransportState* state) FL_NO_EXCEPT;

fl::pair<fl::function<fl::optional<fl::json>()>, fl::function<void(const fl::json&)>>
getTransportCallbacks(TransportState* state) FL_NO_EXCEPT;
 
} // namespace ble
} // namespace net
} // namespace fl