v1.2.0

Author: KravitzLab

.development

@@ -0,0 +1 @@
+some-text  

examples/FORCE/FORCE.ino

@@ -17,7 +17,7 @@
 //                                        DON'T EDIT THESE LINES
 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 #include <Force.h>                                      //Include FORCE library 
-String ver = "v1.1.2";                                  //unique identifier text
+String ver = "v1.2.0";                                  //unique identifier text
 Force force(ver);                                       //start FORCE object
 
 void setup() {

examples/FORCE_RandomOut/FORCE_RandomOut.ino

@@ -0,0 +1,63 @@
+/*
+  FORCE example code
+  by Lex Kravitz and Bridget Matikainen-Ankney
+
+  alexxai@wustl.edu
+  May, 2021
+
+  KravitzLabDevices/FORCE_library is licensed under the GNU General Public License v3.0
+
+  Permissions of this strong copyleft license are conditioned on making available complete source code of licensed works
+  and modifications, which include larger works using a licensed work, under the same license. Copyright and license
+  notices must be preserved. Contributors provide an express grant of patent rights.
+
+*/
+
+///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+//                                        DON'T EDIT THESE LINES
+///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+#include <Force.h>                                      //Include FORCE library 
+String ver = "v1.2.0";                                  //unique identifier text
+Force force(ver);                                       //start FORCE object
+
+void setup() {
+  force.begin();                                        //setup FORCE
+}
+
+void loop() {
+  force.run();                                          //call force.run() at least once per loop
+  
+  ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+  //                                      WRITE CUSTOM BEHAVIORAL CODE BELOW HERE
+  ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+  if (force.pressLength > force.hold_time) {                  //if the force lever is held down for longer than the hold_req
+    //Choose a random number
+    randomSeed(millis());                                     //get a new randomSeed here so the sequence isn't the same every time
+    int randnum = random(1, 4);                               //Pick a random number between 1 and 3
+    Serial.print("Random Num: ");                             //Print the random number
+    Serial.println(randnum);                          
+
+    force.presses++;                                          //keep count of successful presses
+    force.Dispense();                                         //dispense reward
+
+    if (randnum == 3) {                                       //if random number is 3...
+      while ((force.unixtime - force.dispenseTime) < 15) {    //...and it is within 15 seconds of a dispense
+        force.run();                                          //keep force screen and timers running while waiting around for the 15sec delay
+        if (force.lick == true) {                             //if animal licks in this time period:
+
+          /////////////////////////////////////////////////
+          // FORCE does this when both conditions are true
+          /////////////////////////////////////////////////
+          Serial.println("Output triggered!");                
+          digitalWrite (13, HIGH);
+          delay(1000);
+          digitalWrite (13, LOW);
+          
+          break;
+        }
+      }
+    }
+    
+    force.Timeout(force.timeout_length);                      //timeout (length in seconds)
+  }
+}

src/Force.cpp

@@ -14,14 +14,30 @@ Force::Force(String ver) {
   library_version = ver; 
 }
 
+/////////////////////////////////////////////////////////////////////////
+// RTC Functions 
+/////////////////////////////////////////////////////////////////////////
+RTC_PCF8523 rtc;
+
+void dateTime(uint16_t* date, uint16_t* time) {
+  DateTime now = rtc.now();
+  // return date using FAT_DATE macro to format fields
+  *date = FAT_DATE(now.year(), now.month(), now.day());
+
+  // return time using FAT_TIME macro to format fields
+  *time = FAT_TIME(now.hour(), now.minute(), now.second());
+}
+
 /////////////////////////////////////////////////////////////////////////
 //     
 /////////////////////////////////////////////////////////////////////////
 void Force::run() {
   Sense();
   UpdateDisplay();
   WriteToSD();
-  SerialOutput();
+  DateTime now = rtc.now();
+  unixtime  = now.unixtime();
+  //   SerialOutput();
 }
 
 /////////////////////////////////////////////////////////////////////////
@@ -49,6 +65,8 @@ void Force::Dispense() {
   digitalWrite(13, HIGH); // RED LED
   delay (dispense_amount); //how long to open solenoid?
   digitalWrite(SOLENOID, LOW);
+  DateTime now = rtc.now();
+  dispenseTime = now.unixtime();
   digitalWrite(A2, LOW);
   digitalWrite(13, LOW); // RED LED
   pressTime = millis();
@@ -85,19 +103,7 @@ void Force::Click() {
   tone(A5, 800, 8);
 }
 
-/////////////////////////////////////////////////////////////////////////
-// RTC Functions 
-/////////////////////////////////////////////////////////////////////////
-RTC_PCF8523 rtc;
-
-void dateTime(uint16_t* date, uint16_t* time) {
-  DateTime now = rtc.now();
-  // return date using FAT_DATE macro to format fields
-  *date = FAT_DATE(now.year(), now.month(), now.day());
 
-  // return time using FAT_TIME macro to format fields
-  *time = FAT_TIME(now.hour(), now.minute(), now.second());
-}
 
 /////////////////////////////////////////////////////////////////////////
 // Begin
@@ -469,6 +475,8 @@ void Force::graphLegend() {
     tft.setTextColor(ST7735_WHITE);
     tft.setCursor(0, 28);
     tft.print ("Lick");
+    DateTime now = rtc.now();
+    lickTime = now.unixtime();
   }
 
   if (calibrated == false){

src/Force.h

@@ -97,6 +97,8 @@ class Force {
     void error(uint8_t errno);
     void getFilename(char *filename);
     void logdata();
+    unsigned long unixtime = 0;
+
 
     // --- Solenoid functions --- //
     float dispense_time = 0;
@@ -126,6 +128,8 @@ class Force {
     int trials_per_block = 10;
     int max_force = 20; 
     unsigned long start_time = 0;
+    unsigned long lickTime = 0;
+    unsigned long dispenseTime = 0;
 
     // --- Serial out--- //
     void SerialOutput();