Index: firmware/App/Controllers/Valves.c =================================================================== diff -u -r27e8758fa6199e72b914e1199786a4396ce74d06 -rb50acaa8dda74292fb41110440eaaa40f2959fb7 --- firmware/App/Controllers/Valves.c (.../Valves.c) (revision 27e8758fa6199e72b914e1199786a4396ce74d06) +++ firmware/App/Controllers/Valves.c (.../Valves.c) (revision b50acaa8dda74292fb41110440eaaa40f2959fb7) @@ -193,6 +193,126 @@ /*********************************************************************//** * @brief + * The setValveState function sets the valve state for given valve. + * @details \b Inputs: none + * @details \b Outputs: valveStates[], pendingValveStateChanges[], pendingValveStateChangeCountDowns[] + * @details \b Alarm: ALARM_ID_DD_SOFTWARE_FAULT when invalid valve ID passed + * @param valveID ID of valve to set state for + * @param valveStateName name of valve state to set given valve to + * @return TRUE if new valve state is set for given valve ID, FALSE if not. + *************************************************************************/ +BOOL setValveState( DD_VALVES_T valveID, VALVE_STATE_NAMES_T valveStateName ) +{ + BOOL result = FALSE; // initialize result flag to FALSE + + if ( valveID < DD_NUM_OF_VALVES ) + { + if ( TRUE == checkValveStateName( valveID, valveStateName ) ) + { + valveStates[ valveID ].data = convertValveStateNameToValveState( valveStateName ); + result = TRUE; + // If a delayed state change is pending for this valve, cancel it + pendingValveStateChanges[ valveID ] = DEENERGIZED; + pendingValveStateChangeCountDowns[ valveID ] = 0; + } + } + else + { + SET_ALARM_WITH_2_U32_DATA( ALARM_ID_DD_SOFTWARE_FAULT, SW_FAULT_ID_VALVES_INVALID_VALVE_ID, valveID ) + } + + return result; +} + +/*********************************************************************//** + * @brief + * The setValveStateDelayed function sets the valve state for given valve + * after a given delay. + * @details \b Inputs: pendingValveStateChangeCountDowns[] + * @details \b Outputs: pendingValveStateChangeCountDowns[], pendingValveStateChangeCountDowns[] + * @details \b Alarm: ALARM_ID_DD_SOFTWARE_FAULT when invalid valve ID passed + * @param valveID ID of valve to set state for + * @param valveStateName name of valve state to set given valve to + * @param delayMs delay duration (in ms) before actuation + * @return TRUE if new valve state is set for given valve ID, FALSE if not. + *************************************************************************/ +BOOL setValveStateDelayed( DD_VALVES_T valveID, VALVE_STATE_NAMES_T valveStateName, U32 delayMs ) +{ + BOOL result = FALSE; // initialize result flag to FALSE + + if ( valveID < DD_NUM_OF_VALVES ) + { + if ( TRUE == checkValveStateName( valveID, valveStateName ) ) + { + // If a delayed state change is already pending for this valve, execute it now before setting a new delayed state change + if ( pendingValveStateChangeCountDowns[ valveID ] > 0 ) + { + valveStates[ valveID ].data = pendingValveStateChanges[ valveID ]; + } + // Set delayed valve state change + pendingValveStateChanges[ valveID ] = convertValveStateNameToValveState( valveStateName ); + pendingValveStateChangeCountDowns[ valveID ] = delayMs / TASK_PRIORITY_INTERVAL; + result = TRUE; + } + } + else + { + SET_ALARM_WITH_2_U32_DATA( ALARM_ID_DD_SOFTWARE_FAULT, SW_FAULT_ID_VALVES_INVALID_VALVE_ID, valveID ) + } + + return result; +} + +/*********************************************************************//** + * @brief + * The getValveStateName function gets the current valve state enum for given valve. + * @details \b Inputs: valveStates[] + * @details \b Outputs: none + * @details \b Alarm: ALARM_ID_DD_SOFTWARE_FAULT when invalid valve ID passed. + * @param valveID ID of valve to get state for + * @return the current valve state for given valve in enum + *************************************************************************/ +VALVE_STATE_NAMES_T getValveStateName( DD_VALVES_T valveID ) +{ + // Initialized per CppCheck. + VALVE_STATE_NAMES_T name = NUM_OF_VALVE_STATES; + + if ( valveID < DD_NUM_OF_VALVES ) + { + U32 valveState = getU32OverrideValue( &valveSensedStates[ valveID ] ); + + name = ( DEENERGIZED == valveState ? VALVE_STATE_CLOSED : VALVE_STATE_OPEN ); + } + else + { + SET_ALARM_WITH_2_U32_DATA( ALARM_ID_DD_SOFTWARE_FAULT, SW_FAULT_ID_VALVES_INVALID_VALVE_ID, valveID ) + } + + return name; +} + + +/*********************************************************************//** + * @brief + * The setHydValvesStatetoClosedState function sets all Hydraulics / DD + * valves to close state except balancing chamber, UF and Inlet water control. + * @details \b Inputs: none + * @details \b Outputs: valve states + * @return none. + *************************************************************************/ +void setHydValvesStatetoClosedState( void ) +{ + DD_VALVES_T valve; + + // Set all Hydraulics valves to closed state + for ( valve = FIRST_HYD_VALVE; valve <= LAST_HYD_VALVE; valve++ ) + { + setValveState( valve, VALVE_STATE_CLOSED ); + } +} + +/*********************************************************************//** + * @brief * The readCommandedValveStates function gets the hydraulics, Balancing chamber * and Ultrafiltration valvesStates that can be passed to FPGA for setting valves. * @details \b Inputs: valveStates[] @@ -314,106 +434,6 @@ /*********************************************************************//** * @brief - * The setValveState function sets the valve state for given valve. - * @details \b Inputs: none - * @details \b Outputs: valveStates[], pendingValveStateChanges[], pendingValveStateChangeCountDowns[] - * @details \b Alarm: ALARM_ID_DD_SOFTWARE_FAULT when invalid valve ID passed - * @param valveID ID of valve to set state for - * @param valveStateName name of valve state to set given valve to - * @return TRUE if new valve state is set for given valve ID, FALSE if not. - *************************************************************************/ -BOOL setValveState( DD_VALVES_T valveID, VALVE_STATE_NAMES_T valveStateName ) -{ - BOOL result = FALSE; // initialize result flag to FALSE - - if ( valveID < DD_NUM_OF_VALVES ) - { - if ( TRUE == checkValveStateName( valveID, valveStateName ) ) - { - valveStates[ valveID ].data = convertValveStateNameToValveState( valveStateName ); - result = TRUE; - // If a delayed state change is pending for this valve, cancel it - pendingValveStateChanges[ valveID ] = DEENERGIZED; - pendingValveStateChangeCountDowns[ valveID ] = 0; - } - } - else - { - SET_ALARM_WITH_2_U32_DATA( ALARM_ID_DD_SOFTWARE_FAULT, SW_FAULT_ID_VALVES_INVALID_VALVE_ID, valveID ) - } - - return result; -} - -/*********************************************************************//** - * @brief - * The setValveStateDelayed function sets the valve state for given valve - * after a given delay. - * @details \b Inputs: pendingValveStateChangeCountDowns[] - * @details \b Outputs: pendingValveStateChangeCountDowns[], pendingValveStateChangeCountDowns[] - * @details \b Alarm: ALARM_ID_DD_SOFTWARE_FAULT when invalid valve ID passed - * @param valveID ID of valve to set state for - * @param valveStateName name of valve state to set given valve to - * @param delayMs delay duration (in ms) before actuation - * @return TRUE if new valve state is set for given valve ID, FALSE if not. - *************************************************************************/ -BOOL setValveStateDelayed( DD_VALVES_T valveID, VALVE_STATE_NAMES_T valveStateName, U32 delayMs ) -{ - BOOL result = FALSE; // initialize result flag to FALSE - - if ( valveID < DD_NUM_OF_VALVES ) - { - if ( TRUE == checkValveStateName( valveID, valveStateName ) ) - { - // If a delayed state change is already pending for this valve, execute it now before setting a new delayed state change - if ( pendingValveStateChangeCountDowns[ valveID ] > 0 ) - { - valveStates[ valveID ].data = pendingValveStateChanges[ valveID ]; - } - // Set delayed valve state change - pendingValveStateChanges[ valveID ] = convertValveStateNameToValveState( valveStateName ); - pendingValveStateChangeCountDowns[ valveID ] = delayMs / TASK_PRIORITY_INTERVAL; - result = TRUE; - } - } - else - { - SET_ALARM_WITH_2_U32_DATA( ALARM_ID_DD_SOFTWARE_FAULT, SW_FAULT_ID_VALVES_INVALID_VALVE_ID, valveID ) - } - - return result; -} - -/*********************************************************************//** - * @brief - * The getValveStateName function gets the current valve state enum for given valve. - * @details \b Inputs: valveStates[] - * @details \b Outputs: none - * @details \b Alarm: ALARM_ID_DD_SOFTWARE_FAULT when invalid valve ID passed. - * @param valveID ID of valve to get state for - * @return the current valve state for given valve in enum - *************************************************************************/ -VALVE_STATE_NAMES_T getValveStateName( DD_VALVES_T valveID ) -{ - // Initialized per CppCheck. - VALVE_STATE_NAMES_T name = NUM_OF_VALVE_STATES; - - if ( valveID < DD_NUM_OF_VALVES ) - { - U32 valveState = getU32OverrideValue( &valveSensedStates[ valveID ] ); - - name = ( DEENERGIZED == valveState ? VALVE_STATE_CLOSED : VALVE_STATE_OPEN ); - } - else - { - SET_ALARM_WITH_2_U32_DATA( ALARM_ID_DD_SOFTWARE_FAULT, SW_FAULT_ID_VALVES_INVALID_VALVE_ID, valveID ) - } - - return name; -} - -/*********************************************************************//** - * @brief * The getValveState function gets the current valve state for given valve. * @details \b Inputs: valveStates[] * @details \b Outputs: none @@ -439,25 +459,6 @@ /*********************************************************************//** * @brief - * The setHydValvesStatetoClosedState function sets all Hydraulics / DD - * valves to close state except balancing chamber, UF and Inlet water control. - * @details \b Inputs: none - * @details \b Outputs: valve states - * @return none. - *************************************************************************/ -void setHydValvesStatetoClosedState( void ) -{ - DD_VALVES_T valve; - - // Set all Hydraulics valves to closed state - for ( valve = FIRST_HYD_VALVE; valve <= LAST_HYD_VALVE; valve++ ) - { - setValveState( valve, VALVE_STATE_CLOSED ); - } -} - -/*********************************************************************//** - * @brief * The publishValvesStates function publishes DD valves states at the set interval. * @details \b Inputs: valvesStatesPublicationTimerCounter * @details \b Outputs: valvesStatesPublicationTimerCounter