phyphoxBle.h

Go to the documentation of this file.

// phyphox BLE 2.0 — the public include.
//
//   #include <phyphoxBle.h>
//   void setup() { PhyphoxBLE::start(); }
//   void loop()  { PhyphoxBLE::write(analogRead(A0) * 3.3f / 4096); delay(50); PhyphoxBLE::poll(); }
//
// A few lines add phyphox to a project: this is the simple API and the library's main feature.
// Everything else — describing views, graphs, user inputs and buttons, requesting phone
// sensors — is in phyphoxBleExperiment.h and optional.
//
// The transport (which BLE library talks to the radio) is chosen here from the board macros.
#ifndef PHYPHOXBLE
#define PHYPHOXBLE
 
#include <Arduino.h>
#include "phyphoxBleExperiment.h"
#include "core/Server.h"
 
// ---------------------------------------------------------------- phone sensor types
// The strings are phyphox file-format sensor names (phyphox-docs spec/input.yml).
#define SENSOR_ACCELEROMETER "accelerometer"
#define SENSOR_ACCELEROMETER_WITHOUT_G "linear_acceleration"
#define SENSOR_LINEAR_ACCELERATION "linear_acceleration"
#define SENSOR_GRAVITY "gravity"
#define SENSOR_GYROSCOPE "gyroscope"
#define SENSOR_MAGNETIC_FIELD "magnetic_field"
#define SENSOR_PRESSURE "pressure"
#define SENSOR_LIGHT "light"
#define SENSOR_PROXIMITY "proximity"
#define SENSOR_TEMPERATURE "temperature"
#define SENSOR_HUMIDITY "humidity"
#define SENSOR_ATTITUDE "attitude"
#define SENSOR_CUSTOM "custom"
#define SENSOR_MAGNETOMETER SENSOR_MAGNETIC_FIELD
 
// ---------------------------------------------------------------- colours (1.x)
#define COLOR_RED "fe005d"
#define COLOR_BLUE "39a2ff"
#define COLOR_GREEN "2bfb4c"
#define COLOR_ORANGE "ff7e22"
#define COLOR_WHITE "ffffff"
#define COLOR_YELLOW "edf668"
#define COLOR_MAGENTA "eb46f4"
 
// ---------------------------------------------------------------- transport selection
#include "transport/Select.h"
#if defined(PHYPHOX_BLE_USE_ESP32)
  #include "transport/Esp32CoreBleTransport.h"
  #define PHYPHOX_BLE_TRANSPORT phyphox::Esp32CoreBleTransport
#elif defined(PHYPHOX_BLE_USE_ESP32_BLE4)
  #include "transport/Esp32Ble4Transport.h"
  #define PHYPHOX_BLE_TRANSPORT phyphox::Esp32Ble4Transport
#elif defined(PHYPHOX_BLE_USE_NINAB31)
  #include "transport/NinaB31Transport.h"
  #define PHYPHOX_BLE_TRANSPORT phyphox::NinaB31Transport
#elif defined(PHYPHOX_BLE_USE_ARDUINOBLE)
  #include "transport/ArduinoBleTransport.h"
  #define PHYPHOX_BLE_TRANSPORT phyphox::ArduinoBleTransport
#endif
 
// ---------------------------------------------------------------- the simple API
 
class PhyphoxBLE {
public:
    // ---- start
    static void start(const char* deviceName = "phyphox-Arduino");
    static void start(const char* deviceName, PhyphoxBleExperiment& experiment);
    static void start(const char* deviceName, uint8_t* xml, size_t len);
    static void start(uint8_t* xml, size_t len) { start("phyphox-Arduino", xml, len); }
    static void addExperiment(PhyphoxBleExperiment& experiment);
 
    // ---- every loop()
    static void poll();
    static void poll(int timeoutMs);   
 
    // ---- data to the phone (channels 1…5; channel 0 is the phone's arrival time)
    // (const references: 1.x took float&, which rejected write(analogRead(A0) * k); const& takes both)
    static void write(const float& v1);
    static void write(const float& v1, const float& v2);
    static void write(const float& v1, const float& v2, const float& v3);
    static void write(const float& v1, const float& v2, const float& v3, const float& v4);
    static void write(const float& v1, const float& v2, const float& v3, const float& v4, const float& v5);
    static void write(uint8_t* bytes, unsigned int len);
    static void write(float* values, unsigned int count);
 
    // ---- data from the phone (the last value of input channels 1…5)
    static void read(float& v1);
    static void read(float& v1, float& v2);
    static void read(float& v1, float& v2, float& v3);
    static void read(float& v1, float& v2, float& v3, float& v4);
    static void read(float& v1, float& v2, float& v3, float& v4, float& v5);
    static void read(uint8_t* bytes, unsigned int len);   
    static float readChannel(int channel);                 
    static bool changed(int channel);                      
    static void onChange(int channel, phyphox::ChangeCallback);
    static void onPress(int channel, phyphox::PressCallback);
    static void (*configHandler)();
 
    // ---- events (start/pause/clear/sync from the app)
    static void (*experimentEventHandler)();
    static uint8_t eventType;          
    static int64_t experimentTime;     
    static int64_t systemTime;         
    static const phyphox::ExperimentEvent& lastEvent();
 
    // ---- radio parameters (before start())
    static void setMTU(uint16_t payload);
    static uint16_t minConInterval, maxConInterval, slaveLatency, timeout;
 
    // ---- introspection and debugging
    static void printXML(Print* out);            
    static void printErrors(Print* out);         
    static const phyphox::ServerStats& stats();
    static uint16_t currentConnections;          
    static bool isSubscribed;                    
    static const char* version() { return PHYPHOX_BLE_VERSION; }
    static const char* transportName();
    static void begin(Print* debugOut);          
 
    static phyphox::Server& server();
};
 
#endif