Merge branch 'main' of https://github.com/KitronikLtd/Kitronik-Pico-Smart-Air-Quality-Board-MicroPython into main

Author: AlasdairAtKitronik

PicoAirQuality.py

@@ -109,7 +109,7 @@ def highPowerOff(self, pin):
 class KitronikDataLogger:
     # Function is called when the class is initialised - sets the maximum permissable filesize, the data separator and creates the log file with the entered filename
     # Separator options: ("comma", "semicolon", "tab")
-    def __init__(self, file, separator):
+    def __init__(self, file = "data_log.txt", separator = "semicolon"):
         self.MAX_FILE_SIZE = 500000 # This is approximately 10000 full entries
         if (separator == "comma"):
             self.SEPARATOR = ","
@@ -123,8 +123,9 @@ def __init__(self, file, separator):
             f.close()
         except OSError:
             print("File already exists")
-        self.name = ""
-        self.subject = ""
+        self.line1 = ""
+        self.line2 = ""
+        self.line3 = ""
         self.dataHeadings = ""
         self.projectInfo = False
         self.headings = False
@@ -133,10 +134,13 @@ def __init__(self, file, separator):
     def writeProjectInfo(self, line1="", line2="", line3=""):
         if (line1 != ""):
             self.writeFile(self.FILENAME, line1 + "\r\n")
+            self.line1 = line1
         if (line2 != ""):
             self.writeFile(self.FILENAME, line2 + "\r\n")
+            self.line2 = line2
         if (line3 != ""):
             self.writeFile(self.FILENAME, line3 + "\r\n")
+            self.line3 = line3
         self.projectInfo = True
 
     # This writes whatever is passed to it to the file     
@@ -224,9 +228,9 @@ def removeOneLine(self):
         if self.projectInfo:        # If there is Project Info, skip over these lines and then write them to the temporary file
             for l in range(3):
                 readFrom.readline()
-            writeTo.write(self.LOG_HEADER)
-            writeTo.write(self.name + "\r\n")
-            writeTo.write(self.subject  + "\r\n")
+            writeTo.write(self.line1 + "\r\n")
+            writeTo.write(self.line2 + "\r\n")
+            writeTo.write(self.line3  + "\r\n")
         if self.headings:
             readFrom.readline()     # If there are Headings, skip over this line and then write them to the temporary file
             writeTo.write(self.dataHeadings  + "\r\n")
@@ -463,12 +467,13 @@ def readParameter(self, parameter):
     # Set an alarm for a specific hour and minute
     # Extra options to set a periodically repeating alarm (set alarmRepeat to True and then specifiy the hour and/or minute period between alarms)
     def setAlarm(self, hour, minute, alarmRepeat=False, hourPeriod=0, minutePeriod=0):
-        self.alarmHour = hour
-        self.alarmMinute = minute
+        self.alarmHour = math.ceil(hour)
+        self.alarmMinute = math.ceil(minute)
         self.alarmRepeat = alarmRepeat
+        
         if alarmRepeat:
-            self.hourPeriod = hourPeriod
-            self.minutePeriod = minutePeriod
+            self.hourPeriod = math.ceil(hourPeriod)
+            self.minutePeriod = math.ceil(minutePeriod)
         self.alarmSet = True
 
     # Check whether the alarm conditions have been met and then trigger the alarm

README.md

@@ -200,10 +200,10 @@ There are three options for the data separator:
 
 There are two functions which are used to setup the data log file with some extra information:  
 ```python
-log.writeProjectInfo(name, subject)
-log.setupDataFields(field1, field2, field3, field4, field5, field6, field7, field8, field9, field10)
+log.writeProjectInfo(line1, line2, line3)
+log.nameColumnHeadings(field1, field2, field3, field4, field5, field6, field7, field8, field9, field10)
 ```
-The first writes a standard header line to the file, and then allows two user-entered fields, designated here as 'name' and 'subject'.  
+The first writesup to three user-entered free text fields (if only two arguments are given, only two lines will be written).  
 The second allows the user to include up to 10 data field headings which can then need to be matched to the order of the data fields in the data entry (these headings will become column headings if the data is imported to a spreadsheet program).  
 With these sections included, the start of a log file will look something like this:  
 ```
@@ -237,7 +237,7 @@ To register a servo ready to be used:
 ```python
  output.registerServo()
 ```
-This process sets the PIO PWM active on the servo pin.  
+This process sets the PIO PWM active on the servo pin (**Note:** The servo is registered by default).  
 To control the movement of a servo, turning it to a set angle (or controlling the speed/direction of a continuous rotation servo):  
 ```python
 output.servoToPosition(degrees)