From 1cf143feacaaf149a5f353505bdfdcdff0dd26e6 Mon Sep 17 00:00:00 2001 From: lewisxhe Date: Thu, 19 Nov 2020 10:39:52 +0800 Subject: [PATCH] Update examples description --- docs/examples_cn.md | 191 +++++++++++++++++++++++-------------------- docs/examples_en.md | 192 ++++++++++++++++++++++++-------------------- 2 files changed, 210 insertions(+), 173 deletions(-) diff --git a/docs/examples_cn.md b/docs/examples_cn.md index f2d36d1..4557ccd 100644 --- a/docs/examples_cn.md +++ b/docs/examples_cn.md @@ -1,91 +1,110 @@ -``` -examples/ +. ├── BasicUnit #基础硬件单元目录 -│ ├── AXP20x_ADC #电源管理ADC示例 -│ ├── AXP20x_ChargeCurrent #电源管理充电管理示例 -│ ├── AXP20x_IRQ #电源管理中断示例 -│ ├── BMA423_Accel #三轴加速度计基本示例 -│ ├── BMA423_Direction #三轴加速度计获取屏幕方向 -│ ├── BMA423_Feature #三轴加速度计特性 -│ ├── BMA423_StepCount #三轴加速度计内置步数获取示例 -│ ├── DrawSD_BMP #画BMP格式图片到屏幕(只适用带SD卡槽主板) -│ ├── Motor #基本震动驱动 -│ ├── PlayMP3FromPROGMEM #从Flash中获取音频数据播放MP3 -│ ├── PlayMP3FromSDToDAC #从SD卡中获取音频数据播放MP3 -│ ├── PlayMP3FromSPIFFS #从SPIFFS中获取音频数据播放MP3 -│ ├── RTC #基本RTC设置和闹钟示例 -│ ├── SDCard #基本SD卡操作示例 -│ ├── SetTimeFromBLE #从BLE中设置RTC时间 -│ ├── TouchPad #基本触摸示例 -│ ├── UserButton #基本用户按键示例 -│ ├── WakeupFormPEKKey #使用电源管理PEK按键唤醒ESP32 -│ ├── WakeupFormSensor #使用三轴加速度计唤醒ESP32 -│ ├── WakeupFormTimer #使用内置定时器唤醒ESP32 -│ ├── BluetoothAudio #通过蓝牙播放音频 -│ └── BluetoothAudioWeb #通过蓝牙播放音频,附带网页控制 +│   ├── AXP20x_ADC #电源管理ADC示例 +│   ├── AXP20x_ChargeCurrent #电源管理充电管理示例 +│   ├── AXP20x_IRQ #电源管理中断示例 +│   ├── BMA423_Accel #三轴加速度计基本示例 +│   ├── BMA423_Direction #三轴加速度计获取屏幕方向 +│   ├── BMA423_Feature #三轴加速度计特性 +│   ├── BMA423_StepCount #三轴加速度计内置步数获取示例 +│   ├── BluetoothAudio #通过蓝牙播放音频 +│   ├── BluetoothAudioWeb #通过蓝牙播放音频,附带网页控制 +│   ├── DRV2605_Basic #DRV2605 Vibration Basic +│   ├── DRV2605_Complex #DRV2605 Vibration Complex +│   ├── DRV2605_Realtime #DRV2605 Vibration Realtime +│   ├── DrawSD_BMP #画BMP格式图片到屏幕(只适用带SD卡槽主板) +│   ├── GPS_Unit #TWatch-2020-V2 GPS unit test +│   ├── Motor #基本震动驱动示例 +│   ├── PlayMP3FromPROGMEM #从Flash中获取音频数据播放MP3 +│   ├── PlayMP3FromSDToDAC #从SD卡中获取音频数据播放MP3 +│   ├── PlayMP3FromSPIFFS #从SPIFFS中获取音频数据播放MP3 +│   ├── RTC #基本RTC设置和闹钟示例 +│   ├── SDCard #基本SD卡操作示例 +│   ├── SetTimeFromBLE #从BLE中设置RTC时间 +│   ├── TimeSynchronization #WiFi时间同步 +│   ├── TouchMultitask #多任务触摸读取 +│   ├── TouchPad #基本触摸示例 +│   ├── UserButton #基本用户按键示例 +│   ├── WakeupFormPEKKey #使用电源管理PEK按键唤醒ESP32 +│   ├── WakeupFormSensor #使用三轴加速度计唤醒ESP32 +│   ├── WakeupFormTimer #使用内置定时器唤醒ESP32 +│   └── WakeupFormTouchScreen #从触摸屏唤醒ESP32 ├── ClientProject #客户的示例目录 -│ └── SimpleFramework #使用TFT_eSPI构成的框架 +│   └── SimpleFramework #使用TFT_eSPI构成的框架 ├── ExternTFTLibrary #使用PlatfromIO,外部TFT_eSPI与TTGO_TWatch_Library搭配使用示例 -│ └── src +│   └── src ├── LVGL #LVGL图形框架演示目录 -│ ├── AnalogRead #获取模拟数据在显示屏中绘制曲线 -│ ├── BatmanDial #简单的蝙蝠侠样式时钟 -│ ├── IRremote #红外遥控示例 -│ ├── LilyGoGui #简单的手表界面 -│ ├── Lvgl_Base #LVGL基础入门 -│ ├── Lvgl_Button #LVGL按键的示例 -│ ├── SimplePlayer #LVGL简易播放器示例 -│ ├── SimpleWatch #LVGL简易手表示例 -│ └── TQuick #LVGL简易电机驱动 -├── Sensor #传感器目录 -│ ├── Fingerprint #指纹传感器示例 -│ ├── Rotary #旋转编码器示例 -│ └── VEMl6075 #紫外线传感器示例 -├── Shield #此目录只适用TWATCH-2019，不适用TWATCH2020 -│ ├── AlarmClock #RTC闹钟示例 -│ ├── BBQKeyboard #BBQ键盘示例 -│ ├── DRV8833 #电机示例 -│ ├── GameControl #游戏手柄示例 -│ ├── HeartRate #心率传感器示例 -│ ├── INMP441_Mic #麦克风示例 -│ ├── LoRa_SX127x #LORA示例 -│ ├── M6_GPS #ubolx GPS示例 -│ ├── NFC_Lock #NFC 示例 -│ ├── S7xG_GPS #S76/78G GPS 示例 -│ ├── S7xG_LoRa #S76/78G LORA 示例 -│ ├── SIM800L #SIM800L 2G通信模块示例 -│ ├── SIM868 #SIM868 2G通信定位模块示例 -│ └── SPM1423HM4H_Mic #麦克风示例 -├── T-Block #此目录只适用TBLOCK，不适用其他 -│ ├── CapTouch #MPR121 电容触摸传感器示例 -│ ├── Epaper_BL #1.54`带背光墨水屏驱动示例 -│ ├── Epaper_TP #1.54`带触摸墨水屏驱动示例 -│ ├── Epaper_GDEW0371W7 #3.71`带触摸墨水屏驱动示例 -│ ├── LEDMatrix #LED点阵示例 -│ ├── MPU6050_accel_pitch_roll #MPU6050 加速度示例 -│ ├── MPU6050_accel_simple #MPU6050 加速度示例 -│ ├── MPU6050_gyro_pitch_roll_yaw #MPU6050 陀螺仪示例 -│ ├── MPU6050_gyro_simple #MPU6050 陀螺仪示例 -│ ├── MPU6050_temperature #MPU6050 内置温度传感器示例 -│ └── TouchScreen #ST7796S / ILI9488 显示屏模块示例 +│   ├── AnalogRead #获取模拟数据在显示屏中绘制曲线 +│   ├── BatmanDial #简单的蝙蝠侠样式时钟 +│   ├── ChargingAnimation #lvgl & fs 充电动画演示 +│   ├── IRremote #红外遥控示例 +│   ├── LilyGoGui #简单的手表界面 +│   ├── Lvgl_Base #LVGL基础入门 +│   ├── Lvgl_Button #LVGL按键的示例 +│   ├── SimplePlayer #LVGL简易播放器示例 +│   ├── SimpleWatch #LVGL简易手表示例 +│   └── lvgl_fs #从文件系统中读取png图片显示在lvgl中 ├── LilyPi #此目录只适用LilyPi，不适用其他 -│ ├── Epaper_GDEW0371W7 #3.71`带触摸墨水屏驱动示例 -│ ├── IRRemote #使用外部模块红外遥控示例 -│ └── lv_demo_widgets #lvgl 演示示例 -└── TFT_eSPI #TFT_eSPI 显示示例 - ├── All_Free_Fonts_Demo - ├── Arduino_Life - ├── FlappyBird - ├── IOTA_Price - ├── Pong_v3 - ├── RLE_Font_test - ├── TFT_Char_times - ├── TFT_Clock - ├── TFT_Clock_Digital - ├── TFT_Ellipse - ├── TFT_Meter_5 - ├── TFT_graphicstest_PDQ3 - ├── TFT_graphicstest_small - ├── UTFT_demo_fast - └── fillScreen -``` \ No newline at end of file +│   ├── Epaper_GDEW0371W7 #3.71`带触摸墨水屏驱动示例 +│   ├── IRRemote #使用外部模块红外遥控示例 +│   └── lv_demo_widgets #lvgl 演示示例 +├── NES #NES游戏模拟器 +├── Sensor #传感器目录 +│   ├── Fingerprint #指纹传感器示例 +│   ├── MAX30208 #MAX30208 温度传感器 +│   ├── Rotary #旋转编码器示例 +│   └── VEMl6075 #紫外线传感器示例 +├── Shield #此目录只适用TWATCH-2019，不适用TWATCH2020 +│   ├── AlarmClock #RTC闹钟示例 +│   ├── BBQKeyboard #BBQ键盘示例 +│   ├── DRV8833 #电机示例 +│   ├── GameControl #游戏手柄示例 +│   ├── HeartRate #心率传感器示例 +│   ├── INMP441_Mic #麦克风示例 +│   ├── LoRa_SX127x #LORA示例 +│   ├── M6_GPS #Ubolx GPS示例 +│   ├── NFC_Lock #NFC 示例 +│   ├── S7xG_GPS #S76/78G GPS 示例 +│   ├── S7xG_LoRa #S76/78G LORA 示例 +│   ├── SIM800L #SIM800L 2G通信模块示例 +│   ├── SIM868 #SIM868 2G通信定位模块示例 +│   └── SPM1423HM4H_Mic #麦克风示例 +├── T-Block #此目录只适用TBLOCK，不适用其他 +│   ├── CapTouch #MPR121 电容触摸传感器示例 +│   ├── Epaper #1.54` 墨水屏，不带背光和触摸 +│   ├── Epaper_BL #1.54`带背光墨水屏驱动示例 +│   ├── Epaper_Badge #1.54`电子纸 电子徽章 +│   ├── Epaper_GDEW0371W7 #3.71`带触摸墨水屏驱动示例 +│   ├── Epaper_GDEW0371W7_BTN #3.71`带触摸墨水屏带按键驱动示例 +│   ├── Epaper_TP #1.54`带触摸墨水屏驱动示例 +│   ├── LEDMatrix #LED点阵示例 +│   ├── MPU6050_accel_pitch_roll #MPU6050 加速度示例 +│   ├── MPU6050_accel_simple #MPU6050 加速度示例 +│   ├── MPU6050_gyro_pitch_roll_yaw #MPU6050 陀螺仪示例 +│   ├── MPU6050_gyro_simple #MPU6050 陀螺仪示例 +│   ├── MPU6050_temperature #MPU6050 内置温度传感器示例 +│   └── TouchScreen #ST7796S / ILI9488 显示屏模块示例 +├── TFT_eSPI +│   ├── All_Free_Fonts_Demo +│   ├── Arduino_Life +│   ├── ESPFace +│   ├── FlappyBird +│   ├── IOTA_Price +│   ├── Pong_v3 +│   ├── RLE_Font_test +│   ├── TFT_Char_times +│   ├── TFT_Clock +│   ├── TFT_Clock_Digital +│   ├── TFT_Ellipse +│   ├── TFT_Meter_5 +│   ├── TFT_graphicstest_PDQ3 +│   ├── TFT_graphicstest_small +│   ├── UTFT_demo_fast +│   └── fillScreen +├── T_Bao # T_Bao 小车示例 +├── T_Bao2 # T_Bao 小车示例 +├── T_Quick # T_Quick 小车示例 +└── U8g2_for_TFT_eSPI # U8g2示例 + ├── Shennong + └── Unicode + diff --git a/docs/examples_en.md b/docs/examples_en.md index e50a989..6e299a1 100644 --- a/docs/examples_en.md +++ b/docs/examples_en.md @@ -1,92 +1,110 @@ -``` -examples/ +. ├── BasicUnit #Basic hardware unit catalog -│ ├── AXP20x_ADC #Power Management ADC Example -│ ├── AXP20x_ChargeCurrent #Power managementCharging management example -│ ├── AXP20x_IRQ #Power management interrupt example -│ ├── BMA423_Accel #Basic example of three-axis accelerometer -│ ├── BMA423_Direction #Three-axis accelerometer to get screen orientation -│ ├── BMA423_Feature #Three-axis accelerometer features -│ ├── BMA423_StepCount #Three-axis accelerometer built-in steps acquisition example -│ ├── DrawSD_BMP #Draw BMP format pictures to the screen (only for motherboards with SD card slot) -│ ├── Motor #Basic Vibration Drive -│ ├── PlayMP3FromPROGMEM #Get audio data from Flash and play MP3 -│ ├── PlayMP3FromSDToDAC #Get audio data from SD card to play MP3 -│ ├── PlayMP3FromSPIFFS #Get audio data from SPIFFS and play MP3 -│ ├── RTC #Basic RC settings and alarm clock examples -│ ├── SDCard #Basic SD card operation example -│ ├── SetTimeFromBLE #Set RTC time from BLE -│ ├── TouchPad #Basic touch example -│ ├── UserButton #Basic user button example -│ ├── WakeupFormPEKKey #Use the power management PEK button to wake up ESP32 -│ ├── WakeupFormSensor #Use the three-axis accelerometer to wake up the ESP32 -│ ├── WakeupFormTimer #Use built-in timer to wake up ESP32 -│ ├── BluetoothAudio #Bluetooth playback -│ └── BluetoothAudioWeb #Bluetooth playback, with web control - +│   ├── AXP20x_ADC #Power Management ADC Example +│   ├── AXP20x_ChargeCurrent #Power managementCharging management example +│   ├── AXP20x_IRQ #Power management interrupt example +│   ├── BMA423_Accel #Basic example of three-axis accelerometer +│   ├── BMA423_Direction #Three-axis accelerometer to get screen orientation +│   ├── BMA423_Feature #Three-axis accelerometer features +│   ├── BMA423_StepCount #Three-axis accelerometer built-in steps acquisition example +│   ├── BluetoothAudio #Bluetooth playback +│   ├── BluetoothAudioWeb #Bluetooth playback, with web control +│   ├── DRV2605_Basic #DRV2605 Vibration Basic +│   ├── DRV2605_Complex #DRV2605 Vibration Complex +│   ├── DRV2605_Realtime #DRV2605 Vibration Realtime +│   ├── DrawSD_BMP #Draw BMP format pictures to the screen (only for motherboards with SD card slot) +│   ├── GPS_Unit #TWatch-2020-V2 GPS unit test +│   ├── Motor #Basic Vibration Drive +│   ├── PlayMP3FromPROGMEM #Get audio data from Flash and play MP3 +│   ├── PlayMP3FromSDToDAC #Get audio data from SD card to play MP3 +│   ├── PlayMP3FromSPIFFS #Get audio data from SPIFFS and play MP3 +│   ├── RTC #Basic RC settings and alarm clock examples +│   ├── SDCard #Basic SD card operation example +│   ├── SetTimeFromBLE #Set RTC time from BLE +│   ├── TimeSynchronization #Time synchronization +│   ├── TouchMultitask #Touch multitasking +│   ├── TouchPad #Basic touch example +│   ├── UserButton #Basic user button example +│   ├── WakeupFormPEKKey #Use the power management PEK button to wake up ESP32 +│   ├── WakeupFormSensor #Use the three-axis accelerometer to wake up the ESP32 +│   ├── WakeupFormTimer #Use built-in timer to wake up ESP32 +│   └── WakeupFormTouchScreen #Wake up from the touch screen ├── ClientProject #Customer's example directory -│ └── SimpleFramework #Use TFT_eSPI frame +│   └── SimpleFramework #Use TFT_eSPI frame ├── ExternTFTLibrary #Use PlatfromIO, an example of using external TFT_eSPI with TTGO_TWatch_Library -│ └── src +│   └── src ├── LVGL #LVGLGraphic Framework Demo Directory -│ ├── AnalogRead #Get simulation data and draw a curve in the display -│ ├── BatmanDial #Simple Batman style clock -│ ├── IRremote #Infrared remote control example -│ ├── LilyGoGui #Simple watch interface -│ ├── Lvgl_Base #LVGL Getting Started -│ ├── Lvgl_Button #LVGLKey Examples -│ ├── SimplePlayer #LVGLSimple player example -│ ├── SimpleWatch #LVGLSimple watch example -│ └── TQuick #LVGL Simple Motor Drive -├── Sensor #Sensor directory -│ ├── Fingerprint #Fingerprint sensor example -│ ├── Rotary #Rotary encoder example -│ └── VEMl6075 #UV sensor example -├── Shield #This directory is only applicable to TWATCH-2019, not applicable to TWATCH2020 -│ ├── AlarmClock #RTC Alarm clock example -│ ├── BBQKeyboard #BBQ keyboard example -│ ├── DRV8833 #Motor example -│ ├── GameControl #Gamepad example -│ ├── HeartRate #Heart rate sensor example -│ ├── INMP441_Mic #Microphone example -│ ├── LoRa_SX127x #LORA Example -│ ├── M6_GPS #ubolx GPS example -│ ├── NFC_Lock #NFC example -│ ├── S7xG_GPS #S76/78G GPS example -│ ├── S7xG_LoRa #S76/78G LORA example -│ ├── SIM800L #SIM800L 2G communication module example -│ ├── SIM868 #SIM868 2G communication positioning module example -│ └── SPM1423HM4H_Mic #Microphone example -├── T-Block #This directory is only applicable to TBLOCK, not applicable to others -│ ├── CapTouch #MPR121 Capacitive touch sensor example -│ ├── Epaper_BL #1.54`Ink screen driver example with backlight -│ ├── Epaper_TP #1.54`Drive example with touch ink screen -│ ├── Epaper_GDEW0371W7 #3.71`Drive example with touch ink screen -│ ├── LEDMatrix #LEDdot matrix example -│ ├── MPU6050_accel_pitch_roll #MPU6050 Acceleration example -│ ├── MPU6050_accel_simple #MPU6050 Acceleration example -│ ├── MPU6050_gyro_pitch_roll_yaw #MPU6050 Gyroscope example -│ ├── MPU6050_gyro_simple #MPU6050 Gyroscope example -│ ├── MPU6050_temperature #MPU6050 Example of built-in temperature sensor -│ └── TouchScreen #ST7796S / ILI9488 Display module example +│   ├── AnalogRead #Get simulation data and draw a curve in the display +│   ├── BatmanDial #Simple Batman style clock +│   ├── ChargingAnimation #Charging animation demonstration +│   ├── IRremote #Infrared remote control example +│   ├── LilyGoGui #Simple watch interface +│   ├── Lvgl_Base #LVGL Getting Started +│   ├── Lvgl_Button #LVGLKey Examples +│   ├── SimplePlayer #LVGLSimple player example +│   ├── SimpleWatch #LVGLSimple watch example +│   └── lvgl_fs #Read the png from fs and display it in lvgl ├── LilyPi #This directory is only applicable to LilyPi, not applicable to others -│ ├── Epaper_GDEW0371W7 #3.71`Drive example with touch ink screen -│ ├── IRRemote #Example of using external module infrared remote control -│ └── lv_demo_widgets #lvgl example -└── TFT_eSPI #TFT_eSPI Display example - ├── All_Free_Fonts_Demo - ├── Arduino_Life - ├── FlappyBird - ├── IOTA_Price - ├── Pong_v3 - ├── RLE_Font_test - ├── TFT_Char_times - ├── TFT_Clock - ├── TFT_Clock_Digital - ├── TFT_Ellipse - ├── TFT_Meter_5 - ├── TFT_graphicstest_PDQ3 - ├── TFT_graphicstest_small - ├── UTFT_demo_fast - └── fillScreen -``` \ No newline at end of file +│   ├── Epaper_GDEW0371W7 #3.71`Drive example with touch ink screen +│   ├── IRRemote #Example of using external module infrared remote control +│   └── lv_demo_widgets #lvgl example +├── NES #NES emulator +├── Sensor +│   ├── Fingerprint #Fingerprint sensor example +│   ├── MAX30208 #MAX30208 temperature sensor +│   ├── Rotary #Rotary encoder example +│   └── VEMl6075 #UV sensor example +├── Shield +│   ├── AlarmClock #RTC Alarm clock example +│   ├── BBQKeyboard #BBQ keyboard example +│   ├── DRV8833 #Motor example +│   ├── GameControl #Gamepad example +│   ├── HeartRate #Heart rate sensor example +│   ├── INMP441_Mic #Microphone example +│   ├── LoRa_SX127x #LoRa Example +│   ├── M6_GPS #Ubolx GPS example +│   ├── NFC_Lock #NFC example +│   ├── S7xG_GPS #S76/78G GPS example +│   ├── S7xG_LoRa #S76/78G LoRa example +│   ├── SIM800L #SIM800L 2G communication module example +│   ├── SIM868 #SIM868 2G communication positioning module example +│   └── SPM1423HM4H_Mic #Microphone example +├── T-Block #This directory is only applicable to TBLOCK, not applicable to others +│   ├── CapTouch #MPR121 Capacitive touch sensor example +│   ├── Epaper #1.54`Ink Single electronic paper, without backlight and touch +│   ├── Epaper_BL #1.54`Ink screen driver example with backlight +│   ├── Epaper_Badge #1.54`Ink Electronic badge +│   ├── Epaper_GDEW0371W7 #3.71`Drive example with touch ink screen +│   ├── Epaper_GDEW0371W7_BTN #3.71`Drive example with touch ink screen and button +│   ├── Epaper_TP #1.54`Drive example with touch ink screen +│   ├── LEDMatrix #LEDdot matrix example +│   ├── MPU6050_accel_pitch_roll #MPU6050 Acceleration example +│   ├── MPU6050_accel_simple #MPU6050 Acceleration example +│   ├── MPU6050_gyro_pitch_roll_yaw #MPU6050 Gyroscope example +│   ├── MPU6050_gyro_simple #MPU6050 Gyroscope example +│   ├── MPU6050_temperature #MPU6050 Example of built-in temperature sensor +│   └── TouchScreen #ST7796S / ILI9481 Display module example +├── TFT_eSPI +│   ├── All_Free_Fonts_Demo +│   ├── Arduino_Life +│   ├── ESPFace +│   ├── FlappyBird +│   ├── IOTA_Price +│   ├── Pong_v3 +│   ├── RLE_Font_test +│   ├── TFT_Char_times +│   ├── TFT_Clock +│   ├── TFT_Clock_Digital +│   ├── TFT_Ellipse +│   ├── TFT_Meter_5 +│   ├── TFT_graphicstest_PDQ3 +│   ├── TFT_graphicstest_small +│   ├── UTFT_demo_fast +│   └── fillScreen +├── T_Bao #Expansion trolley +├── T_Bao2 #Expansion trolley +├── T_Quick #Expansion trolley +└── U8g2_for_TFT_eSPI #U8g2 examples + ├── Shennong + └── Unicode +