Device.h

Go to the documentation of this file.

 
 
#ifndef DEVICE_H_
#define DEVICE_H_
 
#include <Arduino.h>
#include <SPI.h>
 
//"Use the Save EEPROM fusebit so it wont get deleted every time you program the mcu."
//https://www.avrfreaks.net/forum/tut-c-using-eeprom-memory-avr-gcc
#include <avr/eeprom.h>
 
#include <avr/io.h>
#include <stdbool.h>
#include "UserInputHandler/UserInputHandler.h"
#include "Screens/ScreenManager.h"
#include "Channels/Channel.h"
#include "Channels/DDS_Channel.h"
#include "Channels/PS_Channel.h"
#include "Channels/DMM_Channel.h"
#include "Configuration.h"

typedef enum DeviceControlStates
{
    DEV_CTRL_LOCAL,               
    DEV_CTRL_REMOTE,         
    DEV_CTRL_RWLOCK,         
    NUM_DEV_CTRL_ELEMENTS      
}DeviceControlStates_t; 
extern const char* DeviceControlStateNames[NUM_DEV_CTRL_ELEMENTS];     

typedef enum DevicePowerUpOutputEnabledStates
{
    DEV_POWERUP_OUTPUTS_OFF,     
    DEV_POWERUP_OUTPUTS_LASTSTATE, 
    DEV_POWERUP_OUTPUTS_ON,           
    NUM_DEV_POWERUP_ELEMENTS        
}DevicePowerUpOutputEnabledStates_t;
extern const char* DevicePowerUpOutputEnabledStateNames[NUM_DEV_POWERUP_ELEMENTS];  

typedef struct DeviceVoltagesStruct
{
    float ATX_3V3;           
    float ATX_5V;         
}DeviceVoltages_t;

typedef struct DeviceCalibrationFactors
{
    float Cal_RefVoltage;     
    float Cal_ATX_5V;         
    float Cal_ATX_3V3;           
    float Cal_DMM1;             
    float Cal_DMM2;             
    float Cal_PS_VOLT;           
    float Cal_PS_CURR;           
    float Cal_PS_CURR_OFFSET; 
    float Cal_DDS_FREQ;         
 
    bool Cal_Valid;                
}DeviceCalibrationFactors_t;

typedef struct DevSettingsEEPROMLayout
{
    float PS_Voltage;                                         
    bool PS_Enabled;                                          
    uint8_t PS_OvpLevel;                                     
    bool PS_OvpState;                                            
    float PS_OvpDelay;                                           
    float PS_OcpLevel;                                           
    bool PS_OcpState;                                            
    float PS_OcpDelay;                                           
    float PS_OppLevel;                                           
    bool PS_OppState;                                            
    float PS_OppDelay;                                           
    PsRegulationModes_t PS_RegulationMode;                      
 
    float DDS1_Frequency;                                     
    SignalForms_t DDS1_SignalForm;                              
    float DDS1_Amplitude;                                     
    float DDS1_Offset;                                           
    bool DDS1_Enabled;                                          
    float DDS1_PWM_Value;                                     
    
    float DDS2_Frequency;                                     
    SignalForms_t DDS2_SignalForm;                              
    float DDS2_Amplitude;                                     
    float DDS2_Offset;                                           
    bool DDS2_Enabled;                                          
    float DDS2_PWM_Value;                                     
    
    DevicePowerUpOutputEnabledStates_t PowerOnOutputsState;        
        
}DevSettingsEEPROMLayout_t;
 
#if defined DDS_USER_DEFINED_WAVEFORMS_ENABLED && defined DDS_SUBSYSTEM_ENABLED
    typedef struct DevSettingsUserDDSWaveformEEPROMLayout
    {
        uint16_t DDS1_UserWaveTable[(1 << DDS_QUANTIZER_BITS)];       
        uint16_t DDS2_UserWaveTable[(1 << DDS_QUANTIZER_BITS)];       
    }DevSettingsUserDDSWaveformEEPROMLayout_t;
#endif
 

class DeviceClass
{           
    private:
        bool _settingsChanged;                                      
        
    public: 
        #ifdef PS_SUBSYSTEM_ENABLED
            PS_Channel PsChannel;                                    
        #endif
        #ifdef DDS_SUBSYSTEM_ENABLED
            DDS_Channel DdsChannel1;                              
            DDS_Channel DdsChannel2;                              
        #endif
        #ifdef MEASURE_SUBSYSTEM_ENABLED
            DMM_Channel DmmChannel1;                              
            DMM_Channel DmmChannel2;                              
        #endif
        Channel* Channels[NUM_CHANNELS];                         
        
        uint8_t SelectedScpiChannelIndex;                           
        
        DevicePowerUpOutputEnabledStates_t PowerOnOutputsState;        
        
        DeviceControlStates_t DeviceControlState;                    
        
        DeviceVoltages_t DeviceVoltages;                          
        DeviceCalibrationFactors_t CalibrationFactors;              
 
        UserInputHandlerClass UserInputHandler;                        
        ScreenManagerClass ScreenManager;                            
 
        uint16_t TimeCounter_KeyPolling_ms;                            
        uint16_t TimeCounter_AutoSave_ms;                            
        uint16_t TimeCounter_PowerSupplyChannelRegulation_ms;        
    
        DeviceClass();                                               
        void Init();                                                
        void InitDeviceTimer();                                      
        
        void DeviceMainLoop();                                        
        
        void DeviceTimerTickISR();
        
        void SetSettingsChanged(bool settingsChanged);
        
        void SaveSettings();        
                                        
        void LoadSettings();        
                                       
        void ResetDevice();                  
                                       
        void ResetDeviceCalibration();        

        void ReportCalibrationFactors();
        
        void CoerceCalibrationFactors();
                             
        void SaveSettingsCalibrationFactors();        
                     
        void LoadSettingsCalibrationFactors();                        
        
        #if defined DDS_USER_DEFINED_WAVEFORMS_ENABLED && defined DDS_SUBSYSTEM_ENABLED
            void SaveSettingsDDSUserWaveforms();
                              
            void LoadSettingsDDSUserWaveforms();                    
        #endif
        
        void SetDeviceControlState(DeviceControlStates_t controlState);
        
        bool IsUserInputLocked();
        
        void UpdateControlStateOnUserInput();
};
 
extern DeviceClass Device;           
 
#endif /* DEVICE_H_ */