Index: MsgDefs.h =================================================================== diff -u -r307b617bfe20082eda480e9f410aec514b1a4899 -r70b03310f630755509ceac5fc71c65686b99ae8b --- MsgDefs.h (.../MsgDefs.h) (revision 307b617bfe20082eda480e9f410aec514b1a4899) +++ MsgDefs.h (.../MsgDefs.h) (revision 70b03310f630755509ceac5fc71c65686b99ae8b) @@ -1,23 +1,29 @@ -/************************************************************************** - * - * Copyright (c) 2019-2020 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 MsgDefs.h - * - * @date 27-Feb-2020 - * @author S. Nash - * - * @brief header file for Message Definitions module - * - **************************************************************************/ +/************************************************************************** +* +* Copyright (c) 2019-2020 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 MsgDefs.h +* +* @author (last) Sean Nash +* @date (last) 05-Aug-2020 +* +* @author (original) Sean +* @date (original) 27-Feb-2020 +* +***************************************************************************/ #ifndef __MESSAGE_DEFINITIONS_H__ #define __MESSAGE_DEFINITIONS_H__ -// ********** public definitions ********** +// ********** public definitions ********** + +/** + * @addtogroup SystemMessageIDs + * @{ + */ /// Enumeration of system message IDs enum Msg_IDs @@ -73,14 +79,28 @@ MSG_ID_SALINE_BOLUS_DATA = 0x30, ///< HD broadcast of saline bolus data MSG_ID_DG_CONDUCTIVITY_DATA = 0x31, ///< DG broadcast of the conductivity sensors data MSG_ID_USER_REQUEST_ALARM_SILENCE = 0x32, ///< UI request alarm silence (or cancel) + MSG_ID_HD_ACCELEROMETER_DATA = 0x33, ///< HD broadcast of accelerometer data + MSG_ID_DG_ACCELEROMETER_DATA = 0x34, ///< DG broadcast of accelerometer data + MSG_ID_UI_NEW_TREATMENT_PARAMS = 0x35, ///< UI request to validate new treatment parameter set + MSG_ID_HD_NEW_TREATMENT_PARAMS_RESPONSE = 0x36, ///< HD response to new treatment parameters set + MSG_ID_DG_HEAT_DISINFECT_DATA = 0x37, ///< DG heat disinfection publish data + MSG_ID_UI_START_TREATMENT = 0x38, ///< UI user request to initiate a treatment + MSG_ID_HD_START_TREATMENT_RESPONSE = 0x39, ///< HD response to user request to initiate a treatment + 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_UI_TREATMENT_END_REQUEST = 0x3C, ///< UI user treatment end request + MSG_ID_HD_TREATMENT_END_RESPONSE = 0x3D, ///< HD response to user request to end treatment + + 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 // service/test CAN messages MSG_ID_FIRST_TESTER_MESSAGE = 0x8000, ///< First HD test message ID MSG_ID_TESTER_LOGIN_REQUEST = MSG_ID_FIRST_TESTER_MESSAGE, ///< HD tester log-in - MSG_ID_HD_MESSAGE = 0x8001, ///< HD message. TODO - needed? + MSG_ID_HD_MESSAGE = 0x8001, ///< Obsolete - TODO - remove when all references to this ID are deleted + MSG_ID_DIAL_OUT_FLOW_SET_PT_OVERRIDE = 0x8001, ///< Dialysate outlet flow set point override request MSG_ID_OFF_BUTTON_STATE_OVERRIDE = 0x8002, ///< Off button override request MSG_ID_STOP_BUTTON_STATE_OVERRIDE = 0x8003, ///< Stop button override request MSG_ID_ALARM_LAMP_PATTERN_OVERRIDE = 0x8004, ///< Alarm lamp pattern override request @@ -117,7 +137,17 @@ MSG_ID_DIAL_OUT_PUMP_MEAS_SPEED_OVERRIDE = 0x8023, ///< Dialysate outlet pump measured motor speed override request MSG_ID_DIAL_OUT_PUMP_MEAS_ROTOR_SPEED_OVERRIDE = 0x8024, ///< Dialysate outlet pump measured rotor speed override request MSG_ID_DIAL_OUT_LOAD_CELL_WEIGHT_OVERRIDE = 0x8025, ///< Load cell measured weight override request - MSG_ID_HD_SAFETY_SHUTDOWN_OVERRIDE = 0x8026, ///< HD safety shutdown override request + MSG_ID_HD_SAFETY_SHUTDOWN_OVERRIDE = 0x8026, ///< HD safety shutdown override request + MSG_ID_HD_ACCEL_OVERRIDE = 0x8027, ///< HD accelerometer sensor override request + MSG_ID_HD_ACCEL_MAX_OVERRIDE = 0x8028, ///< HD accelerometer sensor max. override request + MSG_ID_HD_ACCEL_SEND_INTERVAL_OVERRIDE = 0x8029, ///< HD accelerometer data broadcast interval override request + MSG_ID_HD_ACCEL_SET_CALIBRATION = 0x802A, ///< HD accelerometer set calibration factors request + MSG_ID_HD_BLOOD_FLOW_SET_CALIBRATION = 0x802B, ///< Blood flow set calibration factors request + MSG_ID_HD_DIALYSATE_FLOW_SET_CALIBRATION = 0x802C, ///< Dialysate flow set calibration factors request + MSG_ID_HD_SET_PARAMETER_TREATMENT_PARAMETER = 0x802D, ///< Set a treatment parameter (will change actual setting, not an override) + MSG_ID_HD_VALVES_HOME = 0x802E, ///< Home an HD Valve + MSG_ID_HD_VALVES_POSITION_OVERRIDE = 0x802F, ///< Set an HD valve to a position in counts + MSG_ID_HD_VALVES_SET_BLOOD_TRAP_VALVE = 0x8030, ///< Set the HD blood trap valve status MSG_ID_FIRST_DG_TESTER_MESSAGE = 0xA000, ///< First DG test message ID MSG_ID_DG_TESTER_LOGIN_REQUEST = MSG_ID_FIRST_DG_TESTER_MESSAGE, ///< DG tester log-in @@ -130,7 +160,7 @@ MSG_ID_RO_PUMP_SET_PT_OVERRIDE = 0xA008, ///< RO pump set pt. override request MSG_ID_RO_MEASURED_FLOW_OVERRIDE = 0xA009, ///< RO measured flow rate override request MSG_ID_RO_PUMP_SEND_INTERVAL_OVERRIDE = 0xA00A, ///< RO pump data broadcast interval override request - MSG_ID_DRAIN_PUMP_SET_PT_OVERRIDE = 0xA00B, ///< Drain pump set pt. override request + MSG_ID_DRAIN_PUMP_SET_RPM_OVERRIDE = 0xA00B, ///< Drain pump set RPM override request MSG_ID_DRAIN_PUMP_SEND_INTERVAL_OVERRIDE = 0xA00C, ///< Drain pump data broadcast interval override request MSG_ID_LOAD_CELLL_SEND_INTERVAL_OVERRIDE = 0xA00D, ///< Load cell data broadcast interval override request MSG_ID_VALVE_STATE_OVERRIDE = 0xA00E, ///< Valve state override request @@ -142,14 +172,31 @@ MSG_ID_DG_SAFETY_SHUTDOWN_OVERRIDE = 0xA014, ///< DG safety shutdown override request MSG_ID_CONDUCTIVITY_OVERRIDE = 0xA015, ///< Conductivity sensor override request MSG_ID_CONDUCTIVITY_PUBLISH_INTERVAL_OVERRIDE = 0xA016, ///< Conductivity sensors data publish override + MSG_ID_DG_ACCEL_OVERRIDE = 0xA017, ///< DG accelerometer sensor override request + MSG_ID_DG_ACCEL_MAX_OVERRIDE = 0xA018, ///< DG accelerometer sensor max. override request + MSG_ID_DG_ACCEL_SEND_INTERVAL_OVERRIDE = 0xA019, ///< DG accelerometer data broadcast interval override request + MSG_ID_DG_ACCEL_SET_CALIBRATION = 0xA01A, ///< DG accelerometer set calibration factors request + MSG_ID_RO_PUMP_SET_PWM = 0xA01B, ///< RO pump set PWM for open loop + MSG_ID_DRAIN_PUMP_SET_DELTA_PRESSURE_OVERRIDE = 0xA01C, ///< Drain pump set delta pressure override + MSG_ID_HEAT_DISINFECT_RECIRC_PATH_DURATION_MINS = 0xA01D, ///< Heat disinfection recirculation path duration in minutes + MSG_ID_HEAT_DISINFECT_R1_TO_R2_DURATION_MINS = 0xA01E, ///< Heat disinfection reservoir 1 to reservoir 2 duration in minutes + MSG_ID_HEAT_DISINFECT_R2_TO_R1_DURATION_MINS = 0xA01F, ///< Heat disinfection reservoir 2 to reservoir 1 duration in minutes + MSG_ID_HEAT_DISINFECT_NO_OF_CYCLES_TO_RUN = 0xA020, ///< Heat disinfection number of cycles to run + MSG_ID_HEAT_DISINFECT_PUBLISH_INTERVAL_OVERRIDE = 0xA021, ///< Heat disinfection data publish interval override request MSG_ID_HD_DEBUG_EVENT = 0xFFF1, ///< HD debug event text to be logged in event log 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 @@ -171,9 +218,14 @@ REQUEST_REJECT_REASON_UF_NOT_IN_PROGESS, ///< Ultrafiltration is not currently in progress REQUEST_REJECT_REASON_UF_NOT_PAUSED, ///< Ultrafiltration is not currently paused REQUEST_REJECT_REASON_SALINE_BOLUS_IN_PROGRESS, ///< A saline bolus is in progress + REQUEST_REJECT_REASON_PARAM_OUT_OF_RANGE, ///< A treatment parameter is out of range + REQUEST_REJECT_REASON_HEPARIN_PRESTOP_EXCEEDS_DURATION, ///< The Heparin pre-stop setting is greater than the treatment duration + 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