Index: firmware/App/Services/SystemCommMessages.c =================================================================== diff -u -r4459be59bdc2896b44bcf6cd42d2762190e23c16 -r8dad6fab1c33602ad94908fd31b8b15153a9eb6e --- firmware/App/Services/SystemCommMessages.c (.../SystemCommMessages.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) +++ firmware/App/Services/SystemCommMessages.c (.../SystemCommMessages.c) (revision 8dad6fab1c33602ad94908fd31b8b15153a9eb6e) @@ -37,28 +37,33 @@ #include "WatchdogMgmt.h" #include "RTC.h" +/** + * @addtogroup SystemCommMessages + * @{ + */ + // ********** private definitions ********** -#define ACK_REQUIRED TRUE -#define ACK_NOT_REQUIRED FALSE +#define ACK_REQUIRED TRUE ///< Macro for functions that want to know if an outgoing message requires acknowledgement from receiver. +#define ACK_NOT_REQUIRED FALSE ///< Macro for functions that want to know if an outgoing message requires acknowledgement from receiver. #ifdef DEBUG_ENABLED #define DEBUG_EVENT_MAX_TEXT_LEN 40 #endif // ********** private data ********** -static BOOL testerLoggedIn = FALSE; -static volatile U16 nextSeqNo = 1; +static BOOL testerLoggedIn = FALSE; ///< Flag indicates whether an external tester (connected PC) has sent a valid login message. +static volatile U16 nextSeqNo = 1; ///< Value of sequence number to use for next transmitted message. // ********** private function prototypes ********** static U32 serializeMessage( MESSAGE_T msg, COMM_BUFFER_T buffer, BOOL ackReq ); static BOOL sendTestAckResponseMsg( MSG_ID_T msgID, BOOL ack ); static BOOL sendAckResponseMsg( MSG_ID_T msgID, COMM_BUFFER_T buffer, BOOL ack ); -/************************************************************************* - * @brief serializeMessage +/*********************************************************************//** + * @brief * The serializeMessage function serializes a given message into a given * array of bytes. A sequence # is added to the message here and the ACK * bit of the sequence # is set if ACK is required per parameter. A sync byte @@ -142,8 +147,8 @@ return result; } -/************************************************************************* - * @brief sendACKMsg +/*********************************************************************//** + * @brief * The sendACKMsg function constructs and queues for transmit an ACK message * for a given received message. * @details @@ -172,8 +177,8 @@ return result; } -/************************************************************************* - * @brief sendTestAckResponseMsg +/*********************************************************************//** + * @brief * The sendTestAckResponseMsg function constructs a simple response * message for a handled test message and queues it for transmit on the * appropriate UART channel. @@ -206,8 +211,8 @@ // ***************** Message Sending Helper Functions ******************** // *********************************************************************** -/************************************************************************* - * @brief sendOffButtonMsgToUI +/*********************************************************************//** + * @brief * The sendOffButtonMsgToUI function constructs an off button msg to the UI * and queues the msg for transmit on the appropriate CAN channel. * @details @@ -233,7 +238,7 @@ return result; } -/************************************************************************* +/*********************************************************************//** * @brief * The sendChangeUFSettingsResponse function constructs a UF change settings * response to the UI and queues the msg for transmit on the appropriate CAN @@ -284,7 +289,7 @@ return result; } -/************************************************************************* +/*********************************************************************//** * @brief * The sendChangeUFSettingsResponse function constructs a UF change settings * option response to the UI and queues the msg for transmit on the appropriate CAN @@ -326,7 +331,7 @@ return result; } -/************************************************************************* +/*********************************************************************//** * @brief * The sendChangeTreatmentDurationResponse function constructs a treatment * duration change response to the UI and queues the msg for transmit on the @@ -365,7 +370,7 @@ return result; } -/************************************************************************* +/*********************************************************************//** * @brief * The sendChangeBloodDialysateRateChangeResponse function constructs a change * blood and dialysate rate settings response to the UI and queues the msg for @@ -404,7 +409,7 @@ return result; } -/************************************************************************* +/*********************************************************************//** * @brief * The sendTreatmentParamsRangesToUI function constructs a treatment parameter * ranges message to the UI and queues the msg for transmit on the appropriate CAN channel. @@ -448,7 +453,7 @@ return result; } -/************************************************************************* +/*********************************************************************//** * @brief * The sendDialysateTempTargetsToDG function constructs a dialysate temperature * set points message for DG and queues the msg for transmit on the appropriate CAN channel. @@ -480,7 +485,7 @@ return result; } -/************************************************************************* +/*********************************************************************//** * @brief * The sendDGSwitchReservoirCommand function constructs a DG set active * reservoir message for DG and queues the msg for transmit on the appropriate CAN channel. @@ -509,7 +514,7 @@ return result; } -/************************************************************************* +/*********************************************************************//** * @brief * The sendDGFillCommand function constructs a DG fill command message * and queues the msg for transmit on the appropriate CAN channel. @@ -538,7 +543,7 @@ return result; } -/************************************************************************* +/*********************************************************************//** * @brief * The sendDGDrainCommand function constructs a DG drain command message * and queues the msg for transmit on the appropriate CAN channel. @@ -567,7 +572,7 @@ return result; } -/************************************************************************* +/*********************************************************************//** * @brief * The sendDGStartStopCommand function constructs a DG start/stop command * message and queues the msg for transmit on the appropriate CAN channel. @@ -596,7 +601,7 @@ return result; } -/************************************************************************* +/*********************************************************************//** * @brief * The sendDGStartStopTrimmerHeaterCommand function constructs a DG start/stop * trimmer heater command message and queues the msg for transmit on the @@ -626,7 +631,7 @@ return result; } -/************************************************************************* +/*********************************************************************//** * @brief * The sendDGSampleWaterCommand function constructs a DG sample water command * message and queues the msg for transmit on the appropriate CAN channel. @@ -651,7 +656,7 @@ return result; } -/************************************************************************* +/*********************************************************************//** * @brief * The broadcastAccelData function constructs an accelerometer data msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. @@ -698,8 +703,8 @@ return result; } -/************************************************************************* - * @brief broadcastAlarmStatus +/*********************************************************************//** + * @brief * The broadcastAlarmStatus function constructs an alarm status msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. * @details @@ -742,8 +747,8 @@ return result; } -/************************************************************************* - * @brief broadcastAlarmTriggered +/*********************************************************************//** + * @brief * The broadcastAlarmTriggered function constructs an alarm triggered msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. * @details @@ -777,8 +782,8 @@ return result; } -/************************************************************************* - * @brief broadcastAlarmCleared +/*********************************************************************//** + * @brief * The broadcastAlarmCleared function constructs an alarm cleared msg to be * broadcast and queues the msg for transmit on the appropriate CAN channel. * @details @@ -806,8 +811,8 @@ return result; } -/************************************************************************* - * @brief broadcastBloodFlowData +/*********************************************************************//** + * @brief * The broadcastBloodFlowData function constructs a blood flow data msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. * @details @@ -850,8 +855,8 @@ return result; } -/************************************************************************* - * @brief broadcastDialInFlowData +/*********************************************************************//** + * @brief * The broadcastDialInFlowData function constructs a dialysate flow data msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. * @details @@ -894,8 +899,8 @@ return result; } -/************************************************************************* - * @brief broadcastDialInFlowData +/*********************************************************************//** + * @brief * The broadcastDialInFlowData function constructs a dialysate outlet flow data * msg to be broadcast and queues the msg for transmit on the appropriate CAN channel. * @details @@ -923,8 +928,8 @@ return result; } -/************************************************************************* - * @brief broadcastPresOcclData +/*********************************************************************//** + * @brief * The broadcastPresOcclData function constructs a pres/occl data msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. * @details @@ -963,8 +968,8 @@ return result; } -/************************************************************************* - * @brief broadcastRTCEpoch +/*********************************************************************//** + * @brief * The broadcastRTCEpoch function constructs an epoch msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. * @details @@ -992,7 +997,7 @@ return result; } -/************************************************************************* +/*********************************************************************//** * @brief * The broadcastTreatmentTime function constructs a treatment time msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. @@ -1028,7 +1033,7 @@ return result; } -/************************************************************************* +/*********************************************************************//** * @brief * The broadcastTreatmentState function constructs a treatment state msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. @@ -1064,7 +1069,7 @@ return result; } -/************************************************************************* +/*********************************************************************//** * @brief * The broadcastPowerOffWarning function constructs a power off warning msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. @@ -1089,7 +1094,7 @@ return result; } -/************************************************************************* +/*********************************************************************//** * @brief * The broadcastHDOperationMode function constructs an HD operation mode * broadcast message and queues the msg for transmit on the appropriate CAN channel. @@ -1145,8 +1150,8 @@ // **************** Message Handling Helper Functions ******************** // *********************************************************************** -/************************************************************************* - * @brief handleDGCheckIn +/*********************************************************************//** + * @brief * The handleDGCheckIn function handles a check-in from the DG. * @details * Inputs : none @@ -1159,8 +1164,8 @@ checkInFromDG(); } -/************************************************************************* - * @brief handleUICheckIn +/*********************************************************************//** + * @brief * The handleUICheckIn function handles a check-in from the UI. * @details * Inputs : none @@ -1173,7 +1178,7 @@ checkInFromUI(); } -/************************************************************************* +/*********************************************************************//** * @brief * The handleAlarmTriggered function handles a triggered alarm event message. * @details @@ -1203,7 +1208,7 @@ } } -/************************************************************************* +/*********************************************************************//** * @brief * The handleAlarmCleared function handles a cleared alarm event message. * @details @@ -1228,8 +1233,8 @@ } } -/************************************************************************* - * @brief handleOffButtonConfirmMsgFromUI +/*********************************************************************//** + * @brief * The handleOffButtonConfirmMsgFromUI function handles a response to an * off button message to the UI. * @details @@ -1249,7 +1254,7 @@ } } -/************************************************************************* +/*********************************************************************//** * @brief * The handleLoadCellReadingsFromDG function handles a load cell readings * broadcast message from the DG. @@ -1274,7 +1279,7 @@ // TODO - how to know if DG stops sending these? } -/************************************************************************* +/*********************************************************************//** * @brief * The handleDGTemperatureData function handles a temperature readings * broadcast message from the DG. @@ -1297,7 +1302,7 @@ // TODO - how to know if DG stops sending these? } -/************************************************************************* +/*********************************************************************//** * @brief * The handleROPumpData function handles an RO pump data broadcast * message from the DG. @@ -1319,7 +1324,7 @@ // TODO - what to do if invalid payload length? } -/************************************************************************* +/*********************************************************************//** * @brief * The handleDrainPumpData function handles a drain pump broadcast * message from the DG. @@ -1341,7 +1346,7 @@ // TODO - what to do if invalid payload length? } -/************************************************************************* +/*********************************************************************//** * @brief * The handleDGPressuresData function handles a DG pressure sensor readings * broadcast message from the DG. @@ -1363,7 +1368,7 @@ // TODO - what to do if invalid payload length? } -/************************************************************************* +/*********************************************************************//** * @brief * The handleDGReservoirData function handles a reservoir data broadcast * message from the DG. @@ -1385,7 +1390,7 @@ // TODO - what to do if invalid payload length? } -/************************************************************************* +/*********************************************************************//** * @brief * The handleUFPauseResumeRequest function handles a ultrafiltration pause * or resume request message from the UI. @@ -1417,7 +1422,7 @@ sendAckResponseMsg( (MSG_ID_T)message->hdr.msgID, COMM_BUFFER_OUT_CAN_HD_2_UI, result ); } -/************************************************************************* +/*********************************************************************//** * @brief * The handleUIStartTreatmentMsg function handles a treatment start/cancel * message from the UI. @@ -1454,7 +1459,7 @@ sendAckResponseMsg( (MSG_ID_T)message->hdr.msgID, COMM_BUFFER_OUT_CAN_HD_2_UI, result ); } -/************************************************************************* +/*********************************************************************//** * @brief * The handleTreatmentParametersFromUI function handles a treatment parameters * set and validate request message from the UI. @@ -1483,7 +1488,7 @@ } } -/************************************************************************* +/*********************************************************************//** * @brief * The handleUIUserConfirmTreatmentParameters function handles a user confirmation * of treatment parameters message from the UI. @@ -1505,7 +1510,7 @@ sendAckResponseMsg( (MSG_ID_T)message->hdr.msgID, COMM_BUFFER_OUT_CAN_HD_2_UI, result ); } -/************************************************************************* +/*********************************************************************//** * @brief * The sendTreatmentParametersResponseMsg function constructs a treatment parameters * response to the UI and queues the msg for transmit on the appropriate CAN channel. @@ -1538,7 +1543,7 @@ return result; } -/************************************************************************* +/*********************************************************************//** * @brief * The handleChangeUFSettingsRequest function handles a ultrafiltration * change settings request message from the UI. @@ -1564,7 +1569,7 @@ } } -/************************************************************************* +/*********************************************************************//** * @brief * The handleChangeUFSettingsConfirmation function handles a ultrafiltration * change setting confirmation message from the UI. @@ -1590,7 +1595,7 @@ } } -/************************************************************************* +/*********************************************************************//** * @brief * The handleChangeTreatmentDurationRequest function handles a treatment * duration setting change message from the UI. @@ -1616,7 +1621,7 @@ } } -/************************************************************************* +/*********************************************************************//** * @brief * The handleChangeBloodDialysateRateChangeRequest function handles a blood * and dialysate rate settings change message from the UI. @@ -1646,7 +1651,7 @@ } } -/************************************************************************* +/*********************************************************************//** * @brief * The handleDGOpMode function handles a DG broadcast of it's current mode. * @details @@ -1675,7 +1680,7 @@ } } -/************************************************************************* +/*********************************************************************//** * @brief * The handleFWVersionRequest function handles a request for HD f/w version. * @details @@ -1765,8 +1770,8 @@ } #endif -/************************************************************************* - * @brief isTestingActivated +/*********************************************************************//** + * @brief * The isTestingActivated function determines whether a tester has successfully * logged in to activate testing functionality. * @details @@ -1779,8 +1784,8 @@ return testerLoggedIn; } -/************************************************************************* - * @brief sendTestAckResponseMsg +/*********************************************************************//** + * @brief * The sendTestAckResponseMsg function constructs a simple response * message for a handled test message and queues it for transmit on the * appropriate UART channel. @@ -1808,8 +1813,8 @@ return result; } -/************************************************************************* - * @brief handleTesterLogInRequest +/*********************************************************************//** + * @brief * The handleTesterLogInRequest function handles a request to login as a * tester. * @details @@ -1835,7 +1840,7 @@ sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, testerLoggedIn ); } -/************************************************************************* +/*********************************************************************//** * @brief * The handleTestOffButtonStateOverrideRequest function handles a request to * override the state of the off button. @@ -1869,7 +1874,7 @@ sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result ); } -/************************************************************************* +/*********************************************************************//** * @brief * The handleTestStopButtonStateOverrideRequest function handles a request to * override the stop button state. @@ -1935,8 +1940,8 @@ sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result ); } -/************************************************************************* - * @brief handleTestWatchdogCheckInStateOverrideRequest +/*********************************************************************//** + * @brief * The handleTestWatchdogCheckInStateOverrideRequest function handles a * request to override the check-in status of a given task. * @details @@ -1947,8 +1952,8 @@ *************************************************************************/ DATA_ARRAY_OVERRIDE_HANDLER_FUNC_U32( BOOL, handleTestWatchdogCheckInStateOverrideRequest, testSetWatchdogTaskCheckInOverride, testResetWatchdogTaskCheckInOverride ) -/************************************************************************* - * @brief handleTestAlarmStateOverrideRequest +/*********************************************************************//** + * @brief * The handleTestAlarmStateOverrideRequest function handles a request to * override the active status of a given alarm. * @details @@ -1959,8 +1964,8 @@ *************************************************************************/ DATA_ARRAY_OVERRIDE_HANDLER_FUNC_U32( BOOL, handleTestAlarmStateOverrideRequest, testSetAlarmStateOverride, testResetAlarmStateOverride ) -/************************************************************************* - * @brief handleTestAlarmTimeOverrideRequest +/*********************************************************************//** + * @brief * The handleTestAlarmTimeOverrideRequest function handles a request to * override the time since activation of a given alarm. * @details @@ -1971,8 +1976,8 @@ *************************************************************************/ DATA_ARRAY_OVERRIDE_HANDLER_FUNC_U32( U32, handleTestAlarmTimeOverrideRequest, testSetAlarmStartOverride, testResetAlarmStartOverride ) -/************************************************************************* - * @brief handleTestAlarmStatusBroadcastIntervalOverrideRequest +/*********************************************************************//** + * @brief * The handleTestAlarmStatusBroadcastIntervalOverrideRequest function handles a request to * override the broadcast interval for alarm status. * @details @@ -1983,8 +1988,8 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_U32( U32, handleTestAlarmStatusBroadcastIntervalOverrideRequest, testSetAlarmStatusPublishIntervalOverride, testResetAlarmStatusPublishIntervalOverride ) -/************************************************************************* - * @brief handleTestBloodFlowSetPointOverrideRequest +/*********************************************************************//** + * @brief * The handleTestBloodFlowSetPointOverrideRequest function handles a request to * override the set point for the blood flow rate (mL/min). * @details @@ -2015,8 +2020,8 @@ sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result ); } -/************************************************************************* - * @brief handleTestBloodFlowMeasuredOverrideRequest +/*********************************************************************//** + * @brief * The handleTestBloodFlowMeasuredOverrideRequest function handles a request to * override the measured blood flow rate (mL/min). * @details @@ -2027,8 +2032,8 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_F32( F32, handleTestBloodFlowMeasuredOverrideRequest, testSetMeasuredBloodFlowRateOverride, testResetMeasuredBloodFlowRateOverride ) -/************************************************************************* - * @brief handleTestBloodPumpRotorMeasuredSpeedOverrideRequest +/*********************************************************************//** + * @brief * The handleTestBloodPumpRotorMeasuredSpeedOverrideRequest function handles a request to * override the measured blood pump rotor speed (RPM). * @details @@ -2039,8 +2044,8 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_F32( F32, handleTestBloodPumpRotorMeasuredSpeedOverrideRequest, testSetMeasuredBloodPumpRotorSpeedOverride, testResetMeasuredBloodPumpRotorSpeedOverride ) -/************************************************************************* - * @brief handleTestBloodPumpMeasuredSpeedOverrideRequest +/*********************************************************************//** + * @brief * The handleTestBloodPumpMeasuredSpeedOverrideRequest function handles a request to * override the measured blood pump speed (RPM). * @details @@ -2051,8 +2056,8 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_F32( F32, handleTestBloodPumpMeasuredSpeedOverrideRequest, testSetMeasuredBloodPumpSpeedOverride, testResetMeasuredBloodPumpSpeedOverride ) -/************************************************************************* - * @brief handleTestBloodPumpMCMeasuredSpeedOverrideRequest +/*********************************************************************//** + * @brief * The handleTestBloodPumpMCMeasuredSpeedOverrideRequest function handles a request to * override the measured blood pump motor controller speed (RPM). * @details @@ -2063,8 +2068,8 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_F32( F32, handleTestBloodPumpMCMeasuredSpeedOverrideRequest, testSetMeasuredBloodPumpMCSpeedOverride, testResetMeasuredBloodPumpMCSpeedOverride ) -/************************************************************************* - * @brief handleTestBloodPumpMCMeasuredCurrentOverrideRequest +/*********************************************************************//** + * @brief * The handleTestBloodPumpMCMeasuredCurrentOverrideRequest function handles a request to * override the measured blood pump motor controller current (mA). * @details @@ -2075,8 +2080,8 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_F32( F32, handleTestBloodPumpMCMeasuredCurrentOverrideRequest, testSetMeasuredBloodPumpMCCurrentOverride, testResetMeasuredBloodPumpMCCurrentOverride ) -/************************************************************************* - * @brief handleTestBloodFlowBroadcastIntervalOverrideRequest +/*********************************************************************//** + * @brief * The handleTestBloodFlowBroadcastIntervalOverrideRequest function handles a request to * override the broadcast interval for blood flow data. * @details @@ -2087,8 +2092,8 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_U32( U32, handleTestBloodFlowBroadcastIntervalOverrideRequest, testSetBloodFlowDataPublishIntervalOverride, testResetBloodFlowDataPublishIntervalOverride ) -/************************************************************************* - * @brief handleTestDialInFlowSetPointOverrideRequest +/*********************************************************************//** + * @brief * The handleTestDialInFlowSetPointOverrideRequest function handles a request to * override the set point for the dialysate inlet flow rate (mL/min). * @details @@ -2119,7 +2124,7 @@ sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result ); } -/************************************************************************* +/*********************************************************************//** * @brief * The handleTestDialOutFlowSetPointOverrideRequest function handles a request to * override the set point for the dialysate outlet flow rate (mL/min). @@ -2151,8 +2156,8 @@ sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result ); } -/************************************************************************* - * @brief handleTestDialInFlowMeasuredOverrideRequest +/*********************************************************************//** + * @brief * The handleTestDialInFlowMeasuredOverrideRequest function handles a request to * override the measured dialysate inlet flow rate (mL/min). * @details @@ -2163,8 +2168,8 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_F32( F32, handleTestDialInFlowMeasuredOverrideRequest, testSetMeasuredDialInFlowRateOverride, testResetMeasuredDialInFlowRateOverride ) -/************************************************************************* - * @brief handleTestDialInPumpRotorMeasuredSpeedOverrideRequest +/*********************************************************************//** + * @brief * The handleTestDialInPumpRotorMeasuredSpeedOverrideRequest function handles a request to * override the measured dialysate inlet pump rotor speed (RPM). * @details @@ -2175,8 +2180,8 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_F32( F32, handleTestDialInPumpRotorMeasuredSpeedOverrideRequest, testSetMeasuredDialInPumpRotorSpeedOverride, testResetMeasuredDialInPumpRotorSpeedOverride ) -/************************************************************************* - * @brief handleTestDialInPumpMeasuredSpeedOverrideRequest +/*********************************************************************//** + * @brief * The handleTestDialInPumpMeasuredSpeedOverrideRequest function handles a request to * override the measured dialysate inlet pump speed (RPM). * @details @@ -2187,8 +2192,8 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_F32( F32, handleTestDialInPumpMeasuredSpeedOverrideRequest, testSetMeasuredDialInPumpSpeedOverride, testResetMeasuredDialInPumpSpeedOverride ) -/************************************************************************* - * @brief handleTestDialInPumpMCMeasuredSpeedOverrideRequest +/*********************************************************************//** + * @brief * The handleTestDialInPumpMCMeasuredSpeedOverrideRequest function handles a request to * override the measured dialysate inlet pump motor controller speed (RPM). * @details @@ -2199,8 +2204,8 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_F32( F32, handleTestDialInPumpMCMeasuredSpeedOverrideRequest, testSetMeasuredDialInPumpMCSpeedOverride, testResetMeasuredDialInPumpMCSpeedOverride ) -/************************************************************************* - * @brief handleTestDialInPumpMCMeasuredCurrentOverrideRequest +/*********************************************************************//** + * @brief * The handleTestDialInPumpMCMeasuredCurrentOverrideRequest function handles a request to * override the measured dialysate inlet pump motor controller current (mA). * @details @@ -2211,8 +2216,8 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_F32( F32, handleTestDialInPumpMCMeasuredCurrentOverrideRequest, testSetMeasuredDialInPumpMCCurrentOverride, testResetMeasuredDialInPumpMCCurrentOverride ) -/************************************************************************* - * @brief handleTestDialInFlowBroadcastIntervalOverrideRequest +/*********************************************************************//** + * @brief * The handleTestDialInFlowBroadcastIntervalOverrideRequest function handles a request to * override the broadcast interval for dialysate inlet flow data. * @details @@ -2223,8 +2228,8 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_U32( U32, handleTestDialInFlowBroadcastIntervalOverrideRequest, testSetDialInFlowDataPublishIntervalOverride, testResetDialInFlowDataPublishIntervalOverride ) -/************************************************************************* - * @brief handleTestArterialPressureOverrideRequest +/*********************************************************************//** + * @brief * The handleTestArterialPressureOverrideRequest function handles a request to * override the arterial pressure. * @details @@ -2235,8 +2240,8 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_F32( F32, handleTestArterialPressureOverrideRequest, testSetArterialPressureOverride, testResetArterialPressureOverride ) -/************************************************************************* - * @brief handleTestVenousPressureOverrideRequest +/*********************************************************************//** + * @brief * The handleTestVenousPressureOverrideRequest function handles a request to * override the venous pressure. * @details @@ -2247,8 +2252,8 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_F32( F32, handleTestVenousPressureOverrideRequest, testSetVenousPressureOverride, testResetVenousPressureOverride ) -/************************************************************************* - * @brief handleTestBloodPumpOcclusionOverrideRequest +/*********************************************************************//** + * @brief * The handleTestBloodPumpOcclusionOverrideRequest function handles a request to * override the blood pump occlusion sensor. * @details @@ -2259,8 +2264,8 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_F32( F32, handleTestBloodPumpOcclusionOverrideRequest, testSetBloodPumpOcclusionOverride, testResetBloodPumpOcclusionOverride ) -/************************************************************************* - * @brief handleTestDialysateInletPumpOcclusionOverrideRequest +/*********************************************************************//** + * @brief * The handleTestDialysateInletPumpOcclusionOverrideRequest function handles a request to * override the dialysate inlet pump occlusion sensor. * @details @@ -2271,8 +2276,8 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_F32( F32, handleTestDialysateInletPumpOcclusionOverrideRequest, testSetDialInPumpOcclusionOverride, testResetDialInPumpOcclusionOverride ) -/************************************************************************* - * @brief handleTestDialysateOutletPumpOcclusionOverrideRequest +/*********************************************************************//** + * @brief * The handleTestDialysateOutletPumpOcclusionOverrideRequest function handles a request to * override the dialysate outlet pump occlusion sensor. * @details @@ -2283,8 +2288,8 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_F32( F32, handleTestDialysateOutletPumpOcclusionOverrideRequest, testSetDialOutPumpOcclusionOverride, testResetDialOutPumpOcclusionOverride ) -/************************************************************************* - * @brief handleTestPresOcclBroadcastIntervalOverrideRequest +/*********************************************************************//** + * @brief * The handleTestPresOcclBroadcastIntervalOverrideRequest function handles a request to * override the broadcast interval for pressure/occlusion data. * @details @@ -2295,8 +2300,8 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_U32( U32, handleTestPresOcclBroadcastIntervalOverrideRequest, testSetPresOcclDataPublishIntervalOverride, testResetPresOcclDataPublishIntervalOverride ) -/************************************************************************* - * @brief handleSetRTCTimestamp +/*********************************************************************//** + * @brief * The handleSetRTCTimestamp function handles a request to write time and * date to RTC * @details @@ -2326,7 +2331,7 @@ sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result ); } -/************************************************************************* +/*********************************************************************//** * @brief * The handleTestDialOutFlowBroadcastIntervalOverrideRequest function handles * a request to override the broadcast interval for dialysate outlet pump data. @@ -2338,7 +2343,7 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_U32( U32, handleTestDialOutFlowBroadcastIntervalOverrideRequest, testSetDialOutPumpAndLoadCellDataPublishIntervalOverride, testResetDialOutPumpAndLoadCellDataPublishIntervalOverride ) -/************************************************************************* +/*********************************************************************//** * @brief * The handleTestDialOutUFReferenceVolumeOverrideRequest function handles a * request to override the ultrafiltration reference volume for the dialysate @@ -2351,7 +2356,7 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_F32( F32, handleTestDialOutUFReferenceVolumeOverrideRequest, testSetDialOutUFRefVolumeOverride, testResetDialOutUFRefVolumeOverride ) -/************************************************************************* +/*********************************************************************//** * @brief * The handleTestDialOutUFMeasuredVolumeOverrideRequest function handles a * request to override the ultrafiltration measured volume for the dialysate @@ -2364,7 +2369,7 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_F32( F32, handleTestDialOutUFMeasuredVolumeOverrideRequest, testSetDialOutUFTotVolumeOverride, testResetDialOutUFTotVolumeOverride ) -/************************************************************************* +/*********************************************************************//** * @brief * The handleTestDialOutPumpMCMeasuredSpeedOverrideRequest function handles a * request to override the measured motor controller speed for the dialysate @@ -2377,7 +2382,7 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_F32( F32, handleTestDialOutPumpMCMeasuredSpeedOverrideRequest, testSetMeasuredDialOutPumpMCSpeedOverride, testResetMeasuredDialOutPumpMCSpeedOverride ) -/************************************************************************* +/*********************************************************************//** * @brief * The handleTestDialOutPumpMCMeasuredCurrentOverrideRequest function handles a * request to override the measured motor controller current for the dialysate @@ -2390,7 +2395,7 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_F32( F32, handleTestDialOutPumpMCMeasuredCurrentOverrideRequest, testSetMeasuredDialOutPumpMCCurrentOverride, testResetMeasuredDialOutPumpMCCurrentOverride ) -/************************************************************************* +/*********************************************************************//** * @brief * The handleTestDialOutPumpMeasuredSpeedOverrideRequest function handles a * request to override the measured speed for the dialysate outlet pump. @@ -2402,7 +2407,7 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_F32( F32, handleTestDialOutPumpMeasuredSpeedOverrideRequest, testSetMeasuredDialOutPumpSpeedOverride, testResetMeasuredDialOutPumpSpeedOverride ) -/************************************************************************* +/*********************************************************************//** * @brief * The handleTestDialOutPumpMeasuredRotorSpeedOverrideRequest function handles a * request to override the measured rotor speed for the dialysate outlet pump. @@ -2414,7 +2419,7 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_F32( F32, handleTestDialOutPumpMeasuredRotorSpeedOverrideRequest, testSetMeasuredDialOutPumpRotorSpeedOverride, testResetMeasuredDialOutPumpRotorSpeedOverride ) -/************************************************************************* +/*********************************************************************//** * @brief * The handleTestDialOutLoadCellWeightOverrideRequest function handles a * request to override the measured load cell weight for the dialysate outlet pump. @@ -2426,7 +2431,7 @@ *************************************************************************/ DATA_ARRAY_OVERRIDE_HANDLER_FUNC_F32( F32, handleTestDialOutLoadCellWeightOverrideRequest, testSetDialOutLoadCellWeightOverride, testResetDialOutLoadCellWeightOverride ) -/************************************************************************* +/*********************************************************************//** * @brief * The handleTestHDSafetyShutdownOverrideRequest function handles a * request to override the safety shutdown signal. @@ -2438,7 +2443,7 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_U32( U32, handleTestHDSafetyShutdownOverrideRequest, testSetSafetyShutdownOverride, testResetSafetyShutdownOverride ) -/************************************************************************* +/*********************************************************************//** * @brief * The handleTestHDAccelOverrideRequest function handles a request to * override the measured accelerometer sensor readings. @@ -2450,7 +2455,7 @@ *************************************************************************/ DATA_ARRAY_OVERRIDE_HANDLER_FUNC_F32( F32, handleTestHDAccelOverrideRequest, testSetAccelAxisOverride, testResetAccelAxisOverride ) -/************************************************************************* +/*********************************************************************//** * @brief * The handleTestHDAccelMaxOverrideRequest function handles a request to * override the measured accelerometer sensor maximum readings. @@ -2462,7 +2467,7 @@ *************************************************************************/ DATA_ARRAY_OVERRIDE_HANDLER_FUNC_F32( F32, handleTestHDAccelMaxOverrideRequest, testSetAccelMaxOverride, testResetAccelMaxOverride ) -/************************************************************************* +/*********************************************************************//** * @brief * The handleTestHDAccelBroadcastIntervalOverrideRequest function handles a * request to override the broadcast interval for accelerometer data messages. @@ -2474,7 +2479,7 @@ *************************************************************************/ DATA_OVERRIDE_HANDLER_FUNC_U32( U32, handleTestHDAccelBroadcastIntervalOverrideRequest, testSetAccelDataPublishIntervalOverride, testResetAccelDataPublishIntervalOverride ) -/************************************************************************* +/*********************************************************************//** * @brief * The handleSetAccelCalibration function handles a request to set * accelerometer calibration factors. @@ -2500,7 +2505,7 @@ sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result ); } -/************************************************************************* +/*********************************************************************//** * @brief * The handleSetBloodFlowCalibration function handles a request to set * blood flow calibration factors. @@ -2526,7 +2531,7 @@ sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result ); } -/************************************************************************* +/*********************************************************************//** * @brief * The handleSetDialysateFlowCalibration function handles a request to set * dialysate flow calibration factors. @@ -2552,7 +2557,7 @@ sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result ); } -/************************************************************************* +/*********************************************************************//** * @brief * The handleSetDialysateFlowCalibration function handles a request to set * dialysate flow calibration factors. @@ -2577,3 +2582,5 @@ // respond to request sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result ); } + +/**@}*/