From 59d2fe7cdc86dbc733f5a3e20c8b166400e3cd9b Mon Sep 17 00:00:00 2001 From: thatscringebro Date: Sat, 14 Oct 2023 13:58:57 -0400 Subject: [PATCH] small fixes --- .vscode/extensions.json | 10 +++++++ include/README | 39 +++++++++++++++++++++++++++ lib/README | 46 ++++++++++++++++++++++++++++++++ platformio.ini | 1 + src/main.cpp | 59 +++++++++++++++++------------------------ test/README | 11 ++++++++ 6 files changed, 131 insertions(+), 35 deletions(-) create mode 100644 .vscode/extensions.json create mode 100644 include/README create mode 100644 lib/README create mode 100644 test/README diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..080e70d --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,10 @@ +{ + // See http://go.microsoft.com/fwlink/?LinkId=827846 + // for the documentation about the extensions.json format + "recommendations": [ + "platformio.platformio-ide" + ], + "unwantedRecommendations": [ + "ms-vscode.cpptools-extension-pack" + ] +} diff --git a/include/README b/include/README new file mode 100644 index 0000000..194dcd4 --- /dev/null +++ b/include/README @@ -0,0 +1,39 @@ + +This directory is intended for project header files. + +A header file is a file containing C declarations and macro definitions +to be shared between several project source files. You request the use of a +header file in your project source file (C, C++, etc) located in `src` folder +by including it, with the C preprocessing directive `#include'. + +```src/main.c + +#include "header.h" + +int main (void) +{ + ... +} +``` + +Including a header file produces the same results as copying the header file +into each source file that needs it. Such copying would be time-consuming +and error-prone. With a header file, the related declarations appear +in only one place. If they need to be changed, they can be changed in one +place, and programs that include the header file will automatically use the +new version when next recompiled. The header file eliminates the labor of +finding and changing all the copies as well as the risk that a failure to +find one copy will result in inconsistencies within a program. + +In C, the usual convention is to give header files names that end with `.h'. +It is most portable to use only letters, digits, dashes, and underscores in +header file names, and at most one dot. + +Read more about using header files in official GCC documentation: + +* Include Syntax +* Include Operation +* Once-Only Headers +* Computed Includes + +https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html diff --git a/lib/README b/lib/README new file mode 100644 index 0000000..6debab1 --- /dev/null +++ b/lib/README @@ -0,0 +1,46 @@ + +This directory is intended for project specific (private) libraries. +PlatformIO will compile them to static libraries and link into executable file. + +The source code of each library should be placed in a an own separate directory +("lib/your_library_name/[here are source files]"). + +For example, see a structure of the following two libraries `Foo` and `Bar`: + +|--lib +| | +| |--Bar +| | |--docs +| | |--examples +| | |--src +| | |- Bar.c +| | |- Bar.h +| | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html +| | +| |--Foo +| | |- Foo.c +| | |- Foo.h +| | +| |- README --> THIS FILE +| +|- platformio.ini +|--src + |- main.c + +and a contents of `src/main.c`: +``` +#include +#include + +int main (void) +{ + ... +} + +``` + +PlatformIO Library Dependency Finder will find automatically dependent +libraries scanning project source files. + +More information about PlatformIO Library Dependency Finder +- https://docs.platformio.org/page/librarymanager/ldf.html diff --git a/platformio.ini b/platformio.ini index f015c4a..27113c9 100644 --- a/platformio.ini +++ b/platformio.ini @@ -13,3 +13,4 @@ platform = atmelavr board = uno framework = arduino monitor_speed = 115200 +lib_deps = arduino-libraries/LiquidCrystal@^1.0.7 \ No newline at end of file diff --git a/src/main.cpp b/src/main.cpp index 05c9131..11c9ddd 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -1,4 +1,4 @@ -//#include +#include #include #include @@ -140,6 +140,25 @@ void displayMenuTop(){ } } +void stopAlarm() { + alarmState = ALARM_OFF; + noTone(BUZZER_PIN); + digitalWrite(ALARM_LED_PIN, LOW); +} + +void snoozeAlarm() { + alarmState = ALARM_SNOOZE; + noTone(BUZZER_PIN); + alarmStartTime = millis(); +} + +void saveAlarmSettings() { + // Save alarm settings and the alarm set flag to EEPROM + EEPROM.write(ALARM_SETTINGS_ADDRESS, alarmHour); + EEPROM.write(ALARM_SETTINGS_ADDRESS + 1, alarmMinute); + EEPROM.write(ALARM_SET_FLAG_ADDRESS, isAlarmSet); +} + void displayMenuInfo(){ lcd.setCursor(0, 1); char str[16]; @@ -183,6 +202,7 @@ void handleMenuButton() { lcd.clear(); menuState = MENU_ALARM_TIME; editModeState = EDIT_HOUR; + saveAlarmSettings(); editMode = false; break; case MENU_ALARM_TIME: @@ -242,6 +262,7 @@ void handleSetButton() { break; case EDIT_MINUTE: editModeState = EDIT_HOUR; + saveAlarmSettings(); editMode = false; break; } @@ -373,18 +394,6 @@ void checkAlarm() { } } -void stopAlarm() { - alarmState = ALARM_OFF; - noTone(BUZZER_PIN); - digitalWrite(ALARM_LED_PIN, LOW); -} - -void snoozeAlarm() { - alarmState = ALARM_SNOOZE; - noTone(BUZZER_PIN); - alarmStartTime = millis(); -} - void restoreAlarmSettings() { // Read alarm settings from EEPROM and set variables accordingly // If no settings are found, use default values @@ -392,6 +401,8 @@ void restoreAlarmSettings() { byte storedMinute = EEPROM.read(ALARM_SETTINGS_ADDRESS + 1); isAlarmSet = EEPROM.read(ALARM_SET_FLAG_ADDRESS); + Serial.println(storedHour + ", " + storedMinute); + // Check if EEPROM contains valid alarm settings if (isAlarmSet && storedHour != 255 && storedMinute != 255) { alarmHour = storedHour; @@ -404,28 +415,6 @@ void restoreAlarmSettings() { } } -void saveAlarmSettings() { - // Save alarm settings and the alarm set flag to EEPROM - EEPROM.write(ALARM_SETTINGS_ADDRESS, alarmHour); - EEPROM.write(ALARM_SETTINGS_ADDRESS + 1, alarmMinute); - EEPROM.write(ALARM_SET_FLAG_ADDRESS, isAlarmSet); -} - -void setAlarm() { - isAlarmSet = true; - - // Save alarm settings and the alarm set flag to EEPROM when the alarm is set - saveAlarmSettings(); -} - -void clearAlarm() { - // Clear the alarm and update the alarm set flag in EEPROM - alarmHour = 6; - alarmMinute = 0; - isAlarmSet = false; - saveAlarmSettings(); -} - void setup() { //For debugging Serial.begin(115200); diff --git a/test/README b/test/README new file mode 100644 index 0000000..9b1e87b --- /dev/null +++ b/test/README @@ -0,0 +1,11 @@ + +This directory is intended for PlatformIO Test Runner and project tests. + +Unit Testing is a software testing method by which individual units of +source code, sets of one or more MCU program modules together with associated +control data, usage procedures, and operating procedures, are tested to +determine whether they are fit for use. Unit testing finds problems early +in the development cycle. + +More information about PlatformIO Unit Testing: +- https://docs.platformio.org/en/latest/advanced/unit-testing/index.html