neil hancock / Mbed 2 deprecated kl25z_Usb_Logger

Logger to USB stick running on KL25Z

Dependencies:   F401RE-USBHost FastAnalogIn RTC mbed tsi_sensor2 mbed-rtos2

Fork of ReadSendData by Stuart Scott

Homepage for kXX_logger(was kl25x_usb_logger)

2014Nov12 - Added TSI - only works for kl25z, and fails after 4287seconds

Tests sequences for freezing 4287seconds 4287 4287 - Changed to USB write update every two seconds and lasted 4283seconds. Added mbed TSI_sensor - kudos to mbed as it turns out to be complex to do capacitive touch sensing. Kinetis L series Cortex-M0 (kl25z) has simpler capacitive sensing hardware which mbed/TSI_sensor lib uses, but doesn't support Cortex-M4 versions. K20D is older more complex interface. TSS hasn't had an open source support by Freescale in the past however that has changed. Currently I found KDS1.1.1 has a Processor Expert TSSlib that can be imported - but I'm getting a weird compile/include error - and not found any examples of how to make it work.

2014Oct05 - Published simple kl25z_usb_logger

Testing: Version (2:f06fbf86887e) has run over 28days starting 2014Sept07, reading a sensor data every seconds and then on the USB stick open file, write record, close file

This is over 2,419,200seconds ( 28days*24hrs*3600seconds) The stick data reflected 2,447,633 seconds, but only had 1,776,366 data records. After 407,650 data records started missing updates - analysis: the file could not be opened and read to the end in the allocated 1 second, and therefore missed the next ADC deadline.

By the end of the test period with 1,776,366 records on the USB Stick, ever read then write was causing it to miss two/three ADC updates - ie taking longer than two seconds.

Analysis: this was an aggressive test, and normally would not be opening, writing, closing every 1 second. However big plus the file mechanism held up and the program continued to operate, with a graceful failure of a missed ADC readings. The output used JSON, which reads nicely but turns out not to be supported by Excel (2014?) I was using.

Conclusion: Overall the USB Mechanisms and file read is stable. However the USB stack used doesn't have an event based management for stick insertion and removal, or OTG power management . This KL25Z has been a very useful test to prove the configuration of clocks for USB Stack is possible and stable. The target processor being looked at is the MK20 and is similar in clocks, but slightly more comprehensive USB OTG Next step is to investigate the full Freescale Kinetis USB OTG Stack with power management on a custom K20 board, using Kinetis Design Studio, and very low power capability.

Example https://github.com/ErichStyger/mcuoneclipse/tree/master/Examples/FRDM-K20D50M/FRDM-K20_MSD_Host http://mcuoneclipse.com/2014/10/25/usb-cdc-with-the-frdm-k64f-finally/#comment-37727 - Commentary on Freescale USB versions

main.cpp@2:f06fbf86887e, 2014-10-05 (annotated)

Committer:
neilh20
Date:
Sun Oct 05 21:04:14 2014 +0000
Revision:
2:f06fbf86887e
Parent:
0:eb0dc2b5bc51
Child:
3:d94384ab6f12
Logger to USB stick on KL25z

Who changed what in which revision?

