Index: DGDefs.h =================================================================== diff -u -ra3423542cf15d36156ff66d5b18a3e36ae8088c4 -r4d2b5be84c79ac486a5f529cdbe14a3894ed30f1 --- DGDefs.h (.../DGDefs.h) (revision a3423542cf15d36156ff66d5b18a3e36ae8088c4) +++ DGDefs.h (.../DGDefs.h) (revision 4d2b5be84c79ac486a5f529cdbe14a3894ed30f1) @@ -1,59 +1,59 @@ /************************************************************************** * -* Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. +* Copyright (c) 2020-2022 Diality Inc. - All Rights Reserved. * * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * -* @file DGDefs.h +* @file DGDefs.h * -* @author (last) Quang Nguyen -* @date (last) 02-Sep-2020 +* @author (last) Dara Navaei +* @date (last) 22-Nov-2021 * -* @author (original) Sean Nash -* @date (original) 29-May-2020 +* @author (original) Sean Nash +* @date (original) 29-May-2020 * ***************************************************************************/ - -#ifndef __DG_DEFS_H__ -#define __DG_DEFS_H__ - -// ********** public definitions ********** - -/** - * @addtogroup DGOperationModes - * @{ - */ - -/// Enumeration of operation modes. These are in order of priority (highest to lowest). -enum DG_Op_Modes -{ - DG_MODE_FAUL = 0, ///< Fault mode - DG_MODE_SERV, ///< Service mode - DG_MODE_INIT, ///< Initialization & POST mode - DG_MODE_STAN, ///< Standby mode - connected to HD - DG_MODE_SOLO, ///< Standby Solo mode - no HD connected - DG_MODE_CIRC, ///< Re-circulate mode - DG_MODE_FILL, ///< Fill mode - DG_MODE_DRAI, ///< Drain mode - DG_MODE_FLUS, ///< Flush mode - DG_MODE_HEAT, ///< Heat Disinfect mode - DG_MODE_CHEM, ///< Chemical Disinfect mode - DG_MODE_NLEG, ///< Not legal - an illegal mode transition occurred - NUM_OF_DG_MODES ///< Number of DG operation modes -}; -typedef enum DG_Op_Modes DG_OP_MODE_T; ///< Type for DG operation modes enumeration - -/**@}*/ - -/** - * @addtogroup DGInitAndPOSTMode - * @{ - */ - -/// Enumeration of init & POST mode states. -enum DG_POST_States -{ + +#ifndef __DG_DEFS_H__ +#define __DG_DEFS_H__ + +// ********** public definitions ********** + +/** + * @addtogroup DGOperationModes + * @{ + */ + +/// Enumeration of operation modes. These are in order of priority (highest to lowest). +enum DG_Op_Modes +{ + DG_MODE_FAUL = 0, ///< Fault mode + DG_MODE_SERV, ///< Service mode + DG_MODE_INIT, ///< Initialization & POST mode + DG_MODE_STAN, ///< Standby mode - connected to HD + DG_MODE_SOLO, ///< Standby Solo mode - no HD connected + DG_MODE_GENE, ///< Generation idle mode + DG_MODE_FILL, ///< Fill mode + DG_MODE_DRAI, ///< Drain mode + DG_MODE_FLUS, ///< Flush mode + DG_MODE_HEAT, ///< Heat Disinfect mode + DG_MODE_CHEM, ///< Chemical Disinfect mode + DG_MODE_NLEG, ///< Not legal - an illegal mode transition occurred + NUM_OF_DG_MODES ///< Number of DG operation modes +}; +typedef enum DG_Op_Modes DG_OP_MODE_T; ///< Type for DG operation modes enumeration + +/**@}*/ + +/** + * @addtogroup DGInitAndPOSTMode + * @{ + */ + +/// Enumeration of init & POST mode states. +enum DG_POST_States +{ DG_POST_STATE_START = 0, ///< Start initialize & POST mode state DG_POST_STATE_FW_COMPATIBILITY, ///< Run firmware compatibility test state DG_POST_STATE_FW_INTEGRITY, ///< Run firmware image integrity test state @@ -63,134 +63,158 @@ DG_POST_STATE_TEMPERATURE_SENSORS, ///< Temperature Sensors POST state DG_POST_STATE_ACCELEROMETER, ///< Accelerometer POST state DG_POST_STATE_PRESSURES, ///< Pressure sensors POST state + DG_POST_STATE_RO_PUMP, ///< RO pump POST state + DG_POST_STATE_DRAIN_PUMP, ///< Drain pump POST state + DG_POST_STATE_CONCENTRATE_PUMPS, ///< Concentrate pumps POST state + DG_POST_STATE_CONDUCTIVITY_SENSORS, ///< Conductivity sensors POST state + DG_POST_STATE_RESERVOIRS, ///< Reservoirs POST state DG_POST_STATE_UV_REACTORS, ///< UV reactors POST state DG_POST_STATE_THERMISTORS, ///< Thermistors POST state DG_POST_STATE_FANS, ///< Fans POST state - DG_POST_DRAIN_PUMP, ///< Drain pump POST state + DG_POST_STATE_DIALYSATE_FLOW_SENSOR, ///< Dialysate flow sensor POST state DG_POST_STATE_WATCHDOG, ///< Watchdog POST test state + DG_POST_STATE_SAFETY_SHUTDOWN, ///< Safety shutdown POST test state DG_POST_STATE_LOAD_CELL, ///< Load cells POST state DG_POST_STATE_COMPLETED, ///< POST completed successfully state DG_POST_STATE_FAILED, ///< POST failed state NUM_OF_DG_POST_STATES ///< Number of initialize & POST mode states -}; -typedef enum DG_POST_States DG_POST_STATE_T; ///< Type for DG POST states enumeration - -/**@}*/ - -/** - * @addtogroup DGFaultMode - * @{ - */ - -/// Enumeration of fault mode states. -enum DG_Fault_States -{ - DG_FAULT_STATE_START = 0, ///< Start fault state - NUM_OF_DG_FAULT_STATES ///< Number of fault mode states -}; -typedef enum DG_Fault_States DG_FAULT_STATE_T; ///< Type for DG fault states enumeration - -/**@}*/ - -/** - * @addtogroup DGSoloStandbyMode - * @{ - */ - -/// Enumeration of solo standby mode states. -enum DG_Solo_States -{ - DG_SOLO_STANDBY_STATE_START = 0, ///< Start solo standby mode state - DG_SOLO_IDLE_STATE, ///< Idle solo standby mode state - NUM_OF_DG_SOLO_STANDBY_STATES ///< Number of solo standby mode states -}; -typedef enum DG_Solo_States DG_SOLO_STANDBY_STATE_T; ///< Type for DG solo mode states enumeration - -/**@}*/ - -/** - * @addtogroup DGStandbyMode - * @{ - */ - -/// Enumeration of standby mode states. -enum DG_Standby_Mode_States -{ - DG_STANDBY_MODE_STATE_START = 0, ///< Start standby mode state +}; +typedef enum DG_POST_States DG_POST_STATE_T; ///< Type for DG POST states enumeration + +/**@}*/ + +/** + * @addtogroup DGFaultMode + * @{ + */ + +/// Enumeration of fault mode states. +enum DG_Fault_States +{ + DG_FAULT_STATE_START = 0, ///< Start fault state + NUM_OF_DG_FAULT_STATES ///< Number of fault mode states +}; +typedef enum DG_Fault_States DG_FAULT_STATE_T; ///< Type for DG fault states enumeration + +/**@}*/ + +/** + * @addtogroup DGSoloStandbyMode + * @{ + */ + +/// Enumeration of solo standby mode states. +enum DG_Solo_States +{ + DG_SOLO_STANDBY_STATE_START = 0, ///< Start solo standby mode state + DG_SOLO_IDLE_STATE, ///< Idle solo standby mode state + NUM_OF_DG_SOLO_STANDBY_STATES ///< Number of solo standby mode states +}; +typedef enum DG_Solo_States DG_SOLO_STANDBY_STATE_T; ///< Type for DG solo mode states enumeration + +/**@}*/ + +/** + * @addtogroup DGStandbyMode + * @{ + */ + +/// Enumeration of standby mode states. +enum DG_Standby_Mode_States +{ + DG_STANDBY_MODE_STATE_START = 0, ///< Start standby mode state DG_STANDBY_MODE_STATE_IDLE, ///< Idle standby mode state DG_STANDBY_MODE_STATE_FLUSH_FILTER, ///< Sample water flush filter state DG_STANDBY_MODE_STATE_FLUSH_FILTER_IDLE, ///< Sample water flush filter idle state - DG_STANDBY_MODE_STATE_SAMPLE_WATER, ///< Sample water state - NUM_OF_DG_STANDBY_MODE_STATES ///< Number of standby mode states -}; -typedef enum DG_Standby_Mode_States DG_STANDBY_MODE_STATE_T; ///< Type for DG standby mode states enumeration - -/**@}*/ - -/** - * @addtogroup DGRecirculateMode - * @{ - */ - -/// Enumeration of re-circulation mode states. -enum DG_Recirculate_Mode_States -{ - DG_RECIRCULATE_MODE_STATE_START = 0, ///< Start re-circulation mode state - DG_RECIRCULATE_MODE_STATE_FLUSH_LINES, ///< Flush lines state - DG_RECIRCULATE_MODE_STATE_RECIRC_WATER, ///< Re-circulate water state - DG_RECIRCULATE_MODE_STATE_PAUSE, ///< Pause state (pumps, heaters, lamps off) - NUM_OF_DG_RECIRCULATE_MODE_STATES ///< Number of fill mode states -}; -typedef enum DG_Recirculate_Mode_States DG_RECIRCULATE_MODE_STATE_T; ///< Type for DG recirculation mode states enumeration - -/**@}*/ - -/** - * @addtogroup DGFillMode - * @{ - */ - -/// Enumeration of fill mode states. -enum DG_Fill_Mode_States -{ - DG_FILL_MODE_STATE_START = 0, ///< Start fill mode state + DG_STANDBY_MODE_STATE_SAMPLE_WATER, ///< Sample water state + NUM_OF_DG_STANDBY_MODE_STATES ///< Number of standby mode states +}; +typedef enum DG_Standby_Mode_States DG_STANDBY_MODE_STATE_T; ///< Type for DG standby mode states enumeration + +/**@}*/ + +/** + * @addtogroup DGRecirculateMode + * @{ + */ + +/// Enumeration of generation idle mode states. +enum DG_Generation_Idle_Mode_States +{ + DG_GEN_IDLE_MODE_STATE_START = 0, ///< Start generation idle mode state + DG_GEN_IDLE_MODE_STATE_FLUSH_LINES, ///< Flush lines state + DG_GEN_IDLE_MODE_STATE_FLUSH_WATER, ///< Flush water state + NUM_OF_DG_GEN_IDLE_MODE_STATES ///< Number of fill mode states +}; +typedef enum DG_Generation_Idle_Mode_States DG_GEN_IDLE_MODE_STATE_T; ///< Type for DG generation idle mode states enumeration + +/**@}*/ + +/** + * @addtogroup DGFillMode + * @{ + */ + +/// Enumeration of fill mode states. +enum DG_Fill_Mode_States +{ + DG_FILL_MODE_STATE_START = 0, ///< Start fill mode state DG_FILL_MODE_STATE_CHECK_INLET_WATER, ///< Check inlet water quality state DG_FILL_MODE_STATE_BICARB_PUMP_CHECK, ///< Run bicarb concentrate pump and check conductivity range DG_FILL_MODE_STATE_ACID_PUMP_CHECK, ///< Run acid concentrate pump and check conductivity range - DG_FILL_MODE_STATE_DIALYSATE_PRODUCTION, ///< Dialysate production state + DG_FILL_MODE_STATE_DIALYSATE_PRODUCTION, ///< Dialysate production state DG_FILL_MODE_STATE_DELIVER_DIALYSATE, ///< Deliver dialysate state - DG_FILL_MODE_STATE_PAUSED, ///< Dialysate generation pause state - NUM_OF_DG_FILL_MODE_STATES ///< Number of fill mode states -}; -typedef enum DG_Fill_Mode_States DG_FILL_MODE_STATE_T; ///< Type for DG fill mode states enumeration - -/**@}*/ - -/** - * @addtogroup DGDrainMode - * @{ - */ - -/// Enumeration of drain mode states. -enum DG_Drain_States -{ - DG_DRAIN_STATE_START = 0, ///< Start drain mode state + DG_FILL_MODE_STATE_PAUSED, ///< Dialysate generation pause state + NUM_OF_DG_FILL_MODE_STATES ///< Number of fill mode states +}; +typedef enum DG_Fill_Mode_States DG_FILL_MODE_STATE_T; ///< Type for DG fill mode states enumeration + +/**@}*/ + +/** + * @addtogroup DGDrainMode + * @{ + */ + +/// Enumeration of drain mode states. +enum DG_Drain_States +{ + DG_DRAIN_STATE_START = 0, ///< Start drain mode state DG_DRAIN_STATE_DRAIN, ///< Drain drain mode state - DG_DRAIN_STATE_TARE, ///< Tare drain mode state - NUM_OF_DG_DRAIN_STATES ///< Number of drain mode states -}; -typedef enum DG_Drain_States DG_DRAIN_STATE_T; ///< Type for DG drain mode states enumeration - -/**@}*/ - -/** - * @addtogroup DGFlushMode - * @{ - */ - -/// Enumeration of flush mode states. -enum DG_Flush_States -{ + DG_DRAIN_STATE_TARE, ///< Tare drain mode state + DG_DRAIN_STATE_RINSE, ///< Rinse concentrate lines drain mode state + NUM_OF_DG_DRAIN_STATES ///< Number of drain mode states +}; +typedef enum DG_Drain_States DG_DRAIN_STATE_T; ///< Type for DG drain mode states enumeration + +/**@}*/ + +/** + * @addtogroup HDDisinfectStates + * @{ + */ + +/// Sub-mode states while in standby mode disinfect +enum DG_Disinfect_States +{ + DG_DISINFECT_FLUSH_STATE = 0, ///< DG disinfect flush + DG_DISINFECT_HEAT_STATE, ///< DG disinfect heat + DG_DISINFECT_CHEM_STATE, ///< DG disinfect chemical + DG_DISINFECT_NOT_RUNNING_STATE, ///< DG disinfect not running + NUM_OF_DG_DISINFECT_STATES ///< Number of DG disinfect states +}; +typedef enum DG_Disinfect_States DG_DISINFECT_STATE_T; ///< Type for DG disinfect states that are broadcast to UI + +/**@}*/ + +/** + * @addtogroup DGFlushMode + * @{ + */ + +/// Enumeration of flush mode states. +enum DG_Flush_States +{ DG_FLUSH_STATE_START = 0, ///< Flush, start mode state DG_FLUSH_STATE_DRAIN_R1, ///< Flush, drain reservoir 1 state DG_FLUSH_STATE_DRAIN_R2, ///< Flush, drain reservoir 2 state @@ -204,9 +228,9 @@ DG_FLUSH_STATE_FLUSH_WITH_FRESH_WATER, ///< Flush, flush with fresh water DG_FLUSH_STATE_CANCEL_BASIC_PATH, ///< Flush, cancel basic path state DG_FLUSH_STATE_CANCEL_WATER_PATH, ///< Flush, cancel water path state - DG_FLUSH_STATE_COMPLETE, ///< Flush, complete mode state - NUM_OF_DG_FLUSH_STATES ///< Number of flush mode states -}; + DG_FLUSH_STATE_COMPLETE, ///< Flush, complete mode state + NUM_OF_DG_FLUSH_STATES ///< Number of flush mode states +}; typedef enum DG_Flush_States DG_FLUSH_STATE_T; ///< Type for DG flush mode states enumeration /// Enumeration of flush mode UI states. @@ -233,18 +257,18 @@ F32 drainLineVolume; ///< Drain line volume. U32 flushUIState; ///< Flush UI state. } MODE_FLUSH_DATA_T; -#endif - -/**@}*/ - -/** - * @addtogroup DGHeatDisinfectMode - * @{ - */ - -/// Enumeration of heat disinfect mode states. -enum DG_Heat_States -{ +#endif + +/**@}*/ + +/** + * @addtogroup DGHeatDisinfectMode + * @{ + */ + +/// Enumeration of heat disinfect mode states. +enum DG_Heat_States +{ DG_HEAT_DISINFECT_STATE_START = 0, ///< Heat disinfect, start mode state DG_HEAT_DISINFECT_STATE_DRAIN_R1, ///< Heat disinfect, drain R1 state DG_HEAT_DISINFECT_STATE_DRAIN_R2, ///< Heat disinfect, drain R2 state @@ -268,8 +292,8 @@ DG_HEAT_DISINFECT_STATE_CANCEL_BASIC_PATH, ///< Heat disinfect, cancel mode basic path state DG_HEAT_DISINFECT_STATE_CANCEL_WATER_PATH, ///< Heat disinfect, cancel mode water path state DG_HEAT_DISINFECT_STATE_COMPLETE, ///< Heat disinfect, complete state - NUM_OF_DG_HEAT_DISINFECT_STATES ///< Number of heat disinfect mode states -}; + NUM_OF_DG_HEAT_DISINFECT_STATES ///< Number of heat disinfect mode states +}; typedef enum DG_Heat_States DG_HEAT_DISINFECT_STATE_T; ///< Type for DG heat disinfect states enumeration /// Enumeration of heat disinfect mode states. @@ -286,7 +310,7 @@ HEAT_DISINFECT_UI_STATE_CANCEL_DISINFECT, ///< Heat disinfect UI, cancel disinfect state HEAT_DISINFECT_UI_STATE_COMPLETE, ///< Heat disinfect UI, complete state NUM_OF_HEAT_DISINFECT_UI_STATES ///< Number of heat disinfect mode UI states -}; +}; typedef enum DG_Heat_UI_States DG_HEAT_DISINFECT_UI_STATE_T; ///< Type for DG heat disinfect UI states enumeration #if defined(_HD_) || defined(_DG_) @@ -302,17 +326,17 @@ U32 heatDisinfectUIState; ///< Heat disinfect UI state. } MODE_HEAT_DISINFECT_DATA_T; #endif - -/**@}*/ - -/** - * @addtogroup DGChemicalDisinfectMode - * @{ - */ - -/// Enumeration of chemical disinfect mode states. -enum DG_Chem_States -{ + +/**@}*/ + +/** + * @addtogroup DGChemicalDisinfectMode + * @{ + */ + +/// Enumeration of chemical disinfect mode states. +enum DG_Chem_States +{ DG_CHEM_DISINFECT_STATE_START = 0, ///< Chemical disinfect, start state DG_CHEM_DISINFECT_STATE_DRAIN_R1, ///< Chemical disinfect, drain R1 state DG_CHEM_DISINFECT_STATE_DRAIN_R2, ///< Chemical disinfect, drain R2 state @@ -337,9 +361,9 @@ DG_CHEM_DISINFECT_STATE_RINSE_CIRCULATION, ///< Chemical disinfect, rinse circulation state DG_CHEM_DISINFECT_STATE_CANCEL_BASIC_PATH, ///< Chemical disinfect, cancel basic path state DG_CHEM_DISINFECT_STATE_CANCEL_WATER_PATH, ///< Chemical disinfect, cancel water path state - DG_CHEM_DISINFECT_STATE_COMPLETE, ///< Chemical disinfect, complete state - NUM_OF_DG_CHEM_DISINFECT_STATES ///< Number of chemical disinfect mode states -}; + DG_CHEM_DISINFECT_STATE_COMPLETE, ///< Chemical disinfect, complete state + NUM_OF_DG_CHEM_DISINFECT_STATES ///< Number of chemical disinfect mode states +}; typedef enum DG_Chem_States DG_CHEM_DISINFECT_STATE_T; ///< Type for DG chemical disinfect states enumeration /// Enumeration of chemical disinfect mode UI states @@ -371,7 +395,7 @@ U32 postDisinfectCurrentRinseCount; ///< Current post disinfect rinse count. U32 chemDisinfectUIState; ///< Chemical disinfect UI state. } MODE_CHEMICAL_DISINFECT_DATA_T; -#endif +#endif /**@}*/ @@ -398,25 +422,26 @@ /// Enumeration of available DG commands. enum DG_Command { - DG_CMD_NONE = 0, ///< Not a command - DG_CMD_SWITCH_RESERVOIR = 1, ///< Command to request DG switch reservoirs - DG_CMD_START_DRAIN = 2, ///< Command to request DG to start drain - DG_CMD_STOP_DRAIN = 3, ///< Command to request DG to stop drain - DG_CMD_START_FILL = 4, ///< Command to request DG to start fill - DG_CMD_STOP_FILL = 5, ///< Command to request DG to stop fill - DG_CMD_START_TRIMMER_HEATER = 6, ///< Command to request DG to start trimmer heater - DG_CMD_STOP_TRIMMER_HEATER = 7, ///< Command to request DG to stop trimmer heater - DG_CMD_VALVE_SETTING = 8, ///< Command to request DG to change valve settings - DG_CMD_SAMPLE_WATER = 9, ///< Command to request DG to sample water - DG_CMD_START_FLUSH = 10, ///< Command to request DG to start flush - DG_CMD_STOP_FLUSH = 11, ///< Command to request DG to stop flu - DG_CMD_START_HEAT_DISINFECT = 12, ///< Command to request DG to start heat disinfect - DG_CMD_STOP_HEAT_DISINFECT = 13, ///< Command to request DG to stop heat disinfect - DG_CMD_START_CHEM_DISINFECT = 14, ///< Command to request DG to start chemical disinfect - DG_CMD_STOP_CHEM_DISINFECT = 15, ///< Command to request DG to stop chemical disinfect - NUM_OF_DG_COMMANDS ///< Number of DG commands + DG_CMD_NONE = 0, ///< Not a command + DG_CMD_SWITCH_RESERVOIR = 1, ///< Command to request DG switch reservoirs + DG_CMD_START_DRAIN = 2, ///< Command to request DG to start drain + DG_CMD_STOP_DRAIN = 3, ///< Command to request DG to stop drain + DG_CMD_START_FILL = 4, ///< Command to request DG to start fill + DG_CMD_STOP_FILL = 5, ///< Command to request DG to stop fill + DG_CMD_START_TRIMMER_HEATER = 6, ///< Command to request DG to start trimmer heater + DG_CMD_STOP_TRIMMER_HEATER = 7, ///< Command to request DG to stop trimmer heater + DG_CMD_VALVE_SETTING = 8, ///< Command to request DG to change valve settings + DG_CMD_SAMPLE_WATER = 9, ///< Command to request DG to sample water + DG_CMD_START_FLUSH = 10, ///< Command to request DG to start flush + DG_CMD_STOP_FLUSH = 11, ///< Command to request DG to stop flu + DG_CMD_START_HEAT_DISINFECT = 12, ///< Command to request DG to start heat disinfect + DG_CMD_STOP_HEAT_DISINFECT = 13, ///< Command to request DG to stop heat disinfect + DG_CMD_START_CHEM_DISINFECT = 14, ///< Command to request DG to start chemical disinfect + DG_CMD_STOP_CHEM_DISINFECT = 15, ///< Command to request DG to stop chemical disinfect + DG_CMD_REQUEST_CONC_MIXING_RATIOS = 16, ///< Command to request DG to send the concentrate pumps mixing ratios + NUM_OF_DG_COMMANDS ///< Number of DG commands }; -typedef enum DG_Command DG_COMMAND_T; ///< Type for DG commands enumeration +typedef enum DG_Command DG_COMMAND_T; ///< Type for DG commands enumeration /// Enumeration of sample water command parameters. enum Sample_Water_Commands @@ -489,5 +514,24 @@ } LOAD_CELL_ID_T; /**@}*/ - -#endif + +/**@}*/ + +/** + * @addtogroup CommonHeader + * @{ + */ + +/// Enumeration of DG event IDs. +enum DG_Event_List +{ + DG_EVENT_STARTUP = 0, ///< DG startup event + DG_EVENT_OP_MODE_CHANGE, ///< DG Op mode change event + DG_EVENT_SUB_MODE_CHANGE, ///< DG Op sub-mode change event + NUM_OF_DG_EVENT_IDS ///< Total number of DG events +}; +typedef enum DG_Event_List DG_EVENT_ID_T; ///< Type for DG event list enumeration + +/**@}*/ + +#endif