mailbox_error_codes.h

Go to the documentation of this file.

#pragma once
 
#include <algorithm>
#include <array>
#include <cstdint>
#include <nlohmann/json_fwd.hpp>
#include <string_view>
 
namespace mm::comm {
 
struct MailboxErrorCode {
  uint16_t code = 0;             
  std::string_view name;         
  std::string_view description;  
};
 
void to_json(nlohmann::json& j, const MailboxErrorCode& e);
 
inline constexpr auto kMailboxErrorCodes = std::to_array<MailboxErrorCode>({
    {0x0001, "MBXERR_SYNTAX", "Syntax of the 6-octet mailbox header is wrong"},
    {0x0002, "MBXERR_UNSUPPORTEDPROTOCOL", "The mailbox protocol is not supported"},
    {0x0003, "MBXERR_INVALIDCHANNEL",
     "Channel field contains a wrong value (a slave may ignore it)"},
    {0x0004, "MBXERR_SERVICENOTSUPPORTED", "The service in the mailbox protocol is not supported"},
    {0x0005, "MBXERR_INVALIDHEADER",
     "The mailbox protocol header is wrong (excluding the 6-octet mailbox header)"},
    {0x0006, "MBXERR_SIZETOOSHORT", "Length of received mailbox data is too short"},
    {0x0007, "MBXERR_NOMOREMEMORY",
     "Mailbox protocol cannot be processed because of limited resources"},
    {0x0008, "MBXERR_INVALIDSIZE", "The length of data is inconsistent"},
    {0x0009, "MBXERR_SERVICEINWORK", "Mailbox service already in use"},
});
 
constexpr std::string_view mailboxErrorCodeDescription(uint16_t code) {
  const auto it = std::find_if(kMailboxErrorCodes.begin(), kMailboxErrorCodes.end(),
                               [code](const MailboxErrorCode& e) { return e.code == code; });
  return it != kMailboxErrorCodes.end() ? it->description : std::string_view{};
}
 
}  // namespace mm::comm