-
Notifications
You must be signed in to change notification settings - Fork 430
/
M5Stack.h
184 lines (158 loc) · 6.12 KB
/
M5Stack.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
// Copyright (c) M5Stack. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full
// license information.
/**
* \par Copyright (C), 2016-2017, M5Stack
* \class M5Stack
* \brief M5Stack library.
* @file M5Stack.h
* @author M5Stack
* @version V0.2.4
* @date 2018/10/29
* @brief Header for M5Stack.cpp module
*
* \par Description
* This file is a driver for M5Stack Core/Basic/Gray.
*
* \par Method List:
*
* System:
M5.begin();
M5.update();
Power:
M5.Power.setPowerBoostKeepOn()
M5.Power.setCharge(uint8_t mode);
M5.Power.setPowerBoostKeepOn(bool en);
M5.Power.isChargeFull();
M5.Power.setWakeupButton(uint8_t button);
M5.Power.powerOFF();
bool setPowerBoostOnOff(bool en);
bool setPowerBoostSet(bool en);
bool setPowerVin(bool en);
bool setPowerWLEDSet(bool en);
LCD:
M5.lcd.setBrightness(uint8_t brightness);
M5.Lcd.drawPixel(int16_t x, int16_t y, uint16_t color);
M5.Lcd.drawLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t color);
M5.Lcd.fillRect(int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color);
M5.Lcd.fillScreen(uint16_t color); M5.Lcd.drawCircle(int16_t x0, int16_t y0, int16_t r, uint16_t color);
M5.Lcd.drawCircleHelper(int16_t x0, int16_t y0, int16_t r, uint8_t cornername,uint16_t color);
M5.Lcd.fillCircle(int16_t x0, int16_t y0, int16_t r, uint16_t color);
M5.Lcd.fillCircleHelper(int16_t x0, int16_t y0, int16_t r, uint8_t cornername,int16_t delta, uint16_t color);
M5.Lcd.drawTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color);
M5.Lcd.fillTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color);
M5.Lcd.drawRoundRect(int16_t x0, int16_t y0, int16_t w, int16_t h, int16_t radius, uint16_t color);
M5.Lcd.fillRoundRect(int16_t x0, int16_t y0, int16_t w, int16_t h, int16_t radius, uint16_t color);
M5.Lcd.drawBitmap(int16_t x, int16_t y, const uint8_t bitmap[], int16_t w, int16_t h, uint16_t color);
M5.Lcd.drawRGBBitmap(int16_t x, int16_t y, const uint16_t bitmap[], int16_t w, int16_t h),
M5.Lcd.drawChar(uint16_t x, uint16_t y, char c, uint16_t color, uint16_t bg, uint8_t size);
M5.Lcd.setCursor(uint16_t x0, uint16_t y0);
M5.Lcd.setTextColor(uint16_t color);
M5.Lcd.setTextColor(uint16_t color, uint16_t backgroundcolor);
M5.Lcd.setTextSize(uint8_t size);
M5.Lcd.setTextWrap(boolean w);
M5.Lcd.printf();
M5.Lcd.print();
M5.Lcd.println();
M5.Lcd.drawCentreString(const char *string, int dX, int poY, int font);
M5.Lcd.drawRightString(const char *string, int dX, int poY, int font);
M5.Lcd.drawJpg(const uint8_t *jpg_data, size_t jpg_len, uint16_t x, uint16_t y);
M5.Lcd.drawJpgFile(fs::FS &fs, const char *path, uint16_t x, uint16_t y);
M5.Lcd.drawBmpFile(fs::FS &fs, const char *path, uint16_t x, uint16_t y);
Button:
M5.BtnA/B/C.read(); // Must be called in loop(), or via update()
M5.BtnA/B/C.isPressed();
M5.BtnA/B/C.isReleased();
M5.BtnA/B/C.wasPressed();
M5.BtnA/B/C.wasReleased();
M5.BtnA/B/C.wasreleasedFor()
M5.BtnA/B/C.pressedFor(uint32_t ms);
M5.BtnA/B/C.releasedFor(uint32_t ms);
M5.BtnA/B/C.lastChange();
Speaker:
M5.Speaker.tone(uint32_t freq);
M5.Speaker.tone(freq, time);
M5.Speaker.beep();
M5.Speaker.setBeep(uint16_t frequency, uint16_t duration);
M5.Speaker.mute();
*
* \par History:
* <pre>
* `<Author>` `<Time>` `<Version>` `<Descr>`
* Zibin Zheng 2017/07/14 0.0.1 Rebuild the new.
* Bin 2018/10/29 0.2.4 Add Button API
* </pre>
*
*/
// #define ESP32
#ifndef _M5STACK_H_
#define _M5STACK_H_
#if defined(ESP32)
#include <Arduino.h>
#include <SPI.h>
#include <Wire.h>
#include "FS.h"
#include "M5Display.h"
#include "SD.h"
#include "gitTagVersion.h"
#include "IMU.h"
#include "utility/Button.h"
#include "utility/CommUtil.h"
#include "utility/Config.h"
#include "utility/Power.h"
#include "utility/Speaker.h"
#include "utility/MPU6886.h"
#include "utility/SH200Q.h"
class M5Stack {
public:
M5Stack();
void begin(bool LCDEnable = true, bool SDEnable = true,
bool SerialEnable = true, bool I2CEnable = false);
// Updates the status of hardware buttons, and ends any completed tone on the speaker.
// Recommended to be placed in loop()
void update();
// LCD display, derived from TFT_eSPI. See examples
M5Display Lcd = M5Display();
// Power and battery charge control. Call Power.begin() in setup().
POWER Power;
// Button API
#define DEBOUNCE_MS 10
// Hardware button A. Call read() before checking if isPressed()
Button BtnA = Button(BUTTON_A_PIN, true, DEBOUNCE_MS);
// Hardware button B. Call read() before checking if isPressed()
Button BtnB = Button(BUTTON_B_PIN, true, DEBOUNCE_MS);
// Hardware button C. Call read() before checking if isPressed()
Button BtnC = Button(BUTTON_C_PIN, true, DEBOUNCE_MS);
// SPEAKER on DAC pin 25
SPEAKER Speaker;
// UART
// HardwareSerial Serial0 = HardwareSerial(0);
// HardwareSerial Serial2 = HardwareSerial(2);
// I2C
IMU Imu;
CommUtil I2C = CommUtil();
MPU6886 Mpu6886;
SH200Q Sh200Q;
/**
* Function has been moved to Power class (for compatibility)
* This name will be removed in a future release.
*/
void setPowerBoostKeepOn(bool en) __attribute__((deprecated));
void setWakeupButton(uint8_t button) __attribute__((deprecated));
void powerOFF() __attribute__((deprecated));
private:
bool isInited;
};
extern M5Stack M5;
#define m5 M5
#define lcd Lcd
#define imu Imu
#define IMU Imu
#define MPU6886 Mpu6886
#define mpu6886 Mpu6886
#define SH200Q Sh200Q
#define sh200q Sh200Q
#else
#error "This library only supports boards with ESP32 processor."
#endif
#endif