Merge branch 'm5stack:master' into master

Author: felmue

examples/Basics/Button/Button.ino

@@ -1,47 +1,43 @@
 /*
-    Name:       button.ino
-    Created:    2018/9/21 14:06:15
-    Author:     sakabin
+*******************************************************************************
+* Copyright (c) 2021 by M5Stack
+*                  Equipped with M5Core sample source code
+* Visit the website for more information：https://docs.m5stack.com/en/products
+*
+* describe：Button example
+* date：2021/7/15
+*******************************************************************************
 */
-
 #include <M5Stack.h>
-// The setup() function runs once each time the micro-controller starts
+// After M5Core is started or reset
+// the program in the setUp () function will be run, and this part will only be run once.  
 void setup() {
-  // init lcd, serial, but don't init sd card
-  M5.begin(true, false, true);
-  
-  /*
-    Power chip connected to gpio21, gpio22, I2C device
-    Set battery charging voltage and current
-    If used battery, please call this function in your project
-  */
-  M5.Power.begin();
+  M5.begin();  //Init M5Core
+  M5.Power.begin();//Init Power module
 
-  M5.Lcd.clear(BLACK);
-  M5.Lcd.setTextColor(YELLOW);
-  M5.Lcd.setTextSize(2);
-  M5.Lcd.setCursor(65, 10);
-  M5.Lcd.println("Button example");
+  M5.Lcd.setTextColor(YELLOW);  // Set the font color to yellow
+  M5.Lcd.setTextSize(2);  // Set the font size
+  M5.Lcd.setCursor(65, 10); //Move the cursor position to (x, y)
+  M5.Lcd.println("Button example"); //The screen prints the formatted string and wraps the line
   M5.Lcd.setCursor(3, 35);
   M5.Lcd.println("Press button B for 700ms");
   M5.Lcd.println("to clear screen.");
   M5.Lcd.setTextColor(RED);
 }
 
-// Add the main program code into the continuous loop() function
+//After the program in setup() runs, it runs the program in loop()
+//The loop() function is an infinite loop in which the program runs repeatedly
 void loop() {
-  // update button state
-  M5.update();
- 
-  // if you want to use Releasefor("was released for"), use .wasReleasefor(int time) below
+  M5.update();  //Read the press state of the key
+ //Returns 1 if key A is released or pressed longer than the specified time
   if (M5.BtnA.wasReleased() || M5.BtnA.pressedFor(1000, 200)) {
     M5.Lcd.print('A');
   } else if (M5.BtnB.wasReleased() || M5.BtnB.pressedFor(1000, 200)) {
     M5.Lcd.print('B');
   } else if (M5.BtnC.wasReleased() || M5.BtnC.pressedFor(1000, 200)) {
     M5.Lcd.print('C');
   } else if (M5.BtnB.wasReleasefor(700)) {
-    M5.Lcd.clear(BLACK);
+    M5.Lcd.clear(WHITE);  // Clear the screen and set white to the background color
     M5.Lcd.setCursor(0, 0);
   }
 }

examples/Basics/Display/Display.ino

@@ -1,21 +1,23 @@
+/*
+*******************************************************************************
+* Copyright (c) 2021 by M5Stack
+*                  Equipped with M5Core sample source code
+* Visit the website for more information：https://docs.m5stack.com/en/products
+*
+* describe：Display Example
+* date：2021/7/15
+*******************************************************************************
+*/
 #include <M5Stack.h>
 
-// the setup routine runs once when M5Stack starts up
+// After M5Core is started or reset
+// the program in the setUp () function will be run, and this part will only be run once.
 void setup() {
-  
-  // initialize the M5Stack object
-  M5.begin();
+  M5.begin(); //Init M5Core
+  M5.Power.begin(); //Init Power module
 
-  /*
-    Power chip connected to gpio21, gpio22, I2C device
-    Set battery charging voltage and current
-    If used battery, please call this function in your project
-  */
-  M5.Power.begin();
-  
-  // Lcd display
-  M5.Lcd.fillScreen(WHITE);
-  delay(500);
+  M5.Lcd.fillScreen(WHITE); // Set the screen background color to white
+  delay(500); //Delay 500ms
   M5.Lcd.fillScreen(RED);
   delay(500);
   M5.Lcd.fillScreen(GREEN);
@@ -25,34 +27,31 @@ void setup() {
   M5.Lcd.fillScreen(BLACK);
   delay(500);
 
-  // text print
-  M5.Lcd.fillScreen(BLACK);
-  M5.Lcd.setCursor(10, 10);
-  M5.Lcd.setTextColor(WHITE);
-  M5.Lcd.setTextSize(1);
-  M5.Lcd.printf("Display Test!");
+  M5.Lcd.setCursor(10, 10); // Move the cursor position to (x,y)
+  M5.Lcd.setTextColor(WHITE); // Set the font color to white,
+  M5.Lcd.setTextSize(1);  // Set the font size
+  M5.Lcd.printf("Display Test!");  // Serial output format string
 
   // draw graphic
   delay(1000);
-  M5.Lcd.drawRect(100, 100, 50, 50, BLUE);
+  M5.Lcd.drawRect(100, 100, 50, 50, BLUE);  // Draw a 50x50 blue rectangle wireframe at (x,y)
   delay(1000);
-  M5.Lcd.fillRect(100, 100, 50, 50, BLUE);
+  M5.Lcd.fillRect(100, 100, 50, 50, BLUE);  // Draw a blue rectangle 50x50 at (x,y)
   delay(1000);
-  M5.Lcd.drawCircle(100, 100, 50, RED);
+  M5.Lcd.drawCircle(100, 100, 50, RED); // Draw a red circle of radius 50 at (x,y)
   delay(1000);
-  M5.Lcd.fillCircle(100, 100, 50, RED);
+  M5.Lcd.fillCircle(100, 100, 50, RED); //Draw a red circle of radius 50 at (x,y)
   delay(1000);
-  M5.Lcd.drawTriangle(30, 30, 180, 100, 80, 150, YELLOW);
+  M5.Lcd.drawTriangle(30, 30, 180, 100, 80, 150, YELLOW); // Make a triangle wireframe with (x1,y1) (x2,y2) (x3,y3) as the vertices
   delay(1000);
-  M5.Lcd.fillTriangle(30, 30, 180, 100, 80, 150, YELLOW);
-
+  M5.Lcd.fillTriangle(30, 30, 180, 100, 80, 150, YELLOW); // Construct a triangle with (x1,y1) (x2,y2) (x3,y3) as its vertices
 }
 
-// the loop routine runs over and over again forever
+//After the program in setup() runs, it runs the program in loop()
+//The loop() function is an infinite loop in which the program runs repeatedly
 void loop(){
 
-  //rand draw 
   M5.Lcd.fillTriangle(random(M5.Lcd.width()-1), random(M5.Lcd.height()-1), random(M5.Lcd.width()-1), random(M5.Lcd.height()-1), random(M5.Lcd.width()-1), random(M5.Lcd.height()-1), random(0xfffe));
 
-  M5.update();
+  M5.update();  //Read the press state of the key
 }