Index: firmware/App/Services/TxParams.c =================================================================== diff -u -rda59fa4a98dbc11c37677e92a66aa940d251678f -rad1296a077cec6ed95674cc1267a750aaf8213c4 --- firmware/App/Services/TxParams.c (.../TxParams.c) (revision da59fa4a98dbc11c37677e92a66aa940d251678f) +++ firmware/App/Services/TxParams.c (.../TxParams.c) (revision ad1296a077cec6ed95674cc1267a750aaf8213c4) @@ -181,6 +181,12 @@ static BOOL validTreatParamsReceived = FALSE; ///< Flag indicates user has provided treatment parameters. static BOOL treatParamsConfirmed = FALSE; ///< Flag indicates user has confirmed the treatment parameters. +static BOOL validTreatmentDurationReceived; ///< Flag indicates valid treatment duration was validated. +static U32 validatedTreatmentDuration_min; ///< Last validated treatment duration in minutes. +static U32 validatedHeparinDeliveryDuration_min; ///< Last validated Heparin delivery duration in minutes. +static F32 validatedUFVolumeGoalL; ///< Last validated UF volume goal in L. +static F32 validatedUFRateLhr; ///< Last validated UF rate in L/hr. +static BOOL validUFVolumeReceived; ///< Flag indicates valid UF volume was validated. // ********** private function prototypes ********** @@ -193,6 +199,12 @@ static void extractTreatmentParamsFromPayload( TREATMENT_PARAMS_DATA_RESPONSE_PAYLOAD_T payload ); //static void checkPressureParamsRange( TREATMENT_PARAMS_DATA_RESPONSE_PAYLOAD_T* txParams ); static void sendTreatmentParamsResponse( BOOL rejected, U32 *reasons ); +static BOOL isPressureLimitValueValid( U32 value, U32 minValue, U32 maxValue ); +static BOOL isArterialPressureLimitWindowValid( U32 value ); +static BOOL isVenousPressureLimitWindowValid( U32 value ); +static BOOL isVenousAsymmetricPressureLimitWindowValid( U32 value ); +static BOOL isTmpPressureLimitWindowValid( U32 value ); + //static void getInstitutionalRecordEdgeValue( TREATMENT_PARAM_T param, CRITICAL_DATAS_T* value, BOOL isMin ); /*********************************************************************//** @@ -392,7 +404,7 @@ U32 result = 1; // Validate parameter - if ( param <= NUM_OF_SYS_CONFIG_TREATMENT_PARAMS ) + if ( param < NUM_OF_SYS_CONFIG_TREATMENT_PARAMS ) { CRITICAL_DATAS_T data = getCriticalData( &sysConfigTreatmentParameters[ param ] ); @@ -422,6 +434,36 @@ /*********************************************************************//** * @brief + * The setSysConfigTreatmentParameterU32 function sets a given unsigned + * integer system configured treatment parameter. + * @details \b Alarm: ALARM_ID_TD_SOFTWARE_FAULT if invalid parameter ID is given. + * @details \b Inputs: none. + * @details \b Outputs: sysConfigTreatmentParameters[]. + * @param param ID of system configured treatment parameter to set. + * @param value unsigned integer value to set. + * @return TRUE if parameter updated successfully, FALSE otherwise. + *************************************************************************/ +BOOL setSysConfigTreatmentParameterU32( SYS_CONFIG_TREATMENT_PARAM_T param, U32 value ) +{ + BOOL result = FALSE; + + if ( param < NUM_OF_SYS_CONFIG_TREATMENT_PARAMS ) + { + CRITICAL_DATAS_T data = getCriticalData( &sysConfigTreatmentParameters[ param ] ); + + data.uInt = value; + result = setCriticalData( &sysConfigTreatmentParameters[ param ], data ); + } + else + { + SET_ALARM_WITH_2_U32_DATA( ALARM_ID_TD_SOFTWARE_FAULT, SW_FAULT_ID_MODE_TREATMENT_PARAMS_INVALID_SET_U32_PARAM, (U32)param ) + } + + return result; +} + +/*********************************************************************//** + * @brief * The validateAndSetTreatmentParameters function validates received * treatment parameters. * @details \b Message \b Sent: MSG_ID_TD_RESP_TREATMENT_PARAMS_TO_VALIDATE @@ -460,7 +502,6 @@ // Extract treatment parameters from given payload to staging array so we can more easily work with them extractTreatmentParamsFromPayload( params ); - // Range check each treatment parameter paramsAreInRange = checkTreatmentParamsInRange( &rejReasons[0] ); @@ -819,17 +860,26 @@ /*********************************************************************//** * @brief - * The resetTreatmentParameters function resets the Treatment Parameters + * The initTreatmentParameters function initializes the Treatment Parameters * session flags and parameter values. - * @details Inputs: none - * @details Outputs: validTreatParamsReceived, treatParamsConfirmed, - * treatParamsRejected cleared and parameters reset. + * @details \b Inputs: none. + * @details \b Outputs: validTreatParamsReceived, treatParamsConfirmed, + * validTreatmentDurationReceived, validatedTreatmentDuration_min, + * validatedUFVolumeGoalL, validatedUFRateLhr, + * validUFVolumeReceived, validatedHeparinDeliveryDuration_min, + * treatment parameters reset. * @return none *************************************************************************/ -void resetTreatmentParameters( void ) +void initTreatmentParameters( void ) { - validTreatParamsReceived = FALSE; - treatParamsConfirmed = FALSE; + validTreatParamsReceived = FALSE; + treatParamsConfirmed = FALSE; + validTreatmentDurationReceived = FALSE; + validatedTreatmentDuration_min = 0U; + validatedUFVolumeGoalL = 0.0F; + validatedUFRateLhr = 0.0F; + validUFVolumeReceived = FALSE; + validatedHeparinDeliveryDuration_min = 0U; resetAllTreatmentParameters(); } @@ -963,10 +1013,22 @@ *************************************************************************/ BOOL isTreatmentParamInRange( TREATMENT_PARAM_T param, CRITICAL_DATAS_T value ) { - BOOL result = TRUE; // TODO FALSE; + BOOL result = FALSE; if ( param < NUM_OF_TREATMENT_PARAMS ) { + if ( CRITICAL_DATA_TYPE_U32 == TREAT_PARAMS_PROPERTIES[ param ].dataType ) + { + result = ( ( value.uInt >= TREAT_PARAMS_PROPERTIES[ param ].min.uInt ) && + ( value.uInt <= TREAT_PARAMS_PROPERTIES[ param ].max.uInt ) ? TRUE : FALSE ); + } + else + { + result = ( ( value.sFlt >= TREAT_PARAMS_PROPERTIES[ param ].min.sFlt ) && + ( value.sFlt <= TREAT_PARAMS_PROPERTIES[ param ].max.sFlt ) ? TRUE : FALSE ); + } + } + // switch( param ) // { // case TREATMENT_PARAM_TREATMENT_MODALITY: @@ -1096,7 +1158,7 @@ // } //#endif // } - } + else { SET_ALARM_WITH_2_U32_DATA( ALARM_ID_TD_SOFTWARE_FAULT, SW_FAULT_ID_MODE_TREATMENT_PARAMS_INVALID_PARAM, (U32)param ) @@ -1405,6 +1467,831 @@ /************************************************************************* + * In-treatment treatment parameter edit function + *************************************************************************/ + + +/*********************************************************************//** + * @brief + * The validateAndSetTreatmentDuration function handles the UI treatment + * duration validation request during Treatment mode. + * @details \b Message \b Sent: MSG_ID_TD_DURATION_VALIDATE_RESPONSE including acceptance status, rejection reason, requested duration, UF volume goal (L), + * calculated UF rate (L/hr) and heparin delivery duration (minutes). + * @details \b Inputs: none. + * @details \b Outputs: validTreatmentDurationReceived, validatedTreatmentDuration_min, validatedUFRateLhr, validatedHeparinDeliveryDuration_min. + * @param message set message from UI which includes the requested treatment duration in minutes. + * @return TRUE if response message is sent successfully, FALSE otherwise. + *************************************************************************/ +BOOL validateAndSetTreatmentDuration( MESSAGE_T *message ) +{ + BOOL result = FALSE; + DURATION_VALIDATE_REQUEST_PAYLOAD_T request; + DURATION_VALIDATE_RESPONSE_PAYLOAD_T response; + + F32 presUFVolumeMl = getTreatmentParameterF32( TREATMENT_PARAM_UF_VOLUME ) * (F32)ML_PER_LITER; + F32 elapsedTreatmentTimeMin = (F32)getActualTreatmentTimeSecs() / (F32)SEC_PER_MIN; + F32 measuredUFVolumeMl = getUltrafiltrationVolumeDrawn() * (F32)ML_PER_LITER; + F32 remainingUFVolumeMl = presUFVolumeMl - measuredUFVolumeMl; + + U32 minDuration = getU32TreatmentParamLowerRangeLimit( TREATMENT_PARAM_TREATMENT_DURATION ); + U32 maxDuration = getU32TreatmentParamUpperRangeLimit( TREATMENT_PARAM_TREATMENT_DURATION ); + + U32 currentTreatmentDuration_min = getTreatmentParameterU32( TREATMENT_PARAM_TREATMENT_DURATION ); + U32 currentHeparinDuration_min = getTreatmentParameterU32( TREATMENT_PARAM_HEPARIN_DELIVERY_DURATION ); + U32 treatmentHeparinDiff_min = 0U; + + response.accepted = FALSE; + response.rejectionReason = REQUEST_REJECT_REASON_INVALID_REQUEST_FORMAT; + response.duration = 0U; + response.ufVolumeGoal = 0.0F; + response.ufRate = 0.0F; + response.heparinDuration = 0U; + + // Clear previously validated values. + validTreatmentDurationReceived = FALSE; + validatedTreatmentDuration_min = 0U; + validatedUFRateLhr = 0.0F; + validatedHeparinDeliveryDuration_min = 0U; + + if ( message->hdr.payloadLen == sizeof( DURATION_VALIDATE_REQUEST_PAYLOAD_T ) ) + { + memcpy( &request, &message->payload[ 0 ], sizeof( DURATION_VALIDATE_REQUEST_PAYLOAD_T ) ); + + response.duration = request.duration; + + if ( ( request.duration >= minDuration ) && ( request.duration <= maxDuration ) ) + { + if ( (F32)request.duration > elapsedTreatmentTimeMin ) + { + if ( remainingUFVolumeMl < 0.0F ) + { + remainingUFVolumeMl = 0.0F; + } + + F32 remainingTreatmentTimeMin = (F32)request.duration - elapsedTreatmentTimeMin; + + // Calculate new UF rate (mL/min). + F32 newUfRateMlMin = remainingUFVolumeMl / remainingTreatmentTimeMin; + + // Convert UF values for UI response. + response.ufVolumeGoal = presUFVolumeMl / (F32)ML_PER_LITER; + response.ufRate = ( newUfRateMlMin * (F32)MIN_PER_HOUR ) / (F32)ML_PER_LITER; + + if ( newUfRateMlMin <= MAX_UF_RATE_ML_MIN ) + { + // Adjust Heparin delivery duration to maintain the previous difference from treatment duration. + if ( currentTreatmentDuration_min > currentHeparinDuration_min ) + { + treatmentHeparinDiff_min = currentTreatmentDuration_min - currentHeparinDuration_min; + } + + if ( response.duration > treatmentHeparinDiff_min ) + { + validatedHeparinDeliveryDuration_min = response.duration - treatmentHeparinDiff_min; + } + else + { + validatedHeparinDeliveryDuration_min = 0U; + } + + response.heparinDuration = validatedHeparinDeliveryDuration_min; + response.accepted = TRUE; + response.rejectionReason = REQUEST_REJECT_REASON_NONE; + + // Store validated values for confirmation step. + validTreatmentDurationReceived = TRUE; + validatedTreatmentDuration_min = response.duration; + validatedUFRateLhr = response.ufRate; + validatedHeparinDeliveryDuration_min = response.heparinDuration; + } + else + { + response.rejectionReason = REQUEST_REJECT_REASON_UF_RATE_OUT_OF_RANGE; + } + } + else + { + response.rejectionReason = REQUEST_REJECT_REASON_TREATMENT_TIME_LESS_THAN_CURRENT; + } + } + else + { + response.rejectionReason = REQUEST_REJECT_REASON_TREATMENT_TIME_OUT_OF_RANGE; + } + } + + result = sendMessage( MSG_ID_TD_DURATION_VALIDATE_RESPONSE, COMM_BUFFER_OUT_CAN_TD_2_UI, (U08 *)&response, sizeof( DURATION_VALIDATE_RESPONSE_PAYLOAD_T ) ); + + return result; +} + +/*********************************************************************//** + * @brief + * The validateAndSetBolusVolume function handles the UI fluid bolus volume + * change request during Treatment mode. + * @details \b Message \b Sent: MSG_ID_TD_BOLUS_VOLUME_CHANGE_RESPONSE including acceptance status and rejection reason. + * @details \b Inputs: none. + * @details \b Outputs: none. + * @param message set message from UI which includes the requested bolus volume. + * @return TRUE if response message is sent successfully, FALSE otherwise. + *************************************************************************/ +BOOL validateAndSetBolusVolume( MESSAGE_T *message ) +{ + BOOL result = FALSE; + BOLUS_VOLUME_CHANGE_REQUEST_PAYLOAD_T request; + UI_RESPONSE_PAYLOAD_T response; + U32 minBolusVolume_mL = getU32TreatmentParamLowerRangeLimit( TREATMENT_PARAM_FLUID_BOLUS_VOLUME ); + U32 maxBolusVolume_mL = getU32TreatmentParamUpperRangeLimit( TREATMENT_PARAM_FLUID_BOLUS_VOLUME ); + + response.accepted = FALSE; + response.rejectionReason = REQUEST_REJECT_REASON_INVALID_REQUEST_FORMAT; + + if ( message->hdr.payloadLen == sizeof( BOLUS_VOLUME_CHANGE_REQUEST_PAYLOAD_T ) ) + { + memcpy( &request, &message->payload[ 0 ], sizeof( BOLUS_VOLUME_CHANGE_REQUEST_PAYLOAD_T ) ); + + if ( ( request.bolusVolume >= minBolusVolume_mL ) && + ( request.bolusVolume <= maxBolusVolume_mL ) ) + { + response.accepted = TRUE; + response.rejectionReason = REQUEST_REJECT_REASON_NONE; + + setTreatmentParameterU32( TREATMENT_PARAM_FLUID_BOLUS_VOLUME, request.bolusVolume ); + } + else + { + response.rejectionReason = REQUEST_REJECT_REASON_PARAM_OUT_OF_RANGE; + } + } + + result = sendMessage( MSG_ID_TD_BOLUS_VOLUME_CHANGE_RESPONSE, COMM_BUFFER_OUT_CAN_TD_2_UI, (U08 *)&response, sizeof( UI_RESPONSE_PAYLOAD_T ) ); + + return result; +} + +/*********************************************************************//** + * @brief + * The pressureLimitHandleChangeRequest function handles the UI pressure + * limit change request during Treatment mode. + * @details \b Message \b Sent: MSG_ID_TD_PRESSURE_LIMITS_CHANGE_RESPONSE including acceptance status and per-parameter rejection reasons. + * @details \b Inputs: none. + * @details \b Outputs: none. + * @param message set message from UI which includes the requested pressure limit windows. + * @return TRUE if response message is sent successfully, FALSE otherwise. + *************************************************************************/ +BOOL pressureLimitHandleChangeRequest( MESSAGE_T *message ) +{ + BOOL result = FALSE; + BOOL accepted = FALSE; + + PRESSURE_LIMIT_CHANGE_REQUEST_T request; + PRESSURE_LIMITS_CHANGE_RESPONSE_PAYLOAD_T response; + + memset( &request, 0, sizeof( request ) ); + memset( &response, 0, sizeof( response ) ); + + response.arterialPressureLimitWindowRejectionReason = REQUEST_REJECT_REASON_INVALID_REQUEST_FORMAT; + response.venousPressureLimitWindowRejectionReason = REQUEST_REJECT_REASON_INVALID_REQUEST_FORMAT; + response.venousAsymmetricPressureLimitWindowRejectionReason = REQUEST_REJECT_REASON_INVALID_REQUEST_FORMAT; + response.tmpPressureLimitWindowRejectionReason = REQUEST_REJECT_REASON_INVALID_REQUEST_FORMAT; + + if ( message->hdr.payloadLen == sizeof( PRESSURE_LIMIT_CHANGE_REQUEST_T ) ) + { + memcpy( &request, &message->payload[ 0 ], sizeof( PRESSURE_LIMIT_CHANGE_REQUEST_T ) ); + + response.arterialPressureLimitWindowRejectionReason = REQUEST_REJECT_REASON_NONE; + response.venousPressureLimitWindowRejectionReason = REQUEST_REJECT_REASON_NONE; + response.venousAsymmetricPressureLimitWindowRejectionReason = REQUEST_REJECT_REASON_NONE; + response.tmpPressureLimitWindowRejectionReason = REQUEST_REJECT_REASON_NONE; + + if ( FALSE == isArterialPressureLimitWindowValid( request.arterialPressureLimitWindowMMHG ) ) + { + response.arterialPressureLimitWindowRejectionReason = REQUEST_REJECT_REASON_PARAM_OUT_OF_RANGE; + } + + if ( FALSE == isVenousPressureLimitWindowValid( request.venousPressureLimitWindowMMHG ) ) + { + response.venousPressureLimitWindowRejectionReason = REQUEST_REJECT_REASON_PARAM_OUT_OF_RANGE; + } + + if ( FALSE == isVenousAsymmetricPressureLimitWindowValid( request.venousAsymmetricPressureLimitWindowMMHG ) ) + { + response.venousAsymmetricPressureLimitWindowRejectionReason = REQUEST_REJECT_REASON_PARAM_OUT_OF_RANGE; + } + + if ( FALSE == isTmpPressureLimitWindowValid( request.tmpPressureLimitWindowMMHG ) ) + { + response.tmpPressureLimitWindowRejectionReason = REQUEST_REJECT_REASON_PARAM_OUT_OF_RANGE; + } + + // Accept request only when all pressure limit values are valid. + accepted = ( REQUEST_REJECT_REASON_NONE == response.arterialPressureLimitWindowRejectionReason ) && + ( REQUEST_REJECT_REASON_NONE == response.venousPressureLimitWindowRejectionReason ) && + ( REQUEST_REJECT_REASON_NONE == response.venousAsymmetricPressureLimitWindowRejectionReason ) && + ( REQUEST_REJECT_REASON_NONE == response.tmpPressureLimitWindowRejectionReason ); + + if ( TRUE == accepted ) + { + setSysConfigTreatmentParameterU32( TREATMENT_PARAM_ART_PRES_LIMIT_WINDOW, request.arterialPressureLimitWindowMMHG ); + + setSysConfigTreatmentParameterU32( TREATMENT_PARAM_VEN_PRES_LIMIT_WINDOW, request.venousPressureLimitWindowMMHG ); + + setSysConfigTreatmentParameterU32( TREATMENT_PARAM_VEN_PRES_LIMIT_ASYMMETRIC, request.venousAsymmetricPressureLimitWindowMMHG ); + + setSysConfigTreatmentParameterU32( TREATMENT_PARAM_TMP_PRES_LIMIT_WINDOW, request.tmpPressureLimitWindowMMHG ); + + updatePressureLimitWindows(); + } + } + + response.accepted = accepted; + + result = sendMessage( MSG_ID_TD_PRESSURE_LIMITS_CHANGE_RESPONSE, COMM_BUFFER_OUT_CAN_TD_2_UI, (U08 *)&response, sizeof( PRESSURE_LIMITS_CHANGE_RESPONSE_PAYLOAD_T ) ); + + return result; +} + +/*********************************************************************//** + * @brief + * The isPressureLimitValueValid function checks whether a pressure limit + * value is within the specified range. + * @details \b Inputs: none. + * @details \b Outputs: none. + * @param value pressure limit value to validate. + * @param minValue minimum allowable pressure limit value. + * @param maxValue maximum allowable pressure limit value. + * @return TRUE if value is valid, FALSE otherwise. + *************************************************************************/ +static BOOL isPressureLimitValueValid( U32 value, U32 minValue, U32 maxValue ) +{ + return ( ( value >= minValue ) && ( value <= maxValue ) ); +} + +/*********************************************************************//** + * @brief + * The isArterialPressureLimitWindowValid function validates the arterial + * pressure limit window value. + * @details \b Inputs: none. + * @details \b Outputs: none. + * @param value arterial pressure limit window value (mmHg). + * @return TRUE if the value is within valid range, FALSE otherwise. + *************************************************************************/ +static BOOL isArterialPressureLimitWindowValid( U32 value ) +{ + BOOL pressureValid; + + pressureValid = isPressureLimitValueValid( + value, + getU32SysConfigTreatmentParamLowerRangeLimit( TREATMENT_PARAM_ART_PRES_LIMIT_WINDOW ), + getU32SysConfigTreatmentParamUpperRangeLimit( TREATMENT_PARAM_ART_PRES_LIMIT_WINDOW ) ); + + return pressureValid; +} + +/*********************************************************************//** + * @brief + * The isVenousPressureLimitWindowValid function validates the venous + * pressure limit window value. + * @details \b Inputs: none. + * @details \b Outputs: none. + * @param value venous pressure limit window value (mmHg). + * @return TRUE if the value is within valid range, FALSE otherwise. + *************************************************************************/ +static BOOL isVenousPressureLimitWindowValid( U32 value ) +{ + BOOL pressureValid; + + pressureValid = isPressureLimitValueValid( + value, + getU32SysConfigTreatmentParamLowerRangeLimit( TREATMENT_PARAM_VEN_PRES_LIMIT_WINDOW ), + getU32SysConfigTreatmentParamUpperRangeLimit( TREATMENT_PARAM_VEN_PRES_LIMIT_WINDOW ) ); + + return pressureValid; +} + +/*********************************************************************//** + * @brief + * The isVenousAsymmetricPressureLimitWindowValid function validates the + * venous asymmetric pressure limit window value. + * @details \b Inputs: none. + * @details \b Outputs: none. + * @param value venous asymmetric pressure limit window value (mmHg). + * @return TRUE if the value is within valid range, FALSE otherwise. + *************************************************************************/ +static BOOL isVenousAsymmetricPressureLimitWindowValid( U32 value ) +{ + BOOL pressureValid; + + pressureValid = isPressureLimitValueValid( + value, + getU32SysConfigTreatmentParamLowerRangeLimit( TREATMENT_PARAM_VEN_PRES_LIMIT_ASYMMETRIC ), + getU32SysConfigTreatmentParamUpperRangeLimit( TREATMENT_PARAM_VEN_PRES_LIMIT_ASYMMETRIC ) ); + + return pressureValid; +} + +/*********************************************************************//** + * @brief + * The isTmpPressureLimitWindowValid function validates the TMP pressure + * limit window value. + * @details \b Inputs: none. + * @details \b Outputs: none. + * @param value TMP pressure limit window value (mmHg). + * @return TRUE if the value is within valid range, FALSE otherwise. + *************************************************************************/ +static BOOL isTmpPressureLimitWindowValid( U32 value ) +{ + BOOL pressureValid; + + pressureValid = isPressureLimitValueValid( + value, + getU32SysConfigTreatmentParamLowerRangeLimit( TREATMENT_PARAM_TMP_PRES_LIMIT_WINDOW ), + getU32SysConfigTreatmentParamUpperRangeLimit( TREATMENT_PARAM_TMP_PRES_LIMIT_WINDOW ) ); + + return pressureValid; +} + +/*********************************************************************//** + * @brief + * The validateAndSetUFVolume function handles the UI ultrafiltration + * volume validation request during Treatment mode. + * @details \b Message \b Sent: MSG_ID_TD_RESP_ULTRAFILTRATION_VOLUME_TO_VALIDATE including acceptance status, rejection reason, UF volume goal (L), and UF rate (L/hr). + * @details \b Inputs: none. + * @details \b Outputs: validUFVolumeReceived, validatedUFVolumeGoalL, validatedUFRateLhr. + * @param message set message from UI which includes the requested UF volume in L. + * @return TRUE if response message is sent successfully, FALSE otherwise. + *************************************************************************/ +BOOL validateAndSetUFVolume( MESSAGE_T *message ) +{ + BOOL result = FALSE; + UF_VOLUME_VALIDATE_REQUEST_PAYLOAD_T request; + UF_VOLUME_RESPONSE_PAYLOAD_T response; + + F32 elapsedTreatmentTimeMin = (F32)getActualTreatmentTimeSecs() / (F32)SEC_PER_MIN; + F32 measuredUFVolumeMl = getUltrafiltrationVolumeDrawn() * (F32)ML_PER_LITER; + F32 treatmentDurationMin = (F32)getTreatmentParameterU32( TREATMENT_PARAM_TREATMENT_DURATION ); + F32 requestedUFVolumeMl = 0.0F; + F32 requestedUFVolumeL = 0.0F; + F32 remainingUFVolumeMl = 0.0F; + F32 remainingTreatmentTimeMin = 0.0F; + F32 newUfRateMlMin = 0.0F; + F32 minUFVolumeL = getF32TreatmentParamLowerRangeLimit( TREATMENT_PARAM_UF_VOLUME ); + F32 maxUFVolumeL = getF32TreatmentParamUpperRangeLimit( TREATMENT_PARAM_UF_VOLUME ); + + response.accepted = FALSE; + response.rejectionReason = REQUEST_REJECT_REASON_INVALID_REQUEST_FORMAT; + response.ufVolumeGoal = 0.0F; + response.ufRate = 0.0F; + + // Clear previously validated values. + validUFVolumeReceived = FALSE; + validatedUFVolumeGoalL = 0.0F; + validatedUFRateLhr = 0.0F; + + if ( message->hdr.payloadLen == sizeof( UF_VOLUME_VALIDATE_REQUEST_PAYLOAD_T ) ) + { + memcpy( &request, &message->payload[ 0 ], sizeof( UF_VOLUME_VALIDATE_REQUEST_PAYLOAD_T ) ); + + // Convert requested UF volume from L to mL for firmware calculations. + requestedUFVolumeL = request.ufVolume; + requestedUFVolumeMl = requestedUFVolumeL * (F32)ML_PER_LITER; + + // Send UF volume to UI in L. + response.ufVolumeGoal = requestedUFVolumeL; + + if ( ( requestedUFVolumeL >= minUFVolumeL ) && ( requestedUFVolumeL <= maxUFVolumeL ) ) + { + if ( requestedUFVolumeMl > measuredUFVolumeMl ) + { + if ( treatmentDurationMin > elapsedTreatmentTimeMin ) + { + remainingUFVolumeMl = requestedUFVolumeMl - measuredUFVolumeMl; + remainingTreatmentTimeMin = treatmentDurationMin - elapsedTreatmentTimeMin; + + // Calculate new UF rate in mL/min. + newUfRateMlMin = remainingUFVolumeMl / remainingTreatmentTimeMin; + + response.ufRate = ( newUfRateMlMin * (F32)MIN_PER_HOUR ) / (F32)ML_PER_LITER; + + if ( newUfRateMlMin <= MAX_UF_RATE_ML_MIN ) + { + response.accepted = TRUE; + response.rejectionReason = REQUEST_REJECT_REASON_NONE; + + // Store validated values for confirmation step. + validUFVolumeReceived = TRUE; + validatedUFVolumeGoalL = response.ufVolumeGoal; + validatedUFRateLhr = response.ufRate; + } + else + { + response.rejectionReason = REQUEST_REJECT_REASON_UF_RATE_OUT_OF_RANGE; + } + } + else + { + response.rejectionReason = REQUEST_REJECT_REASON_TREATMENT_TIME_LESS_THAN_CURRENT; + } + } + else + { + response.rejectionReason = REQUEST_REJECT_REASON_UF_VOLUME_OUT_OF_RANGE; + } + } + else + { + response.rejectionReason = REQUEST_REJECT_REASON_UF_VOLUME_OUT_OF_RANGE; + } + } + + result = sendMessage( MSG_ID_TD_TREATMENT_UF_VOLUME_VALIDATE_RESPONSE, COMM_BUFFER_OUT_CAN_TD_2_UI, (U08 *)&response, sizeof( UF_VOLUME_RESPONSE_PAYLOAD_T ) ); + + return result; +} + +/*********************************************************************//** + * @brief + * The validateAndSetTreatmentSetPoints function handles a UI treatment + * set point change request during Treatment mode. + * @details \b Message \b Sent: MSG_ID_TD_TREATMENT_SET_POINTS_CHANGE_RESPONSE including acceptance status and rejection reason for each treatment set point parameter. + * @details \b Inputs: none. + * @details \b Outputs: none. + * @param message set message from UI which includes the requested treatment set point values. + * @return TRUE if response message is sent successfully, FALSE otherwise. + *************************************************************************/ +BOOL validateAndSetTreatmentSetPoints( MESSAGE_T *message ) +{ + BOOL result = FALSE; + BOOL isValid = TRUE; + CRITICAL_DATAS_T requestedValue; + TREATMENT_PARAMETER_EDIT_REQUEST_T request; + TREATMENT_SET_POINTS_CHANGE_RESPONSE_T response; + + memset( &requestedValue, 0, sizeof( requestedValue ) ); + memset( &request, 0, sizeof( request ) ); + memset( &response, 0, sizeof( response ) ); + + if ( message->hdr.payloadLen == sizeof( request ) ) + { + memcpy( &request, message->payload, sizeof( TREATMENT_PARAMETER_EDIT_REQUEST_T ) ); + + requestedValue.uInt = request.treatmentModality; + if ( FALSE == isTreatmentParamInRange( TREATMENT_PARAM_TREATMENT_MODALITY, requestedValue ) ) + { + response.rejectionReason[ TREATMENT_SETPOINT_TREATMENT_MODALITY ] = REQUEST_REJECT_REASON_PARAM_OUT_OF_RANGE; + isValid = FALSE; + } + + requestedValue.uInt = request.bloodFlowRate; + if ( FALSE == isTreatmentParamInRange( TREATMENT_PARAM_BLOOD_FLOW, requestedValue ) ) + { + response.rejectionReason[ TREATMENT_SETPOINT_BLOOD_FLOW ] = REQUEST_REJECT_REASON_PARAM_OUT_OF_RANGE; + isValid = FALSE; + } + + requestedValue.uInt = request.dialysateFlowRate; + if ( FALSE == isTreatmentParamInRange( TREATMENT_PARAM_DIALYSATE_FLOW, requestedValue ) ) + { + response.rejectionReason[ TREATMENT_SETPOINT_DIALYSATE_FLOW ] = REQUEST_REJECT_REASON_PARAM_OUT_OF_RANGE; + isValid = FALSE; + } + + requestedValue.sFlt = request.dialysateTemperature; + if ( FALSE == isTreatmentParamInRange( TREATMENT_PARAM_DIALYSATE_TEMPERATURE, requestedValue ) ) + { + response.rejectionReason[ TREATMENT_SETPOINT_DIALYSATE_TEMPERATURE ] = REQUEST_REJECT_REASON_PARAM_OUT_OF_RANGE; + isValid = FALSE; + } + + requestedValue.uInt = request.hepatitis; + if ( FALSE == isTreatmentParamInRange( TREATMENT_PARAM_HEPATITIS_B, requestedValue ) ) + { + response.rejectionReason[ TREATMENT_SETPOINT_HEPATITIS_STATUS ] = REQUEST_REJECT_REASON_PARAM_OUT_OF_RANGE; + isValid = FALSE; + } + + requestedValue.uInt = request.acidConcentrate; + if ( FALSE == isTreatmentParamInRange( TREATMENT_PARAM_ACID_CONCENTRATE, requestedValue ) ) + { + response.rejectionReason[ TREATMENT_SETPOINT_ACID_CONCENTRATE ] = REQUEST_REJECT_REASON_PARAM_OUT_OF_RANGE; + isValid = FALSE; + } + + requestedValue.sFlt = request.acidConcentrateConversionFactor; + if ( FALSE == isTreatmentParamInRange( TREATMENT_PARAM_ACID_CONCENTRATE_CONV_FACTOR, requestedValue ) ) + { + response.rejectionReason[ TREATMENT_SETPOINT_ACID_CONVERSION_FACTOR ] = REQUEST_REJECT_REASON_PARAM_OUT_OF_RANGE; + isValid = FALSE; + } + + requestedValue.uInt = request.bicarbonateConcentrate; + if ( FALSE == isTreatmentParamInRange( TREATMENT_PARAM_DRY_BICARB_CART_SIZE, requestedValue ) ) + { + response.rejectionReason[ TREATMENT_SETPOINT_BICARB_CONCENTRATE ] = REQUEST_REJECT_REASON_PARAM_OUT_OF_RANGE; + isValid = FALSE; + } + + requestedValue.uInt = request.sodium; + if ( FALSE == isTreatmentParamInRange( TREATMENT_PARAM_SODIUM, requestedValue ) ) + { + response.rejectionReason[ TREATMENT_SETPOINT_SODIUM ] = REQUEST_REJECT_REASON_PARAM_OUT_OF_RANGE; + isValid = FALSE; + } + + requestedValue.uInt = request.bicarbonate; + if ( FALSE == isTreatmentParamInRange( TREATMENT_PARAM_BICARBONATE, requestedValue ) ) + { + response.rejectionReason[ TREATMENT_SETPOINT_BICARBONATE ] = REQUEST_REJECT_REASON_PARAM_OUT_OF_RANGE; + isValid = FALSE; + } + + if ( TRUE == isValid ) + { + setTreatmentParameterU32( TREATMENT_PARAM_TREATMENT_MODALITY, request.treatmentModality ); + setTreatmentParameterU32( TREATMENT_PARAM_BLOOD_FLOW, request.bloodFlowRate ); + setTreatmentParameterU32( TREATMENT_PARAM_DIALYSATE_FLOW, request.dialysateFlowRate ); + setTreatmentParameterF32( TREATMENT_PARAM_DIALYSATE_TEMPERATURE, request.dialysateTemperature ); + setTreatmentParameterU32( TREATMENT_PARAM_HEPATITIS_B, request.hepatitis ); + setTreatmentParameterU32( TREATMENT_PARAM_ACID_CONCENTRATE, request.acidConcentrate ); + setTreatmentParameterF32( TREATMENT_PARAM_ACID_CONCENTRATE_CONV_FACTOR, request.acidConcentrateConversionFactor ); + setTreatmentParameterU32( TREATMENT_PARAM_DRY_BICARB_CART_SIZE, request.bicarbonateConcentrate ); + setTreatmentParameterU32( TREATMENT_PARAM_SODIUM, request.sodium ); + setTreatmentParameterU32( TREATMENT_PARAM_BICARBONATE, request.bicarbonate ); + + response.accepted = TRUE; + } + } + else + { + response.rejectionReason[ TREATMENT_SETPOINT_BLOOD_FLOW ] = REQUEST_REJECT_REASON_INVALID_REQUEST_FORMAT; + } + + result = sendMessage( MSG_ID_TD_TREATMENT_SET_POINTS_CHANGE_RESPONSE, COMM_BUFFER_OUT_CAN_TD_2_UI, (U08 *)&response, sizeof( TREATMENT_SET_POINTS_CHANGE_RESPONSE_T ) ); + + return result; +} + +/*********************************************************************//** + * @brief + * The validateAndSetBloodFlowRate function handles a UI treatment set point blood flow rate change request during Treatment mode. + * @details \b Message \b Sent: MSG_ID_TD_TREATMENT_SET_POINT_BLOOD_FLOW_CHANGE_RESPONSE including acceptance status and rejection reason. + * @details \b Inputs: none. + * @details \b Outputs: none. + * @param message set message from UI which includes the requested blood flow rate. + * @return TRUE if response message is sent successfully, FALSE otherwise. + *************************************************************************/ +BOOL validateAndSetBloodFlowRate( MESSAGE_T *message ) +{ + BOOL result = FALSE; + CRITICAL_DATAS_T requestedValue; + BLOOD_FLOW_RATE_CHANGE_REQUEST_PAYLOAD_T request; + UI_RESPONSE_PAYLOAD_T response; + + memset( &requestedValue, 0, sizeof( requestedValue ) ); + memset( &request, 0, sizeof( request ) ); + memset( &response, 0, sizeof( response ) ); + + response.rejectionReason = REQUEST_REJECT_REASON_INVALID_REQUEST_FORMAT; + + if ( message->hdr.payloadLen == sizeof( BLOOD_FLOW_RATE_CHANGE_REQUEST_PAYLOAD_T ) ) + { + memcpy( &request, &message->payload[ 0 ], sizeof( BLOOD_FLOW_RATE_CHANGE_REQUEST_PAYLOAD_T ) ); + + requestedValue.uInt = request.flowRate; + + if ( TRUE == isTreatmentParamInRange( TREATMENT_PARAM_BLOOD_FLOW, requestedValue ) ) + { + setTreatmentParameterU32( TREATMENT_PARAM_BLOOD_FLOW, request.flowRate ); + setDialysisBloodPumpFlowRate( request.flowRate ); + + response.accepted = TRUE; + response.rejectionReason = REQUEST_REJECT_REASON_NONE; + } + else + { + response.rejectionReason = REQUEST_REJECT_REASON_PARAM_OUT_OF_RANGE; + } + } + + result = sendMessage( MSG_ID_TD_TREATMENT_SET_POINT_BLOOD_FLOW_CHANGE_RESPONSE, COMM_BUFFER_OUT_CAN_TD_2_UI, (U08 *)&response, sizeof( UI_RESPONSE_PAYLOAD_T ) ); + + return result; +} + +/*********************************************************************//** + * @brief + * The validateAndSetDialysateFlowRate function handles a UI treatment set point + * dialysate flow rate change request during Treatment mode. + * @details \b Message \b Sent: MSG_ID_TD_TREATMENT_SET_POINT_DIALYSATE_FLOW_CHANGE_RESPONSE including acceptance status and rejection reason. + * @details \b Inputs: none. + * @details \b Outputs: none. + * @param message set message from UI which includes the requested dialysate flow rate. + * @return TRUE if response message is sent successfully, FALSE otherwise. + *************************************************************************/ +BOOL validateAndSetDialysateFlowRate( MESSAGE_T *message ) +{ + BOOL result = FALSE; + CRITICAL_DATAS_T requestedValue; + DIALYSATE_FLOW_RATE_CHANGE_REQUEST_PAYLOAD_T request; + UI_RESPONSE_PAYLOAD_T response; + + memset( &requestedValue, 0, sizeof( requestedValue ) ); + memset( &request, 0, sizeof( request ) ); + memset( &response, 0, sizeof( response ) ); + + response.rejectionReason = REQUEST_REJECT_REASON_INVALID_REQUEST_FORMAT; + + if ( message->hdr.payloadLen == sizeof( DIALYSATE_FLOW_RATE_CHANGE_REQUEST_PAYLOAD_T ) ) + { + memcpy( &request, &message->payload[ 0 ], sizeof( DIALYSATE_FLOW_RATE_CHANGE_REQUEST_PAYLOAD_T ) ); + + requestedValue.uInt = request.flowRate; + + if ( TRUE == isTreatmentParamInRange( TREATMENT_PARAM_DIALYSATE_FLOW, requestedValue ) ) + { + setTreatmentParameterU32( TREATMENT_PARAM_DIALYSATE_FLOW, request.flowRate ); + + response.accepted = TRUE; + response.rejectionReason = REQUEST_REJECT_REASON_NONE; + } + else + { + response.rejectionReason = REQUEST_REJECT_REASON_PARAM_OUT_OF_RANGE; + } + } + + result = sendMessage( MSG_ID_TD_TREATMENT_SET_POINT_DIALYSATE_FLOW_CHANGE_RESPONSE, COMM_BUFFER_OUT_CAN_TD_2_UI, (U08 *)&response, sizeof( UI_RESPONSE_PAYLOAD_T ) ); + + return result; +} + +/*********************************************************************//** + * @brief + * The validateAndSetDialysateTemperature function handles a UI treatment + * set point dialysate temperature change request during Treatment mode. + * @details \b Message \b Sent: MSG_ID_TD_TREATMENT_SET_POINT_DIALYSATE_TEMPERATURE_CHANGE_RESPONSE including acceptance status and rejection reason. + * @details \b Inputs: none. + * @details \b Outputs: none. + * @param message set message from UI which includes the requested dialysate temperature. + * @return TRUE if response message is sent successfully, FALSE otherwise. + *************************************************************************/ +BOOL validateAndSetDialysateTemperature( MESSAGE_T *message ) +{ + BOOL result = FALSE; + CRITICAL_DATAS_T requestedValue; + DIALYSATE_TEMPERATURE_CHANGE_REQUEST_PAYLOAD_T request; + UI_RESPONSE_PAYLOAD_T response; + + memset( &requestedValue, 0, sizeof( requestedValue ) ); + memset( &request, 0, sizeof( request ) ); + memset( &response, 0, sizeof( response ) ); + + response.rejectionReason = REQUEST_REJECT_REASON_INVALID_REQUEST_FORMAT; + + if ( message->hdr.payloadLen == sizeof( DIALYSATE_TEMPERATURE_CHANGE_REQUEST_PAYLOAD_T ) ) + { + memcpy( &request, &message->payload[ 0 ], sizeof( DIALYSATE_TEMPERATURE_CHANGE_REQUEST_PAYLOAD_T ) ); + + requestedValue.sFlt = request.temperature; + + if ( TRUE == isTreatmentParamInRange( TREATMENT_PARAM_DIALYSATE_TEMPERATURE, requestedValue ) ) + { + setTreatmentParameterF32( TREATMENT_PARAM_DIALYSATE_TEMPERATURE, request.temperature ); + + response.accepted = TRUE; + response.rejectionReason = REQUEST_REJECT_REASON_NONE; + } + else + { + response.rejectionReason = REQUEST_REJECT_REASON_PARAM_OUT_OF_RANGE; + } + } + + result = sendMessage( MSG_ID_TD_TREATMENT_SET_POINT_DIALYSATE_TEMP_CHANGE_RESPONSE, COMM_BUFFER_OUT_CAN_TD_2_UI, (U08 *)&response, sizeof( UI_RESPONSE_PAYLOAD_T ) ); + + return result; +} + +/*********************************************************************//** + * @brief + * The signalUserConfirmationOfTreatmentDuration function handles the UI + * treatment duration confirmation request during Treatment mode. + * @details \b Message \b Sent: MSG_ID_TD_DURATION_CONFIRM_RESPONSE including acceptance status and rejection reason. + * @details \b Inputs: validTreatmentDurationReceived, validatedTreatmentDuration_min, validatedUFRateLhr, validatedHeparinDeliveryDuration_min. + * @details \b Outputs: validTreatmentDurationReceived, validatedTreatmentDuration_min, validatedUFRateLhr, validatedHeparinDeliveryDuration_min. + * @param message set message from UI which includes the confirmed treatment duration, UF rate and heparin delivery duration. + * @return TRUE if response message is sent successfully, FALSE otherwise. + *************************************************************************/ +BOOL signalUserConfirmationOfTreatmentDuration( MESSAGE_T *message ) +{ + BOOL result = FALSE; + DURATION_CONFIRM_REQUEST_PAYLOAD_T request; + UI_RESPONSE_PAYLOAD_T response; + F32 presUFVolumeMl = getTreatmentParameterF32( TREATMENT_PARAM_UF_VOLUME ) * (F32)ML_PER_LITER; + F32 validatedUFRateMlMin = ( validatedUFRateLhr * (F32)ML_PER_LITER ) / (F32)MIN_PER_HOUR; + + response.accepted = FALSE; + response.rejectionReason = REQUEST_REJECT_REASON_INVALID_REQUEST_FORMAT; + + if ( message->hdr.payloadLen == sizeof( DURATION_CONFIRM_REQUEST_PAYLOAD_T ) ) + { + memcpy( &request, &message->payload[ 0 ], sizeof( DURATION_CONFIRM_REQUEST_PAYLOAD_T ) ); + + // Verify confirmed duration and UF rate match previously validated values. + if ( ( TRUE == validTreatmentDurationReceived ) && ( request.duration == validatedTreatmentDuration_min ) && + ( fabs( request.ufRate - validatedUFRateLhr ) < NEARLY_ZERO ) && + ( request.heparinDuration == validatedHeparinDeliveryDuration_min ) ) + { + setTreatmentParameterU32( TREATMENT_PARAM_TREATMENT_DURATION, validatedTreatmentDuration_min ); + setTreatmentParameterU32( TREATMENT_PARAM_HEPARIN_DELIVERY_DURATION, validatedHeparinDeliveryDuration_min ); + updateTreatmentBroadcastData(); + setDialysisDDParams( getTreatmentParameterU32( TREATMENT_PARAM_DIALYSATE_FLOW ), presUFVolumeMl, validatedUFRateMlMin ); + + response.accepted = TRUE; + response.rejectionReason = REQUEST_REJECT_REASON_NONE; + + // Clear stored validated values. + validTreatmentDurationReceived = FALSE; + validatedTreatmentDuration_min = 0U; + validatedUFRateLhr = 0.0F; + validatedHeparinDeliveryDuration_min = 0U; + } + else if ( FALSE == validTreatmentDurationReceived ) + { + response.rejectionReason = REQUEST_REJECT_REASON_CONFIRMATION_NOT_EXPECTED; + } + else + { + response.rejectionReason = REQUEST_REJECT_REASON_CONFIRMATION_MISMATCH; + } + } + + result = sendMessage( MSG_ID_TD_DURATION_CONFIRM_RESPONSE, COMM_BUFFER_OUT_CAN_TD_2_UI, (U08 *)&response, sizeof( UI_RESPONSE_PAYLOAD_T ) ); + + return result; +} + +/*********************************************************************//** + * @brief + * The signalUserConfirmationOfUFVolume function handles the UI + * ultrafiltration volume confirmation request during Treatment mode. + * @details \b Message \b Sent: MSG_ID_TD_ULTRAFILTRATION_CHANGE_CONFIRM_RESPONSE including acceptance status and rejection reason. + * @details \b Inputs: validUFVolumeReceived, validatedUFVolumeGoalL, validatedUFRateLhr. + * @details \b Outputs: validUFVolumeReceived, validatedUFVolumeGoalL, validatedUFRateLhr. + * @param message set message from UI which includes the confirmed UF volume and UF rate. + * @return TRUE if response message is sent successfully, FALSE otherwise. + *************************************************************************/ +BOOL signalUserConfirmationOfUFVolume( MESSAGE_T *message ) +{ + BOOL result = FALSE; + UF_VOLUME_CONFIRM_REQUEST_PAYLOAD_T request; + UI_RESPONSE_PAYLOAD_T response; + F32 validatedUFVolumeGoalMl = 0.0F; + F32 validatedUFRateMlMin = 0.0F; + + response.accepted = FALSE; + response.rejectionReason = REQUEST_REJECT_REASON_INVALID_REQUEST_FORMAT; + + if ( message->hdr.payloadLen == sizeof( UF_VOLUME_CONFIRM_REQUEST_PAYLOAD_T ) ) + { + memcpy( &request, &message->payload[ 0 ], sizeof( UF_VOLUME_CONFIRM_REQUEST_PAYLOAD_T ) ); + + validatedUFVolumeGoalMl = validatedUFVolumeGoalL * (F32)ML_PER_LITER; + validatedUFRateMlMin = ( validatedUFRateLhr * (F32)ML_PER_LITER ) / (F32)MIN_PER_HOUR; + + // Verify confirmed UF volume and UF rate match previously validated values. + if ( ( TRUE == validUFVolumeReceived ) && ( fabs( request.ufVolume - validatedUFVolumeGoalL ) < NEARLY_ZERO ) && + ( fabs( request.ufRate - validatedUFRateLhr ) <= 0.01F ) ) + { + setTreatmentParameterF32( TREATMENT_PARAM_UF_VOLUME, validatedUFVolumeGoalL ); + updateTreatmentBroadcastData(); + setDialysisDDParams( getTreatmentParameterU32( TREATMENT_PARAM_DIALYSATE_FLOW ), validatedUFVolumeGoalMl, validatedUFRateMlMin ); + + response.accepted = TRUE; + response.rejectionReason = REQUEST_REJECT_REASON_NONE; + + // Clear stored validated values. + validUFVolumeReceived = FALSE; + validatedUFVolumeGoalL = 0.0F; + validatedUFRateLhr = 0.0F; + } + else if ( FALSE == validUFVolumeReceived ) + { + response.rejectionReason = REQUEST_REJECT_REASON_CONFIRMATION_NOT_EXPECTED; + } + else + { + response.rejectionReason = REQUEST_REJECT_REASON_CONFIRMATION_MISMATCH; + } + } + + result = sendMessage( MSG_ID_TD_ULTRAFILTRATION_CHANGE_CONFIRM_RESPONSE, COMM_BUFFER_OUT_CAN_TD_2_UI, (U08 *)&response, sizeof( UI_RESPONSE_PAYLOAD_T ) ); + + return result; +} + + +/************************************************************************* * TEST SUPPORT FUNCTIONS *************************************************************************/