GlobalVarHandler.h

/*
 *      GlobalVarHandler.h
 *
 *      Created on:     2016.09.05
 *      Author:         Vizi Gábor
 *      E-mail:         vizi.gabor90@gmail.com
 *      Function:       Global Variable Handler: Handle set-get variable from uart or other
 *      Target:         STM32Fx
 *      Version:        v4
 *      Last modified:  2016.09.28
 */

#ifndef GLOBALVARHANDLER_H_
#define GLOBALVARHANDLER_H_


#include "include.h"


/*------------------------------------------------------------------------------
 *  Macros & definitions
 *----------------------------------------------------------------------------*/

#define GLOBALVARHANDLER_UNIT_ENABLE
#define GLOBALVARHANDLER_DESCRIPTION_ENABLE

#define GLOBALVARHANDLER_NAME_MAX_LENGTH        (20)



/*------------------------------------------------------------------------------
 *  Type definitions
 *----------------------------------------------------------------------------*/

typedef uint8_t VarID_t;


typedef enum
{
    Type_Unknown = 0,
    Type_Bool,
    Type_Uint8,
    Type_Int8,
    Type_Uint16,
    Type_Int16,
    Type_Uint32,
    Type_Int32,
    Type_Float,
    Type_Bits,
    Type_String,
    Type_Enumerator,
    Type_Count
} VarType_t;


typedef enum
{
    Process_Unknown = 0,
    Process_GlobalVariableNameNotFind,
    Process_SourceNotEnabled,
    Process_IsReadOnly,
    Process_FailType,
    Process_FailParam,
    Process_FailParamTooLongString,
    Process_FailParamIsNotNumber,
    Process_FailParamIsNotHexNumber,
    Process_FailParamIsNotHexStart,
    Process_FailParamIsNotBinary,
    Process_FailParamTooLongBinary,
    Process_InvalidValue_TooMuch,
    Process_InvalidValue_TooSmall,
    Process_InvalidValue_NotBool,
    Process_InvalidValue_NotEnumString,
    Process_Settings_EmptyEnumList,
    Process_Ok_Answered,
    Process_Ok_SetSuccessful_SendOk
} ProcessResult_t;


typedef enum
{
    SetGet_Unknown = 0,
    SetGet_Get,
    SetGet_Set,
    SetGet_Help
} SetGetType_t;


typedef struct
{

    const char * const name;                
    const VarType_t type;                   

    void * const varPointer;                
    const bool isReadOnly;                  

    const uint32_t maxValue;                
    const uint32_t minValue;                

    const CommProtocol_t sourceEnable;      

    const bool isHex;                       

    const char * const *enumList;           

#ifdef GLOBALVARHANDLER_UNIT_ENABLE
    const char * const unit;                
#endif
#ifdef GLOBALVARHANDLER_DESCRIPTION_ENABLE
    const char * const description;         
#endif

} GlobalVarCommand_t;



/*------------------------------------------------------------------------------
 *  Global function declarations
 *----------------------------------------------------------------------------*/

bool GlobalVarHandler_CheckCommandStructAreValid(void);
void GlobalVarHandler_ProcessCommand(
        const char *commandName, const char *param,
        SetGetType_t setGetType, CommProtocol_t source,
        char *resultBuffer, uint8_t resultBufferLength);

void GlobalVarHandler_ListAllVariableParameters(void);
void GlobalVarHandler_PrintAllVariableValues(void);



#endif /* GLOBALVARHANDLER_H_ */