command_code.h

#pragma once
 
/************************************************************************************************
 * @file   command_code.h
 *
 * @brief  Header file defining the CommandCodes
 *
 * @date   2025-01-04
 * @author Aryan Kashem
 ************************************************************************************************/
 
/* Standard library Headers */
#include <string>
 
/* Inter-component Headers */
 
/* Intra-component Headers */
 
enum class CommandCode {
  /* MISC Commands */
  METADATA, 
  /* GPIO Commands */
  GPIO_SET_PIN_STATE,         
  GPIO_SET_ALL_STATES,        
  GPIO_GET_PIN_STATE,         
  GPIO_GET_ALL_STATES,        
  GPIO_GET_PIN_MODE,          
  GPIO_GET_ALL_MODES,         
  GPIO_GET_PIN_ALT_FUNCTION,  
  GPIO_GET_ALL_ALT_FUNCTIONS, 
  /* I2C Commands */
 
  /* SPI Commands */
 
  /* UART Commands */
 
  /* FLASH Commands */
 
  NUM_COMMAND_CODES 
};
 
std::string encodeCommand(const CommandCode commandCode, std::string &message);
 
std::pair<CommandCode, std::string> decodeCommand(std::string &message);