Index: firmware/App/Services/SystemCommMessages.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Services/SystemCommMessages.c (.../SystemCommMessages.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Services/SystemCommMessages.c (.../SystemCommMessages.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -73,9 +73,8 @@ * bit of the sequence # is set if ACK is required per parameter. A sync byte * is inserted at the beginning of the message and an 8-bit CRC is appended to * the end of the message. The message is queued for transmission in the given buffer. - * @details - * Inputs : none - * Outputs : given data array populated with serialized message data and queued for transmit. + * @details Inputs: none + * @details Outputs: given data array populated with serialized message data and queued for transmit. * @param msg message to serialize * @param buffer outgoing buffer that message should be queued in * @param ackReq is an acknowledgement from receiver required? @@ -153,9 +152,8 @@ * @brief * The sendACKMsg function constructs and queues for transmit an ACK message * for a given received message. - * @details - * Inputs : none - * Outputs : ACK message queued for transmit on broadcast CAN channel. + * @details Inputs: none + * @details Outputs: ACK message queued for transmit on broadcast CAN channel. * @param message message to send an ACK for * @return TRUE if ACK message queued successfully, FALSE if not *************************************************************************/ @@ -183,9 +181,8 @@ * @brief * The sendTestAckResponseMsg function constructs a simple response message for * a handled test message and queues it for transmit on the appropriate UART channel. - * @details - * Inputs : none - * Outputs : response message constructed and queued for transmit. + * @details Inputs: none + * @details Outputs: response message constructed and queued for transmit. * @param msgID ID of handled message that we are responding to * @param buffer outgoing buffer that message should be queued in * @param ack TRUE if test message was handled successfully, FALSE if not @@ -217,9 +214,8 @@ * @brief * The broadcastAlarmTriggered function constructs an alarm triggered msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : alarm triggered msg constructed and queued. + * @details Inputs: none + * @details Outputs: alarm triggered msg constructed and queued. * @param alarm ID of alarm triggered * @param almData1 1st data associated with alarm * @param almData2 2nd data associated with alarm @@ -252,9 +248,8 @@ * @brief * The broadcastAlarmCleared function constructs an alarm cleared msg to be * broadcast and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : alarm cleared msg constructed and queued. + * @details Inputs: none + * @details Outputs: alarm cleared msg constructed and queued. * @param alarm ID of alarm cleared * @return TRUE if msg successfully queued for transmit, FALSE if not *************************************************************************/ @@ -281,9 +276,8 @@ * @brief * The broadcastAccelData function constructs an accelerometer data msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : accelerometer data broadcast msg constructed and queued. + * @details Inputs: none + * @details Outputs: accelerometer data broadcast msg constructed and queued. * @param x X axis vector magnitude (in g) * @param y Y axis vector magnitude (in g) * @param z Z axis vector magnitude (in g) @@ -328,9 +322,8 @@ * @brief * The broadcastRTCEpoch function constructs an epoch msg to be broadcast * and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : RTC time and date in epoch + * @details Inputs: none + * @details Outputs: RTC time and date in epoch * @param epoch Current time and date in epoch * @return TRUE if msg successfully queued for transmit, FALSE if not *************************************************************************/ @@ -357,9 +350,8 @@ * @brief * The broadcastDGHDOperationMode function constructs a DG operation mode * broadcast message and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : DG operation mode msg constructed and queued + * @details Inputs: none + * @details Outputs: DG operation mode msg constructed and queued * @param mode current operation mode of the DG. * @param subMode current sub-mode of the current operation mode of the DG. * @return TRUE if msg successfully queued for transmit, FALSE if not @@ -388,9 +380,8 @@ /*********************************************************************//** * @brief * The broadcastLoadCellData function sends out load cell data. - * @details - * Inputs : none - * Outputs : load cell data msg constructed and queued + * @details Inputs: none + * @details Outputs: load cell data msg constructed and queued * @param loadCellA1 load cell A 1 data in grams * @param loadCellA2 load cell A 2 data in grams * @param loadCellB1 load cell B 1 data in grams @@ -425,9 +416,8 @@ /*********************************************************************//** * @brief * The broadcastValvesStates function sends out DG valves states. - * @details - * Inputs : none - * Outputs : Valves states msg constructed and queued + * @details Inputs: none + * @details Outputs: Valves states msg constructed and queued * @param valvesStates valves states * refer to setFPGAValveStates function in FPGA.c for details * @return TRUE if msg successfully queued for transmit, FALSE if not @@ -454,9 +444,8 @@ /*********************************************************************//** * @brief * The broadcastHeatersData function sends out DG heaters data - * @details - * Inputs : heaters data - * Outputs : heatears data msg constructed and queued + * @details Inputs: heaters data + * @details Outputs: heatears data msg constructed and queued * @param mainPrimaryDC main primary heater duty cycle * @param smallPrimaryDC small primary heater duty cycle * @param trimmerDC trimmer heater duty cycle @@ -489,9 +478,8 @@ /*********************************************************************//** * @brief * The broadcastROPumpData function sends out RO pump data. - * @details - * Inputs : none - * Outputs : RO pump data msg constructed and queued + * @details Inputs: none + * @details Outputs: RO pump data msg constructed and queued * @param tgtPressure target pressure for RO pump in PSI * @param measFlow measure RO flow rate in LPM * @param setPWM set PWM duty cycle in % @@ -524,9 +512,8 @@ /*********************************************************************//** * @brief * The broadcastDrainPumpData function sends out RO pump data. - * @details - * Inputs : none - * Outputs : Drain pump data msg constructed and queued + * @details Inputs: none + * @details Outputs: Drain pump data msg constructed and queued * @param tgtSpeed target speed for drain pump in RPM * @param dac set DAC value * @return TRUE if msg successfully queued for transmit, FALSE if not @@ -557,9 +544,8 @@ /*********************************************************************//** * @brief * The broadcastPressureSensorsData function sends out DG pressure data. - * @details - * Inputs : none - * Outputs : Pressure data msg constructed and queued + * @details Inputs: none + * @details Outputs: Pressure data msg constructed and queued * @param measROIn measured RO pump inlet pressure in PSI * @param measROOut measured RO pump outlet pressure in PSI * @param measDrainIn measured Drain pump inlet pressure in PSI @@ -594,9 +580,8 @@ /*********************************************************************//** * @brief * The broadcastReservoirData function broadcasts the DG reservoir data. - * @details - * Inputs : none - * Outputs : Reservoir data msg constructed and queued + * @details Inputs: none + * @details Outputs: Reservoir data msg constructed and queued * @param resID ID of currently active reservoir * @param fillToVol Current target fill to volume for inactive reservoir * @param drainToVol Current target drain to volume for inactive reservoir @@ -630,8 +615,8 @@ * @brief * The broadcastTemperatureSensorsData function sends out DG temperature * sensors data. - * Inputs : none - * Outputs : temperature sensors data message constructed and queued + * @details Inputs: none + * @details Outputs: temperature sensors data message constructed and queued * @param sensorsValue sensors value array * @param byteLength payload length in bytes * @return TRUE if msg successfully queued for transmit, FALSE if not @@ -658,9 +643,8 @@ /*********************************************************************//** * @brief * The broadcastConductivityData function sends out conductivity data. - * @details - * Inputs : none - * Outputs : conductivity data message constructed and queued + * @details Inputs: none + * @details Outputs: conductivity data message constructed and queued * @param roRejectionRatio RO rejection ratio * @param cpi water inlet conductivity data * @param cpo water outlet conductivity data @@ -699,9 +683,8 @@ * @brief * The handlePowerOffWarning function handles a power off warning message * from the HD. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -717,9 +700,8 @@ * @brief * The handleSetDialysateTemperatureCmd function handles a dialysate temperature * set points message from the HD. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -742,9 +724,8 @@ /*********************************************************************//** * @brief * The handleFWVersionCmd function handles a FW version request message. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -777,9 +758,8 @@ * @brief * The handleSwitchReservoirCmd function handles a switch reservoirs command * from the HD. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -804,9 +784,8 @@ /*********************************************************************//** * @brief * The handleFillCmd function handles a fill command from the HD. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -829,9 +808,8 @@ /*********************************************************************//** * @brief * The handleDrainCmd function handles a drain command from the HD. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -856,9 +834,8 @@ * @brief * The handleStartStopTreatmentMsg function handles a treatment start/stop * message from the HD. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -889,9 +866,8 @@ * @brief * The handleStartStopTrimmerHeaterCmd function handles a trimmer heater start/stop * command message from the HD. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -921,9 +897,8 @@ /*********************************************************************//** * @brief * The handleSampleWaterCmd function handles a sample water command from the HD. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -946,9 +921,8 @@ * @brief * The handleSetRTCTimestamp function handles a request to write time and * date to RTC - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -973,9 +947,8 @@ * @brief * The handleStartStopPrimaryHeater function handles a request start or * stop the primary heater - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return result *************************************************************************/ @@ -1016,8 +989,8 @@ * @brief * The sendDebugData function sends debug data out to the PC port. * @details - * Inputs : none - * Outputs : PC serial port + * @details Inputs: none + * @details Outputs: PC serial port * @param dbgData Pointer to debug data * @param len number of bytes of debug data * @return TRUE if debug data was successfully queued for transmit, FALSE if not @@ -1036,8 +1009,8 @@ * @brief * The sendDebugDataToUI function sends debug string to the UI for logging. * @details - * Inputs : none - * Outputs : Message constructed and queued for transmit + * @details Inputs: none + * @details Outputs: Message constructed and queued for transmit * @param str Pointer to debug string * @return none *************************************************************************/ @@ -1065,9 +1038,8 @@ * @brief * The isTestingActivated function determines whether a tester has successfully * logged in to activate testing functionality. - * @details - * Inputs : testerLoggedIn - * Outputs : none + * @details Inputs: testerLoggedIn + * @details Outputs: none * @return TRUE if a tester has logged in to activate testing, FALSE if not *************************************************************************/ BOOL isTestingActivated( void ) @@ -1079,9 +1051,8 @@ * @brief * The sendTestAckResponseMsg function constructs a simple response message for * a handled test message and queues it for transmit on the appropriate UART channel. - * @details - * Inputs : none - * Outputs : response message constructed and queued for transmit. + * @details Inputs: none + * @details Outputs: response message constructed and queued for transmit. * @param msgID ID of handled message that we are responding to * @param ack TRUE if test message was handled successfully, FALSE if not * @return TRUE if response message successfully queued for transmit, FALSE if not @@ -1106,9 +1077,8 @@ /*********************************************************************//** * @brief * The handleTesterLogInRequest function handles a request to login as a tester. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1132,9 +1102,8 @@ * @brief * The handleTestWatchdogCheckInStateOverrideRequest function handles a * request to override the check-in status of a given task. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1165,9 +1134,8 @@ * @brief * The handleTestAlarmStateOverrideRequest function handles a request to * override the active status of a given alarm. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1198,9 +1166,8 @@ * @brief * The handleTestLoadCellOverrideRequest function handles a request to * override the value read from the given load cell. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1231,9 +1198,8 @@ * @brief * The handleTestTemperatureSensorsOverrideRequest function handles a * request to override a temperatures sensor's value. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1265,8 +1231,8 @@ * The handleTestTemperatureSensorsDataPublishOverrideRequest function handles * a request to override the publish interval of temperature sensors data. * @details -* Inputs : none -* Outputs : message handled +* @details Inputs: none +* @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1297,9 +1263,8 @@ * @brief * The handleTestHeatersDataPublishOverrideRequest function handles * a request to override the publish interval of heaters data. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1330,9 +1295,8 @@ * @brief * The handleTestLoadCellDataBroadcastIntervalOverrideRequest function handles * a request to override the broadcast interval for load cell data. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1363,9 +1327,8 @@ * @brief * The handleTestPressureSensorOverrideRequest function handles a request to * override the value read from the given pressure sensor. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1396,9 +1359,8 @@ * @brief * The handleTestPressureDataBroadcastIntervalOverrideRequest function handles * a request to override the broadcast interval for load cell data. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1429,9 +1391,8 @@ * @brief * The handleTestROPumpSetPointOverrideRequest function handles a request to * override the RO pump pressure set point (in PSI). - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1462,9 +1423,8 @@ * @brief * The handleTestROMeasuredFlowOverrideRequest function handles a request to * override the RO flow rate. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1495,9 +1455,8 @@ * @brief * The handleTestROPumpDataBroadcastIntervalOverrideRequest function handles * a request to override the broadcast interval for RO pump data. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1528,9 +1487,8 @@ * @brief * The handleTestDrainPumpSetPointOverrideRequest function handles a request to * override the drain pump speed set point (in RPM). - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1561,9 +1519,8 @@ * @brief * The handleTestDrainPumpDataBroadcastIntervalOverrideRequest function handles * a request to override the broadcast interval for drain pump data. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1594,9 +1551,8 @@ * @brief * The handleTestValveStateOverrideRequest function handles a request to * override the state value read from the given valve. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1627,9 +1583,8 @@ * @brief * The handleTestValvesStatesPublishIntervalOverrideRequest function handles * a request to override the publish interval of valves states from the given valve. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1660,9 +1615,8 @@ * @brief * The handleTestDGSafetyShutdownOverrideRequest function handles a * request to override the safety shutdown signal. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1693,9 +1647,8 @@ * @brief * The handleTestDGAccelOverrideRequest function handles a request to * override the measured accelerometer sensor readings. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1726,9 +1679,8 @@ * @brief * The handleTestDGAccelMaxOverrideRequest function handles a request to * override the measured accelerometer sensor maximum readings. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1759,9 +1711,8 @@ * @brief * The handleTestDGAccelBroadcastIntervalOverrideRequest function handles a * request to override the broadcast interval for accelerometer data messages. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1792,9 +1743,8 @@ * @brief * The handleSetAccelCalibration function handles a request to set * accelerometer calibration factors. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1818,9 +1768,8 @@ * @brief * The handleTestSetConductivityOverrideRequest function handles a * request to override a conductivity sensor's value - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1852,8 +1801,8 @@ * The handleTestSetConductivityDataPublishIntervalOverrideRequest function * handles a request to override the publish interval of conductivity sensors data * @details -* Inputs : none -* Outputs : message handled +* @details Inputs: none +* @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/