Index: firmware/App/Drivers/ConductivitySensors.c =================================================================== diff -u -r8a7e671214ef3f742677f6de58b2b0ea86e8fe5c -re2681bed3a45f89c804ddf2ae607fc416bd61d5d --- firmware/App/Drivers/ConductivitySensors.c (.../ConductivitySensors.c) (revision 8a7e671214ef3f742677f6de58b2b0ea86e8fe5c) +++ firmware/App/Drivers/ConductivitySensors.c (.../ConductivitySensors.c) (revision e2681bed3a45f89c804ddf2ae607fc416bd61d5d) @@ -48,8 +48,8 @@ #define LOWER_WORD_SIZE 4 ///< Size in bytes of the lower word size for retrieving revision data. #define MID_WORD_SIZE 4 ///< Size in bytes of the middle word size for retrieving revision data. #define UPPER_WORD_SIZE 2 ///< Size in bytes of the upper word size for retrieving revision data. -#define MAX_CONDUCTIVITY_SENSOR_FAILURES 2 -#define MAX_CONDUCTIVITY_SENSOR_FAILURE_WINDOW_MS ( 60 * MS_PER_SECOND ) +#define MAX_CONDUCTIVITY_SENSOR_FAILURES 2 ///< Number of failures before alarming in timed window count. +#define MAX_CONDUCTIVITY_SENSOR_FAILURE_WINDOW_MS ( 60 * MS_PER_SECOND ) ///< Set time for timed window count. #define MAX_ALLOWED_UNCHANGED_CONDUCTIVITY_READS ( 500 / TASK_PRIORITY_INTERVAL ) ///< New reading every 333ms, expect to get valid new reading in 500ms. #define SIEMENS_TO_MICROSIEMENS_CONVERSION 1000000 ///< Siemens to microSiemens conversion factor. #define COND_SENSORS_FPGA_ERROR_TIMEOUT_MS ( 2 * MS_PER_SECOND ) ///< Conductivity sensors FPGA error timeout in milliseconds. @@ -66,17 +66,17 @@ /// Conductivity Sensor Status group typedef struct { - U08 condReadCount; - U08 condErrorCount; - U08 tempReadCount; - U08 tempErrorCount; + U08 condReadCount; ///< Last conductivity read count. + U08 condErrorCount; ///< Last conductivity error count. + U08 tempReadCount; ///< Last temperature read count. + U08 tempErrorCount; ///< Last temperature error count. U08 interalCondErrorCount; ///< Internal conductivity error count for stale data. U08 interalTempErrorCount; ///< Internal temperature error count for stale data. U08 calMemCount; ///< Cal memory counter. U32 calData; ///< Cal word data storage. BOOL hasCalSlotBeenRead[ NUM_OF_CONDUCTIVTY_CAL_IDXS ]; ///< Boolean array tracking which cal mem data has been read. - BOOL haveAllCalSlotsBeenRead; - BOOL calReadComplete; + BOOL haveAllCalSlotsBeenRead; ///< Boolean to determine if all cal values have been read from the FPGA. + BOOL calReadComplete; ///< Boolean to determine if cal values are within range and ready to read data. } CONDUCTIVITY_SENSOR_STATUS_T; // ********** private data ********** @@ -180,8 +180,6 @@ initFPGAPersistentAlarm( FPGA_PERS_ERROR_D29_COND_SENSOR, ALARM_ID_DD_D29_COND_SENSOR_FPGA_FAULT, COND_SENSORS_FPGA_ERROR_TIMEOUT_MS, COND_SENSORS_FPGA_ERROR_TIMEOUT_MS ); initFPGAPersistentAlarm( FPGA_PERS_ERROR_D43_COND_SENSOR, ALARM_ID_DD_D43_COND_SENSOR_FPGA_FAULT, COND_SENSORS_FPGA_ERROR_TIMEOUT_MS, COND_SENSORS_FPGA_ERROR_TIMEOUT_MS ); initFPGAPersistentAlarm( FPGA_PERS_ERROR_D74_COND_SENSOR, ALARM_ID_DD_D74_COND_SENSOR_FPGA_FAULT, COND_SENSORS_FPGA_ERROR_TIMEOUT_MS, COND_SENSORS_FPGA_ERROR_TIMEOUT_MS ); - //initFPGAPersistentAlarm( FPGA_PERS_ERROR_P9_COND_SENSOR, ALARM_ID_FP_P9_SENSOR_FPGA_FAULT, COND_SENSORS_FPGA_ERROR_TIMEOUT_MS, COND_SENSORS_FPGA_ERROR_TIMEOUT_MS ); - //initFPGAPersistentAlarm( FPGA_PERS_ERROR_P18_COND_SENSOR, ALARM_ID_FP_P18_SENSOR_FPGA_FAULT, COND_SENSORS_FPGA_ERROR_TIMEOUT_MS, COND_SENSORS_FPGA_ERROR_TIMEOUT_MS ); } /*********************************************************************//** @@ -281,7 +279,7 @@ *************************************************************************/ static void readConductivitySensorCalData( void ) { - // Update error counters for each conductivity sensor + // Update cal data and counter for each conductivity sensor conductivitySensorStatus[ D17_COND ].calData = (U32)getFPGAD17CondCalData(); conductivitySensorStatus[ D27_COND ].calData = (U32)getFPGAD27CondCalData(); conductivitySensorStatus[ D29_COND ].calData = (U32)getFPGAD29CondCalData();