Transport.h

Go to the documentation of this file.

// The transport interface: everything the core needs from a BLE stack, and nothing more.
//
// One implementation per BLE *library* (not per chip or stack): ArduinoBLE (covers
// STM32duinoBLE), the ESP32 core BLE library (covers Bluedroid and NimBLE variants), and the
// NINA-B31 serial AT protocol. The core never includes a BLE header; a transport never
// generates XML or interprets channel values. Keeping this boundary thin is what stops the 1.x
// backend drift from coming back.
#ifndef PHYPHOX_BLE_TRANSPORT_H
#define PHYPHOX_BLE_TRANSPORT_H
 
#include <stdint.h>
#include <stddef.h>
#include "../core/Config.h"
 
namespace phyphox {
 
enum CharKind : uint8_t { CH_EXPERIMENT, CH_CONTROL, CH_EVENT, CH_DATA, CH_INPUT, CH_SENSOR, CH_LEGACY_CONFIG };
 
struct CharId {
    CharKind kind;
    uint8_t index;               
};
 
struct GattLayout {
    const char* deviceName;
    uint8_t inputChannels;       
    uint32_t inputChannelMask;   
    uint8_t sensors;             
    const uint8_t* sensorValueSize; 
    bool legacyConfig;           
    uint16_t dataValueSize;      
};
 
class TransportListener {
public:
    virtual ~TransportListener() {}
    virtual void onConnect() = 0;
    virtual void onDisconnect() = 0;
    virtual void onSubscribe(CharId id, bool enabled) = 0;
    virtual void onWrite(CharId id, const uint8_t* data, uint16_t len) = 0;
    virtual void onNotifyStatus(CharId id, bool accepted) = 0;
    virtual void pump() = 0;
};
 
class Transport {
public:
    virtual ~Transport() {}
    virtual bool begin(const GattLayout& layout, TransportListener& listener) = 0;
    virtual bool notify(CharId id, const uint8_t* data, uint16_t len) = 0;
    virtual bool asyncNotifyStatus() const { return false; }
    virtual void setValue(CharId id, const uint8_t* data, uint16_t len) = 0;
    virtual bool connected() const = 0;
    virtual uint16_t mtuPayload() const = 0;
    virtual void requestMtu(uint16_t payload) { (void)payload; }
    virtual void requestConnectionParameters(uint16_t minInterval, uint16_t maxInterval,
                                             uint16_t latency, uint16_t timeout) {
        (void)minInterval; (void)maxInterval; (void)latency; (void)timeout;
    }
    virtual void poll() = 0;
    virtual bool drivesTransfer() const { return false; }
    virtual void restartAdvertising() = 0;
    virtual const char* name() const = 0;   
};
 
} // namespace phyphox
 
#endif