Index: AlarmDefs.h =================================================================== diff -u -r8b6d80b68a2490075a921ccc8a1a80568b4da36e -r265db01fb5db89443dcc79198cb30812b9d0977e --- AlarmDefs.h (.../AlarmDefs.h) (revision 8b6d80b68a2490075a921ccc8a1a80568b4da36e) +++ AlarmDefs.h (.../AlarmDefs.h) (revision 265db01fb5db89443dcc79198cb30812b9d0977e) @@ -19,8 +19,13 @@ #define __ALARM_DEFINITIONS_H__ // ********** public definitions ********** + +/** + * @addtogroup AlarmDefs + * @{ + */ -/// Enumeration of alarm IDs +/// Enumeration of alarm IDs. enum Alarm_List { ALARM_ID_NO_ALARM = 0, ///< Indication for when no alarms is a possible situation @@ -64,7 +69,7 @@ ALARM_ID_RTC_BATTERY_LOW = 38, ///< RTC battery low ALARM_ID_RTC_OR_TIMER_ACCURACY_FAILURE = 39, ///< RTC or MCU timer inaccurate ALARM_ID_RTC_RAM_OPS_ERROR = 40, ///< RTC (i.e read time) or RAM operations failure (read or write) - ALARM_ID_NVDATA_EEPROM_OPS_FAILURE = 41, ///< EEPRON operations (read, write, erase) failure + ALARM_ID_NVDATA_EEPROM_OPS_FAILURE = 41, ///< EEPROM operations (read, write, erase) failure ALARM_ID_NVDATA_MFG_RECORD_CRC_ERROR = 42, ///< Manufacturing record CRC failure ALARM_ID_NVDATA_SRVC_RECORD_CRC_ERROR = 43, ///< Service record CRC failure ALARM_ID_NVDATA_CAL_RECORD_CRC_ERROR = 44, ///< Calibration record CRC failure @@ -94,18 +99,24 @@ ALARM_ID_HD_ACCELEROMETER_SELF_TEST_FAILURE = 68, ///< HD accelerometer failed POST ALARM_ID_DG_ACCELEROMETER_SELF_TEST_FAILURE = 69, ///< DG accelerometer failed POST ALARM_ID_HD_EXCESSIVE_TILT = 70, ///< HD tilt exceeds maximum - ALARM_ID_DG_EXCESSIVE_TILT = 71, ///< DG tilt exceeds maximu + ALARM_ID_DG_EXCESSIVE_TILT = 71, ///< DG tilt exceeds maximum ALARM_ID_HD_SHOCK = 72, ///< HD experienced large acceleration ALARM_ID_DG_SHOCK = 73, ///< DG experienced large acceleration ALARM_ID_HD_ACCELEROMETER_FAILURE = 74, ///< HD accelerometer error (no readings or FPGA reports error) ALARM_ID_DG_ACCELEROMETER_FAILURE = 75, ///< DG accelerometer error (no readings or FPGA reports error) ALARM_ID_DG_CRITICAL_DATA_ERROR = 76, ///< DG critical data integrity check failed ALARM_ID_RO_REJECTION_RATIO_OUT_OF_RANGE = 77, ///< RO rejection ratio out of range NUM_OF_ALARM_IDS ///< Total number of alarms -}; - +}; typedef enum Alarm_List ALARM_ID_T; ///< Type for alarm list enumeration +/**@}*/ + +/** + * @addtogroup AlarmPriorities + * @{ + */ + /// Enumeration of alarm priorities. enum Alarm_Priorities { @@ -114,10 +125,16 @@ ALARM_PRIORITY_MEDIUM = 2, ///< Medium priority alarm ALARM_PRIORITY_HIGH = 3, ///< High priority alarm NUM_OF_ALARM_PRIORITIES ///< Total number of alarm priorities -}; - +}; typedef enum Alarm_Priorities ALARM_PRIORITY_T; ///< Type for alarm priorities enumeration +/**@}*/ + +/** + * @addtogroup AlarmSources + * @{ + */ + /// Enumeration of alarm sources. enum Alarm_Sources { @@ -126,7 +143,8 @@ ALARM_SOURCE_DG, ///< DG firmware alarm source NUMBER_OF_ALARM_SOURCES ///< Number of alarm sources }; - typedef enum Alarm_Sources ALARM_SOURCE_T; ///< Type for alarm sources enumeration + +/**@}*/ -#endif +#endif Index: DGDefs.h =================================================================== diff -u -r6380102d74fb4621c3143e4bc0402a4dff6bb026 -r265db01fb5db89443dcc79198cb30812b9d0977e --- DGDefs.h (.../DGDefs.h) (revision 6380102d74fb4621c3143e4bc0402a4dff6bb026) +++ DGDefs.h (.../DGDefs.h) (revision 265db01fb5db89443dcc79198cb30812b9d0977e) @@ -28,21 +28,21 @@ /// 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. + 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; +typedef enum DG_Op_Modes DG_OP_MODE_T; ///< Type for DG operation modes enumeration /**@}*/ @@ -54,18 +54,18 @@ /// Enumeration of init & POST mode states. enum DG_POST_States { - DG_POST_STATE_START = 0, ///< Start initialize & POST mode state - DG_POST_STATE_FPGA, ///< FPGA POST test state - DG_POST_STATE_TEMPERATURE_SENSORS, ///< Temperature Sensors POST state - DG_POST_STATE_HEATERS, ///< Heaters POST state - DG_POST_STATE_ACCELEROMETER, ///< Accelerometer POST state - DG_POST_STATE_PRESSURES, ///< Pressure sensors POST state - DG_POST_STATE_WATCHDOG, ///< Watchdog POST test 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 + DG_POST_STATE_START = 0, ///< Start initialize & POST mode state + DG_POST_STATE_FPGA, ///< FPGA POST test state + DG_POST_STATE_TEMPERATURE_SENSORS, ///< Temperature Sensors POST state + DG_POST_STATE_HEATERS, ///< Heaters POST state + DG_POST_STATE_ACCELEROMETER, ///< Accelerometer POST state + DG_POST_STATE_PRESSURES, ///< Pressure sensors POST state + DG_POST_STATE_WATCHDOG, ///< Watchdog POST test 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; +typedef enum DG_POST_States DG_POST_STATE_T; ///< Type for DG POST states enumeration /**@}*/ @@ -77,10 +77,10 @@ /// 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. + 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; +typedef enum DG_Fault_States DG_FAULT_STATE_T; ///< Type for DG fault states enumeration /**@}*/ @@ -92,11 +92,11 @@ /// 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. + 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; +typedef enum DG_Solo_States DG_SOLO_STANDBY_STATE_T; ///< Type for DG solo mode states enumeration /**@}*/ @@ -108,12 +108,12 @@ /// 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_SAMPLE_WATER, ///< Sample water standby mode state. - NUM_OF_DG_STANDBY_MODE_STATES ///< Number of 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_SAMPLE_WATER, ///< Sample water standby mode state + NUM_OF_DG_STANDBY_MODE_STATES ///< Number of standby mode states }; -typedef enum DG_Standby_Mode_States DG_STANDBY_MODE_STATE_T; +typedef enum DG_Standby_Mode_States DG_STANDBY_MODE_STATE_T; ///< Type for DG standby mode states enumeration /**@}*/ @@ -125,13 +125,13 @@ /// 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. + 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; +typedef enum DG_Recirculate_Mode_States DG_RECIRCULATE_MODE_STATE_T; ///< Type for DG recirculation mode states enumeration /**@}*/ @@ -143,12 +143,12 @@ /// Enumeration of fill mode states. enum DG_Fill_Mode_States { - DG_FILL_MODE_STATE_START = 0, ///< Start fill mode state. - DG_FILL_MODE_STATE_DIALYSATE_PRODUCTION, ///< Dialysate production state. - DG_FILL_MODE_STATE_DELIVER_DIALYSATE, ///< Deliver dialysate state. - NUM_OF_DG_FILL_MODE_STATES ///< Number of fill mode states. + DG_FILL_MODE_STATE_START = 0, ///< Start fill mode state + DG_FILL_MODE_STATE_DIALYSATE_PRODUCTION, ///< Dialysate production state + DG_FILL_MODE_STATE_DELIVER_DIALYSATE, ///< Deliver dialysate state + NUM_OF_DG_FILL_MODE_STATES ///< Number of fill mode states }; -typedef enum DG_Fill_Mode_States DG_FILL_MODE_STATE_T; +typedef enum DG_Fill_Mode_States DG_FILL_MODE_STATE_T; ///< Type for DG fill mode states enumeration /**@}*/ @@ -160,11 +160,11 @@ /// 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. - NUM_OF_DG_DRAIN_STATES ///< Number of drain mode states. + DG_DRAIN_STATE_START = 0, ///< Start drain mode state + DG_DRAIN_STATE_DRAIN, ///< Drain drain mode state + NUM_OF_DG_DRAIN_STATES ///< Number of drain mode states }; -typedef enum DG_Drain_States DG_DRAIN_STATE_T; +typedef enum DG_Drain_States DG_DRAIN_STATE_T; ///< Type for DG drain mode states enumeration /**@}*/ @@ -176,10 +176,10 @@ /// Enumeration of flush mode states. enum DG_Flush_States { - DG_FLUSH_STATE_START = 0, ///< Start flush mode state. - NUM_OF_DG_FLUSH_STATES ///< Number of flush mode states. + DG_FLUSH_STATE_START = 0, ///< Start flush mode state + NUM_OF_DG_FLUSH_STATES ///< Number of flush mode states }; -typedef enum DG_Flush_States DG_FLUSH_STATE_T; +typedef enum DG_Flush_States DG_FLUSH_STATE_T; ///< Type for DG flush mode states enumeration /**@}*/ @@ -191,18 +191,18 @@ /// Enumeration of heat disinfection mode states. enum DG_Heat_States { - DG_HEAT_DISINFECT_STATE_START = 0, ///< Heat disinfect, start mode state - DG_HEAT_DISINFECT_STATE_EVACUATE_DIALYSATE_FILL_WITH_WATER, ///< Heat disinfect, evacuate dialysate and fill with water - DG_HEAT_DISINFECT_STATE_HEAT_WATER, ///< Heat disinfect, heater the stored water - DG_HEAT_DISINFECT_STATE_DISINFECT_RECIRC_PATH, ///< Heat disinfect, heat disinfect recirculation path - DG_HEAT_DISINFECT_STATE_DISINFECT_RESERVOIR_1_TO_2, ///< Heat disinfect, heat disinfect reservoir 1 to 2 - DG_HEAT_DISINFECT_STATE_DISINFECT_RESERVOIR_2_TO_1, ///< Heat disinfect, heat disinfect reservoir 2 to 1 - DG_HEAT_DISINFECT_STATE_DISINFECT_DRAIN_PATH, ///< Heat disinfect, heat disinfect drain path - DG_HEAT_DISINFECT_STATE_FILL_WITH_WATER_DEPRIME_RESERVOIRS, ///< Heat disinfect, fill with water and de-prime the reservoirs - DG_HEAT_DISINFECT_STATE_COMPLETE, ///< Heat disinfect, complete - NUM_OF_DG_HEAT_DISINFECT_STATES ///< Number of heat disinfect mode states + DG_HEAT_DISINFECT_STATE_START = 0, ///< Heat disinfect, start mode state + DG_HEAT_DISINFECT_STATE_EVACUATE_DIALYSATE_FILL_WITH_WATER, ///< Heat disinfect, evacuate dialysate and fill with water + DG_HEAT_DISINFECT_STATE_HEAT_WATER, ///< Heat disinfect, heater the stored water + DG_HEAT_DISINFECT_STATE_DISINFECT_RECIRC_PATH, ///< Heat disinfect, heat disinfect recirculation path + DG_HEAT_DISINFECT_STATE_DISINFECT_RESERVOIR_1_TO_2, ///< Heat disinfect, heat disinfect reservoir 1 to 2 + DG_HEAT_DISINFECT_STATE_DISINFECT_RESERVOIR_2_TO_1, ///< Heat disinfect, heat disinfect reservoir 2 to 1 + DG_HEAT_DISINFECT_STATE_DISINFECT_DRAIN_PATH, ///< Heat disinfect, heat disinfect drain path + DG_HEAT_DISINFECT_STATE_FILL_WITH_WATER_DEPRIME_RESERVOIRS, ///< Heat disinfect, fill with water and de-prime the reservoirs + DG_HEAT_DISINFECT_STATE_COMPLETE, ///< Heat disinfect, complete + NUM_OF_DG_HEAT_DISINFECT_STATES ///< Number of heat disinfect mode states }; -typedef enum DG_Heat_States DG_HEAT_DISINFECT_STATE_T; +typedef enum DG_Heat_States DG_HEAT_DISINFECT_STATE_T; ///< Type for DG heat disinfect states enumeration /**@}*/ @@ -211,13 +211,13 @@ * @{ */ -/// Enumeration of chem. disinfect mode states. +/// Enumeration of chemical disinfect mode states. enum DG_Chem_States { - DG_CHEM_DISINFECT_STATE_START = 0, ///< Start chemical disinfect mode state. - NUM_OF_DG_CHEM_DISINFECT_STATES ///< Number of chemical disinfect mode states. + DG_CHEM_DISINFECT_STATE_START = 0, ///< Start chemical disinfect mode state + NUM_OF_DG_CHEM_DISINFECT_STATES ///< Number of chemical disinfect mode states }; -typedef enum DG_Chem_States DG_CHEM_DISINFECT_STATE_T; +typedef enum DG_Chem_States DG_CHEM_DISINFECT_STATE_T; ///< Type for DG chemical disinfect states enumeration /**@}*/ @@ -229,10 +229,10 @@ /// Enumeration of service mode states. enum DG_Service_States { - DG_SERVICE_STATE_START = 0, ///< Start service mode state. - NUM_OF_DG_SERVICE_STATES ///< Number of service mode states. + DG_SERVICE_STATE_START = 0, ///< Start service mode state + NUM_OF_DG_SERVICE_STATES ///< Number of service mode statesS }; -typedef enum DG_Service_States DG_SERVICE_STATE_T; +typedef enum DG_Service_States DG_SERVICE_STATE_T; ///< Type for DG service states enumeration /**@}*/ Index: HDDefs.h =================================================================== diff -u -r56402afe56a74fe27f40abe9531b309d13722c91 -r265db01fb5db89443dcc79198cb30812b9d0977e --- HDDefs.h (.../HDDefs.h) (revision 56402afe56a74fe27f40abe9531b309d13722c91) +++ HDDefs.h (.../HDDefs.h) (revision 265db01fb5db89443dcc79198cb30812b9d0977e) @@ -28,18 +28,18 @@ /// Enumeration of operation modes. These are in order of priority (highest to lowest). enum HD_Op_Modes { - MODE_FAUL = 0, ///< Fault mode - MODE_SERV, ///< Service mode - MODE_INIT, ///< Initialization & POST mode - MODE_STAN, ///< Standby mode - MODE_TPAR, ///< Treatment Parameters mode - MODE_PRET, ///< Pre-Treatment mode - MODE_TREA, ///< Treatment mode - MODE_POST, ///< Post-Treatment mode - MODE_NLEG, ///< Not legal - an illegale mode transition occurred - NUM_OF_MODES ///< Number of HD operation modes + MODE_FAUL = 0, ///< Fault mode + MODE_SERV, ///< Service mode + MODE_INIT, ///< Initialization & POST mode + MODE_STAN, ///< Standby mode + MODE_TPAR, ///< Treatment Parameters mode + MODE_PRET, ///< Pre-Treatment mode + MODE_TREA, ///< Treatment mode + MODE_POST, ///< Post-Treatment mode + MODE_NLEG, ///< Not legal - an illegale mode transition occurred + NUM_OF_MODES ///< Number of HD operation modes }; -typedef enum HD_Op_Modes HD_OP_MODE_T; +typedef enum HD_Op_Modes HD_OP_MODE_T; ///< Type for HD operation modes enumeration /**@}*/ @@ -66,7 +66,7 @@ POST_STATE_FAILED, ///< POST self tests failed mode state NUM_OF_POST_STATES ///< Number of initialize & POST mode states }; -typedef enum HD_POST_States HD_POST_STATE_T; +typedef enum HD_POST_States HD_POST_STATE_T; ///< Type for HD POST states enumeration /**@}*/ @@ -81,7 +81,7 @@ HD_FAULT_STATE_START = 0, ///< Start fault state NUM_OF_HD_FAULT_STATES ///< Number of fault mode states }; -typedef enum HD_Fault_States HD_FAULT_STATE_T; +typedef enum HD_Fault_States HD_FAULT_STATE_T; ///< Type for HD fault states enumeration /**@}*/ @@ -94,14 +94,14 @@ enum HD_Standby_States { STANDBY_START_STATE = 0, ///< Start standby - STANDBY_FLUSH_DG_LINES_STATE, ///< - STANDBY_DRAIN_RESERVOIR_STATE, ///< - STANDBY_WAIT_FOR_PRIME_STATE, ///< - STANDBY_FILL_RESERVOIR_STATE, ///< - STANDBY_WAIT_FOR_TREATMENT_STATE, ///< + STANDBY_FLUSH_DG_LINES_STATE, ///< Flush DG lines + STANDBY_DRAIN_RESERVOIR_STATE, ///< Drain reservoirs + STANDBY_WAIT_FOR_PRIME_STATE, ///< Wait for prime + STANDBY_FILL_RESERVOIR_STATE, ///< Fill reservoir + STANDBY_WAIT_FOR_TREATMENT_STATE, ///< Wait for treatment NUM_OF_STANDBY_STATES ///< Number of standby states (sub-modes) }; -typedef enum HD_Standby_States HD_STANDBY_STATE_T; +typedef enum HD_Standby_States HD_STANDBY_STATE_T; ///< Type for HD standby states enumeration /**@}*/ @@ -113,12 +113,12 @@ /// Enumeration of treatment parameters mode states. enum HD_Treatment_Parameters_Mode_States { - HD_TREATMENT_PARAMS_MODE_STATE_START = 0, ///< Start treatment params mode state - HD_TREATMENT_PARAMS_MODE_STATE_WAIT_4_UI_2_SEND, ///< Wait for UI to send treatment params mode state - HD_TREATMENT_PARAMS_MODE_STATE_WAIT_4_UI_2_CONFIRM, ///< Wait for UI to confirm treatment params mode state - NUM_OF_HD_TREATMENT_PARAMS_MODE_STATES ///< Number of treatment params mode states + HD_TREATMENT_PARAMS_MODE_STATE_START = 0, ///< Start treatment params mode state + HD_TREATMENT_PARAMS_MODE_STATE_WAIT_4_UI_2_SEND, ///< Wait for UI to send treatment params mode state + HD_TREATMENT_PARAMS_MODE_STATE_WAIT_4_UI_2_CONFIRM, ///< Wait for UI to confirm treatment params mode state + NUM_OF_HD_TREATMENT_PARAMS_MODE_STATES ///< Number of treatment params mode states }; -typedef enum HD_Treatment_Parameters_Mode_States HD_TREATMENT_PARAMS_MODE_STATE_T; +typedef enum HD_Treatment_Parameters_Mode_States HD_TREATMENT_PARAMS_MODE_STATE_T; ///< Type for HD treatment parameters mode states enumeration /**@}*/ @@ -130,10 +130,10 @@ /// Enumeration of pre-treatment mode states. enum HD_Pre_Treatment_Mode_States { - HD_PRE_TREATMENT_STATE_START = 0, ///< Start pre-treatment mode state - NUM_OF_HD_PRE_TREATMENT_STATES ///< Number of pre-treatment mode states + HD_PRE_TREATMENT_STATE_START = 0, ///< Start pre-treatment mode state + NUM_OF_HD_PRE_TREATMENT_STATES ///< Number of pre-treatment mode states }; -typedef enum HD_Pre_Treatment_Mode_States HD_PRE_TREATMENT_MODE_STATE_T; +typedef enum HD_Pre_Treatment_Mode_States HD_PRE_TREATMENT_MODE_STATE_T; ///< Type for HD pre-treatment mode states enumeration /**@}*/ @@ -145,20 +145,20 @@ /// Sub-mode states while in treatment mode enum Treatment_States { - TREATMENT_START_STATE = 0, ///< Start treatment, prime blood side with gradual ramp for 1 min. while dialyzer is bypassed. No dialysis or UF taking place. - TREATMENT_DIALYSIS_STATE, ///< Perform dialysis. Deliver Heparin as prescribed. Deliver UF as prescribed. Handle saline boluses as requested. - TREATMENT_STOP_STATE, ///< Treatment stopped. All pumps off. Dializer bypassed. - TREATMENT_RINSEBACK_STATE, ///< Perform rinseback with saline. Dialyzer bypassed. Dialysate recirculating. - TREATMENT_RINSEBACK_PAUSE_STATE, ///< Rinseback paused. Blood pump off. Dialyzer bypassed. Dialysate recirculating. - TREATMENT_RECIRC_SETUP_STATE, ///< Rinseback complete. Blood pump off. Blood lines closed. User to disconnect and shunt blood lines. - TREATMENT_RECIRC_STATE, ///< Recirculate saline and dialysate while patient disconnected. Blood lines open and shunted. Dialyzer is bypassed. - TREATMENT_RECIRC_PAUSE_STATE, ///< Recirculate paused. Blood pump off. Blood lines closed and shunted. Dialyzer is bypassed. - TREATMENT_RECIRC_STOP_STATE, ///< Recirculate stopped. Blood pump off. Blood lines open. Waiting for patient to unshunt and connect and resume treatment. - TREATMENT_DIALYSIS_END_STATE, ///< Dialysis has ended. Blood pump slowed. Dialyzer is bypassed. Dialysate is recirculated. User can rinseback. - TREATMENT_END_STATE, ///< Treatment has ended. All pumps off. Dialyzer is bypassed. Blood lines are closed. User to disconnect. - NUM_OF_TREATMENT_STATES ///< Number of treatment states (sub-modes). + TREATMENT_START_STATE = 0, ///< Start treatment, prime blood side with gradual ramp for 1 min. while dialyzer is bypassed. No dialysis or UF taking place + TREATMENT_DIALYSIS_STATE, ///< Perform dialysis. Deliver Heparin as prescribed. Deliver UF as prescribed. Handle saline boluses as requested + TREATMENT_STOP_STATE, ///< Treatment stopped. All pumps off. Dializer bypassed + TREATMENT_RINSEBACK_STATE, ///< Perform rinseback with saline. Dialyzer bypassed. Dialysate recirculating + TREATMENT_RINSEBACK_PAUSE_STATE, ///< Rinseback paused. Blood pump off. Dialyzer bypassed. Dialysate recirculating + TREATMENT_RECIRC_SETUP_STATE, ///< Rinseback complete. Blood pump off. Blood lines closed. User to disconnect and shunt blood lines + TREATMENT_RECIRC_STATE, ///< Recirculate saline and dialysate while patient disconnected. Blood lines open and shunted. Dialyzer is bypassed + TREATMENT_RECIRC_PAUSE_STATE, ///< Recirculate paused. Blood pump off. Blood lines closed and shunted. Dialyzer is bypassed + TREATMENT_RECIRC_STOP_STATE, ///< Recirculate stopped. Blood pump off. Blood lines open. Waiting for patient to unshunt and connect and resume treatment + TREATMENT_DIALYSIS_END_STATE, ///< Dialysis has ended. Blood pump slowed. Dialyzer is bypassed. Dialysate is recirculated. User can rinseback + TREATMENT_END_STATE, ///< Treatment has ended. All pumps off. Dialyzer is bypassed. Blood lines are closed. User to disconnect + NUM_OF_TREATMENT_STATES ///< Number of treatment states (sub-modes) }; -typedef enum Treatment_States TREATMENT_STATE_T; +typedef enum Treatment_States TREATMENT_STATE_T; ///< Type for treatment states enumeration /**@}*/ @@ -170,10 +170,10 @@ /// Enumeration of post-treatment mode states. enum HD_Post_Treatment_Mode_States { - HD_POST_TREATMENT_STATE_START = 0, ///< Start post-treatment mode state - NUM_OF_HD_POST_TREATMENT_STATES ///< Number of post-treatment mode states + HD_POST_TREATMENT_STATE_START = 0, ///< Start post-treatment mode state + NUM_OF_HD_POST_TREATMENT_STATES ///< Number of post-treatment mode states }; -typedef enum HD_Post_Treatment_Mode_States HD_POST_TREATMENT_STATE_T; +typedef enum HD_Post_Treatment_Mode_States HD_POST_TREATMENT_STATE_T; ///< Type for HD post treatment mode states enumeration /**@}*/ @@ -188,7 +188,7 @@ HD_SERVICE_STATE_START = 0, ///< Start service mode state NUM_OF_HD_SERVICE_STATES ///< Number of service mode states }; -typedef enum HD_Service_States HD_SERVICE_STATE_T; +typedef enum HD_Service_States HD_SERVICE_STATE_T; ///< Type for HD services states enumeration /**@}*/ @@ -205,7 +205,7 @@ DIALYSIS_SOLUTION_INFUSION_STATE, ///< Solution infusion state of the dialysis sub-mode state machine NUM_OF_DIALYSIS_STATES ///< Number of dialysis sub-mode states }; -typedef enum Dialysis_States DIALYSIS_STATE_T; +typedef enum Dialysis_States DIALYSIS_STATE_T; ///< Type for dialysis states enumeration /// Enumeration of ultrafiltration states. enum UF_States @@ -217,7 +217,7 @@ UF_COMPLETED_STATE, ///< Completed state of ultrafiltration state machine NUM_OF_UF_STATES ///< Number of ultrafiltration states }; -typedef enum UF_States UF_STATE_T; +typedef enum UF_States UF_STATE_T; ///< Type for ultrafiltration states enumeration /// Enumeration of system message IDs. enum UF_Commands @@ -226,7 +226,7 @@ UF_CMD_RESUME, ///< Resume UF command NUM_OF_UF_CMDS ///< Number of UF commands }; -typedef enum UF_Commands UF_CMD_T; +typedef enum UF_Commands UF_CMD_T; ///< Type for UF command IDs enumeration /// Enumeration of system message IDs. enum UF_Adjustments @@ -235,7 +235,7 @@ UF_ADJ_UF_RATE, ///< Adjust UF rate to achieve new ultrafiltration volume NUM_OF_UF_ADJS ///< Number of UF adjustments }; -typedef enum UF_Adjustments UF_ADJ_T; +typedef enum UF_Adjustments UF_ADJ_T; ///< Type for UF adjustments IDs enumeration /// Enumeration of treatment parameters. enum Treatment_Params @@ -265,7 +265,7 @@ TREATMENT_PARAM_UF_VOLUME, ///< Ultrafiltration volume (in liters) - provided separately by UI NUM_OF_TREATMENT_PARAMS ///< Total number of treatment parameters }; -typedef enum Treatment_Params TREATMENT_PARAM_T; +typedef enum Treatment_Params TREATMENT_PARAM_T; ///< Type for treatment parameters enumeration /// Enumeration of dialyzer types. enum Dialyzer_Types @@ -276,7 +276,7 @@ DIALYZER_TYPE_FRESENIUS_OPTIFLUX_F180NRE, ///< Fresenius Optiflux F180NRe NUM_OF_DIALYZER_TYPES ///< Number of dialyzer types }; -typedef enum Dialyzer_Types DIALYZER_TYPE_T; +typedef enum Dialyzer_Types DIALYZER_TYPE_T; ///< Type for dialyzer types enumeration /// Enumeration of acid concentrates. enum Acid_Concentrates @@ -286,15 +286,15 @@ ACID_CONC_TYPE_FRESENIUS_08_3251_9, ///< Fresensius Naturalyte Acid Concentrate 08-1251-1 NUM_OF_ACID_CONC_TYPES ///< Number of acid concentrates }; -typedef enum Acid_Concentrates ACID_CONCENTRATE_TYPE_T; +typedef enum Acid_Concentrates ACID_CONCENTRATE_TYPE_T; ///< Type for acid concentrates enumeration /// Enumeration of bicarbonate concentrates. enum Bicarb_Concentrates { BICARB_CONC_TYPE_FRESENIUS_CENTRISOL = 0, ///< Fresenius Centrisol Liquid Bicarbonate NUM_OF_BICARB_CONC_TYPES ///< Number of bicarbonate concentrates }; -typedef enum Bicarb_Concentrates BICARB_CONCENTRATE_TYPE_T; +typedef enum Bicarb_Concentrates BICARB_CONCENTRATE_TYPE_T; ///< Type for bicarbonate concentrates enumeration /**@}*/ Index: MsgDefs.h =================================================================== diff -u -r7f3c0b0c74d490a43b4ba34edfb263bf2986e45d -r265db01fb5db89443dcc79198cb30812b9d0977e --- MsgDefs.h (.../MsgDefs.h) (revision 7f3c0b0c74d490a43b4ba34edfb263bf2986e45d) +++ MsgDefs.h (.../MsgDefs.h) (revision 265db01fb5db89443dcc79198cb30812b9d0977e) @@ -18,7 +18,12 @@ #ifndef __MESSAGE_DEFINITIONS_H__ #define __MESSAGE_DEFINITIONS_H__ -// ********** public definitions ********** +// ********** public definitions ********** + +/** + * @addtogroup SystemMessageIDs + * @{ + */ /// Enumeration of system message IDs enum Msg_IDs @@ -84,7 +89,7 @@ MSG_ID_HD_VALVES_DATA = 0x3A, ///< HD broadcast of valves MSG_ID_UI_USER_CONFIRM_TREATMENT_PARAMS = 0x3B, ///< UI user confirmation of treatment parameters - MSG_ID_TEMP_FAST_HD_VALVES_REMOVE_LATER = 0x6D, ///< TODO REMOVE + MSG_ID_TEMP_FAST_HD_VALVES_REMOVE_LATER = 0x6D, ///< TODO REMOVE FOR FAST TESING ONLY #ifdef EMC_TEST_BUILD MSG_ID_CAN_ERROR_COUNT = 0x999, // test code in support of EMC testing #endif @@ -181,9 +186,15 @@ MSG_ID_DG_DEBUG_EVENT = 0xFFF2, ///< DG debug event text to be logged in event log END_OF_MSG_IDS ///< End of system message IDs -}; - +}; typedef enum Msg_IDs MSG_ID_T; ///< Type for message IDs enumeration + +/**@}*/ + +/** + * @addtogroup RequestRejectReasonsID + * @{ + */ /// Enumeration of settings change rejection reason codes enum Request_Reject_Reasons @@ -210,8 +221,9 @@ REQUEST_REJECT_REASON_ARTERIAL_PRESSURE_LOW_VS_HIGH, ///< Arterial pressure low and high alarm limits are not inconsistent REQUEST_REJECT_REASON_VENOUS_PRESSURE_LOW_VS_HIGH, ///< Venous pressure low and high alarm limits are inconsistent NUM_OF_REQUEST_REJECT_REASONS ///< Number of settings change reject codes -}; - +}; typedef enum Request_Reject_Reasons REQUEST_REJECT_REASON_CODE_T; ///< Type for settings change rejection reason codes enumeration + +/**@}*/ #endif