Projects/TempDataLogger/TempDataLogger.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  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 disclaim 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
  49                                 .DataINEndpointNumber      = MASS_STORAGE_IN_EPNUM,
  50                                 .DataINEndpointSize        = MASS_STORAGE_IO_EPSIZE,
  51                                 .DataINEndpointDoubleBank  = false,
  52
  53                                 .DataOUTEndpointNumber     = MASS_STORAGE_OUT_EPNUM,
  54                                 .DataOUTEndpointSize       = MASS_STORAGE_IO_EPSIZE,
  55                                 .DataOUTEndpointDoubleBank = false,
  56
  57                                 .TotalLUNs                 = 1,
  58                         },
  59         };
  60
  61 /** Buffer to hold the previously generated HID report, for comparison purposes inside the HID class driver. */
  62 uint8_t PrevHIDReportBuffer[GENERIC_REPORT_SIZE];
  63
  64 /** LUFA HID Class driver interface configuration and state information. This structure is
  65  *  passed to all HID Class driver functions, so that multiple instances of the same class
  66  *  within a device can be differentiated from one another.
  67  */
  68 USB_ClassInfo_HID_Device_t Generic_HID_Interface =
  69         {
  70                 .Config =
  71                         {
  72                                 .InterfaceNumber              = 1,
  73
  74                                 .ReportINEndpointNumber       = GENERIC_IN_EPNUM,
  75                                 .ReportINEndpointSize         = GENERIC_EPSIZE,
  76                                 .ReportINEndpointDoubleBank   = false,
  77
  78                                 .PrevReportINBuffer           = PrevHIDReportBuffer,
  79                                 .PrevReportINBufferSize       = sizeof(PrevHIDReportBuffer),
  80                         },
  81         };
  82
  83 /** Non-volatile Logging Interval value in EEPROM, stored as a number of 500ms ticks */
  84 uint8_t EEMEM LoggingInterval500MS_EEPROM = DEFAULT_LOG_INTERVAL;
  85
  86 /** SRAM Logging Interval value fetched from EEPROM, stored as a number of 500ms ticks */
  87 uint8_t LoggingInterval500MS_SRAM;
  88
  89 /** Total number of 500ms logging ticks elapsed since the last log value was recorded */
  90 uint16_t CurrentLoggingTicks;
  91
  92 /** FAT Fs structure to hold the internal state of the FAT driver for the Dataflash contents. */
  93 FATFS DiskFATState;
  94
  95 /** FAT Fs structure to hold a FAT file handle for the log data write destination. */
  96 FIL TempLogFile;
  97
  98
  99 /** ISR to handle the 500ms ticks for sampling and data logging */
 100 ISR(TIMER1_COMPA_vect, ISR_BLOCK)
 101 {
 102         uint8_t LEDMask = LEDs_GetLEDs();
 103
 104         /* Check to see if the logging interval has expired */
 105         if (CurrentLoggingTicks++ < LoggingInterval500MS_SRAM)
 106           return;
 107
 108         /* Reset log tick counter to prepare for next logging interval */
 109         CurrentLoggingTicks = 0;
 110
 111         LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
 112
 113         /* Only log when not connected to a USB host */
 114         if (USB_DeviceState == DEVICE_STATE_Unattached)
 115         {
 116                 TimeDate_t CurrentTimeDate;
 117                 DS1307_GetTimeDate(&CurrentTimeDate);
 118
 119                 char     LineBuffer[100];
 120                 uint16_t BytesWritten;
 121
 122                 BytesWritten = sprintf(LineBuffer, "%02d/%02d/20%02d, %02d:%02d:%02d, %d Degrees\r\n",
 123                                        CurrentTimeDate.Day, CurrentTimeDate.Month, CurrentTimeDate.Year,
 124                                        CurrentTimeDate.Hour, CurrentTimeDate.Minute, CurrentTimeDate.Second,
 125                                        Temperature_GetTemperature());
 126
 127                 f_write(&TempLogFile, LineBuffer, BytesWritten, &BytesWritten);
 128                 f_sync(&TempLogFile);
 129         }
 130
 131         LEDs_SetAllLEDs(LEDMask);
 132 }
 133
 134 /** Main program entry point. This routine contains the overall program flow, including initial
 135  *  setup of all components and the main program loop.
 136  */
 137 int main(void)
 138 {
 139         SetupHardware();
 140
 141         /* Fetch logging interval from EEPROM */
 142         LoggingInterval500MS_SRAM = eeprom_read_byte(&LoggingInterval500MS_EEPROM);
 143
 144         /* Check if the logging interval is invalid (0xFF) indicating that the EEPROM is blank */
 145         if (LoggingInterval500MS_SRAM == 0xFF)
 146           LoggingInterval500MS_SRAM = DEFAULT_LOG_INTERVAL;
 147
 148         /* Mount and open the log file on the Dataflash FAT partition */
 149         OpenLogFile();
 150
 151         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 152         sei();
 153
 154         /* Discard the first sample from the temperature sensor, as it is generally incorrect */
 155         volatile uint8_t Dummy = Temperature_GetTemperature();
 156         (void)Dummy;
 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         /* Disable watchdog if enabled by bootloader/fuses */
 194         MCUSR &= ~(1 << WDRF);
 195         wdt_disable();
 196
 197         /* Disable clock division */
 198         clock_prescale_set(clock_div_1);
 199
 200         /* Hardware Initialization */
 201         LEDs_Init();
 202         SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_SCK_LEAD_FALLING | SPI_SAMPLE_TRAILING | SPI_MODE_MASTER);
 203         ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_128);
 204         Temperature_Init();
 205         Dataflash_Init();
 206         USB_Init();
 207         TWI_Init();
 208
 209         /* 500ms logging interval timer configuration */
 210         OCR1A   = (((F_CPU / 1024) / 2) - 1);
 211         TCCR1B  = (1 << WGM12) | (1 << CS12) | (1 << CS10);
 212         TIMSK1  = (1 << OCIE1A);
 213
 214         /* Clear Dataflash sector protections, if enabled */
 215         DataflashManager_ResetDataflashProtections();
 216 }
 217
 218 /** Event handler for the library USB Connection event. */
 219 void EVENT_USB_Device_Connect(void)
 220 {
 221         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 222
 223         /* Close the log file so that the host has exclusive filesystem access */
 224         CloseLogFile();
 225 }
 226
 227 /** Event handler for the library USB Disconnection event. */
 228 void EVENT_USB_Device_Disconnect(void)
 229 {
 230         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 231
 232         /* Mount and open the log file on the Dataflash FAT partition */
 233         OpenLogFile();
 234 }
 235
 236 /** Event handler for the library USB Configuration Changed event. */
 237 void EVENT_USB_Device_ConfigurationChanged(void)
 238 {
 239         bool ConfigSuccess = true;
 240
 241         ConfigSuccess &= HID_Device_ConfigureEndpoints(&Generic_HID_Interface);
 242         ConfigSuccess &= MS_Device_ConfigureEndpoints(&Disk_MS_Interface);
 243
 244         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 245 }
 246
 247 /** Event handler for the library USB Control Request reception event. */
 248 void EVENT_USB_Device_ControlRequest(void)
 249 {
 250         MS_Device_ProcessControlRequest(&Disk_MS_Interface);
 251         HID_Device_ProcessControlRequest(&Generic_HID_Interface);
 252 }
 253
 254 /** Mass Storage class driver callback function the reception of SCSI commands from the host, which must be processed.
 255  *
 256  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface configuration structure being referenced
 257  */
 258 bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
 259 {
 260         bool CommandSuccess;
 261
 262         LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
 263         CommandSuccess = SCSI_DecodeSCSICommand(MSInterfaceInfo);
 264         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 265
 266         return CommandSuccess;
 267 }
 268
 269 /** HID class driver callback function for the creation of HID reports to the host.
 270  *
 271  *  \param[in]     HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 272  *  \param[in,out] ReportID    Report ID requested by the host if non-zero, otherwise callback should set to the
 273  *                             generated report ID
 274  *  \param[in]     ReportType  Type of the report to create, either HID_REPORT_ITEM_In or HID_REPORT_ITEM_Feature
 275  *  \param[out]    ReportData  Pointer to a buffer where the created report should be stored
 276  *  \param[out]    ReportSize  Number of bytes written in the report (or zero if no report is to be sent
 277  *
 278  *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
 279  */
 280 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 281                                          uint8_t* const ReportID,
 282                                          const uint8_t ReportType,
 283                                          void* ReportData,
 284                                          uint16_t* const ReportSize)
 285 {
 286         Device_Report_t* ReportParams = (Device_Report_t*)ReportData;
 287
 288         DS1307_GetTimeDate(&ReportParams->TimeDate);
 289
 290         ReportParams->LogInterval500MS = LoggingInterval500MS_SRAM;
 291
 292         *ReportSize = sizeof(Device_Report_t);
 293         return true;
 294 }
 295
 296 /** HID class driver callback function for the processing of HID reports from the host.
 297  *
 298  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 299  *  \param[in] ReportID    Report ID of the received report from the host
 300  *  \param[in] ReportType  The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
 301  *  \param[in] ReportData  Pointer to a buffer where the created report has been stored
 302  *  \param[in] ReportSize  Size in bytes of the received HID report
 303  */
 304 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 305                                           const uint8_t ReportID,
 306                                           const uint8_t ReportType,
 307                                           const void* ReportData,
 308                                           const uint16_t ReportSize)
 309 {
 310         Device_Report_t* ReportParams = (Device_Report_t*)ReportData;
 311
 312         DS1307_SetTimeDate(&ReportParams->TimeDate);
 313
 314         /* If the logging interval has changed from its current value, write it to EEPROM */
 315         if (LoggingInterval500MS_SRAM != ReportParams->LogInterval500MS)
 316         {
 317                 LoggingInterval500MS_SRAM = ReportParams->LogInterval500MS;
 318                 eeprom_update_byte(&LoggingInterval500MS_EEPROM, LoggingInterval500MS_SRAM);
 319         }
 320 }
 321