lib_system.h

Go to the documentation of this file.

 
#ifndef _LIB_SYSTEM_H_
#define _LIB_SYSTEM_H_
 
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "freertos/event_groups.h"
#include "freertos/queue.h"
 
#include "lib_aws.h"
#include "lib_ota.h"
#include "stdutils.h"
 
 
typedef enum
{
    SYSTEM_MODE_IDLE,   
    SYSTEM_MODE_TEST,   
    SYSTEM_MODE_CONFIG, 
    SYSTEM_MODE_NORMAL, 
    SYSTEM_MODE_OTA,    
    SYSTEM_MODE_ABORT,  
    SYSTEM_MODE_MAX     
} systemMode_et;
 
typedef enum
{
    EVENT_WIFI_CONNECTED,    
    EVENT_WIFI_DISCONNECTED, 
    EVENT_AWS_CONNECTED,     
    EVENT_AWS_DISCONNECTED,  
    EVENT_BLE_CONNECTED,     
    EVENT_BLE_AUTHENTICATED, 
    EVENT_BLE_DISCONNECTED,  
    EVENT_MQTT_CONNECTED,    
    EVENT_MQTT_DISCONNECTED, 
    EVENT_MAX                
} systemEvents_et;
 
typedef void (*systemEventCb_t)(systemEvents_et eventId);
 
typedef struct
{
    logLevels_et *pLogLevels_e; 
    uint8_t logModulesCount_u8; 
    char *pLicenseIdStr;
    char *pWifiSsidStr;                  
    char *pWifiPwdStr;                   
    char *pDeviceNamePrefixStr;          // max 15 bytes
    systemEventCb_t systemEventCallBack; 
    awsConfig_st s_awsConfig;            
} systemInitConfig_st;
 
bool SYSTEM_init(systemInitConfig_st *s_pConfig);
void SYSTEM_start();
void SYSTEM_startOta(char *pUrlStr);
 
bool SYSTEM_startFirmwareUpdate(firmUpdateType_et e_type, char *pUrlStr);
 
bool SYSTEM_startFileDownload(char *pUrlStr);
 
void SYSTEM_restart(uint32_t restartDelay_u32);
 
bool SYSTEM_isWaitingForRestart();
 
systemMode_et SYSTEM_getMode();
 
 
const char *SYSTEM_getModeString();
 
void SYSTEM_abort(char *pMsgStr, const char *pFunNameStr, uint32_t errorCode_u32);
void SYSTEM_factoryReset(bool useFactoryPartition_b8, bool eraseAllData_b8);
 
const char *SYSTEM_getDeviceName();
 
const char *SYSTEM_getMacAddr();
 
const char *SYSTEM_getResetCause();
 
#endif