Index: MsgDefs.h =================================================================== diff -u -rcaa8df5fd4176e83a4f14c07d9415fefee2042db -ra867208e3cb7f5aa012edf23bad03d886f30e2c1 --- MsgDefs.h (.../MsgDefs.h) (revision caa8df5fd4176e83a4f14c07d9415fefee2042db) +++ MsgDefs.h (.../MsgDefs.h) (revision a867208e3cb7f5aa012edf23bad03d886f30e2c1) @@ -9,26 +9,26 @@ * @file MsgDefs.h * * @author (last) Michael Garthwaite -* @date (last) 14-Feb-2022 +* @date (last) 10-Mar-2022 * * @author (original) Sean * @date (original) 27-Feb-2020 * ***************************************************************************/ - -#ifndef __MESSAGE_DEFINITIONS_H__ -#define __MESSAGE_DEFINITIONS_H__ - + +#ifndef __MESSAGE_DEFINITIONS_H__ +#define __MESSAGE_DEFINITIONS_H__ + // ********** public definitions ********** /** * @addtogroup SystemCommMessages * @{ - */ - + */ + /// Enumeration of system message IDs -enum Msg_IDs -{ // normal CAN messages +enum Msg_IDs +{ // normal CAN messages MSG_ID_UNUSED = 0, ///< Zero is an undefined (un-used) message ID) MSG_ID_OFF_BUTTON_PRESS = 1, ///< HD/UI off button interactions MSG_ID_ALARM_STATUS = 2, ///< HD broadcast of system alarm state information @@ -55,7 +55,7 @@ MSG_ID_USER_BLOOD_DIAL_RATE_CHANGE_REQUEST = 0x17, ///< User request to change blood and dialysate rates MSG_ID_USER_BLOOD_DIAL_RATE_CHANGE_RESPONSE = 0x18, ///< HD response to user request to change blood and dialysate rates MSG_ID_SET_DG_DIALYSATE_TEMP_TARGETS = 0x19, ///< HD provides DG with dialysate temperature set points - MSG_ID_TREATMENT_PARAM_CHANGE_RANGES = 0x1A, ///< HD provides several parameter change ranges as they evolve over treatment duration + MSG_ID_TREATMENT_PARAM_CHANGE_RANGES = 0x1A, ///< HD provides several parameter change ranges as they evolve over treatment duration MSG_ID_USER_TREATMENT_TIME_CHANGE_RESPONSE = 0x1B, ///< HD response to user request to change treatment duration MSG_ID_REQUEST_FW_VERSIONS = 0x1C, ///< UI request for f/w versions MSG_ID_HD_VERSION = 0x1D, ///< HD f/w version @@ -73,16 +73,16 @@ MSG_ID_DG_SAMPLE_WATER_CMD = 0x29, ///< HD request to DG to allow user to get a water sample MSG_ID_DG_VALVES_STATES = 0x2A, ///< DG broadcast valve states MSG_ID_DG_START_STOP_TRIMMER_HEATER_CMD = 0x2B, ///< HD request to DG to start/stop trimmer heater - MSG_ID_DG_HEATERS_DATA = 0x2C, ///< DG broadcast of the heaters data - MSG_ID_DG_TEMPERATURE_DATA = 0x2D, ///< DG broadcast of the temperature sensors data + MSG_ID_DG_HEATERS_DATA = 0x2C, ///< DG broadcast of the heaters data + MSG_ID_DG_TEMPERATURE_DATA = 0x2D, ///< DG broadcast of the temperature sensors data MSG_ID_USER_UF_SETTINGS_CHANGE_CONFIRMATION_RESPONSE = 0x2E, ///< HD response to user selection of ultrafiltration settings change option selection MSG_ID_SALINE_BOLUS_DATA = 0x2F, ///< HD broadcast of saline bolus data MSG_ID_DG_START_STOP_HEAT_DISINFECT = 0x30, ///< HD request to start or stop DG heat disinfection - 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_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 disinfect publish data MSG_ID_UI_INITIATE_TREATMENT_REQUEST = 0x38, ///< UI user request to initiate a treatment @@ -202,18 +202,19 @@ MSG_ID_DG_CONCENTRATE_MIXING_RATIOS_DATA = 0xAA, ///< DG concentrate mixing ratios data MSG_ID_DG_SCHEDULED_RUNS_DATA = 0xAB, ///< DG scheduled runs data MSG_ID_DG_SCHEDULED_RUNS_INFO = 0xAC, ///< DG scheduled runs info to be sent to the UI and Dialin - MSG_ID_DG_DIALYSATE_FILL_DATA = 0xAD, ///< DG broadcast dialysate data during fill mode - MSG_ID_DG_FILL_MODE_DATA = 0xAE, ///< DG broadcast of fill mode data + MSG_ID_UI_INSTALLATION_CONFIRM_RESPONSE = 0xAD, ///< HD Confirm installation response + MSG_ID_DG_DIALYSATE_FILL_DATA = 0xAE, ///< DG broadcast dialysate data during fill mode + MSG_ID_DG_FILL_MODE_DATA = 0xAF, ///< DG broadcast of fill mode data -#ifdef EMC_TEST_BUILD - MSG_ID_CAN_ERROR_COUNT = 0x999, // test code in support of EMC testing -#endif - - // service/test CAN messages +#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_DIAL_OUT_FLOW_SET_PT_OVERRIDE = 0x8001, ///< Dialysate outlet flow set point override request + 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 @@ -250,12 +251,12 @@ 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_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_SYRINGE_PUMP_SEND_INTERVAL_OVERRIDE = 0x802A, ///< HD syringe pump data broadcast interval override request - MSG_ID_HD_SYRINGE_PUMP_OPERATION_REQUEST = 0x802B, ///< HD syringe pump operation 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_SYRINGE_PUMP_SEND_INTERVAL_OVERRIDE = 0x802A, ///< HD syringe pump data broadcast interval override request + MSG_ID_HD_SYRINGE_PUMP_OPERATION_REQUEST = 0x802B, ///< HD syringe pump operation request MSG_ID_HD_SYRINGE_PUMP_MEASURED_RATE_OVERRIDE = 0x802C, ///< HD syringe pump measured rate override 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 @@ -308,7 +309,7 @@ MSG_ID_HD_BUBBLE_STATUS_OVERRIDE = 0x805E, ///< HD air bubble detector status override request MSG_ID_HD_BLOOD_PRIME_VOLUME_OVERRIDE = 0x805F, ///< HD blood prime volume override request MSG_ID_HD_BUBBLE_SELF_TEST_REQUEST = 0x8060, ///< HD air bubble detector self-test request - MSG_ID_HD_FAN_RPM_ALARM_START_TIME_OFFSET_OVERRIDE = 0x8061, ///< HD fan RPM alarm start time override request + MSG_ID_HD_FAN_RPM_ALARM_START_TIME_OFFSET_OVERRIDE = 0x8061, ///< HD fan RPM alarm start time override request TODO remove once DEN-12224 merged into staging MSG_ID_HD_SWITCHES_STATUS_OVERRIDE = 0x8062, ///< HD switches status override request MSG_ID_HD_SWITCHES_PUBLISH_INTERVAL_OVERRIDE = 0x8063, ///< HD switches data publish override request MSG_ID_HD_BATTERY_REMAINING_PERCENT_OVERRIDE = 0x8064, ///< HD battery remaining percent override request @@ -336,7 +337,8 @@ MSG_ID_HD_SYRINGE_PUMP_HEPRIN_BOLUS_TARGET_RATE_OVERRIDE = 0x807A, ///< HD heprin bolus target rate override request MSG_ID_HD_REQ_CURRENT_TREATMENT_PARAMETERS = 0x807B, ///< HD request current treatment parameters MSG_ID_HD_RES_CURRENT_TREATMENT_PARAMETERS = 0x807C, ///< HD current treatment paramaters response - + MSG_ID_HD_SET_FANS_RPM_ALARM_START_TIME_OFFSET = 0x807D, ///< HD set fans RPM alarm start time offset + 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 MSG_ID_DG_ALARM_STATE_OVERRIDE = 0xA001, ///< DG alarm state override message ID @@ -345,6 +347,7 @@ MSG_ID_LOAD_CELL_OVERRIDE = 0xA005, ///< Load cell sensor override request MSG_ID_PRESSURE_OVERRIDE = 0xA006, ///< Pressure sensor override request MSG_ID_PRESSURE_SEND_INTERVAL_OVERRIDE = 0xA007, ///< Pressure data broadcast interval override request + MSG_ID_DG_HD_COMMUNICATION_STATUS_OVERRIDE = 0xA008, ///< DG HD Communication Status override 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_RPM = 0xA00B, ///< Drain pump set RPM override request @@ -353,15 +356,15 @@ MSG_ID_VALVE_STATE_OVERRIDE = 0xA00E, ///< Valve state override request MSG_ID_VALVES_STATES_PUBLISH_INTERVAL_OVERRIDE = 0xA00F, ///< Valve data broadcast interval override request MSG_ID_TEMPERATURE_SENSORS_VALUE_OVERRIDE = 0xA010, ///< Temperature sensor override request - MSG_ID_START_STOP_PRIMARY_HEATER = 0xA011, ///< Start/stop primary heaters - MSG_ID_TEMPERATURE_SENSORS_PUBLISH_INTERVAL_OVERRIDE = 0xA012, ///< Temperature sensors data publish override - MSG_ID_HEATERS_PUBLISH_INTERVAL_ORVERRIDE = 0xA013, ///< Heaters data publish override + MSG_ID_START_STOP_PRIMARY_HEATER = 0xA011, ///< Start/stop primary heaters + MSG_ID_TEMPERATURE_SENSORS_PUBLISH_INTERVAL_OVERRIDE = 0xA012, ///< Temperature sensors data publish override + MSG_ID_HEATERS_PUBLISH_INTERVAL_ORVERRIDE = 0xA013, ///< Heaters data publish override 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_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_MONITORED_VOLTAGES_SEND_INTERVAL_OVERRIDE = 0xA01A, ///< DG monitored voltages publish interval override request MSG_ID_DG_MONITORED_VOLTAGES_OVERRIDE = 0xA01B, ///< DG monitored voltage override request MSG_ID_DRAIN_PUMP_TARGET_OUTLET_PRESSURE = 0xA01C, ///< Drain pump target outlet pressure. @@ -408,26 +411,27 @@ MSG_ID_DG_DRAIN_PUMP_MEASURED_RPM_OVERRIDE = 0xA046, ///< DG drain pump measured RPM override MSG_ID_DG_SUPER_CLEAR_ALARMS_CMD = 0xA047, ///< Clears all DG alarms (even if non-recoverable or fault) MSG_ID_DG_ALARM_INFO_SEND_INTERVAL_OVERRIDE = 0xA048, ///< DG alarm information broadcast interval override request - MSG_ID_DG_FAN_RPM_ALARM_START_TIME_OFFSET_OVERRIDE = 0xA049, ///< DG fan RPM alarm start time offset override request + MSG_ID_DG_FAN_RPM_ALARM_START_TIME_OFFSET_OVERRIDE = 0xA049, ///< DG fan RPM alarm start time offset override request // TODO remove once DEN-12224 is implemented MSG_ID_DG_GET_SW_CONFIG_RECORD = 0xA04A, ///< DG get software configuration record request MSG_ID_DG_SET_SW_CONFIG_RECORD = 0xA04B, ///< DG set software configuration record MSG_ID_DG_SEND_SW_CONFIG_RECORD = 0xA04C, ///< DG send software configuration record MSG_ID_DG_FANS_DUTY_CYCLE_OVERRIDE = 0xA04D, ///< DG fans duty cycle override request - MSG_ID_DG_USED_ACID_VOLUME_ML_OVERRIDE = 0xA04F, ///< DG used acid volume override in mL + MSG_ID_DG_USED_ACID_VOLUME_ML_OVERRIDE = 0xA04E, ///< DG used acid volume override in mL + MSG_ID_DG_SET_FANS_RPM_ALARM_START_TIME_OFFSET = 0xA04F, ///< DG set fans RPM alarm start time offset MSG_ID_DG_USED_BICARB_VOLUME_ML_OVERRIDE = 0xA050, ///< DG used bicarb volume override in mL - + 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 MSG_ID_ACK_MESSAGE_THAT_REQUIRES_ACK = 0xFFFF, ///< Acknowledgment of message that requires acknowledgment - + END_OF_MSG_IDS ///< End of system message IDs }; typedef enum Msg_IDs MSG_ID_T; ///< Type for message IDs enumeration /// Enumeration of settings change rejection reason codes -enum Request_Reject_Reasons -{ +enum Request_Reject_Reasons +{ REQUEST_REJECT_REASON_NONE = 0, ///< Used when there is no rejection REQUEST_REJECT_REASON_NOT_ALLOWED_IN_CURRENT_MODE = 1, ///< Request is not allowed in the current operating mode REQUEST_REJECT_REASON_TIMEOUT_WAITING_FOR_USER_CONFIRM = 2, ///< Validated request was not confirmed by user in reasonable time @@ -465,10 +469,15 @@ REQUEST_REJECT_REASON_DG_NOT_IN_STANDBY_IDLE_STATE = 34, ///< Treatment cannot initiate if DG is not in standby idle state REQUEST_REJECT_REASON_INVALID_REQUEST_FORMAT = 35, ///< Request message not formatted properly REQUEST_REJECT_REASON_INVALID_DATE_OR_TIME = 36, ///< Given date/time is invalid - REQUEST_REJECT_REASON_NO_NEW_TREATMENT_ALARM_TRIGGERED = 37, ///< Treatment cannot initiate if an alarm with no new treatment property has triggered before + REQUEST_REJECT_REASON____AVAILABLE_1 = 37, ///< Not used - available for use REQUEST_REJECT_REASON_BATTERY_IS_NOT_CHARGED = 38, ///< Battery does not have enough charge to start treatment REQUEST_REJECT_REASON_RINSEBACK_NOT_COMPLETED = 39, ///< Cannot move on to recirculate without completing full rinseback. - REQUEST_REJECT_REASON_RESERVOIR_ONE_IS_NOT_READY, ///< Reservoir one fill is not complete + REQUEST_REJECT_REASON_RESERVOIR_ONE_IS_NOT_READY = 40, ///< Reservoir one fill is not complete + REQUEST_REJECT_REASON_PUMP_TRACK_NOT_CLOSED = 41, ///< Pump track is not ready / closed + REQUEST_REJECT_REASON_DOOR_NOT_CLOSED = 42, ///< Door is not closed + REQUEST_REJECT_REASON_SYRINGE_NOT_PRESENT = 43, ///< Syringe is not present + REQUEST_REJECT_REASON_DG_DIALYSATE_CAP_OPEN = 44, ///< Dialysate cap open + REQUEST_REJECT_REASON_DG_CONCENTRATE_CAP_OPEN = 45, ///< Concentrate cap open 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 @@ -484,5 +493,5 @@ typedef enum Cmd_Request_Reject_Reasons CMD_REQUEST_REJECT_REASON_CODE_T; ///< Type for command request rejection reason codes enumeration /**@}*/ - -#endif + +#endif