Index: firmware/App/Controllers/RinsePump.c =================================================================== diff -u --- firmware/App/Controllers/RinsePump.c (revision 0) +++ firmware/App/Controllers/RinsePump.c (revision 711ff90b0aab45c4acde333f4c9f11be9b62f383) @@ -0,0 +1,227 @@ +/************************************************************************** +* +* Copyright (c) 2024-2025 Diality Inc. - All Rights Reserved. +* +* THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN +* WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. +* +* @file RinsePump.c +* +* @author (last) Vinayakam Mani +* @date (last) 22-Oct-2025 +* +* @author (original) Vinayakam Mani +* @date (original) 22-Oct-2025 +* +***************************************************************************/ + +#include "RinsePump.h" +#include "Messaging.h" +#include "OperationModes.h" +#include "PersistentAlarm.h" +#include "TaskGeneral.h" +#include "Timers.h" +#include "Valves.h" + +/** + * @addtogroup RinsePump + * @{ + */ + +// ********** private definitions ********** + +#define RINSE_PUMP_DATA_PUB_INTERVAL ( MS_PER_SECOND / TASK_GENERAL_INTERVAL ) ///< Rinse pump data publish interval. +#define DATA_PUBLISH_COUNTER_START_COUNT 13 ///< Rinse pump data publish start counter. + +// ********** private data ********** + +static RINSE_PUMP_STATE_T currentRinsePumpState; ///< Current rinse pump control state. +static U32 rinsePumpDataPublicationTimerCounter; ///< Rinse pump data broadcast timer counter. +static OVERRIDE_U32_T rinsePumpDataPublishInterval; ///< Rinse pump data broadcast interval (in ms). + +// ********** private function prototypes ********** + +static RINSE_PUMP_STATE_T handleRinsePumpStartState( void ); +static RINSE_PUMP_STATE_T handleRinsePumpOffState( void ); +static RINSE_PUMP_STATE_T handleRinsePumpOnState ( void ); +static void publishRinsePumpData( void ); + +/*********************************************************************//** + * @brief + * The initRinsePump function initializes the rinse pump driver. + * @details \b Inputs: none + * @details \b Outputs: Rinse pump driver unit initialized + * @return none + *************************************************************************/ +void initRinsePump(void) +{ + // Initialize controller variables + rinsePumpDataPublicationTimerCounter = DATA_PUBLISH_COUNTER_START_COUNT; + currentRinsePumpState = RINSE_PUMP_STATE_INIT; + rinsePumpDataPublishInterval.data = RINSE_PUMP_DATA_PUB_INTERVAL; + rinsePumpDataPublishInterval.ovData = RINSE_PUMP_DATA_PUB_INTERVAL; + rinsePumpDataPublishInterval.ovInitData = RINSE_PUMP_DATA_PUB_INTERVAL; + rinsePumpDataPublishInterval.override = OVERRIDE_RESET; +} + +/*********************************************************************//** + * @brief + * The setRinsePumpState function sets the current rinse pump state machine state. + * @details \b Alarm: ALARM_ID_DD_SOFTWARE_FAULT if invalid state given. + * @details \b Inputs: currentRinsePumpState + * @details \b Outputs: currentRinsePumpState + * @param state Rinse pump state to set + * @return none + *************************************************************************/ +void setRinsePumpState( RINSE_PUMP_STATE_T state ) +{ + if ( state < NUM_OF_RINSE_PUMP_STATES ) + { + currentRinsePumpState = state; + } + else + { + SET_ALARM_WITH_2_U32_DATA( ALARM_ID_DD_SOFTWARE_FAULT, SW_FAULT_ID_RINSE_PUMP_INVALID_STATE1, (U32)state ) + } +} + +/*********************************************************************//** + * @brief + * The getRinsePumpState function returns the current rinse pump state machine. + * @details \b Inputs: currentRinsePumpState + * @details \b Outputs: none + * @return current state of the rinse pump state machine. + *************************************************************************/ +RINSE_PUMP_STATE_T getRinsePumpState( void ) +{ + return currentRinsePumpState; +} + +/*********************************************************************//** + * @brief + * The execRinsePumpController function executes the rinse pump state machine. + * @details \b Alarm: ALARM_ID_DD_SOFTWARE_FAULT if the current state is invalid. + * @details \b Inputs: currentRinsePumpState + * @details \b Outputs: currentRinsePumpState + * @return none + *************************************************************************/ +void execRinsePumpController( void ) +{ + switch( currentRinsePumpState ) + { + case RINSE_PUMP_STATE_INIT: + currentRinsePumpState = handleRinsePumpStartState(); + break; + + case RINSE_PUMP_STATE_OFF: + currentRinsePumpState = handleRinsePumpOffState(); + break; + + case RINSE_PUMP_STATE_ON: + currentRinsePumpState = handleRinsePumpOnState(); + break; + + default: + SET_ALARM_WITH_2_U32_DATA( ALARM_ID_DD_SOFTWARE_FAULT, SW_FAULT_ID_RINSE_PUMP_INVALID_EXEC_STATE, (U32)currentRinsePumpState ) + break; + } + + publishRinsePumpData(); +} + +/*********************************************************************//** + * @brief + * The handleRinsePumpStartState function starts the rinse pump state machine. + * @details \b Inputs: none + * @details \b Outputs: none + * @return next state of the rinse pump state machine + *************************************************************************/ +static RINSE_PUMP_STATE_T handleRinsePumpStartState( void ) +{ + RINSE_PUMP_STATE_T state = RINSE_PUMP_STATE_OFF; + + return state; +} + +/*********************************************************************//** + * @brief + * The handleRinsePumpOffState function stops the rinse pump + * @details \b Inputs: none + * @details \b Outputs: Rinse pump motor turned off + * @return next state of the rinse pump state machine + *************************************************************************/ +static RINSE_PUMP_STATE_T handleRinsePumpOffState( void ) +{ + RINSE_PUMP_STATE_T state = RINSE_PUMP_STATE_OFF; + + // Current alpha system uses valve D65 to turn on the rinse pump + // and its just On/off control for now. + setValveState( D79_PMP_VALV, VALVE_STATE_CLOSED ); + + return state; +} + +/*********************************************************************//** + * @brief + * The handleRinsePumpOnState function starts the rinse pump + * @details \b Inputs: none + * @details \b Outputs: Rinse pump motor turned on. + * @return next state of the rinse pump state machine + *************************************************************************/ +static RINSE_PUMP_STATE_T handleRinsePumpOnState( void ) +{ + RINSE_PUMP_STATE_T state = RINSE_PUMP_STATE_ON; + + // D79 Pump On/off control + setValveState( D79_PMP_VALV, VALVE_STATE_OPEN ); + + return state; +} + +/*********************************************************************//** + * @brief + * The publishRinsePumpData function constructs and sends the rinse pump data + * broadcast message. + * @details \b Message \b Sent: MSG_ID_DD_RINSE_PUMP_DATA + * @details \b Inputs: rinsePumpDataPublicationTimerCounter, currentRinsePumpState + * @details \b Outputs: rinsePumpDataPublicationTimerCounter + * @return none + *************************************************************************/ +static void publishRinsePumpData( void ) +{ + if ( ++rinsePumpDataPublicationTimerCounter >= getU32OverrideValue( &rinsePumpDataPublishInterval ) ) + { + RINSE_PUMP_PAYLOAD_T data; + + data.d79State = getRinsePumpState(); + + broadcastData( MSG_ID_DD_RINSE_PUMP_DATA, COMM_BUFFER_OUT_CAN_DD_BROADCAST, (U08*)&data, sizeof( RINSE_PUMP_PAYLOAD_T ) ); + rinsePumpDataPublicationTimerCounter = 0; + } +} + + +/************************************************************************* + * TEST SUPPORT FUNCTIONS + *************************************************************************/ + + +/*********************************************************************//** + * @brief + * The testRinsePumpDataPublishIntervalOverride function overrides the interval + * at which the DD rinse pump data is published. + * @details \b Inputs: none + * @details \b Outputs: rinsePumpDataPublishInterval + * @param message Override message from Dialin which includes the interval + * (in ms) to override the rinse pump broadcast interval to. + * @return TRUE if override request is successful, FALSE if not + *************************************************************************/ +BOOL testRinsePumpDataPublishIntervalOverride( MESSAGE_T *message ) +{ + BOOL result = u32BroadcastIntervalOverride( message, &rinsePumpDataPublishInterval, TASK_GENERAL_INTERVAL ); + + return result; +} + +/**@}*/ + Index: firmware/App/Controllers/RinsePump.h =================================================================== diff -u --- firmware/App/Controllers/RinsePump.h (revision 0) +++ firmware/App/Controllers/RinsePump.h (revision 711ff90b0aab45c4acde333f4c9f11be9b62f383) @@ -0,0 +1,64 @@ +/************************************************************************** +* +* Copyright (c) 2024-2025 Diality Inc. - All Rights Reserved. +* +* THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN +* WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. +* +* @file RinsePump.h +* +* @author (last) Vinayakam Mani +* @date (last) 22-Oct-2025 +* +* @author (original) Vinayakam Mani +* @date (original) 22-Oct-2025 +* +***************************************************************************/ + +#ifndef __RINSE_PUMP_H__ +#define __RINSE_PUMP_H__ + +// ********** public definitions ********** + +#include "DDCommon.h" + +/** + * @defgroup RinsePump RinsePump + * @brief Rinse Pump controller unit. Provides higher level control of the rinse pump. + * + * @addtogroup RinsePump + * @{ + */ + +// ********** public definitions ********** + +#pragma pack(push, 1) +/// Payload record structure for air pump data broadcast message +typedef struct +{ + U32 d79State; ///< Rinse pump state status +} RINSE_PUMP_PAYLOAD_T; +#pragma pack(pop) + +/// Enumeration of air pump states. +typedef enum RinsePumpControllerStates +{ + RINSE_PUMP_STATE_INIT = 0, ///< Rinse Pump Initialize state + RINSE_PUMP_STATE_OFF, ///< Rinse Pump Off state + RINSE_PUMP_STATE_ON, ///< Rinse Pump On state + NUM_OF_RINSE_PUMP_STATES, ///< Number of rinse pump states +} RINSE_PUMP_STATE_T; + +// ********** public function prototypes ********** + +void initRinsePump(void); +void execRinsePumpController(void); +void setRinsePumpState( RINSE_PUMP_STATE_T state ); +RINSE_PUMP_STATE_T getRinsePumpState( void ); + +BOOL testRinsePumpDataPublishIntervalOverride( MESSAGE_T *message ); + +/**@}*/ + +#endif + Index: firmware/App/Controllers/Valves.c =================================================================== diff -u -refd5f3144ddaaa697621e0cd08446aa501534a1f -r711ff90b0aab45c4acde333f4c9f11be9b62f383 --- firmware/App/Controllers/Valves.c (.../Valves.c) (revision efd5f3144ddaaa697621e0cd08446aa501534a1f) +++ firmware/App/Controllers/Valves.c (.../Valves.c) (revision 711ff90b0aab45c4acde333f4c9f11be9b62f383) @@ -235,12 +235,12 @@ { case VALVE_STATE_OPEN: case VALVE_STATE_CLOSED: - if ( ( D53_VALV == valveID ) || ( D52_VALV == valveID ) || ( D8_VALV == valveID ) || ( D54_VALV == valveID ) || ( D14_VALV == valveID ) || - ( D65_VALV == valveID ) || ( D64_VALV == valveID ) || ( D31_VALV == valveID ) || ( D34_VALV == valveID ) || ( D35_VALV == valveID ) || - ( D40_VALV == valveID ) || ( D47_VALV == valveID ) || ( D3_VALV == valveID ) || ( M4_VALV == valveID ) || ( D23_VALV == valveID ) || - ( D19_VALV == valveID ) || ( D25_VALV == valveID ) || ( D21_VALV == valveID ) || ( D24_VALV == valveID ) || ( D20_VALV == valveID ) || - ( D26_VALV == valveID ) || ( D22_VALV == valveID ) || ( D80_VALV == valveID ) || ( D81_VALV == valveID ) || ( P11_VALV == valveID ) || - ( P33_VALV == valveID ) || ( P34_VALV == valveID ) || ( P37_VALV == valveID ) || ( P6_VALV == valveID ) ) + if ( ( D53_VALV == valveID ) || ( D52_VALV == valveID ) || ( D8_VALV == valveID ) || ( D54_VALV == valveID ) || ( D14_VALV == valveID ) || + ( D65_VALV == valveID ) || ( D64_VALV == valveID ) || ( D31_VALV == valveID ) || ( D34_VALV == valveID ) || ( D35_VALV == valveID ) || + ( D40_VALV == valveID ) || ( D47_VALV == valveID ) || ( D3_VALV == valveID ) || ( M4_VALV == valveID ) || ( D23_VALV == valveID ) || + ( D19_VALV == valveID ) || ( D25_VALV == valveID ) || ( D21_VALV == valveID ) || ( D24_VALV == valveID ) || ( D20_VALV == valveID ) || + ( D26_VALV == valveID ) || ( D22_VALV == valveID ) || ( D80_VALV == valveID ) || ( D81_VALV == valveID ) || ( D79_PMP_VALV == valveID ) || + ( P11_VALV == valveID ) || ( P33_VALV == valveID ) || ( P34_VALV == valveID ) || ( P37_VALV == valveID ) || ( P6_VALV == valveID ) ) { result = TRUE; } Index: firmware/App/Modes/ModeGenDialysate.c =================================================================== diff -u -r325e67dab10f6666702bf0f1256015b31e58de4f -r711ff90b0aab45c4acde333f4c9f11be9b62f383 --- firmware/App/Modes/ModeGenDialysate.c (.../ModeGenDialysate.c) (revision 325e67dab10f6666702bf0f1256015b31e58de4f) +++ firmware/App/Modes/ModeGenDialysate.c (.../ModeGenDialysate.c) (revision 711ff90b0aab45c4acde333f4c9f11be9b62f383) @@ -28,6 +28,7 @@ #include "OperationModes.h" #include "PersistentAlarm.h" #include "Pressure.h" +#include "RinsePump.h" #include "SpentChamberFill.h" #include "TaskGeneral.h" #include "TDInterface.h" @@ -226,6 +227,9 @@ //setDialysatePumpTargetRPM( D48_PUMP, SPENT_DIAL_PUMP_INITIAL_RPM, FALSE ); setDialysatePumpTargetRPM( D48_PUMP, SPENT_DIAL_PUMP_INITIAL_RPM, TRUE ); + //Rinse pump On + setRinsePumpState( RINSE_PUMP_STATE_ON ); + transitionToBalChamberFill(); //Testing @@ -251,6 +255,9 @@ //setDialysatePumpTargetRPM( D48_PUMP, SPENT_DIAL_PUMP_INITIAL_RPM, FALSE ); setDialysatePumpTargetRPM( D48_PUMP, SPENT_DIAL_PUMP_INITIAL_RPM, TRUE ); + //Rinse pump On + setRinsePumpState( RINSE_PUMP_STATE_ON ); + // Disable bypass valve setValveState( D34_VALV, VALVE_STATE_CLOSED ); // Bypass valve setValveState( D35_VALV, VALVE_STATE_OPEN ); // VDI @@ -279,6 +286,9 @@ setDialysatePumpTargetRPM( D12_PUMP, FRESH_DIAL_PUMP_INITIAL_RPM, TRUE ); setDialysatePumpTargetRPM( D48_PUMP, SPENT_DIAL_PUMP_FILL_RPM, TRUE ); + //Rinse pump On + setRinsePumpState( RINSE_PUMP_STATE_ON ); + //Transition to spent chamber fill transitionToSpentChamberFill(); break; @@ -306,6 +316,9 @@ setD28TempFeedbackControl( FALSE ); startHeater( D5_HEAT ); + //Rinse pump On + setRinsePumpState( RINSE_PUMP_STATE_ON ); + setDialysatePumpTargetRPM( D12_PUMP, FRESH_DIAL_PUMP_INITIAL_RPM, TRUE ); setDialysatePumpTargetRPM( D48_PUMP, SPENT_DIAL_PUMP_INITIAL_RPM, TRUE ); break; @@ -317,6 +330,8 @@ requestConcentratePumpOff( D11_PUMP, FALSE ); requestConcentratePumpOff( D10_PUMP, FALSE ); requestConcentratePumpOff( D76_PUMP, FALSE ); + //Rinse pump Off + setRinsePumpState( RINSE_PUMP_STATE_OFF ); stopHeater( D5_HEAT ); stopHeater( D45_HEAT ); Index: firmware/App/Services/AlarmMgmtSWFaults.h =================================================================== diff -u -r4671ebebf1334c098a4725320be54f0b94eff7bc -r711ff90b0aab45c4acde333f4c9f11be9b62f383 --- firmware/App/Services/AlarmMgmtSWFaults.h (.../AlarmMgmtSWFaults.h) (revision 4671ebebf1334c098a4725320be54f0b94eff7bc) +++ firmware/App/Services/AlarmMgmtSWFaults.h (.../AlarmMgmtSWFaults.h) (revision 711ff90b0aab45c4acde333f4c9f11be9b62f383) @@ -146,6 +146,8 @@ SW_FAULT_ID_INVALID_FILTERED_CONDUCTIVITY_SENSOR_ID = 115, SW_FAULT_ID_VOLTAGES_INVALID_STATE = 116, SW_FAULT_ID_VOLTAGES_INVALID_SIGNAL = 117, + SW_FAULT_ID_RINSE_PUMP_INVALID_EXEC_STATE = 118, + SW_FAULT_ID_RINSE_PUMP_INVALID_STATE1 = 119, NUM_OF_SW_FAULT_IDS } DD_SW_FAULT_ID_T; Index: firmware/App/Tasks/TaskGeneral.c =================================================================== diff -u -r3489334b8aa09ce02a2d959a92301a1e52516f8b -r711ff90b0aab45c4acde333f4c9f11be9b62f383 --- firmware/App/Tasks/TaskGeneral.c (.../TaskGeneral.c) (revision 3489334b8aa09ce02a2d959a92301a1e52516f8b) +++ firmware/App/Tasks/TaskGeneral.c (.../TaskGeneral.c) (revision 711ff90b0aab45c4acde333f4c9f11be9b62f383) @@ -26,6 +26,7 @@ #include "Messaging.h" #include "OperationModes.h" #include "PermeateTank.h" +#include "RinsePump.h" #include "ROPump.h" #include "SystemCommDD.h" #include "TaskGeneral.h" @@ -107,6 +108,9 @@ // Heaters controller execHeatersControl(); + // manage rinse pump + execRinsePumpController(); + // Monitor RAM error status //execRAMMonitor(); Index: firmware/source/sys_main.c =================================================================== diff -u -r6e61eeb9768451dc1390037ff83bcbfbbbaf01ca -r711ff90b0aab45c4acde333f4c9f11be9b62f383 --- firmware/source/sys_main.c (.../sys_main.c) (revision 6e61eeb9768451dc1390037ff83bcbfbbbaf01ca) +++ firmware/source/sys_main.c (.../sys_main.c) (revision 711ff90b0aab45c4acde333f4c9f11be9b62f383) @@ -92,6 +92,7 @@ #include "OperationModes.h" #include "PermeateTank.h" #include "Pressure.h" +#include "RinsePump.h" #include "ROPump.h" #include "SafetyShutdown.h" #include "SystemCommDD.h" @@ -202,6 +203,7 @@ initTDInterface(); initFPInterface(); initUltrafiltration(); + initRinsePump(); // FP Modules