diff --git a/docs/assets/css/main.css b/docs/assets/css/main.css index 4034c913..6b30071b 100644 --- a/docs/assets/css/main.css +++ b/docs/assets/css/main.css @@ -2,9 +2,14 @@ --theme-color: hsl(204, 90%, 45%); } +a { + text-decoration: none !important; +} + + .markdown-section { max-width: 80%; - margin-top: 50px; + margin-top: 25px; } .markdown-section a { @@ -26,6 +31,17 @@ body[data-page="en/uiflow/uiflow_home_page.md"] article.markdown-section { padding: 0; } + +body[data-page="zh_CN/arduino/arduino_home_page.md"] article.markdown-section { + max-width: 100%; + padding: 0; +} + +body[data-page="en/arduino/arduino_home_page.md"] article.markdown-section { + max-width: 100%; + padding: 0; +} + .pic{ width:30%; } @@ -70,42 +86,78 @@ body[data-page="en/uiflow/uiflow_home_page.md"] article.markdown-section { .related_links { position: fixed; - top:20%; - right: 4%; - z-index: 9999; + top:35%; + right: 0px; + z-index: 900; + width: 50px; } .related_links a { display: block; - background-color: #041e36; - width: 80px; - height: 80px; + /* background-color: #555555; */ + width: 50px; + height: 50px; text-decoration:none; + transition:all .25s ease; + float: right; } + +.related_links a:first-child { + border-top-left-radius: 3px; + background-color: #76c5f0; +} + +.related_links a:nth-child(2) { + background-color: #007cc2; +} + +.related_links a:nth-child(3) { + background-color: #dc214c; +} + +.related_links a:nth-child(4) { + border-bottom-left-radius: 3px; + background-color: #1f1a17; +} + + + .related_links a:hover { - background-color: #007bff; + width: 90px; } -.related_links img { +.related_links a img { position: relative; - top:12px; - left: 22px; - width: 36px; + top:5px; + left: 5px; + width: 40px; } -.related_links div { +.related_links a:nth-child(4) img{ + top:3.5px; + left: 3.5px; + width: 43px; +} + +.related_links div img { position: relative; - top:15px; - width: 80px; - color: white; - text-align: center; - + top:10px; + left: 0px; + width: 50px; + /* background-color:red ; */ + transition: all .25s ease; } +.related_links div img:hover { + transform: scale(1.05); +} + + + @media screen and (max-width: 768px) { .related_links { display: none; @@ -164,6 +216,7 @@ body[data-page="en/uiflow/uiflow_home_page.md"] article.markdown-section { .dropdown{ display: inline-block; transition:all .25s ease; + color: #343a40; } .dropdown div{ @@ -174,19 +227,20 @@ body[data-page="en/uiflow/uiflow_home_page.md"] article.markdown-section { /* border: 1px solid rgba(0,0,0,.15); border-radius: .25rem; */ transition:all .25s ease; - left: -60px; + left: -44px; text-align: center; - top: 50px; + top: 40px; + z-index: 1001; + } .dropdown:hover { box-shadow: 0px 2px 0 0 #007bff; + color: #007bff; } .dropdown:hover div{ - - will-change: transform; min-width: 10rem; padding: .5rem 0; margin: .125rem 0 0; @@ -195,12 +249,17 @@ body[data-page="en/uiflow/uiflow_home_page.md"] article.markdown-section { list-style: none; background-clip: padding-box; height: max-content; + box-shadow: 0px 12px 11px 0px #888888; } +.dropdown div a:hover{ + color:#007bff !important; +} - - +.dropdown div a:active{ + background-color:#cccccc !important; +} diff --git a/docs/assets/img/product_pics/core/faces_kit/face_01.jpg b/docs/assets/img/product_pics/core/faces_kit/face_01.jpg deleted file mode 100644 index f6300699..00000000 Binary files a/docs/assets/img/product_pics/core/faces_kit/face_01.jpg and /dev/null differ diff --git a/docs/assets/img/product_pics/core/faces_kit/face_01.webp b/docs/assets/img/product_pics/core/faces_kit/face_01.webp new file mode 100644 index 00000000..ad662422 Binary files /dev/null and b/docs/assets/img/product_pics/core/faces_kit/face_01.webp differ diff --git a/docs/assets/img/product_pics/core/fire/m5_fire_01.png b/docs/assets/img/product_pics/core/fire/m5_fire_01.png deleted file mode 100644 index a4e6ba8f..00000000 Binary files a/docs/assets/img/product_pics/core/fire/m5_fire_01.png and /dev/null differ diff --git a/docs/assets/img/product_pics/core/fire/m5_fire_01.webp b/docs/assets/img/product_pics/core/fire/m5_fire_01.webp new file mode 100644 index 00000000..038fa171 Binary files /dev/null and b/docs/assets/img/product_pics/core/fire/m5_fire_01.webp differ diff --git a/docs/assets/img/product_pics/core/gray/gray_01.png b/docs/assets/img/product_pics/core/gray/gray_01.png deleted file mode 100644 index b64f3cf3..00000000 Binary files a/docs/assets/img/product_pics/core/gray/gray_01.png and /dev/null differ diff --git a/docs/assets/img/product_pics/core/gray/gray_01.webp b/docs/assets/img/product_pics/core/gray/gray_01.webp new file mode 100644 index 00000000..45250b3a Binary files /dev/null and b/docs/assets/img/product_pics/core/gray/gray_01.webp differ diff --git a/docs/assets/img/product_pics/core/m5go/m5go_02.png b/docs/assets/img/product_pics/core/m5go/m5go_02.png deleted file mode 100644 index 14e29b73..00000000 Binary files a/docs/assets/img/product_pics/core/m5go/m5go_02.png and /dev/null differ diff --git a/docs/assets/img/product_pics/core/m5go/m5go_02.webp b/docs/assets/img/product_pics/core/m5go/m5go_02.webp new file mode 100644 index 00000000..76223f33 Binary files /dev/null and b/docs/assets/img/product_pics/core/m5go/m5go_02.webp differ diff --git a/docs/assets/img/product_pics/core/minicore/m5stickc/m5stickc_01.jpg b/docs/assets/img/product_pics/core/minicore/m5stickc/m5stickc_01.jpg deleted file mode 100644 index 78ef629b..00000000 Binary files a/docs/assets/img/product_pics/core/minicore/m5stickc/m5stickc_01.jpg and /dev/null differ diff --git a/docs/assets/img/product_pics/core/minicore/m5stickc/m5stickc_01.webp b/docs/assets/img/product_pics/core/minicore/m5stickc/m5stickc_01.webp new file mode 100644 index 00000000..d1f2bd14 Binary files /dev/null and b/docs/assets/img/product_pics/core/minicore/m5stickc/m5stickc_01.webp differ diff --git a/docs/assets/img/product_pics/core/minicore/m5stickc/m5stickc_05.jpg b/docs/assets/img/product_pics/core/minicore/m5stickc/m5stickc_05.jpg deleted file mode 100644 index 559182cf..00000000 Binary files a/docs/assets/img/product_pics/core/minicore/m5stickc/m5stickc_05.jpg and /dev/null differ diff --git a/docs/assets/img/product_pics/core/minicore/m5stickc/m5stickc_05.webp b/docs/assets/img/product_pics/core/minicore/m5stickc/m5stickc_05.webp new file mode 100644 index 00000000..8debc09e Binary files /dev/null and b/docs/assets/img/product_pics/core/minicore/m5stickc/m5stickc_05.webp differ diff --git a/docs/en/api.md b/docs/en/arduino/arduino_api.md similarity index 96% rename from docs/en/api.md rename to docs/en/arduino/arduino_api.md index 1e928503..fe492b52 100644 --- a/docs/en/api.md +++ b/docs/en/arduino/arduino_api.md @@ -1,21 +1,21 @@ -# Arduino API {docsify-ignore-all} - -## M5Core - -||| -|:---:|:---:| -|**[System](en/api/system)** | **[Speaker](en/api/speaker)** | -|**[LCD](en/api/lcd)** | **[Button](en/api/button)** | -|**[IMU Sensor(MPU9250)](en/api/mpu9250)** | **[TF Card](en/api/tf)** | -|**[Power](en/api/power)** |**[I/O](en/api/gpio)** | -|**[I2C Communication](en/api/commutil)** | **[WIFI](en/api/wifi)**| -|**[Timer](en/api/ticker)**| - - -## M5StickC - -||| -|:---:|:---:| -|**[System](en/api/system_m5stickc)** | **[Power Management(AXP192)](en/api/axp192_m5stickc)** | -|**[TFT Screen](en/api/lcd_m5stickc)** | **[IMU(SH200Q)](en/api/sh200q_m5stickc)** | -|**[RTC](en/api/rtc)**| +# Arduino API {docsify-ignore-all} + +## M5Core + +||| +|:---:|:---:| +|**[System](en/api/system)** | **[Speaker](en/api/speaker)** | +|**[LCD](en/api/lcd)** | **[Button](en/api/button)** | +|**[IMU Sensor(MPU9250)](en/api/mpu9250)** | **[TF Card](en/api/tf)** | +|**[Power](en/api/power)** |**[I/O](en/api/gpio)** | +|**[I2C Communication](en/api/commutil)** | **[WIFI](en/api/wifi)**| +|**[Timer](en/api/ticker)**| + + +## M5StickC + +||| +|:---:|:---:| +|**[System](en/api/system_m5stickc)** | **[Power Management(AXP192)](en/api/axp192_m5stickc)** | +|**[TFT Screen](en/api/lcd_m5stickc)** | **[IMU(SH200Q)](en/api/sh200q_m5stickc)** | +|**[RTC](en/api/rtc)**| diff --git a/docs/en/arduino/arduino_development.md b/docs/en/arduino/arduino_development.md new file mode 100644 index 00000000..72b653be --- /dev/null +++ b/docs/en/arduino/arduino_development.md @@ -0,0 +1,101 @@ +# Arduino IDE Development{docsify-ignore-all} + + +1. [Install Arduino-IDE](#Install-Arduino-IDE) + +2. [Install ESP32 Board](#Install-ESP32-Board) + +3. [Install M5Stack Library](#Install-M5Stack-Library) + +4. [Install USB Driver](#Install-USB-Driver) + +## Install Arduino-IDE + + +>[Click here to visit Arduino's official website](https://www.arduino.cc/en/Main/Software),Select the installation package for your own operating system to download. + + + + + +## Install ESP32 Board + +>1.Open up Arduino IDE, navigate to `File`->`Peferences`->`Settings` + + + +>2.Copy the following ESP32 Boards Manager url to `Additional Boards Manager URLs:` + +**https://dl.espressif.com/dl/package_esp32_index.json** + + + +>3.Navigate to `Tools`->`Board:`->`Boards Manager...` + + + +>4.Search `ESP32` in the pop-up window, find it and click `Install` + + + +>5.select `Tools`->`Board:`->`ESP32` + + + +## Install M5Stack Library + +>Different hardware devices, with different case libraries, please choose to download according to the device you use..Open Arduino IDE, then Select `Sketch`->`Include Library`->`Manage Libraries...` + + + +### For M5Core and M5Stick + +?>Search `M5Stack` , find it and click `Install` + + + +### For M5Stick-C + +?>Search `M5StickC` , find it and click `Install` + + + +## Install USB Driver + +>1.Click on the CP210X driver for your operating system below to download. + + + + + +### For Windows + +>Unzip the downloaded driver package, select the installer for your operating system, and double-click to install. + + + + +### For Mac + +>Unzip the downloaded driver package, install the program, double-click the image file to start the installation.. + + + + +s \ No newline at end of file diff --git a/docs/en/arduino/arduino_home_page.md b/docs/en/arduino/arduino_home_page.md new file mode 100644 index 00000000..28c60934 --- /dev/null +++ b/docs/en/arduino/arduino_home_page.md @@ -0,0 +1,34 @@ +
+
+ +
+
+

Arduino IDE

+

A familiar development platform for electronic enthusiasts

+

+ Arduino forum + Tutorial +

+
+
+ + + +
+
+
+

Introduction

+

Explain several preparations before using Arduino, including software download of Arduino IDE, and related environment configuration.

+

View details »

+
+
+

Arduino API

+

The Arduino function library provided by M5Stack.

+

View details »

+
+
+ +
+ + +



\ No newline at end of file diff --git a/docs/en/case.md b/docs/en/case.md index 78b5d0f1..8963631f 100644 --- a/docs/en/case.md +++ b/docs/en/case.md @@ -1,6 +1,6 @@ # M5Stack Cases {docsify-ignore-all} -## M5Stack Awesome +## M5Stack User Cases * [M5Stack-SD-Updater](https://github.com/tobozo/M5Stack-SD-Updater) - Customizable menu system for M5Stack - loads apps from the Micro SD card diff --git a/docs/en/core/basic.md b/docs/en/core/basic.md index 7cd31379..590b1333 100644 --- a/docs/en/core/basic.md +++ b/docs/en/core/basic.md @@ -10,10 +10,10 @@ **M5Stack BASIC Kit**, like its namesake, is a starter kit among the M5Stack development kit series. Its modular, stackable, scalable, and portable device is powered with an ESP-32 core, which makes it open source, low cost, full-function, and easy for developers to handle new product development on all stages include circuit design, PCB design, software, mold design and production. This Basic kit provides a friendly price and full-featured resources which makes it a good starter kit for you to explore IoT. -*Ever wanted to explore the fastest way of IoT prototyping, M5Stack development board is the perfect solution. Not like others, M5Stack development board is highly productlized, covered with industrial grade case, and **ESP32-based** development board. **ESP32** is a hybid Wi-Fi & Bluetooth chip contains a dual-core and 4MB of SPI Flash . Together with 30+ M5Stack [stackable modules](https://docs.m5stack.com/#/en/?id=module) , 40+ [extendable units](https://docs.m5stack.com/#/en/?id=unit), and different levels of program language, you can create and verify your IoT product in a very short time. -Supported development platforms and program languages: Arduino, Blockly language with [UIFlow](http://flow.m5stack.com), [Micropython](http://www.micropython.org). Regardless of what level program skill you have, M5Stack would guide you in every step of the way to realize your idea as well as to the final productilization.* +Ever wanted to explore the fastest way of IoT prototyping, M5Stack development board is the perfect solution. Not like others, M5Stack development board is highly productlized, covered with industrial grade case, and **ESP32-based** development board. **ESP32** is a hybid Wi-Fi & Bluetooth chip contains a dual-core and 4MB of SPI Flash . Together with 30+ M5Stack [stackable modules](https://docs.m5stack.com/#/en/?id=module) , 40+ [extendable units](https://docs.m5stack.com/#/en/?id=unit), and different levels of program language, you can create and verify your IoT product in a very short time. +Supported development platforms and program languages: Arduino, Blockly language with [UIFlow](http://flow.m5stack.com), [Micropython](http://www.micropython.org). Regardless of what level program skill you have, M5Stack would guide you in every step of the way to realize your idea as well as to the final productilization. -*If you ever played with ESP8266, you would realize that ESP32 is a perfect upgrade from ESP8266. In comparison, ESP32 is full-feathered with more GPIO, plenty of analog inputs and two analog outputs, multiple extra perpherials( like a spare UART ). Official development platform ESP-IDF have planted with FreeRTOS. With dual-core and real time OS you can get more organized code and much high speed processor.* +If you ever played with ESP8266, you would realize that ESP32 is a perfect upgrade from ESP8266. In comparison, ESP32 is full-feathered with more GPIO, plenty of analog inputs and two analog outputs, multiple extra perpherials( like a spare UART ). Official development platform ESP-IDF have planted with FreeRTOS. With dual-core and real time OS you can get more organized code and much high speed processor. M5Stack Basic is consist with two separable parts. the upside part has all kinds of processor, chips and some other slot components. The [bottom](https://docs.m5stack.com/#/en/base/core_bottom) part has a lithium battery, [M-BUS](https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_schematic/M-BUS.png) socket and extendable pins on both sides. diff --git a/docs/en/core/face_kit.md b/docs/en/core/face_kit.md index 9cec2a0a..dfb42319 100644 --- a/docs/en/core/face_kit.md +++ b/docs/en/core/face_kit.md @@ -1,6 +1,6 @@ # FACES Kit {docsify-ignore-all} - + :memo:**[Description](#Description)**   :bulb:**[Quick Start](en/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/FACES)**   :electric_plug:**[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Core/Basic/M5-Core-Schematic(20171206).pdf)**   🛒**[Purchase](https://m5stack.com/collections/m5-core/products/face)**    diff --git a/docs/en/core/fire.md b/docs/en/core/fire.md index 5709ae85..6d54bfd1 100644 --- a/docs/en/core/fire.md +++ b/docs/en/core/fire.md @@ -1,12 +1,12 @@ # FIRE {docsify-ignore-all} -fire_01 +fire_01 * * * :memo:**[Description](#Description)**   :bulb:**[Quick Start](en/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Core/Basic/M5-Core-Schematic(20171206).pdf)**   🛒**[Purchase](https://m5stack.com/collections/m5-core/products/fire-iot-development-kit)**   :clapper:**[Related Video](#Related-Video)** -## Description +## Description **M5Stack FIRE Kit** is a upgrade from the Gray kits,except the 9-Axis IMU sensor. It provides more hardware resources : 16M Flash + 4M PSRAM , enhanced Base (M5GO Base and M5GO CHG Base), larger battery, etc. @@ -49,7 +49,7 @@ The GPIO 16 / 17 in Fire is connected to the PSRAM by default, so when you conne - Case Material: PC + ABS - 16 MB Flash - 4 MB PSRAM -- BMM150 + SH200Q/MPU6886 +- BMM150 + MPU6886 - Speaker, 3 Buttons, LCD(320*240), 1 Reset - 2.4G Antenna: Proant 440 - TF card slot (16G Maximum size) diff --git a/docs/en/core/gray.md b/docs/en/core/gray.md index 85d8cf70..b9c23980 100644 --- a/docs/en/core/gray.md +++ b/docs/en/core/gray.md @@ -1,6 +1,6 @@ # GRAY {docsify-ignore-all} -gray_02gray_02 +gray_02gray_02 diff --git a/docs/en/core/m5go.md b/docs/en/core/m5go.md index 600bdce5..14c769d7 100644 --- a/docs/en/core/m5go.md +++ b/docs/en/core/m5go.md @@ -1,6 +1,6 @@ # M5GO IOT Starter Kit {docsify-ignore-all} -gray_02 gray_02 gray_04 +gray_02 gray_02 gray_04 diff --git a/docs/en/core/m5stickc.md b/docs/en/core/m5stickc.md index 37590af2..2e9579af 100644 --- a/docs/en/core/m5stickc.md +++ b/docs/en/core/m5stickc.md @@ -1,6 +1,6 @@ # M5StickC {docsify-ignore-all} - + * * * @@ -95,7 +95,7 @@ There are two versions of IMU sensors (MPU6886 and SH200Q) currently available o Power structure block diagram - + **RED LED & IR Transmitter & BUTTON A & BUTTON B** diff --git a/docs/en/core/m5stickv.md b/docs/en/core/m5stickv.md index aba9328a..648bc545 100644 --- a/docs/en/core/m5stickv.md +++ b/docs/en/core/m5stickv.md @@ -1,4 +1,4 @@ -# Core M5StickV {docsify-ignore-all} +# M5StickV {docsify-ignore-all} diff --git a/docs/en/uiflow/uiflow_home_page.md b/docs/en/uiflow/uiflow_home_page.md index 77f08ad7..33eb52b8 100644 --- a/docs/en/uiflow/uiflow_home_page.md +++ b/docs/en/uiflow/uiflow_home_page.md @@ -1,16 +1,16 @@ -
-
- -
-
-

UIFlow

-

A Web IoT programming platform using Blockly+Python.

-

- Go to UIFlow - Tutorial -

-
-
+
+
+ +
+
+

UIFlow

+

A Web IoT programming platform using Blockly+Python.

+

+ Go to UIFlow + Tutorial +

+
+
@@ -34,22 +34,22 @@
-
-

Data structure

-

Introduction to data types in UIFlow, including constants, variables, characters, random numbers, lists, etc.

-

View details »

-
-
-

Logic

-

The use of logic judgments, operations, and conditional loops, iterations, functions, etc. in UIFlow.

-

View details »

-
-
-

Advanced

-

The higher-level functions in UIFlow involve remote functions and the use of MQTT communication.

-

View details »

-
-
+
+

Data structure

+

Introduction to data types in UIFlow, including constants, variables, characters, random numbers, lists, etc.

+

View details »

+
+
+

Logic

+

The use of logic judgments, operations, and conditional loops, iterations, functions, etc. in UIFlow.

+

View details »

+
+
+

Advanced

+

The higher-level functions in UIFlow involve remote functions and the use of MQTT communication.

+

View details »

+
+
diff --git a/docs/en/unit/m5camera.md b/docs/en/unit/m5camera.md index e639e28a..58595d50 100644 --- a/docs/en/unit/m5camera.md +++ b/docs/en/unit/m5camera.md @@ -29,25 +29,7 @@ The hardware also comes with some reserved weld pad, just in case you want put t -**Please notice:** There are 2 types of **M5Camera** -- Model A & Model B -- They have different circuits, can be identified by backside sticker -- Model A is halt production. The new coming **M5Camera** is just Model B -- In Model A circuit design MPU6050 and camera sensor have I2C conflict, which means you can't use both at the same time. -- Model B have better performance on image quality and processing speed. - - - -**Note: M5Camera is named differently when different hardware is selected. They follow the rules below.** - -*M5Camera_#_#... means optional hardware name follows "M5Camera".* - -* If configured with MPU6050, will be named M5Camera_6050 -* If also configured with microphone, will be named M5Camera_6050_MIC -* If also configured with BME280, will be named M5Camera_6050_MIC_BME280 - - - + ## Product Features @@ -123,7 +105,7 @@ The hardware also comes with some reserved weld pad, just in case you want put t | Pixel Data Bit 6 | D8 |IO36 |IO36 | | Pixel Data Bit 7 | D9 |IO19 |IO19 | | Camera Reset | RESET |IO15 |IO15 | -| Camera Power Down | PWDN | *see Note 1* | *see Note 1* | +| Camera Power Down | PWDN | / | / | | Power Supply 3.3V | 3V3 | 3V3 | 3V3 | | Ground | GND | GND | GND | diff --git a/docs/index.html b/docs/index.html index 5659ae97..0af3764d 100644 --- a/docs/index.html +++ b/docs/index.html @@ -23,8 +23,8 @@ //监听加载状态改变 document.onreadystatechange = completeLoading; //加载状态为complete时隐藏loading效果 - function completeLoading() {   - if (document.readyState == "complete") {     + function completeLoading() { + if (document.readyState == "complete") { var loadingMask = document.getElementById('loading');   loadingMask.style.display = 'none'; // loadingMask.parentNode.removeChild(loadingMask);   @@ -61,25 +61,33 @@
M5Stack Docs
- 中文 +
loading...
@@ -212,67 +220,83 @@ function change_title(language) { if (language == "en") { - $("#language").text("中文"); $("#product").text("Product"); $("#product").attr("href", "#"); - $("#arduino").text("Arduino API"); - $("#arduino").attr("href", "#/en/api"); + $("#arduino").text("Arduino"); + $("#arduino").attr("href", "#/en/arduino/arduino_home_page"); $("#cases").text("Cases"); $("#cases").attr("href", "#/en/case"); - $("#related").text("Software Tutorial"); - $("#related").attr("href", "#/en/related_documents"); $("#faq").text("FAQ"); $("#faq").attr("href", "#/en/faq"); $("#uiflow").attr("href", "#/en/uiflow/uiflow_home_page"); - } else { - $("#language").text("EN"); + $("#platform span").text("Platform"); + $("#language span").text("Language"); + } + if(language == "zh_CN"){ $("#product").text("产品列表"); $("#product").attr("href", "#/zh_CN/"); - $("#arduino").text("Arduino API"); - $("#arduino").attr("href", "#/zh_CN/api"); - $("#cases").text("用户案例"); + $("#arduino").text("Arduino"); + $("#arduino").attr("href", "#/zh_CN/arduino/arduino_home_page"); + $("#cases").text("案例"); $("#cases").attr("href", "#/zh_CN/case"); - $("#related").text("软件教程"); - $("#related").attr("href", "#/zh_CN/related_documents"); $("#faq").text("常见问题"); $("#faq").attr("href", "#/zh_CN/faq"); $("#uiflow").attr("href", "#/zh_CN/uiflow/uiflow_home_page"); + $("#platform span").text("开发平台"); + $("#language span").text("切换语言"); + } + if(language == "ja"){ + $("#product").text("製品リスト"); + $("#product").attr("href", "#/ja/"); + $("#arduino").text("Arduino"); + $("#arduino").attr("href", "#/ja/arduino/arduino_home_page"); + $("#cases").text("事例"); + $("#cases").attr("href", "#/ja/case"); + $("#faq").text("問題"); + $("#faq").attr("href", "#/ja/faq"); + $("#uiflow").attr("href", "#/ja/uiflow/uiflow_home_page"); + $("#platform span").text("開発"); + $("#language span").text("言語選択"); } } - - function language() { + function language(language) { var test = window.location.href; - if ((test.indexOf(/en/) == -1) && (test.indexOf(/zh_CN/) == -1)) { - var test2 = test.concat("", "zh_CN/"); + if ((test.indexOf(/en/) == -1) && (test.indexOf(/zh_CN/) == -1) && (test.indexOf(/ja/) == -1)) { + var test2 = test.concat("", language+"/"); window.location.href = test2; - change_title('zh_CN'); + change_title(language); - } else if (test.indexOf(/en/) == -1) { - var test2 = test.replace(/zh_CN/, "en"); + } + if (test.indexOf(/en/) != -1) { + var test2 = test.replace(/en/, language); window.location.href = test2; - change_title('en'); + change_title(language); - } else { - var test2 = test.replace(/en/, "zh_CN"); + }else if(test.indexOf(/zh_CN/) != -1){ + var test2 = test.replace(/zh_CN/, language); window.location.href = test2; - change_title('zh_CN'); - + change_title(language); + }else if(test.indexOf(/ja/) != -1){ + var test2 = test.replace(/ja/, language); + window.location.href = test2; + change_title(language); } + } function page_loading() { var test = window.location.href; - if ((test.indexOf(/en/) == -1) && (test.indexOf(/zh_CN/) == -1)) { + if ((test.indexOf(/en/) == -1) && (test.indexOf(/zh_CN/) == -1)&& (test.indexOf(/ja/) == -1)) { change_title('en'); - - } else if (test.indexOf(/en/) == -1) { - var test2 = test.replace(/zh_CN/, "en"); + } + if(test.indexOf(/en/) != -1){ + change_title('en'); + } + if(test.indexOf(/zh_CN/) != -1){ change_title('zh_CN'); - - } else { - var test2 = test.replace(/en/, "zh_CN"); - change_title('en'); - + } + if(test.indexOf(/ja/) != -1){ + change_title('ja'); } } @@ -282,6 +306,7 @@ scrollTop: (t - 100) }, 500); } + window.onhashchange = page_loading page_loading(); @@ -301,7 +326,7 @@ - --> \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 057e225a..4e5754b2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -81,14 +81,14 @@ var core_list = [ //Core {a:"/#/en/core/basic", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/core_basic_01.png", p:"BASIC"}, - {a:"/#/en/core/gray", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/core_gray_01.png", p:"GRAY"}, + {a:"/#/en/core/gray", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/core_gray_01.webp", p:"GRAY"}, {a:"/#/en/core/fire", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/core_fire_01.png", p:"FIRE"}, {a:"/#/en/core/m5go_lite", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/kit_m5go_lite_01.png", p:"M5GO Lite"}, {a:"/#/en/core/m5go", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/kit_m5go_01.png", p:"M5GO Kit"}, - {a:"/#/en/core/face_kit", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/kit_faces_01.png", p:"FACES Kit"}, + {a:"/#/en/core/face_kit", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/kit_faces_01.webp", p:"FACES Kit"}, //Stick {a:"/#/en/core/m5stick", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/core_m5stick_01.png", p:"M5Stick"}, - {a:"/#/en/core/m5stickc", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/core_m5stickc_01.png", p:"M5StickC"}, + {a:"/#/en/core/m5stickc", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/core_m5stickc_01.webp", p:"M5StickC"}, {a:"/#/en/core/m5stickv", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/m5stickv_01.jpg", p:"M5StickV"} ]; @@ -250,7 +250,7 @@ {a:"/#/en/module/proto_kit", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/module/module_proto_02.jpg", p:"PROTO-KIT"}, {a:"/#/en/tool/usb_downloader", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/tool/usb_downloader_01.png", p:"USB Downloader"}, {a:"/#/en/tool/usb_isp", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/tool/tool_usb_isp_01.png", p:"USB-ISP"}, - {a:"/#/en/accessory/glass_panel_repair_kit", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/accessory/glass_panel_repair_kit_01.jpg", p:"Glass Panel Repair Kit"}, + {a:"/#/en/accessory/glass_panel_repair_kit", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/accessory/glass_panel_repair_kit_01.jpg", p:"Glass Panel Repair"}, {a:"/#/en/accessory/485t", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/accessory/485t_01.jpg", p:"485T"}, {a:"/#/en/accessory/watch", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/accessory/watch_01.jpg", p:"Watch"}, {a:"/#/en/accessory/sg90_servo", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/accessory/servo_01.jpg", p:"SG90 servo"}, @@ -274,8 +274,8 @@ $(".product_page div:last-child").attr("id",product_class_name[i]); } - console.log(product_class[0][0].a); - console.log(product_class[0].length); + // console.log(product_class[0][0].a); + // console.log(product_class[0].length); for (var class_num=0; class_numM5Stick

"); } - if(product_class[class_num][i].p == "LoRa"){ + if(product_class[class_num][i].p == "LoRa (433MHz)"){ $("#"+product_class_name[class_num]).append("

Communication Modules

"); } if(product_class[class_num][i].p == "BATTERY"){ diff --git a/docs/zh_CN/README.md b/docs/zh_CN/README.md index d68c39f9..12520da8 100644 --- a/docs/zh_CN/README.md +++ b/docs/zh_CN/README.md @@ -81,14 +81,14 @@ var core_list = [ //Core {a:"/#/zh_CN/core/basic", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/core_basic_01.png", p:"BASIC"}, - {a:"/#/zh_CN/core/gray", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/core_gray_01.png", p:"GRAY"}, + {a:"/#/zh_CN/core/gray", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/core_gray_01.webp", p:"GRAY"}, {a:"/#/zh_CN/core/fire", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/core_fire_01.png", p:"FIRE"}, {a:"/#/zh_CN/core/m5go_lite", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/kit_m5go_lite_01.png", p:"M5GO Lite"}, {a:"/#/zh_CN/core/m5go", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/kit_m5go_01.png", p:"M5GO Kit"}, - {a:"/#/zh_CN/core/face_kit", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/kit_faces_01.png", p:"FACES Kit"}, + {a:"/#/zh_CN/core/face_kit", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/kit_faces_01.webp", p:"FACES Kit"}, //Stick {a:"/#/zh_CN/core/m5stick", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/core_m5stick_01.png", p:"M5Stick"}, - {a:"/#/zh_CN/core/m5stickc", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/core_m5stickc_01.png", p:"M5StickC"}, + {a:"/#/zh_CN/core/m5stickc", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/core_m5stickc_01.webp", p:"M5StickC"}, {a:"/#/zh_CN/core/m5stickv", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/m5stickv_01.jpg", p:"M5StickV"} ]; @@ -249,7 +249,7 @@ {a:"/#/zh_CN/module/proto_kit", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/module/module_proto_02.jpg", p:"PROTO-KIT"}, {a:"/#/zh_CN/tool/usb_downloader", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/tool/usb_downloader_01.png", p:"USB Downloader"}, {a:"/#/zh_CN/tool/usb_isp", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/tool/tool_usb_isp_01.png", p:"USB-ISP"}, - {a:"/#/zh_CN/accessory/glass_panel_repair_kit", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/accessory/glass_panel_repair_kit_01.jpg", p:"Glass Panel Repair Kit"}, + {a:"/#/zh_CN/accessory/glass_panel_repair", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/accessory/glass_panel_repair_kit_01.jpg", p:"Glass Panel Repair Kit"}, {a:"/#/zh_CN/accessory/485t", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/accessory/485t_01.jpg", p:"485T"}, {a:"/#/zh_CN/accessory/watch", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/accessory/watch_01.jpg", p:"Watch"}, {a:"/#/zh_CN/accessory/sg90_servo", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/accessory/servo_01.jpg", p:"SG90 servo"}, @@ -273,8 +273,8 @@ $(".product_page div:last-child").attr("id",product_class_name[i]); } - console.log(product_class[0][0].a); - console.log(product_class[0].length); + // console.log(product_class[0][0].a); + // console.log(product_class[0].length); for (var class_num=0; class_numM5Stick

"); } - if(product_class[class_num][i].p == "LoRa"){ + if(product_class[class_num][i].p == "LoRa (433MHz)"){ $("#"+product_class_name[class_num]).append("

Communication Modules

"); } if(product_class[class_num][i].p == "BATTERY"){ diff --git a/docs/zh_CN/api.md b/docs/zh_CN/arduino/arduino_api.md similarity index 96% rename from docs/zh_CN/api.md rename to docs/zh_CN/arduino/arduino_api.md index 13912b4a..25a28623 100644 --- a/docs/zh_CN/api.md +++ b/docs/zh_CN/arduino/arduino_api.md @@ -1,81 +1,81 @@ -# Arduino API {docsify-ignore-all} - -## M5Core - -||| -|:---:|:---:| -|**[System](zh_CN/api/system)** | **[喇叭](zh_CN/api/speaker)** | -|**[LCD 屏](zh_CN/api/lcd)** | **[按键](zh_CN/api/button)** | -|**[MPU9250](zh_CN/api/mpu9250)** | **[TF 卡](zh_CN/api/tf)** | -|**[电源管理](zh_CN/api/power)** |**[I/O](zh_CN/api/gpio)** | -|**[I2C](zh_CN/api/commutil)** |**[EEPROM](zh_CN/api/eeprom)**| -|**[WIFI](zh_CN/api/wifi)**| - - - -## M5StickC - - - -||| -|:---:|:---:| -|**[System](zh_CN/api/system_m5stickc)** | **[AXP192](zh_CN/api/axp192_m5stickc)** | -|**[TFT 屏](zh_CN/api/lcd_m5stickc)** | **[SH200Q](zh_CN/api/sh200q_m5stickc)** | -|**[RTC](zh_CN/api/rtc)**| - - - - - - + +## M5StickC + + + +||| +|:---:|:---:| +|**[System](zh_CN/api/system_m5stickc)** | **[AXP192](zh_CN/api/axp192_m5stickc)** | +|**[TFT 屏](zh_CN/api/lcd_m5stickc)** | **[SH200Q](zh_CN/api/sh200q_m5stickc)** | +|**[RTC](zh_CN/api/rtc)**| + + + + + + \ No newline at end of file diff --git a/docs/zh_CN/arduino/arduino_development.md b/docs/zh_CN/arduino/arduino_development.md new file mode 100644 index 00000000..29174483 --- /dev/null +++ b/docs/zh_CN/arduino/arduino_development.md @@ -0,0 +1,103 @@ +# Arduino IDE 环境搭建{docsify-ignore-all} + + +1. [安装Arduino-IDE](#安装Arduino-IDE) + +2. [安装ESP32的板管理](#安装ESP32的板管理) + +3. [安装M5Stack的库](#安装M5Stack的库) + +4. [安装串口驱动](#安装串口驱动) + +## 安装Arduino-IDE + + +>[点击此处访问 Arduino 官网](https://www.arduino.cc/en/Main/Software),选择对应自己操作系统的安装包进行下载. + + + + + +## 安装ESP32的板管理 + +>1.打开 Arduino IDE,选择 `文件`->`首选项`->`设置` + + + +>2.复制下方的 ESP32 板管理网址到 `附加开发板管理器:` 中 + +**https://dl.espressif.com/dl/package_esp32_index.json** + + + +>3.选择 `工具`->`开发板:`->`开发板管理器...` + + + +>4.在新弹出的对话框中,输入并搜索 `ESP32`,点击`安装`(若出现搜索失败的情况,可以尝试重启Arduino程序) + + + + +>5.选择 `工具`->`开发板:`->`ESP32` + + + +## 安装M5Stack的库 + +>不同的硬件设备,有着不同的案例程序库,请根据你所使用的设备选择下载.打开 Arduino IDE, 然后选择 `项目`->`加载库`->`库管理...` + + + +### For M5Core and M5Stick + +?>搜索 `M5Stack` 并安装,如下图所示 + + + +### For M5Stick-C + +?>搜索 `M5StickC` 并安装,如下图所示 + + + +## 安装串口驱动 + +>1.点击下方对应自己操作系统的CP210X驱动程序 进行下载. + + + + + +### For Windows + +>将下载好的驱动压缩包解压,选择对应您操作系统的安装程序,双击安装. + + + + +### For Mac + +>将下载好的驱动压缩包解压,安装程序,双击镜像文件开始安装. + + + + + + \ No newline at end of file diff --git a/docs/zh_CN/arduino/arduino_home_page.md b/docs/zh_CN/arduino/arduino_home_page.md new file mode 100644 index 00000000..b85318f7 --- /dev/null +++ b/docs/zh_CN/arduino/arduino_home_page.md @@ -0,0 +1,34 @@ +
+
+ +
+
+

Arduino IDE

+

电子发烧友们较为熟悉的编程平台之一.

+

+ Arduino中文论坛 + 查看教程 +

+
+
+ + +
+
+
+

入门介绍

+

讲解使用Arduino前的几个准备工作,包括Arduino IDE的软件下载,以及相关环境配置.

+

View details »

+
+
+

Arduino API

+

M5Stack所提供的Arduino函数库.

+

View details »

+
+
+ + +
+ + +



\ No newline at end of file diff --git a/docs/zh_CN/core/face_kit.md b/docs/zh_CN/core/face_kit.md index 57573987..cd343eca 100644 --- a/docs/zh_CN/core/face_kit.md +++ b/docs/zh_CN/core/face_kit.md @@ -1,6 +1,6 @@ # FACES Kit {docsify-ignore-all} - + :memo:**[描述](#描述)**   :bulb:**[上手指南](en/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[例程](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/FACES)**   :electric_plug:**[原理图](https://github.com/m5stack/M5-Schematic/blob/master/Core/Basic/M5-Core-Schematic(20171206).pdf)**   🛒**[购买链接](https://m5stack.com/collections/m5-core/products/m5go-iot-starter-kit-stem-education)**    diff --git a/docs/zh_CN/core/fire.md b/docs/zh_CN/core/fire.md index bd0c354a..5070b279 100644 --- a/docs/zh_CN/core/fire.md +++ b/docs/zh_CN/core/fire.md @@ -1,6 +1,6 @@ # FIRE {docsify-ignore-all} -fire_01 +fire_01 * * * @@ -51,7 +51,7 @@ Fire 中的 GPIO 16 / 17 默认与PSRAM连接,因此当你在连接或是堆 - 基于ESP32开发 - 16 MB Flash - 4 MB PSRAM -- BMM150 + SH200Q/MPU6886 +- BMM150 + MPU6886 - 扬声器,按键x3,LCD屏幕(320 * 240),电源/复位按键x1 - 2.4G天线:Proant 440 - TF 卡插槽(最大可拓展16GB) diff --git a/docs/zh_CN/core/gray.md b/docs/zh_CN/core/gray.md index 63842db4..e170cddc 100644 --- a/docs/zh_CN/core/gray.md +++ b/docs/zh_CN/core/gray.md @@ -1,6 +1,6 @@ # GRAY {docsify-ignore-all} -gray_02gray_02 +gray_02gray_02 diff --git a/docs/zh_CN/core/m5go.md b/docs/zh_CN/core/m5go.md index b86c79cc..4123f24f 100644 --- a/docs/zh_CN/core/m5go.md +++ b/docs/zh_CN/core/m5go.md @@ -1,6 +1,6 @@ # M5GO IoT Starter Kit {docsify-ignore-all} -gray_02 gray_02 gray_04 +gray_02 gray_02 gray_04 * * * diff --git a/docs/zh_CN/core/m5stickc.md b/docs/zh_CN/core/m5stickc.md index 1a39341e..37187d28 100644 --- a/docs/zh_CN/core/m5stickc.md +++ b/docs/zh_CN/core/m5stickc.md @@ -1,6 +1,6 @@ # M5StickC {docsify-ignore-all} - + * * * @@ -98,7 +98,7 @@ M5StickC仅支持WIN10&Linux&MAC免驱,其余操作系统则需要用户自行 电源结构框图 - + **红色 LED & 红外发射管 IR & 按键 BUTTON A & 按键 BUTTON B** @@ -110,7 +110,7 @@ M5StickC仅支持WIN10&Linux&MAC免驱,其余操作系统则需要用户自行 按键 BUTTON B 按键管脚 -**彩色TFT屏幕** +**彩色TFT屏幕** *驱动芯片:ST7735S* diff --git a/docs/zh_CN/core/m5stickv.md b/docs/zh_CN/core/m5stickv.md index 648e2d13..998ec147 100644 --- a/docs/zh_CN/core/m5stickv.md +++ b/docs/zh_CN/core/m5stickv.md @@ -1,4 +1,4 @@ -# Core M5StickV {docsify-ignore-all} +# M5StickV {docsify-ignore-all} diff --git a/docs/zh_CN/unit/m5camera.md b/docs/zh_CN/unit/m5camera.md index 8942a34b..70d42ce2 100644 --- a/docs/zh_CN/unit/m5camera.md +++ b/docs/zh_CN/unit/m5camera.md @@ -27,24 +27,7 @@ -**注意:** 有两种类型的 **M5Camera** - -Model A 和 Model B,它们有着不同的电路设计、可以通过背面贴纸进行分辨.在Model A的电路设计中,MPU6050和摄像头传感器存在I2C冲突,这意味着您无法同时使用两者,现在如今Model A已经停止生产,Model B在图像质量和处理速度方面具有更好的性能 - - - - -**注意:选配不同硬件时,M5Camera 的命名不一样,遵循以下规则** - -*M5Camera_#_#... 即 M5Camera 后跟选配的硬件。* - -* 如果选配 MPU6050,则命名为 M5Camera_6050 -* 如果还选配了麦克风 SPM1423,则命名为 M5Camera_6050_MIC -* 如果还选配了温湿度气压传感器 BME280,则命名为 M5Camera_6050_BME280 - -因为模块可以生成 WIFI 热点 AP,所以可以用手机、PC 或其他设备通过 WIFI 无线获取摄像头图片,也可以通过模块的 GROVE 接口有线获取摄像头图片。目前可以实现网络摄像头、颜色识别和人脸识别功能。 - - + ## 产品特性 @@ -94,7 +77,6 @@ Model A 和 Model B,它们有着不同的电路设计、可以通过背面贴 ## 管脚映射 -**M5Camera 有两个版本:A Model 和 B Model.** **摄像头驱动芯片 OV2640 接口** @@ -115,7 +97,7 @@ Model A 和 Model B,它们有着不同的电路设计、可以通过背面贴 | Pixel Data Bit 6 | D8 |IO36 |IO36 | | Pixel Data Bit 7 | D9 |IO19 |IO19 | | Camera Reset | RESET |IO15 |IO15 | -| Camera Power Down | PWDN | *查看注意 1* | *查看注意 1* | +| Camera Power Down | PWDN | / | / | | Power Supply 3.3V | 3V3 | 3V3 | 3V3 | | Ground | GND | GND | GND |