Index: HDDefs.h =================================================================== diff -u -ra2acf043b65112d1689b300c51c4751e0709da2d -r2249a37a4490d3a1fc57b3f82bc9ef8d274a12bc --- HDDefs.h (.../HDDefs.h) (revision a2acf043b65112d1689b300c51c4751e0709da2d) +++ HDDefs.h (.../HDDefs.h) (revision 2249a37a4490d3a1fc57b3f82bc9ef8d274a12bc) @@ -1,14 +1,14 @@ /************************************************************************** * -* Copyright (c) 2020-2022 Diality Inc. - All Rights Reserved. +* Copyright (c) 2020-2023 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 HDDefs.h * -* @author (last) Dong Nguyen -* @date (last) 14-Sep-2022 +* @author (last) Michael Garthwaite +* @date (last) 19-Jan-2023 * * @author (original) Sean Nash * @date (original) 29-May-2020 @@ -53,10 +53,10 @@ { POST_STATE_START = 0, ///< Start initialize & POST mode state POST_STATE_FW_INTEGRITY, ///< Run firmware integrity test state - POST_STATE_WATCHDOG, ///< Run watchdog test state - POST_STATE_SAFETY_SHUTDOWN, ///< Run safety shutdown test state POST_STATE_RTC, ///< Run RTC test state POST_STATE_NVDATAMGMT, ///< Run NV Data Mgmt. test state + POST_STATE_WATCHDOG, ///< Run watchdog test state + POST_STATE_SAFETY_SHUTDOWN, ///< Run safety shutdown test state POST_STATE_BLOOD_FLOW, ///< Run blood flow test state POST_STATE_DIALYSATE_INLET_FLOW, ///< Run dialysate inlet flow test state POST_STATE_DIALYSATE_OUTLET_FLOW, ///< Run dialysate outlet flow test state @@ -106,24 +106,28 @@ /// Sub-mode states while in standby mode enum HD_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_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_FLUSH_CMD_RESPONSE_STATE, ///< Wait for DG flush command response. - STANDBY_WAIT_FOR_DG_FLUSH_TO_START_STATE, ///< Wait for DG flush to start. - STANDBY_DG_FLUSH_IN_PROGRESS_STATE, ///< DG flush operation is in progress + STANDBY_WAIT_FOR_DG_FLUSH_CMD_RESPONSE_STATE, ///< Wait for DG flush command response. + STANDBY_WAIT_FOR_DG_FLUSH_TO_START_STATE, ///< Wait for DG flush to start. + STANDBY_DG_FLUSH_IN_PROGRESS_STATE, ///< DG flush operation is in progress - STANDBY_WAIT_FOR_DG_HEAT_DISINFECT_CMD_RESPONSE_STATE, ///< Wait for DG heat disinfect command response. - STANDBY_WAIT_FOR_DG_HEAT_DISINFECT_TO_START_STATE, ///< Wait for DG heat disinfect to start. - STANDBY_DG_HEAT_DISINFECT_IN_PROGRESS_STATE, ///< DG heat disinfect operation is in progress. + STANDBY_WAIT_FOR_DG_HEAT_DISINFECT_CMD_RESPONSE_STATE, ///< Wait for DG heat disinfect command response. + STANDBY_WAIT_FOR_DG_HEAT_DISINFECT_TO_START_STATE, ///< Wait for DG heat disinfect to start. + STANDBY_DG_HEAT_DISINFECT_IN_PROGRESS_STATE, ///< DG heat disinfect operation is in progress. - STANDBY_WAIT_FOR_DG_CHEM_DISINFECT_CMD_RESPONSE_STATE, ///< Wait for DG chemical disinfect command response. - STANDBY_WAIT_FOR_DG_CHEM_DISINFECT_TO_START_STATE, ///< Wait for DG chemical disinfect to start. - STANDBY_DG_CHEM_DISINFECT_IN_PROGRESS_STATE, ///< DG chemical disinfect operation is in progress - NUM_OF_STANDBY_STATES ///< Number of standby states (sub-modes) + STANDBY_WAIT_FOR_DG_CHEM_DISINFECT_CMD_RESPONSE_STATE, ///< Wait for DG chemical disinfect command response. + STANDBY_WAIT_FOR_DG_CHEM_DISINFECT_TO_START_STATE, ///< Wait for DG chemical disinfect to start. + STANDBY_DG_CHEM_DISINFECT_IN_PROGRESS_STATE, ///< DG chemical disinfect operation is in progress + + STANDBY_WAIT_FOR_DG_CHEM_DISINFECT_FLUSH_CMD_RESPONSE_STATE, ///< Wait for DG chemical disinfect flush command response. + STANDBY_WAIT_FOR_DG_CHEM_DISINFECT_FLUSH_TO_START_STATE, ///< Wait for DG chemical disinfect flush to start. + STANDBY_DG_CHEM_DISINFECT_FLUSH_IN_PROGRESS_STATE, ///< DG chemical disinfect flush operation is in progress + 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 HD_Standby_States HD_STANDBY_STATE_T; ///< Type for HD standby states enumeration /**@}*/ @@ -135,8 +139,7 @@ /// 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_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 }; @@ -152,8 +155,7 @@ /// Enumeration of pre-treatment mode states (sub-mode). enum HD_Pre_Treatment_Mode_States { - HD_PRE_TREATMENT_START_STATE = 0, ///< Start pre-treatment mode state - HD_PRE_TREATMENT_WATER_SAMPLE_STATE, ///< Water sample state + 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 @@ -204,8 +206,7 @@ enum HD_Pre_Treatment_Consumable_Self_Test_States { CONSUMABLE_SELF_TESTS_INSTALL_STATE = 0, ///< Consumable self-tests install state - CONSUMABLE_SELF_TESTS_FILL_CMD_STATE, ///< Send command to DG to fill reservoir state - CONSUMABLE_SELF_TESTS_WATER_QUALITY_CHECK_STATE, ///< Consumable self-tests water quality check state + CONSUMABLE_SELF_TESTS_PRIME_STATE, ///< Consumable self-tests prime concentrate lines state CONSUMABLE_SELF_TESTS_BICARB_PUMP_CHECK_STATE, ///< Consumable self-tests bicarbonate concentrate pump check state CONSUMABLE_SELF_TESTS_ACID_PUMP_CHECK_STATE, ///< Consumable self-tests acid concentrate pump check state CONSUMABLE_SELF_TESTS_COMPLETE_STATE, ///< Consumable self-tests complete state @@ -224,8 +225,7 @@ /// Enumeration of no cartridge self-tests sub-mode states. enum HD_Pre_Treatment_No_Cart_Self_Tests_States { - NO_CART_SELF_TESTS_START_STATE = 0, ///< No cartridge self-tests starting state - NO_CART_SELF_TESTS_WAIT_FOR_DOOR_CLOSE_STATE, ///< Wait for door to be closed before running self-tests + 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 NO_CART_SELF_TESTS_HOME_VALVES_STATE, ///< No cartridge home valves state NO_CART_SELF_TESTS_HOME_SYRINGE_PUMP_STATE, ///< No cartridge home syringe pump state @@ -244,9 +244,12 @@ 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 DRY_SELF_TESTS_USED_CARTRIDGE_CHECK_STATE, ///< Used cartridge check dry self-test state - DRY_SELF_TESTS_OCCLUSION_SENSORS_STATE, ///< Occlusion sensors dry self-test state - DRY_SELF_TESTS_PRESSURE_SENSORS_SETUP_STATE, ///< Pressure sensors dry self-test setup valves and pump state - DRY_SELF_TESTS_PRESSURE_SENSORS_PRESSURIZED_STATE, ///< Pressure sensors verify pressure readings state + DRY_SELF_TESTS_CARTRIDGE_LOADED_CHECK_STATE, ///< Cartridge loaded check dry self-test state + DRY_SELF_TESTS_PRESSURE_SENSORS_NORMAL_SETUP_STATE, ///< Pressure sensor setup state. + DRY_SELF_TESTS_PRESSURE_SENSORS_VENOUS_SETUP_STATE, ///< Venous pressure sensor dry self-test setup valves and pump state + DRY_SELF_TESTS_PRESSURE_SENSORS_VENOUS, ///< Venous pressure sensor dry self-test + DRY_SELF_TESTS_PRESSURE_SENSORS_ARTERIAL_SETUP_STATE, ///< Arterial pressure sensor dry self-test setup valves and pump state + DRY_SELF_TESTS_PRESSURE_SENSORS_ARTERIAL, ///< Arterial pressure sensor dry self-test DRY_SELF_TESTS_PRESSURE_SENSORS_DECAY_STATE, ///< Pressure sensors verify pressure loss state DRY_SELF_TESTS_PRESSURE_SENSORS_STABILITY_STATE, ///< Pressure sensors verify pressure stability state DRY_SELF_TESTS_PRESSURE_SENSORS_NORMAL_STATE, ///< Pressure sensors verify normal pressure readings state @@ -263,8 +266,8 @@ enum Wet_Self_Tests_States { WET_SELF_TESTS_START_STATE = 0, ///< Wet self-tests starting state. - WET_SELF_TESTS_SETUP_STATE, ///< Setup reservoirs for wet self-tests. - WET_SELF_TESTS_BUBBLES_STATE, ///< Wet self-test air bubble detectors state. + WET_SELF_TESTS_BUBBLE_CHECK_SETUP_STATE, ///< Setup for wet air bubble self-test state. + WET_SELF_TESTS_BUBBLE_CHECK_STATE, ///< Wet self-test air bubble detectors state. WET_SELF_TESTS_PRIME_CHECK_STATE, ///< Prime check wet self-tests state, checks for primed patient lines. WET_SELF_TESTS_BLOOD_LEAK_DETECTOR_STATE, ///< Blood leak detector self-test state. WET_SELF_TESTS_FIRST_DISPLACEMENT_SETUP_STATE, ///< Setup valve and start dialysate pump for first displacement. @@ -290,8 +293,7 @@ /// Enumeration of prime sub-mode states. enum HD_Pre_Treatment_Prime_States { - HD_PRIME_START_STATE = 0, ///< Prime start state - HD_PRIME_WAIT_FOR_USER_START_STATE, ///< Wait for user to start prime state + 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 @@ -399,8 +401,7 @@ /// Enumeration of ultrafiltration states. enum UF_States { - UF_START_STATE = 0, ///< Start state of the ultrafiltration state machine - UF_PAUSED_STATE, ///< Paused state of the ultrafiltration state machine + UF_PAUSED_STATE = 0, ///< Paused state of the ultrafiltration state machine UF_RUNNING_STATE, ///< Running state of the ultrafiltration state machine NUM_OF_UF_STATES ///< Number of ultrafiltration states }; @@ -740,7 +741,13 @@ HD_EVENT_SERVICE_UPDATE, ///< HD new service record has been updated HD_EVENT_USAGE_INFO_UPDATE, ///< HD new usage information has been updated HD_EVENT_SW_CONFIG_UPDATE, ///< HD new software configuration has been updated - HD_EVENT_NO_EVENT, ///< HD no event has been updated + HD_EVENT_BUTTON, ///< HD button pressed/released + HD_EVENT_SAFETY_LINE, ///< HD safety line pulled/released + HD_EVENT_RSRVR_1_LOAD_CELL_START_VALUES, ///< HD reservoir 1 load cells start values + HD_EVENT_RSRVR_1_LOAD_CELL_END_VALUES, ///< HD reservoir 2 load cells end values + HD_EVENT_RSRVR_2_LOAD_CELL_START_VALUES, ///< HD reservoir 2 load cells start values + HD_EVENT_RSRVR_2_LOAD_CELL_END_VALUES, ///< HD reservoir 2 load cells end values + HD_EVENT_SUB_STATE_CHANGE, ///< HD Op sub-state change event NUM_OF_EVENT_IDS ///< Total number of HD events }; typedef enum HD_Event_List HD_EVENT_ID_T; ///< Type for HD event list enumeration @@ -752,7 +759,7 @@ GENERIC_CONFIRM_CMD_TIMEOUT_CLOSE = 1, ///< Generic Confirm command to hide the confirmation, due to timeout user confirmation GENERIC_CONFIRM_CMD_REJECT = 2, ///< Generic Confirm command to display the confirmation rejection in case the request in not valid/accepted anymore. GENERIC_CONFIRM_CMD_ACCEPT_CLOSE = 3, ///< Generic Confirm command to hide the confirmation, due to accept user confirmation. - NUM_OF_GENERIC_CONFIRM_COMMAND , ///< Total number of generic confirm commands + NUM_OF_GENERIC_CONFIRM_COMMAND ///< Total number of generic confirm commands }; typedef enum Generic_Confirm_Command GENERIC_CONFIRM_COMMAND_T; ///< Type for generic confirm enumeration @@ -774,42 +781,15 @@ }; typedef enum Generic_Confirm_Id GENERIC_CONFIRM_ID_T; ///< Type for generic confirm enumeration -/**@}*/ - -/** - * @addtogroup UIUserConfirm - * @{ - */ - -/// Enumeration of generic confirmation. -enum Generic_Confirm_Command +/// List of confirmation request status +typedef enum Confirmation_Status { - GENERIC_CONFIRM_CMD_REQUEST_OPEN = 0, ///< Generic Confirm command to display the confirmation - GENERIC_CONFIRM_CMD_TIMEOUT_CLOSE = 1, ///< Generic Confirm command to hide the confirmation, due to timeout user confirmation - GENERIC_CONFIRM_CMD_REJECT = 2, ///< Generic Confirm command to display the confirmation rejection in case the request in not valid/accepted anymore. - GENERIC_CONFIRM_CMD_ACCEPT_CLOSE = 3, ///< Generic Confirm command to hide the confirmation, due to accept user confirmation. - NUM_OF_GENERIC_CONFIRM_COMMAND , ///< Total number of generic confirm commands -}; -typedef enum Generic_Confirm_Command GENERIC_CONFIRM_COMMAND_T; ///< Type for generic confirm enumeration + CONFIRMATION_REQUEST_STATUS_REJECTED = 0, ///< Confirmation status rejected + CONFIRMATION_REQUEST_STATUS_ACCEPTED, ///< Confirmation status accepted + CONFIRMATION_REQUEST_STATUS_TIMEOUT, ///< Confirmation status timeout + CONFIRMATION_REQUEST_STATUS_PENDING, ///< Confirmation status pending response + CONFIRMATION_REQUEST_STATUS_UNUSED, ///< Confirmation status Unused + NUM_OF_CONFIRMATION_REQUEST_STATUS ///< Number of confirmation status +} CONFIRMATION_REQUEST_STATUS_T; -/**@}*/ - -/** - * @addtogroup UIUserConfirm - * @{ - */ - -/// Enumeration of generic confirmation. -enum Generic_Confirm_Id -{ - GENERIC_CONFIRM_ID_NONE = 0, ///< Generic Confirm None - GENERIC_CONFIRM_ID_DISINFECT_STOP_WATERFLUSH, ///< water flush stop user confirmation - GENERIC_CONFIRM_ID_DISINFECT_STOP_HEAT, ///< Heat disinfect stop user confirmation - GENERIC_CONFIRM_ID_DISINFECT_STOP_CHEMICAL, ///< Chemical disinfect stop user confirmation - NUM_OF_GENERIC_CONFIRM_IDS, ///< Total number of generic confirm IDs -}; -typedef enum Generic_Confirm_Id GENERIC_CONFIRM_ID_T; ///< Type for generic confirm enumeration - -/**@}*/ - #endif