Index: NVDataMgmt.h =================================================================== diff -u -r169b3efe1866e53f4d31db0cde00594a7c8ad210 -re1f9404958c9ddab9b004399fb0870e09e37512b --- NVDataMgmt.h (.../NVDataMgmt.h) (revision 169b3efe1866e53f4d31db0cde00594a7c8ad210) +++ NVDataMgmt.h (.../NVDataMgmt.h) (revision e1f9404958c9ddab9b004399fb0870e09e37512b) @@ -19,53 +19,59 @@ #include "Common.h" -#define MAX_SYS_SERIAL_NUMBER_CHARACTERS 7U -#define MAX_HW_SERIAL_NUMBER_CHARACTERS 5U -#define MAX_DATE_CHARACTERS 10U +#define MAX_SYS_SERIAL_NUMBER_CHARACTERS 7U ///< Max number of characters for SYS serial number +#define MAX_HW_SERIAL_NUMBER_CHARACTERS 5U ///< Max number of characters for HD serial number +#define MAX_DATE_CHARACTERS 10U ///< Max number of characters for date +/// Log event enum typedef enum LOG_EVENT { - NVDATAMGMT_MODE_CHANGE = 0, - NVDATAMGMT_ALARM, - NVDATAMGMT_DISINFECTION_STARTED, - NVDATAMGMT_DISINFECTION_ENDED, - NVDATAMGMT_DEVICE_TURNED_ON, - NVDATAMGMT_DEVICE_TURNED_OFF, - NVDATAMGMT_UI_CRASHED + NVDATAMGMT_MODE_CHANGE = 0, ///< Mode change + NVDATAMGMT_ALARM, ///< Alarm + NVDATAMGMT_DISINFECTION_STARTED, ///< Disinfection started + NVDATAMGMT_DISINFECTION_ENDED, ///< Disinfection ended + NVDATAMGMT_DEVICE_TURNED_ON, ///< Device turned on + NVDATAMGMT_DEVICE_TURNED_OFF, ///< Device turned off + NVDATAMGMT_UI_CRASHED ///< UI crashed } NVDATAMGMT_LOG_EVENT_T; +/// Read status enum typedef enum READ_STATUS { - NVDATAMGMT_READ_IDLE = 0, - NVDATAMGMT_READ_IN_PROGRESS, - NVDATAMGMT_READ_COMPLETE + NVDATAMGMT_READ_IDLE = 0, ///< Read status idle + NVDATAMGMT_READ_IN_PROGRESS, ///< Read status in progress + NVDATAMGMT_READ_COMPLETE ///< Read status complete } NVDATAMGMT_READ_STATUS_T; #pragma pack(push, 1) +/// Manufacturing data struct typedef struct mfg_Data { - char SYSSerialNumber [ MAX_SYS_SERIAL_NUMBER_CHARACTERS ]; - char HWSerialNumber [ MAX_HW_SERIAL_NUMBER_CHARACTERS ]; - char mfgDate [ MAX_DATE_CHARACTERS ]; + char SYSSerialNumber [ MAX_SYS_SERIAL_NUMBER_CHARACTERS ]; ///< SYS serial number + char HWSerialNumber [ MAX_HW_SERIAL_NUMBER_CHARACTERS ]; ///< HW serial number + char mfgDate [ MAX_DATE_CHARACTERS ]; ///< Manufacturing date } MFG_DATA_T; +/// Service dates struct typedef struct service_dates { - char currentServiceDate [ MAX_DATE_CHARACTERS ]; - char nextServiceDate [ MAX_DATE_CHARACTERS ]; + char currentServiceDate [ MAX_DATE_CHARACTERS ]; ///< Current service date + char nextServiceDate [ MAX_DATE_CHARACTERS ]; ///< Next service date } SERVICE_DATA_T; +/// Calibration data struct typedef struct calibration_Data { - F32 occSensorOffset; - F32 tempSensorOffset; - char calibrationDate [ MAX_DATE_CHARACTERS ]; + F32 occSensorOffset; ///< Item 1 + F32 tempSensorOffset; ///< Item 2 + char calibrationDate [ MAX_DATE_CHARACTERS ]; ///< Calibration date } CALIBRATION_DATA_T; +/// Read data status typedef struct get_data { - NVDATAMGMT_READ_STATUS_T status; - U08* externalBuffer; + NVDATAMGMT_READ_STATUS_T status; ///< Read data status + U08* externalBuffer; ///< External buffer address } READ_DATA_T; #pragma pack(pop) @@ -99,9 +105,9 @@ U32 getWaterConsumption ( void ); -BOOL setDisinfectionDate ( char date ); // TODO ADD TO AE +BOOL setDisinfectionDate ( char date [ MAX_DATE_CHARACTERS ] ); -void getDisinfectionDate ( void ); // TODO ADD TO AE +void getDisinfectionDate ( U08* buffer ); BOOL writeLogData ( U08* data, U32 length );