UserRevisionLine numberNew contents of line
neilh20 2:f06fbf86887e 1 /* low power data logger. [FRDM-KL25Z]
neilh20 2:f06fbf86887e 2
neilh20 2:f06fbf86887e 3 Periodically read data from ADC and when present write it in JSON format to USB Stick
neilh20 2:f06fbf86887e 4
neilh20 2:f06fbf86887e 5 Copyright http://www.apache.org/licenses/LICENSE-2.0
neilh20 2:f06fbf86887e 6 and all subsystems per their own licenses which are believed to be GPL 2.0
neilh20 2:f06fbf86887e 7
neilh20 2:f06fbf86887e 8 [c]Record an analoge value to an internal buffer
neilh20 2:f06fbf86887e 9 [p]and when a USB stick is plugged in store the values on the USB stick in JSON format
neilh20 2:f06fbf86887e 10 (currently requires USB stick at reset)
neilh20 2:f06fbf86887e 11 [c]Debug output the events as they happen.
neilh20 2:f06fbf86887e 12 [c]The ticker delay sets the sampling rate.
neilh20 2:f06fbf86887e 13 [F]Date is set when user sets it,
neilh20 2:f06fbf86887e 14 [c]or elapsed time used in the beginning
neilh20 2:f06fbf86887e 15
neilh20 2:f06fbf86887e 16 [F]If OpenSDA USB power supplied, then flash LEDs to indicate activity as follows
neilh20 2:f06fbf86887e 17 [c]1) the Blue led when taking a sample
neilh20 2:f06fbf86887e 18 [c]2) the green led when delivering samples to the USB stick
neilh20 2:f06fbf86887e 19 [F]3)no led shall be on at same time for clear colours
neilh20 2:f06fbf86887e 20
neilh20 2:f06fbf86887e 21 [F] when not doing anything else sleep to conserve power.
sas37 0:eb0dc2b5bc51 22
neilh20 2:f06fbf86887e 23 To modify this for your application, assuming a ratiometric input to the Vref=3.3V
neilh20 2:f06fbf86887e 24 1) Determine physical pins ADC performed on and type of conversion,
neilh20 2:f06fbf86887e 25 1) Determine the "multiplier" from the incoming 16bit ADC wrt to 3.3V to your units.
neilh20 2:f06fbf86887e 26 2) Write the output code changing the JSON headers to define your headers, dataConversion and units
neilh20 2:f06fbf86887e 27
neilh20 2:f06fbf86887e 28 Thanks to other authors for setting up KL25z for
neilh20 2:f06fbf86887e 29 * FastAnalogIn Library mbed.org/users/Sissors/code/FastAnalogIn/
neilh20 2:f06fbf86887e 30 * USB Host mbed.org/users/va009039/code/F401RE-USBHost/
neilh20 2:f06fbf86887e 31
neilh20 2:f06fbf86887e 32 [] 1st three character nomeclature.
neilh20 2:f06fbf86887e 33 [x] indicates implemented state of feature
neilh20 2:f06fbf86887e 34 [c] - complete and unit tested
neilh20 2:f06fbf86887e 35 [p] - partial in progress or not unit tested
neilh20 2:f06fbf86887e 36 [f] - future idea
sas37 0:eb0dc2b5bc51 37
neilh20 2:f06fbf86887e 38 Testing: Basic tests performed, see attached file logger_tests.docx
neilh20 2:f06fbf86887e 39
neilh20 2:f06fbf86887e 40 Modifications to Hardware
neilh20 2:f06fbf86887e 41 1) FRDM-KL25z add J21 and R8 per the instruction manual for USB host
sas37 0:eb0dc2b5bc51 42
neilh20 2:f06fbf86887e 43 Issues:
neilh20 2:f06fbf86887e 44 1) FRDM-KL25z hardware not designed to switch the USB power so saving power on a connected USB device.
neilh20 2:f06fbf86887e 45 Solution: Add switched 5V power.
neilh20 2:f06fbf86887e 46 2) FRDM-KL25z Hardware not designed for low power accurate wall time clock - wastes power keeping the 8Mhz going.
neilh20 2:f06fbf86887e 47 Solution: add an external low power 32KHz oscilator into hardware pin RTC_IN (An osc is the next step up from a raw Xtal)
sas37 0:eb0dc2b5bc51 48
sas37 0:eb0dc2b5bc51 49
sas37 0:eb0dc2b5bc51 50 */
sas37 0:eb0dc2b5bc51 51
neilh20 2:f06fbf86887e 52 #include "mbed.h"
neilh20 2:f06fbf86887e 53 #include "rtc_api.h"
neilh20 2:f06fbf86887e 54 #include "FastAnalogIn.h"
neilh20 2:f06fbf86887e 55 #include "USBHostMSD.h"
neilh20 2:f06fbf86887e 56
neilh20 2:f06fbf86887e 57 //size of sample buffer
neilh20 2:f06fbf86887e 58 #define BuffSize 16 //16 to test, upto kl25z spare ram of about xxxx?, !2000, linker warns if too large, but also fails
neilh20 2:f06fbf86887e 59 //set the delay used by the ticker
neilh20 2:f06fbf86887e 60 const int sysTockInit_sec = 1; //Test 1, Real life 15minutes or 900sec
sas37 0:eb0dc2b5bc51 61
sas37 0:eb0dc2b5bc51 62 using namespace mbed;
sas37 0:eb0dc2b5bc51 63
neilh20 2:f06fbf86887e 64 //Device Init - per FRDM-KL25Z
neilh20 2:f06fbf86887e 65 DigitalOut ledRed(LED1);
neilh20 2:f06fbf86887e 66 DigitalOut ledGrn(LED2);
neilh20 2:f06fbf86887e 67 DigitalOut ledBlue(LED3);
neilh20 2:f06fbf86887e 68 FastAnalogIn ainPinAA(PTC2); ///AnalogAin pin
sas37 0:eb0dc2b5bc51 69
sas37 0:eb0dc2b5bc51 70 Serial pc(USBTX, USBRX);
sas37 0:eb0dc2b5bc51 71
neilh20 2:f06fbf86887e 72 //Samples stored here - needs to be compact as can use a lot of internal ram
neilh20 2:f06fbf86887e 73 unsigned short sample_u16[BuffSize]; //critical resource for number of samples
neilh20 2:f06fbf86887e 74 unsigned int time_[BuffSize];
sas37 0:eb0dc2b5bc51 75
neilh20 2:f06fbf86887e 76 FILE* fpUsb;
neilh20 2:f06fbf86887e 77 bool UsbPresent=0;
neilh20 2:f06fbf86887e 78 bool warmBoot = rtc_isenabled();
neilh20 2:f06fbf86887e 79 long lp2i =0;
neilh20 2:f06fbf86887e 80 bool sysEventA=0; //Local event
neilh20 2:f06fbf86887e 81 unsigned int tmrE_evt; //Elapsed
neilh20 2:f06fbf86887e 82 Ticker tock; //periodic tick
neilh20 2:f06fbf86887e 83
neilh20 2:f06fbf86887e 84 USBHostMSD msd("usbAa"); //defines the file system access
neilh20 2:f06fbf86887e 85
neilh20 2:f06fbf86887e 86 //--------------------------------------------------------------
neilh20 2:f06fbf86887e 87 void tockEvent()
sas37 0:eb0dc2b5bc51 88 {
neilh20 2:f06fbf86887e 89 tmrE_evt++;
neilh20 2:f06fbf86887e 90 sysEventA=1;
sas37 0:eb0dc2b5bc51 91 }
sas37 0:eb0dc2b5bc51 92
neilh20 2:f06fbf86887e 93 //--------------------------------------------------------------
neilh20 2:f06fbf86887e 94 /* Process output Header to USB,
neilh20 2:f06fbf86887e 95 return !0 if valid USB present
neilh20 2:f06fbf86887e 96 */
neilh20 2:f06fbf86887e 97 bool outputHeaderUsb() {
neilh20 2:f06fbf86887e 98 // JSON {"headings":{"time":{"elapsed":"seconds"}, "adcN":"normalized_to_1.0", "adcV":"Volts"}}
neilh20 2:f06fbf86887e 99
neilh20 2:f06fbf86887e 100 if (!UsbPresent)
neilh20 2:f06fbf86887e 101 {
neilh20 2:f06fbf86887e 102 if (msd.connect()) //Attempt to find a device
neilh20 2:f06fbf86887e 103 {//USB Event: newly connected so attempt write header
neilh20 2:f06fbf86887e 104 if (NULL !=(fpUsb = fopen("/usbAa/test1.txt", "a")))
neilh20 2:f06fbf86887e 105 {
neilh20 2:f06fbf86887e 106 pc.printf("USB File test1.txt opened.\n\r");
neilh20 2:f06fbf86887e 107 fprintf(fpUsb,"{\"headings\":{\"time\":{\"elapsed\":\"seconds\"}, \"adcN\":\"normalized_to_1.0\", \"adcV\":\"Volts\"}}\n");
neilh20 2:f06fbf86887e 108 UsbPresent=1;
neilh20 2:f06fbf86887e 109 fclose(fpUsb); fpUsb=NULL;
neilh20 2:f06fbf86887e 110 } else {
neilh20 2:f06fbf86887e 111 //Can't find a file for some reason. Could be USB full or failed software
neilh20 2:f06fbf86887e 112 pc.printf(" Error: USB File not opened.\n\r");
neilh20 2:f06fbf86887e 113 UsbPresent=0;
neilh20 2:f06fbf86887e 114 }
neilh20 2:f06fbf86887e 115 } //else //Can't find USB device
neilh20 2:f06fbf86887e 116 } else {
neilh20 2:f06fbf86887e 117 // UsbPresent and assume headers written
neilh20 2:f06fbf86887e 118 if (!msd.connected())
neilh20 2:f06fbf86887e 119 {
neilh20 2:f06fbf86887e 120 pc.printf(" USB Flash drive removed.\n\r");
neilh20 2:f06fbf86887e 121 UsbPresent=0;
neilh20 2:f06fbf86887e 122 }
neilh20 2:f06fbf86887e 123 }
neilh20 2:f06fbf86887e 124
neilh20 2:f06fbf86887e 125 return UsbPresent;
neilh20 2:f06fbf86887e 126 }
neilh20 2:f06fbf86887e 127 //--------------------------------------------------------------
neilh20 2:f06fbf86887e 128 void outputHeaders(void) {
neilh20 2:f06fbf86887e 129 outputHeaderUsb();
neilh20 2:f06fbf86887e 130 pc.printf(" Time(S) depthR(norm) Volts Idx %d\n\r",(unsigned int) rtc_read());
neilh20 2:f06fbf86887e 131 }//outputHeaders
sas37 0:eb0dc2b5bc51 132
neilh20 2:f06fbf86887e 133
neilh20 2:f06fbf86887e 134
neilh20 2:f06fbf86887e 135 //--------------------------------------------------------------
neilh20 2:f06fbf86887e 136 /* Manage the write to USB stick
neilh20 2:f06fbf86887e 137 [FUT] detect USB stick and if not present write it when inserted
neilh20 2:f06fbf86887e 138
neilh20 2:f06fbf86887e 139 JSON output json.org
neilh20 2:f06fbf86887e 140 {key:value, key:value, key:value}
neilh20 2:f06fbf86887e 141 {time:[elapsed:<secs 0-2**32>, epoch2014:<secs 0-2**32>,wall:[date:<>,clock:<>],],
neilh20 2:f06fbf86887e 142 adcNorm:<float number 0.0-1.0>,
neilh20 2:f06fbf86887e 143 adcV:<Volts 0-VRef>
neilh20 2:f06fbf86887e 144 */
neilh20 2:f06fbf86887e 145 void manageUsbWrite() {
neilh20 2:f06fbf86887e 146 #define ADC_NORMALIZE (1.0f/65535.0f)
neilh20 2:f06fbf86887e 147 #define ADC_NORM_VREF 3.3
neilh20 2:f06fbf86887e 148 float data_n=( ((float)sample_u16[lp2i]) * ADC_NORMALIZE);
neilh20 2:f06fbf86887e 149 if (outputHeaderUsb())
neilh20 2:f06fbf86887e 150 {
neilh20 2:f06fbf86887e 151 if (NULL !=(fpUsb = fopen("/usbAa/test1.txt", "a")))
neilh20 2:f06fbf86887e 152 {
neilh20 2:f06fbf86887e 153 fprintf(fpUsb, "{\"time\":{\"elapsed\":%10d},\"adcN\": %5.4f, \"adcV\":%6.4f}\n",time_[lp2i],data_n,(ADC_NORM_VREF*data_n));
neilh20 2:f06fbf86887e 154 fclose(fpUsb); fpUsb=NULL;
neilh20 2:f06fbf86887e 155 ledGrn = !ledGrn;
neilh20 2:f06fbf86887e 156 } else {
neilh20 2:f06fbf86887e 157 //Potential Error
neilh20 2:f06fbf86887e 158 UsbPresent=0; //Can't say its dissappeared as will cause USB find problem.
neilh20 2:f06fbf86887e 159 pc.printf(" Error: USB unexpected can't write!!\n\r");
neilh20 2:f06fbf86887e 160 }
neilh20 2:f06fbf86887e 161 }
neilh20 2:f06fbf86887e 162 }
neilh20 2:f06fbf86887e 163 //--------------------------------------------------------------
neilh20 2:f06fbf86887e 164 /* Manage the sample
neilh20 2:f06fbf86887e 165 - store it
neilh20 2:f06fbf86887e 166 - and write it to USB stick
neilh20 2:f06fbf86887e 167 [FUT] detect USB stick and if not present write it when inserted
neilh20 2:f06fbf86887e 168
neilh20 2:f06fbf86887e 169 JSON output json.org
neilh20 2:f06fbf86887e 170 {key:value, key:value, key:value}
neilh20 2:f06fbf86887e 171 {time:[elapsed:<secs 0-2**32>, epoch2014:<secs 0-2**32>,wall:[date:<>,clock:<>],],
neilh20 2:f06fbf86887e 172 adcNorm:<float number 0.0-1.0>,
neilh20 2:f06fbf86887e 173 adcV:<Volts 0-VRef>}
neilh20 2:f06fbf86887e 174 */
neilh20 2:f06fbf86887e 175 void manageSample() {
neilh20 2:f06fbf86887e 176 float data_n=( ((float)sample_u16[lp2i]) * ADC_NORMALIZE);
neilh20 2:f06fbf86887e 177 pc.printf("%10d %5.4f (%6.4fV) %i\n\r",time_[lp2i],data_n,(ADC_NORM_VREF*data_n),lp2i);
neilh20 2:f06fbf86887e 178 ledBlue = !ledBlue;
neilh20 2:f06fbf86887e 179
neilh20 2:f06fbf86887e 180 manageUsbWrite();
neilh20 2:f06fbf86887e 181
neilh20 2:f06fbf86887e 182 }//end manageSample
neilh20 2:f06fbf86887e 183
neilh20 2:f06fbf86887e 184 //--------------------------------------------------------------
neilh20 2:f06fbf86887e 185 /* Manage the sample
neilh20 2:f06fbf86887e 186 - take an ADC sample and
neilh20 2:f06fbf86887e 187 */
neilh20 2:f06fbf86887e 188 void manageAdcIn(void){
neilh20 2:f06fbf86887e 189 //Take samples and store in buffer
neilh20 2:f06fbf86887e 190 if (++lp2i >= BuffSize) lp2i=0;
neilh20 2:f06fbf86887e 191 sample_u16[lp2i]=ainPinAA.read_u16();
neilh20 2:f06fbf86887e 192 time_[lp2i]=(unsigned int)tmrE_evt; //TODO - replace with wall time
neilh20 2:f06fbf86887e 193 }//manageAdcIn
neilh20 2:f06fbf86887e 194
neilh20 2:f06fbf86887e 195 //--------------------------------------------------------------
sas37 0:eb0dc2b5bc51 196 int main()
neilh20 2:f06fbf86887e 197
neilh20 2:f06fbf86887e 198 //TODO: check RCM_SRS0 &RS1
neilh20 2:f06fbf86887e 199 warmBoot = rtc_isenabled();
neilh20 2:f06fbf86887e 200 if (!warmBoot) {
neilh20 2:f06fbf86887e 201 //TODO figure out how to manage wall time
neilh20 2:f06fbf86887e 202 rtc_init(); //Assumes external clock - TODO: options int32Khz RTC_CLKIN ext32KhzXtal
neilh20 2:f06fbf86887e 203 rtc_write(0x0); //Init to some default;
neilh20 2:f06fbf86887e 204 }
neilh20 2:f06fbf86887e 205 ledRed =1;//Off
neilh20 2:f06fbf86887e 206 ledGrn =1; //off
neilh20 2:f06fbf86887e 207 ledBlue = 0; //on
neilh20 2:f06fbf86887e 208 pc.baud(115200);//Opt 57600
neilh20 2:f06fbf86887e 209 pc.printf("\n\rkl25z Logger v0.1 \n\r Sample [time=%dsec, size=%d] Clock=%d\n\r", sysTockInit_sec,BuffSize,SystemCoreClock);
neilh20 2:f06fbf86887e 210
neilh20 2:f06fbf86887e 211 outputHeaders();
neilh20 2:f06fbf86887e 212
neilh20 2:f06fbf86887e 213 tock.attach(&tockEvent,sysTockInit_sec);
neilh20 2:f06fbf86887e 214
sas37 0:eb0dc2b5bc51 215 while (true) {
neilh20 2:f06fbf86887e 216 if(sysEventA)
neilh20 2:f06fbf86887e 217 {
neilh20 2:f06fbf86887e 218 sysEventA=0;
neilh20 2:f06fbf86887e 219 manageAdcIn();
neilh20 2:f06fbf86887e 220 manageSample();
neilh20 2:f06fbf86887e 221 }//else
neilh20 2:f06fbf86887e 222 // TODO go into power down till next event
sas37 0:eb0dc2b5bc51 223 }
neilh20 2:f06fbf86887e 224
sas37 0:eb0dc2b5bc51 225 }