Libraries/IOControl/include/IO/Error.h File Reference
#include "WString.h"
#include <ArduinoJson.h>
Include dependency graph for Libraries/IOControl/include/IO/Error.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

 IO
 
 IO::Error
 

Macros

#define IOERROR_MAX_MAP(XX)
 
#define XX(name, value)   max_##name = value,
 
#define IOERROR_STD_MAP(XX)
 
#define XX(tag, comment)   tag,
 
#define debug_err(err, arg)   debug_w("%s: %s", IO::Error::toString(err).c_str(), (arg).c_str())
 

Typedefs

using IO::ErrorCode = int16_t
 

Enumerations

enum  IO::Error::ErrorMax : ErrorCode
 
enum  IO::Error::Common : ErrorCode { IO::Error::success = 0, IO::Error::pending = 1, IO::Error::max_common_ = max_common }
 

Functions

String IO::Error::toString (ErrorCode err)
 
ErrorCode IO::setSuccess (JsonObject json)
 
ErrorCode IO::setPending (JsonObject json)
 
ErrorCode IO::setError (JsonObject json, ErrorCode err, const String &text=nullptr, const String &arg=nullptr)
 

Macro Definition Documentation

◆ debug_err

#define debug_err (   err,
  arg 
)    debug_w("%s: %s", IO::Error::toString(err).c_str(), (arg).c_str())

◆ IOERROR_MAX_MAP

#define IOERROR_MAX_MAP (   XX)
Value:
XX(common, -100) \
XX(modbus, -200) \
XX(rfswitch, -300)

◆ IOERROR_STD_MAP

#define IOERROR_STD_MAP (   XX)
Value:
XX(access_denied, "Access Denied") \
XX(timeout, "Timeout") \
XX(cancelled, "Cancelled") \
XX(not_impl, "Not Implemented") \
XX(no_mem, "Out of memory") \
XX(busy, "Device or controller is busy") \
XX(bad_config, "Configuration data invalid") \
XX(file, "File Error") \
XX(bad_controller_class, "Wrong controller class specified for device") \
XX(bad_controller, "Controller not registered") \
XX(bad_device_class, "Device class not registered") \
XX(bad_device, "Device not registered") \
XX(bad_node, "Node ID not valid") \
XX(bad_command, "Invalid Command") \
XX(bad_function, "Invalid Function") \
XX(bad_param, "Invalid Parameter") \
XX(bad_checksum, "Checksum failed") \
XX(bad_size, "Data size invalid") \
XX(queue_full, "Request queue is full") \
XX(no_config, "No configuration found") \
XX(no_control_id, "Control ID not specified") \
XX(no_device_id, "Device ID not specified") \
XX(no_command, "Command not specified") \
XX(no_address, "Device address not specified") \
XX(no_baudrate, "Device baud rate not specified") \
XX(no_code, "RF code not specified")

◆ XX [1/2]

#define XX (   name,
  value 
)    max_##name = value,

◆ XX [2/2]

#define XX (   tag,
  comment 
)    tag,
#define XX(name, value)
Definition: Libraries/IOControl/include/IO/Error.h:74