release v1.0.0

m5stack · Sep 26, 2023 · 9352136 · 9352136
1 parent 50d8524
commit 9352136
Show file tree

Hide file tree

Showing 9 changed files with 120 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,11 +1,12 @@
 
 # M5Dial
 
+## Basic library for M5Stack M5Dial Board 
 
 
 License
 ----------------
-M5GFX : [MIT](https://github.com/m5stack/M5GFX/blob/master/LICENSE)
+M5GFX : [MIT](https://github.com/m5stack/M5GFX/blob/master/LICENSE)  
 M5Unified : [MIT](https://github.com/m5stack/M5Unified/blob/master/LICENSE)  
 Encoder : [original](src/utility/Encoder.h)  
 
diff --git a/examples/Basic/button/button.ino b/examples/Basic/button/button.ino
@@ -1,3 +1,18 @@
+/**
+ * @file button.ino
+ * @author SeanKwok (shaoxiang@m5stack.com)
+ * @brief M5Dial Button Test
+ * @version 0.1
+ * @date 2023-09-26
+ *
+ *
+ * @Hardwares: M5Dial
+ * @Platform Version: Arduino M5Stack Board Manager v2.0.7
+ * @Dependent Library:
+ * M5GFX: https://github.com/m5stack/M5GFX
+ * M5Unified: https://github.com/m5stack/M5Unified
+ */
+
 #include "M5Dial.h"
 
 void setup() {
@@ -11,7 +26,6 @@ void setup() {
                               M5Dial.Display.height() / 2);
 }
 
-
 void loop() {
     M5Dial.update();
     if (M5Dial.BtnA.wasPressed()) {

diff --git a/examples/Basic/buzzer/buzzer.ino b/examples/Basic/buzzer/buzzer.ino
@@ -1,3 +1,17 @@
+/**
+ * @file buzzer.ino
+ * @author SeanKwok (shaoxiang@m5stack.com)
+ * @brief M5Dial Buzzer Test
+ * @version 0.1
+ * @date 2023-09-26
+ *
+ *
+ * @Hardwares: M5Dial
+ * @Platform Version: Arduino M5Stack Board Manager v2.0.7
+ * @Dependent Library:
+ * M5GFX: https://github.com/m5stack/M5GFX
+ * M5Unified: https://github.com/m5stack/M5Unified
+ */
 #include "M5Dial.h"
 
 void setup() {

diff --git a/examples/Basic/display/display.ino b/examples/Basic/display/display.ino
@@ -1,3 +1,17 @@
+/**
+ * @file display.ino
+ * @author SeanKwok (shaoxiang@m5stack.com)
+ * @brief M5Dial Display Test
+ * @version 0.1
+ * @date 2023-09-26
+ *
+ *
+ * @Hardwares: M5Dial
+ * @Platform Version: Arduino M5Stack Board Manager v2.0.7
+ * @Dependent Library:
+ * M5GFX: https://github.com/m5stack/M5GFX
+ * M5Unified: https://github.com/m5stack/M5Unified
+ */
 #include "M5Dial.h"
 
 void draw_function(LovyanGFX* gfx) {

diff --git a/examples/Basic/encoder/encoder.ino b/examples/Basic/encoder/encoder.ino
@@ -1,3 +1,18 @@
+/**
+ * @file encoder.ino
+ * @author SeanKwok (shaoxiang@m5stack.com)
+ * @brief M5Dial Encoder Test
+ * @version 0.1
+ * @date 2023-09-26
+ *
+ *
+ * @Hardwares: M5Dial
+ * @Platform Version: Arduino M5Stack Board Manager v2.0.7
+ * @Dependent Library:
+ * M5GFX: https://github.com/m5stack/M5GFX
+ * M5Unified: https://github.com/m5stack/M5Unified
+ */
+
 #include "M5Dial.h"
 
 void setup() {

diff --git a/examples/Basic/rfid/rfid.ino b/examples/Basic/rfid/rfid.ino
@@ -1,3 +1,18 @@
+/**
+ * @file rfid.ino
+ * @author SeanKwok (shaoxiang@m5stack.com)
+ * @brief M5Dial RFID Test
+ * @version 0.1
+ * @date 2023-09-26
+ *
+ *
+ * @Hardwares: M5Dial
+ * @Platform Version: Arduino M5Stack Board Manager v2.0.7
+ * @Dependent Library:
+ * M5GFX: https://github.com/m5stack/M5GFX
+ * M5Unified: https://github.com/m5stack/M5Unified
+ */
+
 #include "M5Dial.h"
 
 void setup() {

diff --git a/examples/Basic/rtc/rtc.ino b/examples/Basic/rtc/rtc.ino
@@ -1,3 +1,18 @@
+/**
+ * @file rtc.ino
+ * @author SeanKwok (shaoxiang@m5stack.com)
+ * @brief M5Dial RTC SNTP Test
+ * @version 0.1
+ * @date 2023-09-26
+ *
+ *
+ * @Hardwares: M5Dial
+ * @Platform Version: Arduino M5Stack Board Manager v2.0.7
+ * @Dependent Library:
+ * M5GFX: https://github.com/m5stack/M5GFX
+ * M5Unified: https://github.com/m5stack/M5Unified
+ */
+
 #if defined(ARDUINO)
 
 #define WIFI_SSID     "YOUR WIFI SSID NAME"

diff --git a/examples/Basic/touch/touch.ino b/examples/Basic/touch/touch.ino
@@ -1,3 +1,18 @@
+/**
+ * @file touch.ino
+ * @author SeanKwok (shaoxiang@m5stack.com)
+ * @brief M5Dial Touch Test
+ * @version 0.1
+ * @date 2023-09-26
+ *
+ *
+ * @Hardwares: M5Dial
+ * @Platform Version: Arduino M5Stack Board Manager v2.0.7
+ * @Dependent Library:
+ * M5GFX: https://github.com/m5stack/M5GFX
+ * M5Unified: https://github.com/m5stack/M5Unified
+ */
+
 #include <M5Dial.h>
 
 void setup(void) {

diff --git a/examples/Basic/wakeup/wakeup.ino b/examples/Basic/wakeup/wakeup.ino
@@ -1,3 +1,18 @@
+/**
+ * @file wakeup.ino
+ * @author SeanKwok (shaoxiang@m5stack.com)
+ * @brief M5Dial Timer Wakeup Test
+ * @version 0.1
+ * @date 2023-09-26
+ *
+ *
+ * @Hardwares: M5Dial
+ * @Platform Version: Arduino M5Stack Board Manager v2.0.7
+ * @Dependent Library:
+ * M5GFX: https://github.com/m5stack/M5GFX
+ * M5Unified: https://github.com/m5stack/M5Unified
+ */
+
 #include <M5Dial.h>
 
 void setup(void) {