Errors.h

Go to the documentation of this file.

// Configuration errors. A setter that receives something the format cannot express records the
// first error per element; the generated experiment then shows every error as a red info
// element (the one channel a user without a serial monitor has), and PhyphoxBLE::printErrors()
// lists them for those with one. Codes keep the 1.x numbering the README documents.
#ifndef PHYPHOX_BLE_CORE_ERRORS_H
#define PHYPHOX_BLE_CORE_ERRORS_H
 
#include <stdint.h>
 
namespace phyphox {
 
enum ErrorCode : uint8_t {
    ERR_NONE = 0,
    ERR_01_TOO_LONG = 1,        
    ERR_02_ABOVE_LIMIT = 2,     
    ERR_03_NOT_HEX_COLOR = 3,   
    ERR_04_INVALID_VALUE = 4,   
    ERR_05_INVALID_LAYOUT = 5,  
    // new in 2.0
    ERR_06_CAPACITY = 6,        
    ERR_07_CHANNEL_CONFLICT = 7,
    ERR_08_NULL_STRING = 8,     
};
 
struct ErrorRecord {
    ErrorCode code = ERR_NONE;
    const char* origin = nullptr;   
    bool set() const { return code != ERR_NONE; }
    void record(ErrorCode c, const char* from) { if (!set()) { code = c; origin = from; } }
};
 
const char* errorText(ErrorCode code);   
 
} // namespace phyphox
 
#endif