homeautmessage.h

/*******************************************************************************
 * Purpose:
 ******************************************************************************/

#ifndef HOMEAUTMESSAGE_H_
#define HOMEAUTMESSAGE_H_


#include "include.h"



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

#define VALID       ( 1 )
#define INVALID     ( 0 )



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

typedef struct
{
    char Header[9];                         
    // |HomeAut|
    char MyAddress[3];                      
    // <MyAddress>
    char Seperator1[1];                     
    // |
    char TargetAddress[3];                  
    // <TargetAddress>
    char Seperator2[1];                     
    // |
    char Function[7];                       
    // <Function>
    char Seperator3[1];                     
    // |
    char DataType[6];                       
    // <DataType> : 6 byte ASCII char
    char Data[8];                           
    // <Data> : 8 byte - ASCII Hex
    char Seperator4[1];                     
    // |
} HomeAut_MessageType;

// For example message:
// |HomeAut|010|014|LOGIN__|NMEDIU00000000|
//type = Login_ImLoginImNodeMedium





// uint8_t  Function[7],
/*
const uint8_t HOMEAUTMESSAGE_DefaultFunctionLogin[] =   "LOGIN__";
const uint8_t HOMEAUTMESSAGE_DefaultFunctionState[] =   "STATE__";
const uint8_t HOMEAUTMESSAGE_DefaultFunctionAlarm[] =   "ALARM__";
const uint8_t HOMEAUTMESSAGE_DefaultFunctionCommand[] = "COMMAND";
const uint8_t HOMEAUTMESSAGE_DefaultFunctionMode[] =    "MODE___";
const uint8_t HOMEAUTMESSAGE_DefaultFunctionConfig[] =  "CONFIG_";
*/


typedef enum
{
    Function_Invalid = 0,
    Function_Login,
    Function_State,
    Function_Alarm,
    Function_Command,
    Function_Mode,
    Function_Config,
    Function_End
} HomeAut_FunctionType;



typedef struct
{
    char name[8];                       
    HomeAut_FunctionType function;      
} FunctionTypeParity;


typedef enum
{
    DataType_Unknown = 0,
    
    // Login
    Login_ImLoginImNodeSmall,
    Login_ImLoginImNodeMedium,
    Login_ImLoginImCenterPanel,
    Login_Welcome,
    Login_Sync,
    
    
    // State
    State_Temperature,
    State_Brightness,
    State_Sound,
    State_Button,
    State_Battery,
    State_Vin,
    State_Accelerometer,
    State_Input,
    State_Output,
    
    // Alarm
    Alarm_TooHot,
    Alarm_TooCold,
    Alarm_InternalTemperature_TooHot,
    Alarm_InternalTemperature_TooCold,
    Alarm_TooBright,
    Alarm_TooDark,
    Alarm_PressedButton,
    Alarm_OnCharge,
    Alarm_OffCharge,
    Alarm_LowBattery,
    Alarm_Accelerometer,
    Alarm_InputRise,
    Alarm_InputFalling,
    Alarm_InputAllState,
    Alarm_Moving,
    Alarm_SoundImpacted,
    Alarm_DoorOpened,
    
    // Command: Master send command to Slave
    Command_SetOutput,
    Command_AllOutput,
    Command_ResetOutput,
    Command_SetLed,
    Command_AllLed,
    Command_ResetLed,
    
    // Mode: Master set Slave mode
    Mode_RemoteControl,
    Mode_Spectator,
    Mode_Sleep,
    
    // Config: Master config the slave
    Config_TODO,
    Config_AnythingLimit,
    
    // Too add new DataType here
    
    DataType_End
} HomeAut_DataType;



typedef struct
{
    const char name[7];                     
    HomeAut_DataType type;                  
} DataTypeParity;



typedef struct
{
    uint8_t MyAddress;                      
    uint8_t TargetAddress;                  
    HomeAut_FunctionType Function;          
    HomeAut_DataType DataType;              
    uint32_t Data;                          
    uint8_t isValid;                        
} HomeAut_InformationType;



/*------------------------------------------------------------------------------
 *  Global variables
 *----------------------------------------------------------------------------*/

extern const FunctionTypeParity FunctionTypeParity_List[];  // Function enum - "FUNCTION" string
    

extern const DataTypeParity DataTypeParity_List[];          // DataType enum - "DATATYPE" string


extern HomeAut_InformationType HOMEAUTMESSAGE_MessageInformation;



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

void HOMEAUTMESSAGE_Test(void);
ReturnType HOMEAUTMESSAGE_CompareMessage(char *messageString);
ReturnType HOMEAUTMESSAGE_CreateMessage(HomeAut_MessageType *createToMessage, HomeAut_InformationType *messageInformation);

ReturnType HOMEAUTMESSAGE_CreateAndSendHomeAutMessage
    ( uint8_t myIp, uint8_t destIp, HomeAut_FunctionType function,
    HomeAut_DataType dataType, uint32_t data, uint8_t isValid);
    




#endif /* HOMEAUTMESSAGE_H_*/