reduced namespace conflict in library manager
171
README.md
|
@ -1,140 +1,67 @@
|
|||
# M5Stack Library
|
||||
# ESP32-Chimera-Core Library
|
||||
|
||||
English | [中文](docs/getting_started_cn.md) | [日本語](docs/getting_started_ja.md)
|
||||
This library is a *substitute* of the original [M5Stack](https://github.com/m5stack/M5Stack/) library, with added support for the following devices:
|
||||
|
||||
Welcome to program with M5Stack Core
|
||||
- M5Stack Classic
|
||||
- M5Stack Fire
|
||||
- Odroid-Go
|
||||
- D-Duino-32-XS
|
||||
- ESP32-Wrover-Kit (v4.1, v4.2, v4.3)
|
||||
|
||||
## 1. Get Started
|
||||
|
||||
#### Here is the article to get started
|
||||
It also implements a set of extra features:
|
||||
|
||||
*1.For MacOS*
|
||||
- Zero-config automatic device selection based on the Arduino Boards menu selection
|
||||
- Screenshots!
|
||||
- I2C Scanner
|
||||
|
||||
https://docs.m5stack.com/#/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS
|
||||
|
||||
*2. For Windows*
|
||||
# Usage
|
||||
|
||||
https://docs.m5stack.com/#/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows
|
||||
- Download the latest release and unzip it in the `~/Arduino/libraries` folder.
|
||||
- Delete the `~/Arduino/M5Stack` folder to prevent any confusion at compilation (you can still restore it later using the Library Manager)
|
||||
- You're done!
|
||||
|
||||
# Developers
|
||||
|
||||
## 2. Example
|
||||
Use `#if defined(_CHIMERA_CORE_)` macros to isolate ESP32-Chimera-Core specific statements.
|
||||
|
||||
https://github.com/m5stack/M5Stack/tree/master/examples
|
||||
```C
|
||||
#if defined(_CHIMERA_CORE_)
|
||||
M5.ScreenShot.init( &M5.Lcd, M5STACK_SD );
|
||||
M5.ScreenShot.begin();
|
||||
M5.ScreenShot.snap();
|
||||
#endif
|
||||
|
||||
## 3. API Reference
|
||||
```
|
||||
|
||||
https://github.com/m5stack/M5Stack/blob/master/src/M5Stack.h#L19
|
||||
Automatic board selection is based on the boards.txt definition, so changing the board from the Arduino Tools menu is enough to trigger the detection.
|
||||
Sketch compilation can eventually be tuned-up to a specific device by using macros.
|
||||
|
||||
https://docs.m5stack.com/#/en/api
|
||||
```C
|
||||
#if defined(_CHIMERA_CORE_)
|
||||
#if defined( ARDUINO_M5Stack_Core_ESP32 )
|
||||
#warning M5STACK CLASSIC DETECTED !!
|
||||
#elif defined( ARDUINO_M5STACK_FIRE )
|
||||
#warning M5STACK FIRE DETECTED !!
|
||||
#elif defined( ARDUINO_ODROID_ESP32 )
|
||||
#warning ODROID DETECTED !!
|
||||
#elif defined ( ARDUINO_ESP32_DEV )
|
||||
#warning WROVER DETECTED !!
|
||||
#else
|
||||
#warning NOTHING DETECTED !!
|
||||
#endif
|
||||
#else
|
||||
#warning M5Stack legacy core detected
|
||||
#endif
|
||||
```
|
||||
|
||||
## 4. H/W Reference
|
||||
|
||||
#### Pinout
|
||||
# Credits & Thanks
|
||||
|
||||
*We have several kinds of M5Cores, There is [their difference in schematic](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_difference_between_cores.md).*
|
||||
- Special thanks to [らびやん (Lovyan03)](https://github.com/lovyan03) for providing strong inspiring support, unconditional kindness and unlimited patience
|
||||
- Kudos to [M5Stack](https://github.com/m5stack) for being the creators of the original M5Stack and its legacy library without which this project would not exist.
|
||||
- [紅樹 タカオ (Takao Akaki)](https://github.com/mongonta0716)
|
||||
- [Nochi](https://github.com/shikarunochi)
|
||||
- [こばさん](https://github.com/wakwak-koba)
|
||||
|
||||
**LCD & TF Card**
|
||||
|
||||
*LCD Resolution: 320x240*
|
||||
|
||||
<table>
|
||||
<tr><td>ESP32 Chip</td><td>GPIO23</td><td>GPIO19</td><td>GPIO18</td><td>GPIO14</td><td>GPIO27</td><td>GPIO33</td><td>GPIO32</td><td>GPIO4</td></tr>
|
||||
<tr><td>ILI9341</td><td>/</td><td>MISO</td><td>CLK</td><td>CS</td><td>DC</td><td>RST</td><td>BL</td><td> </td></tr>
|
||||
<tr><td>TF Card</td><td>MOSI</td><td>MISO</td><td>CLK</td><td> </td><td> </td><td> </td><td> </td><td>CS</td></tr>
|
||||
|
||||
</table>
|
||||
|
||||
**Button & Speaker**
|
||||
|
||||
<table>
|
||||
<tr><td>ESP32 Chip</td><td>GPIO39</td><td>GPIO38</td><td>GPIO37</td><td>GPIO25</td></tr>
|
||||
<tr><td>Button Pin</td><td>BUTTON A</td><td>BUTTON B</td><td>BUTTON C</td></tr>
|
||||
<tr><td>Speaker</td><td> </td><td> </td><td> </td><td>Speaker Pin</td></tr>
|
||||
</table>
|
||||
|
||||
**GROVE A**
|
||||
|
||||
<table>
|
||||
<tr><td>ESP32 Chip</td><td>GPIO22</td><td>GPIO21</td></tr>
|
||||
<tr><td>GROVE A</td><td>SCL</td><td>SDA</td></tr>
|
||||
</table>
|
||||
|
||||
|
||||
### M-BUS
|
||||

|
||||
|
||||
## 5. USER CASES
|
||||
|
||||
* [M5Stack-SD-Updater](https://github.com/tobozo/M5Stack-SD-Updater) - Customizable menu system for M5Stack - loads apps from the Micro SD
|
||||
card
|
||||
|
||||
* [TFT_eSPI](https://github.com/Bodmer/TFT_eSPI) - TFT library for the ESP8266 and ESP32 that supports different driver chips
|
||||
|
||||
|
||||
* [M5Widgets](https://github.com/Kongduino/M5Widgets) - Widgets for the M5Stack
|
||||
|
||||
* [M5StackSAM](https://github.com/tomsuch/M5StackSAM) - Simple Applications Menu Arduino Library for M5Stack
|
||||
|
||||
* [cfGUI](https://github.com/JF002/cfGUI) - A simple GUI library for M5Stack (ESP32)
|
||||
|
||||
* [GUIslice](https://github.com/ImpulseAdventure/GUIslice) - A lightweight GUI framework suitable for embedded displays
|
||||
|
||||
* [M5ez](https://github.com/ropg/M5ez) - The easy way to program on the M5Stack
|
||||
|
||||
|
||||
* [M5Stack MultiApp Advanced](https://github.com/botofancalin/M5Stack-MultiApp-Advanced) - A M5Stack firmware made on PlatformIO
|
||||
|
||||
|
||||
* [M5Stack ESP32 Oscilloscope](https://github.com/botofancalin/M5Stack-ESP32-Oscilloscope) - A fully functional oscilloscope based on ESP32 M5Stack
|
||||
|
||||
* [M5Stack-Avatar](https://github.com/meganetaaan/m5stack-avatar) - An M5Stack library for rendering avatar faces
|
||||
|
||||
* [M5Stack_CrackScreen](https://github.com/nomolk/M5Stack_CrackScreen) - Crack your M5Stack!!
|
||||
|
||||
* [M5_Shuttle_Run](https://github.com/n0bisuke/M5_Shuttle_Run) - M5_Shuttle_Run
|
||||
|
||||
* [nixietubeM5](https://github.com/drayde/nixietubeM5) - (Fake) Nixie Tube Display on a M5Stack
|
||||
|
||||
* [M5Stack_BTCTicker](https://github.com/dankelley2/M5Stack_BTCTicker) - A small Bitcoin price ticker using an M5Stack (ESP32) and the Coindesk API
|
||||
|
||||
* [M5Stack_ETHPrice](https://github.com/donma/M5StackWifiSettingWithETHPrice) - Dependence on example Wifi Setting to get ETH Price from Maicoin
|
||||
|
||||
* [M5Stack-PacketMonitor](https://github.com/tobozo/M5Stack-PacketMonitor) - M5Stack ESP32 Packet Monitor
|
||||
|
||||
* [M5-FFT](https://github.com/ElectroMagus/M5-FFT) - Graphic Equalizer on the M5Stack platform
|
||||
|
||||
* [M5Stack_ESP32_radio](https://github.com/anton-b/M5Stack_ESP32_radio) - Playing mp3 stream out of internet using M5Stack prototype
|
||||
|
||||
* [mp3-player-m5stack](https://github.com/dsiberia9s/mp3-player-m5stack) - MP3 player for M5Stack
|
||||
|
||||
* [ArduinoWiFiPhotoBackup](https://github.com/moononournation/ArduinoWiFiPhotoBackup) - M5STACK Arduino WiFi Photo Backup device
|
||||
|
||||
* [M5StackHIDCtrlAltDel](https://github.com/mhama/M5StackHIDCtrlAltDel) - You can send ctrl+alt+del to your PC from M5Stack
|
||||
|
||||
* [M5Stack Markdown Web Server](https://github.com/PartsandCircuits/M5Stack-MarkdownWebServer) - Markdown & icons loaded from an Micro SD card/TF card to run a web page
|
||||
|
||||
* [M5Stack-Tetris](https://github.com/PartsandCircuits/M5Stack-Tetris) - Tetris for M5Stack Ported to M5Stack by macsbug - https://macsbug.wordpress.com/
|
||||
|
||||
* [M5Stack_FlappyBird_game](https://github.com/pcelli85/M5Stack_FlappyBird_game) - M5Stack FlappyBird Playable
|
||||
|
||||
* [M5Stack-SpaceShooter](https://github.com/PartsandCircuits/M5Stack-SpaceShooter) - Space Invaders knock-off for M5Stack
|
||||
|
||||
* [M5Stack-Pacman-JoyPSP](https://github.com/tobozo/M5Stack-Pacman-JoyPSP) - Pacman on M5Stack/PSP Joypad, with sounds
|
||||
|
||||
* [M5Stack-Thermal-Camera](https://github.com/hkoffer/M5Stack-Thermal-Camera-) - M5Stack Thermal Camera with AMG8833 thermal sensor
|
||||
|
||||
* [M5Stack-3DPrintFiles](https://github.com/PartsandCircuits/M5Stack-3DPrintFiles) - Links to files for 3D printing custom case parts for the M5Stack
|
||||
|
||||
* [truetype2gfx](https://github.com/ropg/truetype2gfx) - Converting fonts from TrueType to Adafruit GFX
|
||||
|
||||
* [m5stack-onscreen-keyboard](https://github.com/yellowelise/m5stack-onscreen-keyboard) - Full size qwerty keyboard for M5Stack
|
||||
|
||||
#### Note:
|
||||
|
||||
* How to install USB driver for establishing serial port
|
||||
|
||||
https://docs.m5stack.com/#/en/related_documents/establish_serial_connection
|
||||
|
||||
* How to upgrade M5Stack Libary
|
||||
|
||||
https://docs.m5stack.com/#/en/related_documents/upgrade_m5stack_lib
|
||||
|
|
BIN
docs/M-BUS.jpg
Before Width: | Height: | Size: 228 KiB |
Before Width: | Height: | Size: 186 KiB |
|
@ -1,35 +0,0 @@
|
|||
Installation instructions for Debian / Ubuntu OS
|
||||
=================================================
|
||||
|
||||
- Install latest Arduino IDE from [arduino.cc](https://www.arduino.cc/en/Main/Software)
|
||||
- Open Terminal and execute the following command (copy->paste and hit enter):
|
||||
|
||||
```bash
|
||||
sudo usermod -a -G dialout $USER && \
|
||||
sudo apt-get install git && \
|
||||
wget https://bootstrap.pypa.io/get-pip.py && \
|
||||
sudo python get-pip.py && \
|
||||
sudo pip install pyserial && \
|
||||
mkdir -p ~/Arduino/hardware/espressif && \
|
||||
cd ~/Arduino/hardware/espressif && \
|
||||
git clone https://github.com/espressif/arduino-esp32.git esp32 && \
|
||||
cd esp32 && \
|
||||
git submodule update --init --recursive && \
|
||||
cd tools && \
|
||||
python2 get.py
|
||||
```
|
||||
- Restart Arduino IDE
|
||||
|
||||
|
||||
|
||||
- If you have Arduino.app installed to /Applications/, modify the installation as follows, beginning at `mkdir -p ~/Arduino...`:
|
||||
|
||||
```bash
|
||||
cd /Applications/Arduino_*/Contents/java/hardware/
|
||||
mkdir -p espressif && \
|
||||
cd espressif && \
|
||||
git clone https://github.com/espressif/arduino-esp32.git esp32 && \
|
||||
cd esp32 && \
|
||||
git submodule update --init --recursive && \
|
||||
cd tools && \
|
||||
python2 get.py```
|
|
@ -1,18 +0,0 @@
|
|||
Installation instructions for Fedora
|
||||
=====================================
|
||||
|
||||
- Install the latest Arduino IDE from [arduino.cc](https://www.arduino.cc/en/Main/Software). `$ sudo dnf -y install arduino` will most likely install an older release.
|
||||
- Open Terminal and execute the following command (copy->paste and hit enter):
|
||||
|
||||
```bash
|
||||
sudo usermod -a -G dialout $USER && \
|
||||
sudo dnf install git python3-pip python3-pyserial && \
|
||||
mkdir -p ~/Arduino/hardware/espressif && \
|
||||
cd ~/Arduino/hardware/espressif && \
|
||||
git clone https://github.com/espressif/arduino-esp32.git esp32 && \
|
||||
cd esp32 && \
|
||||
git submodule update --init --recursive && \
|
||||
cd tools && \
|
||||
python get.py
|
||||
```
|
||||
- Restart Arduino IDE
|
|
@ -1,23 +0,0 @@
|
|||
Installation instructions for Mac OS
|
||||
=====================================
|
||||
|
||||
- Install latest Arduino IDE from [arduino.cc](https://www.arduino.cc/en/Main/Software)
|
||||
- Open Terminal and execute the following command (copy->paste and hit enter):
|
||||
|
||||
```bash
|
||||
mkdir -p ~/Documents/Arduino/hardware/espressif && \
|
||||
cd ~/Documents/Arduino/hardware/espressif && \
|
||||
git clone https://github.com/espressif/arduino-esp32.git esp32 && \
|
||||
cd esp32 && \
|
||||
git submodule update --init --recursive && \
|
||||
cd tools && \
|
||||
python get.py
|
||||
```
|
||||
- If you get the error below. Install the command line dev tools with xcode-select --install and try the command above again:
|
||||
|
||||
```xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools), missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun```
|
||||
|
||||
```xcode-select --install```
|
||||
|
||||
- Restart Arduino IDE
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
Installation instructions for openSUSE
|
||||
======================================
|
||||
|
||||
- Install the latest Arduino IDE from [arduino.cc](https://www.arduino.cc/en/Main/Software).
|
||||
- Open Terminal and execute the following command (copy->paste and hit enter):
|
||||
|
||||
```bash
|
||||
sudo usermod -a -G dialout $USER && \
|
||||
if [ `python --version 2>&1 | grep '2.7' | wc -l` = "1" ]; then \
|
||||
sudo zypper install git python-pip python-pyserial; \
|
||||
else \
|
||||
sudo zypper install git python3-pip python3-pyserial; \
|
||||
fi && \
|
||||
mkdir -p ~/Arduino/hardware/espressif && \
|
||||
cd ~/Arduino/hardware/espressif && \
|
||||
git clone https://github.com/espressif/arduino-esp32.git esp32 && \
|
||||
cd esp32 && \
|
||||
git submodule update --init --recursive && \
|
||||
cd tools && \
|
||||
python get.py
|
||||
```
|
||||
- Restart Arduino IDE
|
Before Width: | Height: | Size: 186 KiB |
Before Width: | Height: | Size: 27 KiB |
Before Width: | Height: | Size: 36 KiB |
Before Width: | Height: | Size: 27 KiB |
Before Width: | Height: | Size: 36 KiB |
Before Width: | Height: | Size: 84 KiB |
Before Width: | Height: | Size: 27 KiB |
Before Width: | Height: | Size: 39 KiB |
Before Width: | Height: | Size: 75 KiB |
Before Width: | Height: | Size: 71 KiB |
Before Width: | Height: | Size: 32 KiB |
Before Width: | Height: | Size: 57 KiB |
Before Width: | Height: | Size: 8.2 KiB |
Before Width: | Height: | Size: 6 KiB |
Before Width: | Height: | Size: 32 KiB |
Before Width: | Height: | Size: 16 KiB |
Before Width: | Height: | Size: 7.6 KiB |
Before Width: | Height: | Size: 4.4 KiB |
Before Width: | Height: | Size: 25 KiB |
Before Width: | Height: | Size: 13 KiB |
Before Width: | Height: | Size: 27 KiB |
Before Width: | Height: | Size: 48 KiB |
Before Width: | Height: | Size: 53 KiB |
Before Width: | Height: | Size: 42 KiB |
|
@ -1,49 +0,0 @@
|
|||
## Steps to install Arduino ESP32 support on Windows
|
||||
### Tested on 32 and 64 bit Windows 10 machines
|
||||
|
||||
1. Download and install the latest Arduino IDE ```Windows Installer``` from [arduino.cc](https://www.arduino.cc/en/Main/Software)
|
||||
2. Download and install Git from [git-scm.com](https://git-scm.com/download/win)
|
||||
3. Start ```Git GUI``` and run through the following steps:
|
||||
- Select ```Clone Existing Repository```
|
||||
|
||||

|
||||
|
||||
- Select source and destination
|
||||
- Sketchbook Directory: Usually ```C:/Users/[YOUR_USER_NAME]/Documents/Arduino``` and is listed underneath the "Sketchbook location" in Arduino preferences.
|
||||
- Source Location: ```https://github.com/espressif/arduino-esp32.git```
|
||||
- Target Directory: ```[ARDUINO_SKETCHBOOK_DIR]/hardware/espressif/esp32```
|
||||
- Click ```Clone``` to start cloning the repository
|
||||
|
||||

|
||||

|
||||
- open a `Git Bash` session pointing to ```[ARDUINO_SKETCHBOOK_DIR]/hardware/espressif/esp32``` and execute ```git submodule update --init --recursive```
|
||||
- Open ```[ARDUINO_SKETCHBOOK_DIR]/hardware/espressif/esp32/tools``` and double-click ```get.exe```
|
||||
|
||||

|
||||
|
||||
- When ```get.exe``` finishes, you should see the following files in the directory
|
||||
|
||||

|
||||
|
||||
4. Plug your ESP32 board and wait for the drivers to install (or install manually any that might be required)
|
||||
5. Start Arduino IDE
|
||||
6. Select your board in ```Tools > Board``` menu
|
||||
7. Select the COM port that the board is attached to
|
||||
8. Compile and upload (You might need to hold the boot button while uploading)
|
||||
|
||||

|
||||
|
||||
### How to update to the latest code
|
||||
|
||||
1. Start ```Git GUI``` and you should see the repository under ```Open Recent Repository```. Click on it!
|
||||
|
||||

|
||||
|
||||
2. From menu ```Remote``` select ```Fetch from``` > ```origin```
|
||||
|
||||

|
||||
|
||||
3. Wait for git to pull any changes and close ```Git GUI```
|
||||
4. Open ```[ARDUINO_SKETCHBOOK_DIR]/hardware/espressif/esp32/tools``` and double-click ```get.exe```
|
||||
|
||||

|
|
@ -1,70 +0,0 @@
|
|||
To use as a component of ESP-IDF
|
||||
=================================================
|
||||
|
||||
## Installation
|
||||
|
||||
- Download and install [esp-idf](https://github.com/espressif/esp-idf)
|
||||
- Create blank idf project (from one of the examples)
|
||||
- in the project folder, create a folder called components and clone this repository inside
|
||||
|
||||
```bash
|
||||
mkdir -p components && \
|
||||
cd components && \
|
||||
git clone https://github.com/espressif/arduino-esp32.git arduino && \
|
||||
cd arduino && \
|
||||
git submodule update --init --recursive && \
|
||||
cd ../.. && \
|
||||
make menuconfig
|
||||
```
|
||||
- ```make menuconfig``` has some Arduino options
|
||||
- "Autostart Arduino setup and loop on boot"
|
||||
- If you enable this options, your main.cpp should be formated like any other sketch
|
||||
|
||||
```arduino
|
||||
//file: main.cpp
|
||||
#include "Arduino.h"
|
||||
|
||||
void setup(){
|
||||
Serial.begin(115200);
|
||||
}
|
||||
|
||||
void loop(){
|
||||
Serial.println("loop");
|
||||
delay(1000);
|
||||
}
|
||||
```
|
||||
|
||||
- Else you need to implement ```app_main()``` and call ```initArduino();``` in it.
|
||||
|
||||
Keep in mind that setup() and loop() will not be called in this case.
|
||||
If you plan to base your code on examples provided in [esp-idf](https://github.com/espressif/esp-idf/tree/master/examples), please make sure move the app_main() function in main.cpp from the files in the example.
|
||||
|
||||
```arduino
|
||||
//file: main.cpp
|
||||
#include "Arduino.h"
|
||||
|
||||
extern "C" void app_main()
|
||||
{
|
||||
initArduino();
|
||||
pinMode(4, OUTPUT);
|
||||
digitalWrite(4, HIGH);
|
||||
//do your own thing
|
||||
}
|
||||
```
|
||||
- "Disable mutex locks for HAL"
|
||||
- If enabled, there will be no protection on the drivers from concurently accessing them from another thread/interrupt/core
|
||||
- "Autoconnect WiFi on boot"
|
||||
- If enabled, WiFi will start with the last known configuration
|
||||
- Else it will wait for WiFi.begin
|
||||
- ```make flash monitor``` will build, upload and open serial monitor to your board
|
||||
|
||||
## Logging To Serial
|
||||
|
||||
If you are writing code that does not require Arduino to compile and you want your `ESP_LOGx` macros to work in Arduino IDE, you can enable the compatibility by adding the following lines after your includes:
|
||||
|
||||
```cpp
|
||||
#ifdef ARDUINO_ARCH_ESP32
|
||||
#include "esp32-hal-log.h"
|
||||
#endif
|
||||
```
|
||||
|
|
@ -1,70 +0,0 @@
|
|||
# M5Stack 库
|
||||
|
||||
English | [中文](docs/getting_started_cn.md) | [日本語](docs/getting_started_ja.md)
|
||||
|
||||
## 1. 上手指南
|
||||
|
||||
*1.For MacOS*
|
||||
|
||||
https://docs.m5stack.com/#/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS
|
||||
|
||||
*2. For Windows*
|
||||
|
||||
https://docs.m5stack.com/#/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows
|
||||
|
||||
|
||||
## 2. 例程
|
||||
|
||||
https://github.com/m5stack/M5Stack/tree/master/examples
|
||||
|
||||
## 3. API 参考
|
||||
|
||||
https://github.com/m5stack/M5Stack/blob/master/src/M5Stack.h#L19
|
||||
|
||||
https://docs.m5stack.com/#/zh_CN/api
|
||||
|
||||
## 4. H/W 参考
|
||||
|
||||
#### 管脚映射
|
||||
|
||||
*我们有几款不同配置的主控 M5Cores,这是他们之间的[对比](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_difference_between_cores.md).*
|
||||
|
||||
**LCD & TF Card**
|
||||
|
||||
*LCD 分辨率: 320x240*
|
||||
|
||||
<table>
|
||||
<tr><td>ESP32 Chip</td><td>GPIO23</td><td>GPIO19</td><td>GPIO18</td><td>GPIO14</td><td>GPIO27</td><td>GPIO33</td><td>GPIO32</td><td>GPIO4</td></tr>
|
||||
<tr><td>ILI9341</td><td>/</td><td>MISO</td><td>CLK</td><td>CS</td><td>DC</td><td>RST</td><td>BL</td><td> </td></tr>
|
||||
<tr><td>TF Card</td><td>MOSI</td><td>MISO</td><td>CLK</td><td> </td><td> </td><td> </td><td> </td><td>CS</td></tr>
|
||||
|
||||
</table>
|
||||
|
||||
**Button & Speaker**
|
||||
|
||||
<table>
|
||||
<tr><td>ESP32 Chip</td><td>GPIO39</td><td>GPIO38</td><td>GPIO37</td><td>GPIO25</td></tr>
|
||||
<tr><td>Button Pin</td><td>BUTTON A</td><td>BUTTON B</td><td>BUTTON C</td></tr>
|
||||
<tr><td>Speaker</td><td> </td><td> </td><td> </td><td>Speaker Pin</td></tr>
|
||||
</table>
|
||||
|
||||
**GROVE A**
|
||||
|
||||
<table>
|
||||
<tr><td>ESP32 Chip</td><td>GPIO22</td><td>GPIO21</td></tr>
|
||||
<tr><td>GROVE A</td><td>SCL</td><td>SDA</td></tr>
|
||||
</table>
|
||||
|
||||
|
||||
### M-BUS
|
||||

|
||||
|
||||
#### Note:
|
||||
|
||||
* 如何安装 CP210x 串口驱动
|
||||
|
||||
https://docs.m5stack.com/#/zh_CN/related_documents/establish_serial_connection
|
||||
|
||||
* 如何升级 M5Stack 库
|
||||
|
||||
https://docs.m5stack.com/#/zh_CN/related_documents/upgrade_m5stack_lib
|
|
@ -1,141 +0,0 @@
|
|||
# M5Stack Library
|
||||
|
||||
[English](../README.md) | [中文](getting_started_cn.md) | 日本語
|
||||
|
||||
M5Stack Core のライブラリへようこそ
|
||||
|
||||
## 1. 始めよう
|
||||
|
||||
#### M5Stackの開発環境を構築しよう
|
||||
|
||||
*1.MacOS環境*
|
||||
|
||||
https://docs.m5stack.com/#/ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS
|
||||
|
||||
*2.Windows環境*
|
||||
|
||||
https://docs.m5stack.com/#/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows
|
||||
|
||||
|
||||
## 2. プログラム例
|
||||
|
||||
https://github.com/m5stack/M5Stack/tree/master/examples
|
||||
|
||||
## 3. 関数リファレンス(API仕様)
|
||||
|
||||
https://github.com/m5stack/M5Stack/blob/master/src/M5Stack.h#L19
|
||||
|
||||
https://docs.m5stack.com/#/ja/api
|
||||
|
||||
|
||||
## 4. ハードウェア仕様
|
||||
|
||||
#### I/Oインタフェイス
|
||||
|
||||
*M5Coreは複数のバリエーションがあります。違いは [こちら](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_difference_between_cores_ja.md)*
|
||||
|
||||
**LCD & SDカード**
|
||||
|
||||
*LCD 解像度: 320x240*
|
||||
|
||||
<table>
|
||||
<tr><td>ESP32 Chip</td><td>GPIO23</td><td>GPIO19</td><td>GPIO18</td><td>GPIO14</td><td>GPIO27</td><td>GPIO33</td><td>GPIO32</td><td>GPIO4</td></tr>
|
||||
<tr><td>ILI9341</td><td>/</td><td>MISO</td><td>CLK</td><td>CS</td><td>DC</td><td>RST</td><td>BL</td><td> </td></tr>
|
||||
<tr><td>SD Card</td><td>MOSI</td><td>MISO</td><td>CLK</td><td> </td><td> </td><td> </td><td> </td><td>CS</td></tr>
|
||||
|
||||
</table>
|
||||
|
||||
**ボタン & スピーカー**
|
||||
|
||||
<table>
|
||||
<tr><td>ESP32 Chip</td><td>GPIO39</td><td>GPIO38</td><td>GPIO37</td><td>GPIO25</td></tr>
|
||||
<tr><td>ボタン</td><td>Aボタン</td><td>Bボタン</td><td>Cボタン</td><td> </td></tr>
|
||||
<tr><td>スピーカー</td><td> </td><td> </td><td> </td><td>Speaker Pin</td></tr>
|
||||
</table>
|
||||
|
||||
**GROVE A**
|
||||
|
||||
<table>
|
||||
<tr><td>ESP32 Chip</td><td>GPIO22</td><td>GPIO21</td></tr>
|
||||
<tr><td>GROVE A</td><td>SCL</td><td>SDA</td></tr>
|
||||
</table>
|
||||
|
||||
|
||||
### M-バス
|
||||

|
||||
|
||||
## 5. 素晴らしい応用例
|
||||
|
||||
* [M5Stack-SD-Updater](https://github.com/tobozo/M5Stack-SD-Updater) - カスタマイズ可能な M5Stack用メニュー - アプリはSDカードから読み込めます
|
||||
card
|
||||
|
||||
* [TFT_eSPI](https://github.com/Bodmer/TFT_eSPI) - いくつかのチップをサポートする TFT ライブラリ(ESP8266/ ESP32向け)
|
||||
|
||||
|
||||
* [M5Widgets](https://github.com/Kongduino/M5Widgets) - M5Stack用ウィジット
|
||||
|
||||
* [M5StackSAM](https://github.com/tomsuch/M5StackSAM) - シンプルな M5Stack用アプリケーションメニュー
|
||||
|
||||
* [cfGUI](https://github.com/JF002/cfGUI) - M5Stack (ESP32)用のシンプルなGUIライブラリ
|
||||
|
||||
* [GUIslice](https://github.com/ImpulseAdventure/GUIslice) - 組み込みディスプレイ向けの 軽量GUIフレームワーク
|
||||
|
||||
* [M5ez](https://github.com/ropg/M5ez) - M5Stackで簡単にプログラムをするインターフェースビルダーライブラリ
|
||||
|
||||
|
||||
* [M5Stack MultiApp Advanced](https://github.com/botofancalin/M5Stack-MultiApp-Advanced) - すべてのアプリを再起動や再起動なしで実行できる、マルチアプリファームウェア
|
||||
|
||||
|
||||
* [M5Stack ESP32 Oscilloscope](https://github.com/botofancalin/M5Stack-ESP32-Oscilloscope) - ESP32 M5Stackをベースにした多機能オシロスコープ
|
||||
|
||||
* [M5Stack-Avatar](https://github.com/meganetaaan/m5stack-avatar) -アバターを表示できるライブラリ
|
||||
|
||||
* [M5Stack_CrackScreen](https://github.com/nomolk/M5Stack_CrackScreen) - M5Stackの画面が割れた時を模擬します。
|
||||
|
||||
* [M5_Shuttle_Run](https://github.com/n0bisuke/M5_Shuttle_Run) - M5Stackでシャトルランができます。
|
||||
|
||||
* [nixietubeM5](https://github.com/drayde/nixietubeM5) - M5Stackでニキシー管ディスプレイを再現します。
|
||||
|
||||
* [M5Stack_BTCTicker](https://github.com/dankelley2/M5Stack_BTCTicker) - M5Stack(ESP32)とCoindesk APIを併用した小さなBitcoinレート表示器
|
||||
|
||||
* [M5Stack_ETHPrice](https://github.com/donma/M5StackWifiSettingWithETHPrice) - WiFiをつかって、Maicoinから ETH 価格を取得する設定例
|
||||
|
||||
* [M5Stack-PacketMonitor](https://github.com/tobozo/M5Stack-PacketMonitor) - M5Stack ESP32 WiFiパケットモニター
|
||||
|
||||
* [M5-FFT](https://github.com/ElectroMagus/M5-FFT) - M5Stack 用FFTアナライザー(グラフィックイコライザ)
|
||||
|
||||
* [M5Stack_ESP32_radio](https://github.com/anton-b/M5Stack_ESP32_radio) - インターネットmp3ストリームを再生
|
||||
|
||||
* [mp3-player-m5stack](https://github.com/dsiberia9s/mp3-player-m5stack) - M5Stack用 MP3プレーヤ
|
||||
|
||||
* [ArduinoWiFiPhotoBackup](https://github.com/moononournation/ArduinoWiFiPhotoBackup) - M5STACK WiFi 写真バックアップデバイス
|
||||
|
||||
* [M5StackHIDCtrlAltDel](https://github.com/mhama/M5StackHIDCtrlAltDel) - M5StackからPCに Ctrl + Alt + Delを送信
|
||||
|
||||
* [M5Stack Markdown Web Server](https://github.com/PartsandCircuits/M5Stack-MarkdownWebServer) -SDからマークダウンとアイコンを読み込んでWebページを表示
|
||||
|
||||
* [M5Stack-Tetris](https://github.com/PartsandCircuits/M5Stack-Tetris) - テトリス for M5Stack (macsbugによる移植) - https://macsbug.wordpress.com/
|
||||
|
||||
* [M5Stack_FlappyBird_game](https://github.com/pcelli85/M5Stack_FlappyBird_game) - M5Stack FlappyBird ゲーム
|
||||
|
||||
* [M5Stack-SpaceShooter](https://github.com/PartsandCircuits/M5Stack-SpaceShooter) - スペースインベーダー for M5Stack
|
||||
|
||||
* [M5Stack-Pacman-JoyPSP](https://github.com/tobozo/M5Stack-Pacman-JoyPSP) - パックマン for M5Stack/PSP ジョイパッド、サウンド付き。
|
||||
|
||||
* [M5Stack-Thermal-Camera](https://github.com/hkoffer/M5Stack-Thermal-Camera-) - M5Stack サーモカメラ (AMG8833 サーモセンサ版)
|
||||
|
||||
* [M5Stack-3DPrintFiles](https://github.com/PartsandCircuits/M5Stack-3DPrintFiles) - M5Stack 3Dプリンタ印刷用モデルデータ
|
||||
|
||||
* [truetype2gfx](https://github.com/ropg/truetype2gfx) - TrueType フォントを Adafruit GFX形式に変換
|
||||
|
||||
* [m5stack-onscreen-keyboard](https://github.com/yellowelise/m5stack-onscreen-keyboard) - フルサイズ qwerty キーボード
|
||||
|
||||
#### ノート:
|
||||
|
||||
* シリアル通信用USBドライバの導入方法
|
||||
|
||||
https://docs.m5stack.com/#/ja/related_documents/establish_serial_connection
|
||||
|
||||
* M5Stackライブラリの更新方法
|
||||
|
||||
https://docs.m5stack.com/#/ja/related_documents/upgrade_m5stack_lib
|
|
@ -1,4 +0,0 @@
|
|||
To use make
|
||||
============
|
||||
|
||||
[makeEspArduino](https://github.com/plerup/makeEspArduino) is a generic makefile for any ESP8266/ESP32 Arduino project.Using make instead of the Arduino IDE makes it easier to do automated and production builds.
|
|
@ -1,11 +0,0 @@
|
|||
Installation instructions for using PlatformIO
|
||||
=================================================
|
||||
|
||||
- [What is PlatformIO?](http://docs.platformio.org/en/latest/what-is-platformio.html?utm_source=github&utm_medium=arduino-esp32)
|
||||
- [PlatformIO IDE](http://platformio.org/platformio-ide?utm_source=github&utm_medium=arduino-esp32)
|
||||
- [PlatformIO Core](http://docs.platformio.org/en/latest/core.html?utm_source=github&utm_medium=arduino-esp32) (command line tool)
|
||||
- [Advanced usage](http://docs.platformio.org/en/latest/platforms/espressif32.html?utm_source=github&utm_medium=arduino-esp32) -
|
||||
custom settings, uploading to SPIFFS, Over-the-Air (OTA), staging version
|
||||
- [Integration with Cloud and Standalone IDEs](http://docs.platformio.org/en/latest/ide.html?utm_source=github&utm_medium=arduino-esp32) -
|
||||
Cloud9, Codeanywhere, Eclipse Che (Codenvy), Atom, CLion, Eclipse, Emacs, NetBeans, Qt Creator, Sublime Text, VIM, Visual Studio, and VSCode
|
||||
- [Project Examples](http://docs.platformio.org/en/latest/platforms/espressif32.html?utm_source=github&utm_medium=arduino-esp32#examples)
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"name": "M5Stack",
|
||||
"description": "An ESP32 Arduino board",
|
||||
"keywords": "M5Stack Odroid-Go ttgo-ts",
|
||||
"name": "ESP32-Chimera-Core",
|
||||
"description": "Alternate library M5Stack/Odroid-Go/D-Duino and possiblly other ESP32/TFT/SD bundles",
|
||||
"keywords": "M5Stack Odroid-Go ttgo-ts d-duino-32-xs esp32-wrover-kit",
|
||||
"authors": {
|
||||
"name": "ESP32-Chimera-Core, a clone of M5Stack-core",
|
||||
"url": "https://github.com/tobozo/ESP32-Chimera-Core"
|
||||
|
|
|
@ -1,8 +1,8 @@
|
|||
name=M5Stack
|
||||
name=ESP32-Chimera-Core
|
||||
version=0.2.9
|
||||
author=M5Stack
|
||||
maintainer=Lovyan03 & Tobozo
|
||||
sentence=Library for M5Stack Core development kit
|
||||
author=Lovyan03 & Tobozo
|
||||
maintainer=tobozo@noreply.github.com
|
||||
sentence=Alternate library M5Stack/Odroid-Go/D-Duino and possiblly other ESP32/TFT/SD bundles
|
||||
paragraph=See more on https://github.com/tobozo/ESP32-Chimera-Core
|
||||
category=Device Control
|
||||
url=https://github.com/tobozo/ESP32-Chimera-Core
|
||||
|
|