StateEnum.hpp

Go to the documentation of this file.

#pragma once

// std
#include <cstdint>
#include <iostream>
#include <string>

namespace rokubimini
{
namespace fsm
{
// FSM state IDs.
// NOTE: This mapping must be equal to the mapping in the firmware.
// For now I'm using random numbers
#define ROKUBIMINI_STATE_ID_CALIBRATE (0)
#define ROKUBIMINI_STATE_ID_DEVICE_MISSING (1)
#define ROKUBIMINI_STATE_ID_ERROR (2)
#define ROKUBIMINI_STATE_ID_FATAL (3)
#define ROKUBIMINI_STATE_ID_OPERATIONAL (4)
#define ROKUBIMINI_STATE_ID_NA (5)
#define ROKUBIMINI_STATE_ID_STANDBY (6)

// FSM state names.
#define ROKUBIMINI_STATE_NAME_CALIBRATE ("Calibrate")
#define ROKUBIMINI_STATE_NAME_DEVICE_MISSING ("DeviceMissing")
#define ROKUBIMINI_STATE_NAME_ERROR ("Error")
#define ROKUBIMINI_STATE_NAME_FATAL ("Fatal")
#define ROKUBIMINI_STATE_NAME_OPERATIONAL ("Operational")
#define ROKUBIMINI_STATE_NAME_NA ("N/A")
#define ROKUBIMINI_STATE_NAME_STANDBY ("Standby")

enum class StateEnum
{
  CALIBRATE,
  DEVICE_MISSING,
  ERROR,
  FATAL,
  OPERATIONAL,
  NA,
  STANDBY,
};

uint16_t stateEnumToId(const StateEnum stateEnum);

StateEnum stateIdToEnum(uint16_t stateId);

std::string stateEnumToName(const StateEnum stateEnum);

StateEnum stateNameToEnum(const std::string& string);

std::ostream& operator<<(std::ostream& out, const StateEnum stateEnum);

}  // namespace fsm
}  // namespace rokubimini