Projects/TempDataLogger/TempDataLogger.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaims all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Main source file for the TemperatureDataLogger project. This file contains the main tasks of
  34  *  the project and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "TempDataLogger.h"
  38
  39 /** LUFA Mass Storage Class driver interface configuration and state information. This structure is
  40  *  passed to all Mass Storage Class driver functions, so that multiple instances of the same class
  41  *  within a device can be differentiated from one another.
  42  */
  43 USB_ClassInfo_MS_Device_t Disk_MS_Interface =
  44         {
  45                 .Config =
  46                         {
  47                                 .InterfaceNumber           = 0,
  48                                 .DataINEndpoint            =
  49                                         {
  50                                                 .Address           = MASS_STORAGE_IN_EPADDR,
  51                                                 .Size              = MASS_STORAGE_IO_EPSIZE,
  52                                                 .Banks             = 1,
  53                                         },
  54                                 .DataOUTEndpoint           =
  55                                         {
  56                                                 .Address           = MASS_STORAGE_OUT_EPADDR,
  57                                                 .Size              = MASS_STORAGE_IO_EPSIZE,
  58                                                 .Banks             = 1,
  59                                         },
  60                                 .TotalLUNs                 = 1,
  61                         },
  62         };
  63
  64 /** Buffer to hold the previously generated HID report, for comparison purposes inside the HID class driver. */
  65 static uint8_t PrevHIDReportBuffer[GENERIC_REPORT_SIZE];
  66
  67 /** LUFA HID Class driver interface configuration and state information. This structure is
  68  *  passed to all HID Class driver functions, so that multiple instances of the same class
  69  *  within a device can be differentiated from one another.
  70  */
  71 USB_ClassInfo_HID_Device_t Generic_HID_Interface =
  72         {
  73                 .Config =
  74                         {
  75                                 .InterfaceNumber              = 1,
  76                                 .ReportINEndpoint             =
  77                                         {
  78                                                 .Address              = GENERIC_IN_EPADDR,
  79                                                 .Size                 = GENERIC_EPSIZE,
  80                                                 .Banks                = 1,
  81                                         },
  82                                 .PrevReportINBuffer           = PrevHIDReportBuffer,
  83                                 .PrevReportINBufferSize       = sizeof(PrevHIDReportBuffer),
  84                         },
  85         };
  86
  87 /** Non-volatile Logging Interval value in EEPROM, stored as a number of 500ms ticks */
  88 static uint8_t EEMEM LoggingInterval500MS_EEPROM = DEFAULT_LOG_INTERVAL;
  89
  90 /** SRAM Logging Interval value fetched from EEPROM, stored as a number of 500ms ticks */
  91 static uint8_t LoggingInterval500MS_SRAM;
  92
  93 /** Total number of 500ms logging ticks elapsed since the last log value was recorded */
  94 static uint16_t CurrentLoggingTicks;
  95
  96 /** FAT Fs structure to hold the internal state of the FAT driver for the Dataflash contents. */
  97 static FATFS DiskFATState;
  98
  99 /** FAT Fs structure to hold a FAT file handle for the log data write destination. */
 100 static FIL TempLogFile;
 101
 102
 103 /** ISR to handle the 500ms ticks for sampling and data logging */
 104 ISR(TIMER1_COMPA_vect, ISR_BLOCK)
 105 {
 106         uint8_t LEDMask = LEDs_GetLEDs();
 107
 108         /* Check to see if the logging interval has expired */
 109         if (++CurrentLoggingTicks < LoggingInterval500MS_SRAM)
 110           return;
 111
 112         /* Reset log tick counter to prepare for next logging interval */
 113         CurrentLoggingTicks = 0;
 114
 115         LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
 116
 117         /* Only log when not connected to a USB host */
 118         if (USB_DeviceState == DEVICE_STATE_Unattached)
 119         {
 120                 TimeDate_t CurrentTimeDate;
 121                 DS1307_GetTimeDate(&CurrentTimeDate);
 122
 123                 char     LineBuffer[100];
 124                 uint16_t BytesWritten;
 125
 126                 BytesWritten = sprintf(LineBuffer, "%02d/%02d/20%02d, %02d:%02d:%02d, %d Degrees\r\n",
 127                                        CurrentTimeDate.Day, CurrentTimeDate.Month, CurrentTimeDate.Year,
 128                                        CurrentTimeDate.Hour, CurrentTimeDate.Minute, CurrentTimeDate.Second,
 129                                        Temperature_GetTemperature());
 130
 131                 f_write(&TempLogFile, LineBuffer, BytesWritten, &BytesWritten);
 132                 f_sync(&TempLogFile);
 133         }
 134
 135         LEDs_SetAllLEDs(LEDMask);
 136 }
 137
 138 /** Main program entry point. This routine contains the overall program flow, including initial
 139  *  setup of all components and the main program loop.
 140  */
 141 int main(void)
 142 {
 143         SetupHardware();
 144
 145         /* Fetch logging interval from EEPROM */
 146         LoggingInterval500MS_SRAM = eeprom_read_byte(&LoggingInterval500MS_EEPROM);
 147
 148         /* Check if the logging interval is invalid (0xFF) indicating that the EEPROM is blank */
 149         if (LoggingInterval500MS_SRAM == 0xFF)
 150           LoggingInterval500MS_SRAM = DEFAULT_LOG_INTERVAL;
 151
 152         /* Mount and open the log file on the Dataflash FAT partition */
 153         OpenLogFile();
 154
 155         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 156         GlobalInterruptEnable();
 157
 158         for (;;)
 159         {
 160                 MS_Device_USBTask(&Disk_MS_Interface);
 161                 HID_Device_USBTask(&Generic_HID_Interface);
 162                 USB_USBTask();
 163         }
 164 }
 165
 166 /** Opens the log file on the Dataflash's FAT formatted partition according to the current date */
 167 void OpenLogFile(void)
 168 {
 169         char LogFileName[12];
 170
 171         /* Get the current date for the filename as "DDMMYY.csv" */
 172         TimeDate_t CurrentTimeDate;
 173         DS1307_GetTimeDate(&CurrentTimeDate);
 174         sprintf(LogFileName, "%02d%02d%02d.csv", CurrentTimeDate.Day, CurrentTimeDate.Month, CurrentTimeDate.Year);
 175
 176         /* Mount the storage device, open the file */
 177         f_mount(0, &DiskFATState);
 178         f_open(&TempLogFile, LogFileName, FA_OPEN_ALWAYS | FA_WRITE);
 179         f_lseek(&TempLogFile, TempLogFile.fsize);
 180 }
 181
 182 /** Closes the open data log file on the Dataflash's FAT formatted partition */
 183 void CloseLogFile(void)
 184 {
 185         /* Sync any data waiting to be written, unmount the storage device */
 186         f_sync(&TempLogFile);
 187         f_close(&TempLogFile);
 188 }
 189
 190 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 191 void SetupHardware(void)
 192 {
 193 #if (ARCH == ARCH_AVR8)
 194         /* Disable watchdog if enabled by bootloader/fuses */
 195         MCUSR &= ~(1 << WDRF);
 196         wdt_disable();
 197
 198         /* Disable clock division */
 199         clock_prescale_set(clock_div_1);
 200 #endif
 201
 202         /* Hardware Initialization */
 203         LEDs_Init();
 204         ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_128);
 205         Temperature_Init();
 206         Dataflash_Init();
 207         USB_Init();
 208         TWI_Init(TWI_BIT_PRESCALE_4, TWI_BITLENGTH_FROM_FREQ(4, 50000));
 209
 210         /* 500ms logging interval timer configuration */
 211         OCR1A   = (((F_CPU / 1024) / 2) - 1);
 212         TCCR1B  = (1 << WGM12) | (1 << CS12) | (1 << CS10);
 213         TIMSK1  = (1 << OCIE1A);
 214
 215         /* Check if the Dataflash is working, abort if not */
 216         if (!(DataflashManager_CheckDataflashOperation()))
 217         {
 218                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 219                 for(;;);
 220         }
 221
 222         /* Clear Dataflash sector protections, if enabled */
 223         DataflashManager_ResetDataflashProtections();
 224 }
 225
 226 /** Event handler for the library USB Connection event. */
 227 void EVENT_USB_Device_Connect(void)
 228 {
 229         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 230
 231         /* Close the log file so that the host has exclusive file system access */
 232         CloseLogFile();
 233 }
 234
 235 /** Event handler for the library USB Disconnection event. */
 236 void EVENT_USB_Device_Disconnect(void)
 237 {
 238         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 239
 240         /* Mount and open the log file on the Dataflash FAT partition */
 241         OpenLogFile();
 242 }
 243
 244 /** Event handler for the library USB Configuration Changed event. */
 245 void EVENT_USB_Device_ConfigurationChanged(void)
 246 {
 247         bool ConfigSuccess = true;
 248
 249         ConfigSuccess &= HID_Device_ConfigureEndpoints(&Generic_HID_Interface);
 250         ConfigSuccess &= MS_Device_ConfigureEndpoints(&Disk_MS_Interface);
 251
 252         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 253 }
 254
 255 /** Event handler for the library USB Control Request reception event. */
 256 void EVENT_USB_Device_ControlRequest(void)
 257 {
 258         MS_Device_ProcessControlRequest(&Disk_MS_Interface);
 259         HID_Device_ProcessControlRequest(&Generic_HID_Interface);
 260 }
 261
 262 /** Mass Storage class driver callback function the reception of SCSI commands from the host, which must be processed.
 263  *
 264  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface configuration structure being referenced
 265  */
 266 bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
 267 {
 268         bool CommandSuccess;
 269
 270         LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
 271         CommandSuccess = SCSI_DecodeSCSICommand(MSInterfaceInfo);
 272         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 273
 274         return CommandSuccess;
 275 }
 276
 277 /** HID class driver callback function for the creation of HID reports to the host.
 278  *
 279  *  \param[in]     HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 280  *  \param[in,out] ReportID    Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
 281  *  \param[in]     ReportType  Type of the report to create, either HID_REPORT_ITEM_In or HID_REPORT_ITEM_Feature
 282  *  \param[out]    ReportData  Pointer to a buffer where the created report should be stored
 283  *  \param[out]    ReportSize  Number of bytes written in the report (or zero if no report is to be sent)
 284  *
 285  *  \return Boolean \c true to force the sending of the report, \c false to let the library determine if it needs to be sent
 286  */
 287 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 288                                          uint8_t* const ReportID,
 289                                          const uint8_t ReportType,
 290                                          void* ReportData,
 291                                          uint16_t* const ReportSize)
 292 {
 293         Device_Report_t* ReportParams = (Device_Report_t*)ReportData;
 294
 295         DS1307_GetTimeDate(&ReportParams->TimeDate);
 296
 297         ReportParams->LogInterval500MS = LoggingInterval500MS_SRAM;
 298
 299         *ReportSize = sizeof(Device_Report_t);
 300         return true;
 301 }
 302
 303 /** HID class driver callback function for the processing of HID reports from the host.
 304  *
 305  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 306  *  \param[in] ReportID    Report ID of the received report from the host
 307  *  \param[in] ReportType  The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
 308  *  \param[in] ReportData  Pointer to a buffer where the received report has been stored
 309  *  \param[in] ReportSize  Size in bytes of the received HID report
 310  */
 311 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 312                                           const uint8_t ReportID,
 313                                           const uint8_t ReportType,
 314                                           const void* ReportData,
 315                                           const uint16_t ReportSize)
 316 {
 317         Device_Report_t* ReportParams = (Device_Report_t*)ReportData;
 318
 319         DS1307_SetTimeDate(&ReportParams->TimeDate);
 320
 321         /* If the logging interval has changed from its current value, write it to EEPROM */
 322         if (LoggingInterval500MS_SRAM != ReportParams->LogInterval500MS)
 323         {
 324                 LoggingInterval500MS_SRAM = ReportParams->LogInterval500MS;
 325                 eeprom_update_byte(&LoggingInterval500MS_EEPROM, LoggingInterval500MS_SRAM);
 326         }
 327 }
 328