Index: TDDefs.h =================================================================== diff -u -r3e6c9b5cd9859e269312f4efafc89de3685178a9 -rbbb488dc82c160e1fa8a5d6b02f417a2dd398b62 --- TDDefs.h (.../TDDefs.h) (revision 3e6c9b5cd9859e269312f4efafc89de3685178a9) +++ TDDefs.h (.../TDDefs.h) (revision bbb488dc82c160e1fa8a5d6b02f417a2dd398b62) @@ -44,12 +44,12 @@ /**@}*/ /** - * @addtogroup HDInitAndPOSTMode + * @addtogroup TDInitAndPOSTMode * @{ */ /// Enumeration of init & POST mode states. -enum HD_POST_States +enum TD_POST_States { POST_STATE_START = 0, ///< Start initialize & POST mode state POST_STATE_FW_INTEGRITY, ///< Run firmware integrity test state @@ -72,82 +72,82 @@ POST_STATE_FAILED, ///< POST self-tests failed state NUM_OF_POST_STATES ///< Number of initialize & POST mode states }; -typedef enum HD_POST_States HD_POST_STATE_T; ///< Type for HD POST states enumeration +typedef enum TD_POST_States TD_POST_STATE_T; ///< Type for TD POST states enumeration /**@}*/ /** - * @addtogroup HDFaultMode + * @addtogroup TDFaultMode * @{ */ /// Enumeration of fault mode states. -enum HD_Fault_States +enum TD_Fault_States { - HD_FAULT_STATE_START = 0, ///< TD fault start state - HD_FAULT_STATE_RUN_NV_POSTS, ///< TD fault run NV posts state - HD_FAULT_STATE_COMPLETE, ///< TD fault run complete state - NUM_OF_HD_FAULT_STATES ///< Number of fault mode states + TD_FAULT_STATE_START = 0, ///< TD fault start state + TD_FAULT_STATE_RUN_NV_POSTS, ///< TD fault run NV posts state + TD_FAULT_STATE_COMPLETE, ///< TD fault run complete state + NUM_OF_TD_FAULT_STATES ///< Number of fault mode states }; -typedef enum HD_Fault_States HD_FAULT_STATE_T; ///< Type for HD fault states enumeration +typedef enum TD_Fault_States TD_FAULT_STATE_T; ///< Type for TD fault states enumeration /**@}*/ /** - * @addtogroup HDStandbyMode + * @addtogroup TDStandbyMode * @{ */ /// Sub-mode states while in standby mode -enum HD_Standby_States +enum TD_Standby_States { STANDBY_START_STATE = 0, ///< Start standby (home actuators). STANDBY_WAIT_FOR_TREATMENT_STATE, ///< Wait for treatment. STANDBY_WAIT_FOR_DISINFECT_STATE, ///< Wait for UI to send disinfect option. - STANDBY_WAIT_FOR_DG_CLEANING_MODE_CMD_RESPONSE_STATE, ///< Wait for DG cleaning mode command response state. - STANDBY_WAIT_FOR_DG_CLEANING_MODE_TO_START_STATE, ///< Wait for DG cleaning mode to start state. + STANDBY_WAIT_FOR_DG_CLEANING_MODE_CMD_RESPONSE_STATE, ///< Wait for DD cleaning mode command response state. + STANDBY_WAIT_FOR_DG_CLEANING_MODE_TO_START_STATE, ///< Wait for DD cleaning mode to start state. STANDBY_CLEANING_MODE_IN_PROGRESS_STATE, ///< Cleaning mode in progress state. NUM_OF_STANDBY_STATES ///< Number of standby states (sub-modes). }; -typedef enum HD_Standby_States HD_STANDBY_STATE_T; ///< Type for HD standby states enumeration +typedef enum TD_Standby_States TD_STANDBY_STATE_T; ///< Type for TD standby states enumeration /**@}*/ /** - * @addtogroup HDTreatmentParamsMode + * @addtogroup TDTreatmentParamsMode * @{ */ /// Enumeration of treatment parameters mode states. -enum HD_Treatment_Parameters_Mode_States +enum TD_Treatment_Parameters_Mode_States { - HD_TREATMENT_PARAMS_MODE_STATE_WAIT_4_UI_2_SEND = 0, ///< 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 + TD_TREATMENT_PARAMS_MODE_STATE_WAIT_4_UI_2_SEND = 0, ///< Wait for UI to send treatment params mode state + TD_TREATMENT_PARAMS_MODE_STATE_WAIT_4_UI_2_CONFIRM, ///< Wait for UI to confirm treatment params mode state + NUM_OF_TD_TREATMENT_PARAMS_MODE_STATES ///< Number of treatment params mode states }; -typedef enum HD_Treatment_Parameters_Mode_States HD_TREATMENT_PARAMS_MODE_STATE_T; ///< Type for HD treatment parameters mode states enumeration +typedef enum TD_Treatment_Parameters_Mode_States TD_TREATMENT_PARAMS_MODE_STATE_T; ///< Type for TD treatment parameters mode states enumeration /**@}*/ /** - * @addtogroup HDPreTreatmentMode + * @addtogroup TDPreTreatmentMode * @{ */ /// Enumeration of pre-treatment mode states (sub-mode). -enum HD_Pre_Treatment_Mode_States +enum TD_Pre_Treatment_Mode_States { - HD_PRE_TREATMENT_WATER_SAMPLE_STATE = 0, ///< Water sample state - HD_PRE_TREATMENT_SELF_TEST_CONSUMABLE_STATE, ///< Consumable self-tests state - HD_PRE_TREATMENT_SELF_TEST_NO_CART_STATE, ///< No cartridge self-tests state - HD_PRE_TREATMENT_CART_INSTALL_STATE, ///< Consumable and cartridge installation state - HD_PRE_TREATMENT_SELF_TEST_DRY_STATE, ///< Self-tests when the cartridge is dry state - HD_PRE_TREATMENT_PRIME_STATE, ///< Prime blood and dialysate circuits and run wet self-tests state - HD_PRE_TREATMENT_RECIRCULATE_STATE, ///< Re-circulate blood and dialysate circuits state - HD_PRE_TREATMENT_PATIENT_CONNECTION_STATE, ///< Patient connection state - NUM_OF_HD_PRE_TREATMENT_STATES ///< Number of pre-treatment mode states + TD_PRE_TREATMENT_WATER_SAMPLE_STATE = 0, ///< Water sample state + TD_PRE_TREATMENT_SELF_TEST_CONSUMABLE_STATE, ///< Consumable self-tests state + TD_PRE_TREATMENT_SELF_TEST_NO_CART_STATE, ///< No cartridge self-tests state + TD_PRE_TREATMENT_CART_INSTALL_STATE, ///< Consumable and cartridge installation state + TD_PRE_TREATMENT_SELF_TEST_DRY_STATE, ///< Self-tests when the cartridge is dry state + TD_PRE_TREATMENT_PRIME_STATE, ///< Prime blood and dialysate circuits and run wet self-tests state + TD_PRE_TREATMENT_RECIRCULATE_STATE, ///< Re-circulate blood and dialysate circuits state + TD_PRE_TREATMENT_PATIENT_CONNECTION_STATE, ///< Patient connection state + NUM_OF_TD_PRE_TREATMENT_STATES ///< Number of pre-treatment mode states }; -typedef enum HD_Pre_Treatment_Mode_States HD_PRE_TREATMENT_MODE_STATE_T; ///< Type for HD pre-treatment mode states enumeration +typedef enum TD_Pre_Treatment_Mode_States TD_PRE_TREATMENT_MODE_STATE_T; ///< Type for TD pre-treatment mode states enumeration /**@}*/ @@ -157,15 +157,15 @@ */ /// Enumeration of sample water sub-mode states. -enum HD_Pre_Treatment_Sample_Water_States +enum TD_Pre_Treatment_Sample_Water_States { SAMPLE_WATER_SETUP_STATE = 0, ///< Sample water setup (flush filter) state SAMPLE_WATER_STATE, ///< Sample water state, receiving sample water commands from the user SAMPLE_WATER_COMPLETE_STATE, ///< Sample water complete state NUM_OF_SAMPLE_WATER_STATES ///< Number of sample water sub-mode states }; /// Type for sample water states enumeration. -typedef enum HD_Pre_Treatment_Sample_Water_States SAMPLE_WATER_STATE_T; +typedef enum TD_Pre_Treatment_Sample_Water_States SAMPLE_WATER_STATE_T; /// Enumeration of user actions that may be requested from sample water sub-mode. enum Requested_Sample_Water_User_Actions @@ -185,7 +185,7 @@ */ /// Enumeration of consumable self-tests sub-mode states. -enum HD_Pre_Treatment_Consumable_Self_Test_States +enum TD_Pre_Treatment_Consumable_Self_Test_States { CONSUMABLE_SELF_TESTS_INSTALL_STATE = 0, ///< Consumable self-tests install state CONSUMABLE_SELF_TESTS_PRIME_STATE, ///< Consumable self-tests prime concentrate lines state @@ -195,7 +195,7 @@ NUM_OF_CONSUMABLE_SELF_TESTS_STATES ///< Number of consumable install sub-mode states }; /// Type for consumable self-tests states enumeration. -typedef enum HD_Pre_Treatment_Consumable_Self_Test_States CONSUMABLE_SELF_TESTS_STATE_T; +typedef enum TD_Pre_Treatment_Consumable_Self_Test_States CONSUMABLE_SELF_TESTS_STATE_T; /**@}*/ @@ -205,7 +205,7 @@ */ /// Enumeration of no cartridge self-tests sub-mode states. -enum HD_Pre_Treatment_No_Cart_Self_Tests_States +enum TD_Pre_Treatment_No_Cart_Self_Tests_States { NO_CART_SELF_TESTS_WAIT_FOR_DOOR_CLOSE_STATE = 0, ///< Wait for door to be closed before running self-tests NO_CART_SELF_TESTS_PRESSURE_CHECKS_STATE, ///< No cartridge pressure sensors self-test state @@ -218,10 +218,10 @@ NUM_OF_NO_CART_SELF_TESTS_STATES ///< Number of no cartridge self-tests states }; /// Type for no cartridge self-tests enumeration. -typedef enum HD_Pre_Treatment_No_Cart_Self_Tests_States NO_CART_SELF_TESTS_STATE_T; +typedef enum TD_Pre_Treatment_No_Cart_Self_Tests_States NO_CART_SELF_TESTS_STATE_T; /// Enumeration of dry self-tests sub-mode states. -enum HD_Pre_Treatment_Dry_Self_Tests_States +enum TD_Pre_Treatment_Dry_Self_Tests_States { DRY_SELF_TESTS_START_STATE = 0, ///< Dry self-tests starting state DRY_SELF_TESTS_WAIT_FOR_DOOR_CLOSE_STATE, ///< Wait for door to close before executing self-tests @@ -243,7 +243,7 @@ NUM_OF_DRY_SELF_TESTS_STATES ///< Number of dry self-tests states }; /// Type for dry self-tests enumeration. -typedef enum HD_Pre_Treatment_Dry_Self_Tests_States DRY_SELF_TESTS_STATE_T; +typedef enum TD_Pre_Treatment_Dry_Self_Tests_States DRY_SELF_TESTS_STATE_T; /// Wet self-tests state machine. enum Wet_Self_Tests_States @@ -275,24 +275,24 @@ */ /// Enumeration of prime sub-mode states. -enum HD_Pre_Treatment_Prime_States +enum TD_Pre_Treatment_Prime_States { - HD_PRIME_WAIT_FOR_USER_START_STATE = 0, ///< Wait for user to start prime state - HD_PRIME_SALINE_SETUP_STATE, ///< Saline setup state - HD_PRIME_SALINE_PURGE_AIR_STATE, ///< Saline purge air state - HD_PRIME_SALINE_CIRC_BLOOD_CIRCUIT_STATE, ///< Circulate blood circuit state - HD_PRIME_RESERVOIR_ONE_FILL_COMPLETE_STATE, ///< Wait for reservoir 1 fill complete - HD_PRIME_DIALYSATE_DIALYZER_STATE, ///< Dialysate dialyzer fluid path state - HD_PRIME_SALINE_DIALYZER_SETUP_STATE, ///< Saline dialyzer setup state - HD_PRIME_SALINE_DIALYZER_STATE, ///< Saline dialyzer fluid path state - HD_PRIME_RESERVOIR_TWO_FILL_COMPLETE_STATE, ///< Wait for reservoir 2 fill complete - HD_PRIME_DIALYSATE_BYPASS_STATE, ///< Dialysate bypass fluid path state - HD_PRIME_WET_SELF_TESTS_STATE, ///< Perform wet self-tests after priming complete - HD_PRIME_PAUSE, ///< Prime pause state, waits to be resumed - HD_PRIME_COMPLETE, ///< Prime complete state - NUM_OF_HD_PRIME_STATES ///< Number of prime sub-mode states + TD_PRIME_WAIT_FOR_USER_START_STATE = 0, ///< Wait for user to start prime state + TD_PRIME_SALINE_SETUP_STATE, ///< Saline setup state + TD_PRIME_SALINE_PURGE_AIR_STATE, ///< Saline purge air state + TD_PRIME_SALINE_CIRC_BLOOD_CIRCUIT_STATE, ///< Circulate blood circuit state + TD_PRIME_RESERVOIR_ONE_FILL_COMPLETE_STATE, ///< Wait for reservoir 1 fill complete + TD_PRIME_DIALYSATE_DIALYZER_STATE, ///< Dialysate dialyzer fluid path state + TD_PRIME_SALINE_DIALYZER_SETUP_STATE, ///< Saline dialyzer setup state + TD_PRIME_SALINE_DIALYZER_STATE, ///< Saline dialyzer fluid path state + TD_PRIME_RESERVOIR_TWO_FILL_COMPLETE_STATE, ///< Wait for reservoir 2 fill complete + TD_PRIME_DIALYSATE_BYPASS_STATE, ///< Dialysate bypass fluid path state + TD_PRIME_WET_SELF_TESTS_STATE, ///< Perform wet self-tests after priming complete + TD_PRIME_PAUSE, ///< Prime pause state, waits to be resumed + TD_PRIME_COMPLETE, ///< Prime complete state + NUM_OF_TD_PRIME_STATES ///< Number of prime sub-mode states }; -typedef enum HD_Pre_Treatment_Prime_States HD_PRE_TREATMENT_PRIME_STATE_T; ///< Type for HD pre-treatment prime sub-mode states enumeration +typedef enum TD_Pre_Treatment_Prime_States TD_PRE_TREATMENT_PRIME_STATE_T; ///< Type for TD pre-treatment prime sub-mode states enumeration /**@}*/ @@ -302,38 +302,38 @@ */ /// Enumeration of pre-treatment recirculate states. -enum HD_Pre_Treatment_Recirc_States +enum TD_Pre_Treatment_Recirc_States { PRE_TREATMENT_RECIRC_STATE = 0, ///< Pre-treatment recirculate state PRE_TREATMENT_RECIRC_STOPPED_STATE, ///< Pre-treatment recirculate stopped state NUM_OF_PRE_TREATMENT_RECIRC_STATES ///< Number of pre-treatment recirculate states }; -/// Type for HD pre-treatment recirculate sub-mode states enumeration -typedef enum HD_Pre_Treatment_Recirc_States HD_PRE_TREATMENT_RECIRC_STATE_T; +/// Type for TD pre-treatment recirculate sub-mode states enumeration +typedef enum TD_Pre_Treatment_Recirc_States TD_PRE_TREATMENT_RECIRC_STATE_T; /**@}*/ /** - * @addtogroup HDPreTreatmentMode + * @addtogroup TDPreTreatmentMode * @{ */ /// Enumeration of pre-treatment patient connect states. -enum HD_Pre_Treatment_Pat_Conn_States +enum TD_Pre_Treatment_Pat_Conn_States { PRE_TREATMENT_PAT_CONN_WAIT_FOR_UF_VOL_STATE = 0, ///< Pre-treatment patient connect wait for UF volume setting state PRE_TREATMENT_PAT_CONN_WAIT_FOR_DLZR_INVERT_STATE, ///< Pre-treatment patient connect wait for dialyzer inverted state PRE_TREATMENT_PAT_CONN_WAIT_FOR_USER_CONFIRM_STATE, ///< Pre-treatment patient connect wait for user confirm state PRE_TREATMENT_PAT_CONN_WAIT_FOR_TREATMENT_START_STATE, ///< Pre-treatment patient connect wait for treatment start state NUM_OF_PRE_TREATMENT_PAT_CONN_STATES ///< Number of pre-treatment patient connect states }; -/// Type for HD pre-treatment patient connect sub-mode states enumeration -typedef enum HD_Pre_Treatment_Pat_Conn_States HD_PRE_TREATMENT_PAT_CONN_STATE_T; +/// Type for TD pre-treatment patient connect sub-mode states enumeration +typedef enum TD_Pre_Treatment_Pat_Conn_States TD_PRE_TREATMENT_PAT_CONN_STATE_T; /**@}*/ /** - * @addtogroup HDTreatmentMode + * @addtogroup TDTreatmentMode * @{ */ @@ -354,35 +354,35 @@ /**@}*/ /** - * @addtogroup HDPostTreatmentMode + * @addtogroup TDPostTreatmentMode * @{ */ /// Enumeration of post-treatment mode states. -enum HD_Post_Treatment_Mode_States +enum TD_Post_Treatment_Mode_States { - HD_POST_TREATMENT_DRAIN_RESERVOIRS_STATE = 0, ///< Drain reservoirs state - HD_POST_TREATMENT_PATIENT_DISCONNECTION_STATE, ///< Patient disconnection state - HD_POST_TREATMENT_DISPOSABLE_REMOVAL_STATE, ///< Disposable removal state - HD_POST_TREATMENT_VERIFY_STATE, ///< Verify cartridge removed, syringe removed, and reservoirs drained state - NUM_OF_HD_POST_TREATMENT_STATES ///< Number of post-treatment mode states + TD_POST_TREATMENT_DRAIN_RESERVOIRS_STATE = 0, ///< Drain reservoirs state + TD_POST_TREATMENT_PATIENT_DISCONNECTION_STATE, ///< Patient disconnection state + TD_POST_TREATMENT_DISPOSABLE_REMOVAL_STATE, ///< Disposable removal state + TD_POST_TREATMENT_VERIFY_STATE, ///< Verify cartridge removed, syringe removed, and reservoirs drained state + NUM_OF_TD_POST_TREATMENT_STATES ///< Number of post-treatment mode states }; -typedef enum HD_Post_Treatment_Mode_States HD_POST_TREATMENT_STATE_T; ///< Type for HD post treatment mode states enumeration +typedef enum TD_Post_Treatment_Mode_States TD_POST_TREATMENT_STATE_T; ///< Type for TD post treatment mode states enumeration /**@}*/ /** - * @addtogroup HDServiceMode + * @addtogroup TDServiceMode * @{ */ /// Enumeration of service mode states. -enum HD_Service_States +enum TD_Service_States { - HD_SERVICE_STATE_START = 0, ///< Start service mode state - NUM_OF_HD_SERVICE_STATES ///< Number of service mode states + TD_SERVICE_STATE_START = 0, ///< Start service mode state + NUM_OF_TD_SERVICE_STATES ///< Number of service mode states }; -typedef enum HD_Service_States HD_SERVICE_STATE_T; ///< Type for HD services states enumeration +typedef enum TD_Service_States TD_SERVICE_STATE_T; ///< Type for TD services states enumeration /**@}*/ @@ -613,7 +613,7 @@ /**@}*/ /** - * @addtogroup HDTreatmentParamsMode + * @addtogroup TDTreatmentParamsMode * @{ */ @@ -681,7 +681,7 @@ /**@}*/ /** - * @addtogroup HDTreatmentMode + * @addtogroup TDTreatmentMode * @{ */ @@ -745,7 +745,7 @@ }; typedef enum TD_Event_List TD_EVENT_ID_T; ///< Type for TD event list enumeration -/// Enumeration of generic confirmation request type from HD to UI. +/// Enumeration of generic confirmation request type from TD to UI. enum Generic_Confirm_Command { GENERIC_CONFIRM_CMD_REQUEST_OPEN = 0, ///< Generic Confirm command to display the confirmation @@ -759,11 +759,11 @@ /**@}*/ /** - * @addtogroup HDOperationModes + * @addtogroup TDOperationModes * @{ */ -/// Enumeration of generic confirmation id between HD and UI. +/// Enumeration of generic confirmation id between TD and UI. enum Generic_Confirm_Id { GENERIC_CONFIRM_ID_NONE = 0, ///< Generic Confirm None