mirror of
https://github.com/m5stack/m5-docs.git
synced 2026-05-20 10:23:01 -07:00
147 lines
1.9 KiB
Markdown
147 lines
1.9 KiB
Markdown
# System
|
|
|
|
## begin()
|
|
|
|
**Syntax:**
|
|
|
|
`void begin(bool LCDEnable=true, bool SDEnable=true, bool SerialEnable=true,bool I2CEnable=false);`
|
|
|
|
**Description:**
|
|
|
|
This function sets enable/disable LCD, TF Card,Serial port and I2C port.
|
|
|
|
**Definition:**
|
|
|
|
```clike
|
|
void M5Stack::begin(bool LCDEnable, bool SDEnable, bool SerialEnable,bool I2CEnable) {
|
|
|
|
// Correct init once
|
|
if (isInited) return;
|
|
else isInited = true;
|
|
|
|
// UART
|
|
if (SerialEnable) {
|
|
Serial.begin(115200);
|
|
Serial.flush();
|
|
delay(50);
|
|
Serial.print("M5Stack initializing...");
|
|
}
|
|
|
|
// LCD INIT
|
|
if (LCDEnable) {
|
|
Lcd.begin();
|
|
}
|
|
|
|
// TF Card
|
|
if (SDEnable) {
|
|
SD.begin(TFCARD_CS_PIN, SPI, 40000000);
|
|
}
|
|
|
|
// TONE
|
|
// Speaker.begin();
|
|
|
|
// Set wakeup button
|
|
Power.setWakeupButton(BUTTON_A_PIN);
|
|
|
|
// I2C init
|
|
if(I2CEnable)
|
|
{
|
|
Wire.begin(21, 22);
|
|
}
|
|
|
|
if (SerialEnable) {
|
|
Serial.println("OK");
|
|
}
|
|
}
|
|
|
|
void M5Stack::update() {
|
|
|
|
//Button update
|
|
BtnA.read();
|
|
BtnB.read();
|
|
BtnC.read();
|
|
|
|
//Speaker update
|
|
Speaker.update();
|
|
}
|
|
|
|
```
|
|
|
|
## update()
|
|
|
|
**Syntax:**
|
|
|
|
`void update();`
|
|
|
|
**Description:**
|
|
|
|
This function reads The State of Button A and B and C.
|
|
|
|
**Definition:**
|
|
|
|
```clike
|
|
void M5Stack::update() {
|
|
|
|
//Button update
|
|
BtnA.read();
|
|
BtnB.read();
|
|
BtnC.read();
|
|
|
|
//Speaker update
|
|
Speaker.update();
|
|
}
|
|
```
|
|
|
|
**Example:**
|
|
|
|
```clike
|
|
#include <M5Stack.h>
|
|
|
|
void setup() {
|
|
M5.begin();
|
|
}
|
|
|
|
void loop() {
|
|
M5.update();
|
|
}
|
|
```
|
|
|
|
## powerOFF()
|
|
|
|
!> Deprecated: Please use Power::deepSleep()
|
|
|
|
**Syntax:**
|
|
|
|
`void powerOFF();`
|
|
|
|
**Description:**
|
|
|
|
This function turns off the power of M5.
|
|
|
|
**Definition:**
|
|
|
|
```clike
|
|
void M5Stack::powerOFF() {
|
|
M5.Power.deepSleep();
|
|
}
|
|
```
|
|
|
|
**Example:**
|
|
|
|
```clike
|
|
#include <M5Stack.h>
|
|
|
|
void setup() {
|
|
M5.begin();
|
|
M5.Lcd.println("This is software power off demo");
|
|
M5.Lcd.println("Press the button A to power off.");
|
|
M5.setWakeupButton(BUTTON_A_PIN);
|
|
}
|
|
|
|
void loop() {
|
|
M5.update();
|
|
if (M5.BtnA.wasPressed()) {
|
|
M5.powerOFF();
|
|
}
|
|
}
|
|
``` |