From 0b1649c45c9243c458cc8132076db1535667ea30 Mon Sep 17 00:00:00 2001 From: LiHuashen <854410664@qq.com> Date: Sat, 22 Dec 2018 17:59:37 +0800 Subject: [PATCH] fixed some bugs --- .../{application => app}/bala_1.jpg | Bin .../{application => app}/bala_2.jpg | Bin .../{application => app}/bala_3.jpg | Bin .../{application => app}/bala_4.jpg | Bin .../{application => app}/bala_5.jpg | Bin .../{application => app}/lidarbot_01.jpg | Bin .../{application => app}/lidarbot_02.jpg | Bin .../{application => app}/lidarbot_03.jpg | Bin .../{application => app}/lidarbot_04.jpg | Bin .../{application => app}/lidarbot_05.jpg | Bin docs/en/{api_reference.md => api.md} | 2 - .../micropython/api_lcd.md | 0 .../micropython/api_speaker.md | 0 .../micropython/peripherals/api_gpio.md | 0 docs/en/{application => app}/bala.md | 2 +- docs/en/app/lidarbot.md | 63 +++++ docs/en/application/lidarbot.md | 2 +- docs/en/base/face_base.md | 14 +- docs/en/{m5stack_cases.md => case.md} | 2 +- docs/en/core/face_kit.md | 2 +- docs/en/faq.md | 2 +- docs/en/product_documents.md | 93 -------- docs/en/{quick_start.md => qs.md} | 2 +- docs/en/related_documents.md | 2 +- docs/en/unit/neopixel.md | 8 +- docs/index.md | 2 +- docs/ja/README.md | 2 +- docs/ja/{api_reference.md => api.md} | 0 .../{api_reference => api}/arduino/api_lcd.md | 0 .../micropython/api_lcd.md | 0 .../micropython/api_speaker.md | 0 .../micropython/peripherals/api_gpio.md | 0 docs/ja/{application => app}/bala.md | 10 +- docs/ja/{application => app}/lidarbot.md | 10 +- docs/ja/{m5stack_cases.md => case.md} | 0 docs/ja/core/face_kit.md | 2 +- docs/ja/file_delet_line.py | 222 ------------------ docs/ja/product_documents.md | 88 ------- docs/ja/{quick_start.md => qs.md} | 0 docs/ja/sidebar.md | 4 +- docs/sidebar.md | 4 +- docs/zh_CN/README.md | 2 +- docs/zh_CN/{api_reference.md => api.md} | 2 - .../{api_reference => api}/arduino/api_lcd.md | 0 .../micropython/api_lcd.md | 0 .../micropython/api_speaker.md | 0 .../micropython/peripherals/api_gpio.md | 0 docs/zh_CN/{application => app}/bala.md | 2 +- docs/zh_CN/{application => app}/lidarbot.md | 2 +- docs/zh_CN/base/face_base.md | 10 +- docs/zh_CN/{m5stack_cases.md => case.md} | 2 - docs/zh_CN/core/face_kit.md | 2 +- docs/zh_CN/product_documents.md | 86 ------- docs/zh_CN/{quick_start.md => qs.md} | 2 - docs/zh_CN/related_documents.md | 2 - docs/zh_CN/sidebar.md | 4 +- docs/zh_CN/unit/env.md | 2 +- 57 files changed, 107 insertions(+), 549 deletions(-) rename docs/assets/img/product_pics/{application => app}/bala_1.jpg (100%) rename docs/assets/img/product_pics/{application => app}/bala_2.jpg (100%) rename docs/assets/img/product_pics/{application => app}/bala_3.jpg (100%) rename docs/assets/img/product_pics/{application => app}/bala_4.jpg (100%) rename docs/assets/img/product_pics/{application => app}/bala_5.jpg (100%) rename docs/assets/img/product_pics/{application => app}/lidarbot_01.jpg (100%) rename docs/assets/img/product_pics/{application => app}/lidarbot_02.jpg (100%) rename docs/assets/img/product_pics/{application => app}/lidarbot_03.jpg (100%) rename docs/assets/img/product_pics/{application => app}/lidarbot_04.jpg (100%) rename docs/assets/img/product_pics/{application => app}/lidarbot_05.jpg (100%) rename docs/en/{api_reference.md => api.md} (82%) rename docs/en/{api_reference => api}/micropython/api_lcd.md (100%) rename docs/en/{api_reference => api}/micropython/api_speaker.md (100%) rename docs/en/{api_reference => api}/micropython/peripherals/api_gpio.md (100%) rename docs/en/{application => app}/bala.md (79%) create mode 100644 docs/en/app/lidarbot.md rename docs/en/{m5stack_cases.md => case.md} (98%) delete mode 100644 docs/en/product_documents.md rename docs/en/{quick_start.md => qs.md} (94%) rename docs/ja/{api_reference.md => api.md} (100%) rename docs/ja/{api_reference => api}/arduino/api_lcd.md (100%) rename docs/ja/{api_reference => api}/micropython/api_lcd.md (100%) rename docs/ja/{api_reference => api}/micropython/api_speaker.md (100%) rename docs/ja/{api_reference => api}/micropython/peripherals/api_gpio.md (100%) rename docs/ja/{application => app}/bala.md (91%) rename docs/ja/{application => app}/lidarbot.md (87%) rename docs/ja/{m5stack_cases.md => case.md} (100%) delete mode 100644 docs/ja/file_delet_line.py delete mode 100644 docs/ja/product_documents.md rename docs/ja/{quick_start.md => qs.md} (100%) rename docs/zh_CN/{api_reference.md => api.md} (89%) rename docs/zh_CN/{api_reference => api}/arduino/api_lcd.md (100%) rename docs/zh_CN/{api_reference => api}/micropython/api_lcd.md (100%) rename docs/zh_CN/{api_reference => api}/micropython/api_speaker.md (100%) rename docs/zh_CN/{api_reference => api}/micropython/peripherals/api_gpio.md (100%) rename docs/zh_CN/{application => app}/bala.md (68%) rename docs/zh_CN/{application => app}/lidarbot.md (83%) rename docs/zh_CN/{m5stack_cases.md => case.md} (98%) delete mode 100644 docs/zh_CN/product_documents.md rename docs/zh_CN/{quick_start.md => qs.md} (93%) diff --git a/docs/assets/img/product_pics/application/bala_1.jpg b/docs/assets/img/product_pics/app/bala_1.jpg similarity index 100% rename from docs/assets/img/product_pics/application/bala_1.jpg rename to docs/assets/img/product_pics/app/bala_1.jpg diff --git a/docs/assets/img/product_pics/application/bala_2.jpg b/docs/assets/img/product_pics/app/bala_2.jpg similarity index 100% rename from docs/assets/img/product_pics/application/bala_2.jpg rename to docs/assets/img/product_pics/app/bala_2.jpg diff --git a/docs/assets/img/product_pics/application/bala_3.jpg b/docs/assets/img/product_pics/app/bala_3.jpg similarity index 100% rename from docs/assets/img/product_pics/application/bala_3.jpg rename to docs/assets/img/product_pics/app/bala_3.jpg diff --git a/docs/assets/img/product_pics/application/bala_4.jpg b/docs/assets/img/product_pics/app/bala_4.jpg similarity index 100% rename from docs/assets/img/product_pics/application/bala_4.jpg rename to docs/assets/img/product_pics/app/bala_4.jpg diff --git a/docs/assets/img/product_pics/application/bala_5.jpg b/docs/assets/img/product_pics/app/bala_5.jpg similarity index 100% rename from docs/assets/img/product_pics/application/bala_5.jpg rename to docs/assets/img/product_pics/app/bala_5.jpg diff --git a/docs/assets/img/product_pics/application/lidarbot_01.jpg b/docs/assets/img/product_pics/app/lidarbot_01.jpg similarity index 100% rename from docs/assets/img/product_pics/application/lidarbot_01.jpg rename to docs/assets/img/product_pics/app/lidarbot_01.jpg diff --git a/docs/assets/img/product_pics/application/lidarbot_02.jpg b/docs/assets/img/product_pics/app/lidarbot_02.jpg similarity index 100% rename from docs/assets/img/product_pics/application/lidarbot_02.jpg rename to docs/assets/img/product_pics/app/lidarbot_02.jpg diff --git a/docs/assets/img/product_pics/application/lidarbot_03.jpg b/docs/assets/img/product_pics/app/lidarbot_03.jpg similarity index 100% rename from docs/assets/img/product_pics/application/lidarbot_03.jpg rename to docs/assets/img/product_pics/app/lidarbot_03.jpg diff --git a/docs/assets/img/product_pics/application/lidarbot_04.jpg b/docs/assets/img/product_pics/app/lidarbot_04.jpg similarity index 100% rename from docs/assets/img/product_pics/application/lidarbot_04.jpg rename to docs/assets/img/product_pics/app/lidarbot_04.jpg diff --git a/docs/assets/img/product_pics/application/lidarbot_05.jpg b/docs/assets/img/product_pics/app/lidarbot_05.jpg similarity index 100% rename from docs/assets/img/product_pics/application/lidarbot_05.jpg rename to docs/assets/img/product_pics/app/lidarbot_05.jpg diff --git a/docs/en/api_reference.md b/docs/en/api.md similarity index 82% rename from docs/en/api_reference.md rename to docs/en/api.md index a63cf29a..41ba380a 100644 --- a/docs/en/api_reference.md +++ b/docs/en/api.md @@ -1,7 +1,5 @@ # API Reference -[中文](zh_CN/api_reference) | English | [日本語](ja/api_reference) - | MicroPython | Arduino | |:------------|:--------| |[LCD](en/api_reference/micropython/api_lcd) | / | diff --git a/docs/en/api_reference/micropython/api_lcd.md b/docs/en/api/micropython/api_lcd.md similarity index 100% rename from docs/en/api_reference/micropython/api_lcd.md rename to docs/en/api/micropython/api_lcd.md diff --git a/docs/en/api_reference/micropython/api_speaker.md b/docs/en/api/micropython/api_speaker.md similarity index 100% rename from docs/en/api_reference/micropython/api_speaker.md rename to docs/en/api/micropython/api_speaker.md diff --git a/docs/en/api_reference/micropython/peripherals/api_gpio.md b/docs/en/api/micropython/peripherals/api_gpio.md similarity index 100% rename from docs/en/api_reference/micropython/peripherals/api_gpio.md rename to docs/en/api/micropython/peripherals/api_gpio.md diff --git a/docs/en/application/bala.md b/docs/en/app/bala.md similarity index 79% rename from docs/en/application/bala.md rename to docs/en/app/bala.md index be90a64e..7bf63f4a 100644 --- a/docs/en/application/bala.md +++ b/docs/en/app/bala.md @@ -1,6 +1,6 @@ # BALA - Balanced Car - + * * * diff --git a/docs/en/app/lidarbot.md b/docs/en/app/lidarbot.md new file mode 100644 index 00000000..35ee779d --- /dev/null +++ b/docs/en/app/lidarbot.md @@ -0,0 +1,63 @@ +# LidarBot + + + +* * * + +:memo:**[Description](#Description)**   :octocat:**[Example](https://github.com/m5stack/Applications-LidarBot/tree/master/LidarBot/Example)**   🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Lidar-Bot-Mini-Car-Lidar-8m-6Hz-McNamm-Wheels-NeoPixel-LED-Bar-with-ESP32/3226069_32951134988.html?spm=a2g1y.12024536.productList_5885013.subject_7)** + +## Description + +LidarBot is a four-wheeled car based on indoor navigation. The car body is loaded with lidar, four Mecanum wheels, control-wheel bottom board(based on MEGA328), two RGB bars, M5Core(CarMainController) and some LEGO holes. + +Real-time communication via ESP-NOW between the car and the remote control handle. After receiving the control signal, the car master controlls the wheels and RGB bars through the specified protocol format. + +And in addition to controlling the car's flexible front, rear, left and right movements, the indoor terrain can also be displayed on the display screens of the car master(M5Core) and the remote control handle. + +## Feature + +- Lidar: 8m @ 6Hz +- Programming Support + + Arduino +- Compatible LEGO + +## Protocol for CarBottomBoard + +*Protocol Format：Data Header(command type) + Data Packet + Data Tail* + +| Control Target | Protocol Format | +| :-------------: |:------------------------------------: | +| Wheels | 0xAA,SpeedX,SpeedY,SpeedZ,SpeedA,0x55 | +| One RGB | 0xAB,LedIndex,R,G,B,0x55 | +| Front RGB Bar | 0xAC,R,G,B,0x55 | +| Back RGB Bar | 0xAD,R,G,B,0x55 | +| All RGB | 0xAE,R,G,B,0x55 | +| ServoMotor0 | 0xAF,Angle,0x55 | +| ServoMotor1 | 0xB0,Angle,0x55 | + +## PARAMETER + +- Communication Parameter + - M5Core(CarMain) <-> Lidar(GPIO16 <-> Lidar) + Serial Configuration: "230400bps, 8, n, 1"(8 bits data, no parity, 1 stop bit) + - M5Core(CarMain) <-> CarBottomBoard(GPIO17 <-> Lidar) + Serial Configuration: "115200bps, 8, n, 1"(8 bits data, no parity, 1 stop bit) +- PinMap + - ServoMotor0 <-> A0(MEGA328) + - ServoMotor1 <-> A1(MEGA328) + - NeoPixelRGB <-> 11(MEGA328) + +## Include + +- 1x LidarBot +- 1x Remote Control Handle +- 2x Battery(1300mAh @ 11.1V) +- 1x Power Charger +- 1x Type-C USB Cable + +## APPLICATIONS + +- Indoor Navigation +- Autonomous walking maze +- Route plan +- Autopilot \ No newline at end of file diff --git a/docs/en/application/lidarbot.md b/docs/en/application/lidarbot.md index b89f1473..35ee779d 100644 --- a/docs/en/application/lidarbot.md +++ b/docs/en/application/lidarbot.md @@ -1,6 +1,6 @@ # LidarBot - + * * * diff --git a/docs/en/base/face_base.md b/docs/en/base/face_base.md index dcdf1959..b76299fc 100644 --- a/docs/en/base/face_base.md +++ b/docs/en/base/face_base.md @@ -2,11 +2,9 @@ ## Description -FACE Base is a base of [FACES Kit](en/product_documents/m5stack-core/face_kit). It's composed of M5Core base and battery as shown below. +FACE Base is a base of [FACES Kit](en/core/face_kit). It's composed of M5Core base and battery as shown below. -
- -
+ There are some expanding gpio(see the last picture) of M-Bus at the back of FACES Base, in order for you make a complex project conveniently. Obsolutely, a battery(600mAh) is built in base, so that you can use FACES Kit without usb cable. @@ -14,9 +12,7 @@ There are some expanding gpio(see the last picture) of M-Bus at the back of FACE **Please stack M5Core and FACES Keyboard(*i.e. QWERTY, GameBoy, Calculator*) over Base when use it as shown below** -
- -
+ ## Related Link @@ -25,6 +21,4 @@ There are some expanding gpio(see the last picture) of M-Bus at the back of FACE ## M-Bus -
- basic_05 -
+basic_05 diff --git a/docs/en/m5stack_cases.md b/docs/en/case.md similarity index 98% rename from docs/en/m5stack_cases.md rename to docs/en/case.md index eb8625ff..96f6e31e 100644 --- a/docs/en/m5stack_cases.md +++ b/docs/en/case.md @@ -1,6 +1,6 @@ # M5Stack Cases -[中文](/zh_CN/m5stack_cases) | English | [日本語](/ja/m5stack_cases) + ## STEM Education Cases diff --git a/docs/en/core/face_kit.md b/docs/en/core/face_kit.md index c291a407..d2a734f2 100644 --- a/docs/en/core/face_kit.md +++ b/docs/en/core/face_kit.md @@ -1,6 +1,6 @@ # FACES Kit -**FACES Kit** is a kit composed of M5Core GRAY, functional keyboards, FACES Base, FACES Charger and some accessories(including DuPont lines, lanyard, M3 fixing screws and so on). Currently, the functional keyboards are composed of GameBoy, Calculator and QWERTY. We'll add other keyboards to FACES Kit. You can program it through Arduino IDE or MicroPython. For different applications, you can stack corresponding keyboard on FACES Base and burn corresponding firmware into M5Core. And here, you can learn more about [FACES Base](en/product_documents/bases/face_base). +**FACES Kit** is a kit composed of M5Core GRAY, functional keyboards, FACES Base, FACES Charger and some accessories(including DuPont lines, lanyard, M3 fixing screws and so on). Currently, the functional keyboards are composed of GameBoy, Calculator and QWERTY. We'll add other keyboards to FACES Kit. You can program it through Arduino IDE or MicroPython. For different applications, you can stack corresponding keyboard on FACES Base and burn corresponding firmware into M5Core. And here, you can learn more about [FACES Base](en/base/face_base). *For each keyboard, it's integrated **MEGA328** chip, so that when you press a button, a corresponding value(**hexadecimal format**) will be sent from keyboard to M5Core. They(keyboard and m5core) are communicating using I2C. And the I2C address of each keyboard is 0x08.* diff --git a/docs/en/faq.md b/docs/en/faq.md index 53dbb51f..64e5b1be 100644 --- a/docs/en/faq.md +++ b/docs/en/faq.md @@ -1,5 +1,5 @@ # FAQ -[中文](/zh_CN/faq) | English | [日本語](/ja/faq) + ## (coming soon...) \ No newline at end of file diff --git a/docs/en/product_documents.md b/docs/en/product_documents.md deleted file mode 100644 index a0d8acf5..00000000 --- a/docs/en/product_documents.md +++ /dev/null @@ -1,93 +0,0 @@ -# Product Documents - -*** - - - -**M5Core** - -[![basic_01.jpg](https://i.loli.net/2018/12/13/5c121478df534.jpg)](en/core/basic)[![gray_01.jpg](https://i.loli.net/2018/12/13/5c1214ef29949.jpg)](en/core/gray)[![product_pic_fire.jpg](https://i.loli.net/2018/12/13/5c121562a65be.jpg)](en/core/fire) - -**MiniCore** - -[![m5stick_01.jpg](https://i.loli.net/2018/12/13/5c12158935965.jpg)](en/core/m5stick) - - - -**Kit** - -[![m5go_01.png](https://i.loli.net/2018/12/13/5c12159c9c2aa.png)](en/core/m5go_iot_starter_kit)[![face_kit_01.jpg](https://i.loli.net/2018/12/13/5c1215b26d803.jpg)](en/core/face_kit) - - - -*** - - - -**Communication Modules** - -[![gps_01.jpg](https://i.loli.net/2018/12/13/5c12160039059.jpg)](en/module/gps) [![lora_01.jpg](https://i.loli.net/2018/12/13/5c12161755792.jpg)](en/module/lora) [![lorawan_01.jpg](https://i.loli.net/2018/12/13/5c1216c437a6c.jpg)](en/module/lorawan) [![sim800_01.jpg](https://i.loli.net/2018/12/13/5c12165b1bc66.jpg)](en/module/sim800) - -[![commu_01.jpg](https://i.loli.net/2018/12/13/5c121675145ca.jpg)](en/module/commu) - - - - - -**Expansion Modules** - -[![battery_01.jpg](https://i.loli.net/2018/12/13/5c121754d1485.jpg)](en/module/battery)[![proto_01.jpg](https://i.loli.net/2018/12/13/5c12175690f25.jpg)](en/module/proto)[![plus_1.png](https://i.loli.net/2018/12/13/5c121789cd9f9.png)](en/module/plus) - - - -**Drive Modules** - -[![stepmotor_01.jpg](https://i.loli.net/2018/12/13/5c1217aa25a91.jpg)](en/module/stepmotor)[![servo_01.jpg](https://i.loli.net/2018/12/13/5c1217abb1cd9.jpg)](en/module/servo) - - - - - -*** - - - -[![lan_01.png](https://i.loli.net/2018/12/13/5c1223ee16411.png)](en/base/lan_base) [![node_01.png](https://i.loli.net/2018/12/13/5c1223fd8d2cb.png)](en/base/node_base) - - - -*** - - - -**Input/Sensing Unit** - -[![M5GO_Unit_env.png](https://i.loli.net/2018/12/13/5c12229aed8e7.png)](en/unit/env) [![M5GO_Unit_ir.png](https://i.loli.net/2018/12/13/5c1222c75a47c.png)](en/unit/ir) [![M5GO_Unit_pir.png](https://i.loli.net/2018/12/13/5c1222b138916.png)](en/unit/pir) [![M5GO_Unit_angle.png](https://i.loli.net/2018/12/13/5c1219eb78c21.png)](en/unit/angle) - -[![M5GO_Unit_adc.png](https://i.loli.net/2018/12/13/5c12192a6110d.png)](en/unit/adc)[![M5GO_Unit_dac.png](https://i.loli.net/2018/12/13/5c1219d495a9a.png)](en/unit/dac)[![M5GO_Unit_button.png](https://i.loli.net/2018/12/13/5c121a068c209.png)](en/unit/button)[![M5GO_Unit_dual_button.png](https://i.loli.net/2018/12/13/5c121a1adfedb.png)](en/unit/dual_button) - -[![M5GO_Unit_joystick_01.png](https://i.loli.net/2018/12/13/5c121a8c96259.png)](en/unit/joystick)[![M5GO_Unit_earth_01.png](https://i.loli.net/2018/12/13/5c121a6619dd1.png)](en/unit/earth)[![M5GO_Unit_color.png](https://i.loli.net/2018/12/13/5c121a2debd7c.png)](en/unit/color)[![m5camera_01.png](https://i.loli.net/2018/12/13/5c1218b4d4a50.png)](en/unit/m5camera) - -[![M5GO_Unit_light_01.png](https://i.loli.net/2018/12/13/5c121db73426d.png)](en/unit/light)[![M5GO_Unit_makey.png](https://i.loli.net/2018/12/13/5c121dd514166.png)](en/unit/makey)[![M5GO_Unit_ncir.png](https://i.loli.net/2018/12/13/5c121df24f746.png)](en/unit/ncir)[![M5GO_Unit_thermal.png](https://i.loli.net/2018/12/13/5c121e38b72c9.png)](en/unit/thermal) - -[![M5GO_Unit_tof.png](https://i.loli.net/2018/12/13/5c121e5cd47e1.png)](en/unit/tof) - - -**Output/Controlling Unit** - -[![M5GO_Unit_rgb.png](https://i.loli.net/2018/12/13/5c121f5c98542.png)](en/unit/rgb)[![M5GO_Unit_relay.png](https://i.loli.net/2018/12/13/5c121f6e9a185.png)](en/unit/relay)[![M5GO_Unit_neopixel.png](https://i.loli.net/2018/12/13/5c121f8457fcb.png)](en/unit/neopixel) - -**Interface Unit** - -[![M5GO_Unit_hub_01.png](https://i.loli.net/2018/12/13/5c121f970bb1f.png)](en/unit/hub)[![M5GO_Unit_3.96_01.png](https://i.loli.net/2018/12/13/5c121fac3607e.png)](en/unit/396port) -[![M5GO_Unit_proto_01.png](https://i.loli.net/2018/12/13/5c121e125b2fe.png)](en/unit/proto) - -*** - - - -[![bala_1.png](https://i.loli.net/2018/12/13/5c1224ba208bc.png)](en/application/bala) [![lidarbot_01.png](https://i.loli.net/2018/12/13/5c1224dbe9609.png)](en/application/lidarbot) - - diff --git a/docs/en/quick_start.md b/docs/en/qs.md similarity index 94% rename from docs/en/quick_start.md rename to docs/en/qs.md index 2eb2e595..c03e6591 100644 --- a/docs/en/quick_start.md +++ b/docs/en/qs.md @@ -1,6 +1,6 @@ # Quick Start -[中文](/zh_CN/quick_start) | English | [日本語](/ja/quick_start) + *This document is intended to help you set up the software environment(Arudino, MicroPython) for development of M5Stack. Through a simple example we would like to illustrate how to develop M5Stack boards, firmware(Arduino) or source files(MicroPython) download to M5Stack boards.* diff --git a/docs/en/related_documents.md b/docs/en/related_documents.md index bf8c389d..8f0b35ff 100644 --- a/docs/en/related_documents.md +++ b/docs/en/related_documents.md @@ -1,6 +1,6 @@ # Related Documents -[中文](/zh_CN/related_documents) | English | [日本語](/ja/related_documents) + 1. [Establish Serial Connection](en/related_documents/establish_serial_connection) diff --git a/docs/en/unit/neopixel.md b/docs/en/unit/neopixel.md index 73b0a4dc..8abc93e1 100644 --- a/docs/en/unit/neopixel.md +++ b/docs/en/unit/neopixel.md @@ -4,7 +4,7 @@ *** -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-NeoPixel-RGB-LEDs-Cable-SK6812-with-GROVE-Port-2m-1m-50cm-20cm-10cm/3226069_32950831315.html?spm=a2g1x.12024536.productList_5885013.pic_0)** +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-NeoPixel-RGB-LEDs-Cable-SK6812-with-GROVE-Port-2m-1m-50cm-20cm-10cm/3226069_32950831315.html?spm=a2g1x.12024536.productList_5885013.pic_0)** ## Description @@ -40,11 +40,11 @@ Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ 具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/NEOPIXEL/UIFlow)。 -## Schematic + - + -### PinMap + \ No newline at end of file diff --git a/docs/ja/README.md b/docs/ja/README.md index b8764e20..48f0cecf 100644 --- a/docs/ja/README.md +++ b/docs/ja/README.md @@ -82,7 +82,7 @@ -[![bala_1.png](https://i.loli.net/2018/12/13/5c1224ba208bc.png)](ja/application/bala) [![lidarbot_01.png](https://i.loli.net/2018/12/13/5c1224dbe9609.png)](ja/application/lidarbot) +[![bala_1.png](https://i.loli.net/2018/12/13/5c1224ba208bc.png)](ja/app/bala) [![lidarbot_01.png](https://i.loli.net/2018/12/13/5c1224dbe9609.png)](ja/app/lidarbot) \ No newline at end of file diff --git a/docs/ja/api_reference.md b/docs/ja/api.md similarity index 100% rename from docs/ja/api_reference.md rename to docs/ja/api.md diff --git a/docs/ja/api_reference/arduino/api_lcd.md b/docs/ja/api/arduino/api_lcd.md similarity index 100% rename from docs/ja/api_reference/arduino/api_lcd.md rename to docs/ja/api/arduino/api_lcd.md diff --git a/docs/ja/api_reference/micropython/api_lcd.md b/docs/ja/api/micropython/api_lcd.md similarity index 100% rename from docs/ja/api_reference/micropython/api_lcd.md rename to docs/ja/api/micropython/api_lcd.md diff --git a/docs/ja/api_reference/micropython/api_speaker.md b/docs/ja/api/micropython/api_speaker.md similarity index 100% rename from docs/ja/api_reference/micropython/api_speaker.md rename to docs/ja/api/micropython/api_speaker.md diff --git a/docs/ja/api_reference/micropython/peripherals/api_gpio.md b/docs/ja/api/micropython/peripherals/api_gpio.md similarity index 100% rename from docs/ja/api_reference/micropython/peripherals/api_gpio.md rename to docs/ja/api/micropython/peripherals/api_gpio.md diff --git a/docs/ja/application/bala.md b/docs/ja/app/bala.md similarity index 91% rename from docs/ja/application/bala.md rename to docs/ja/app/bala.md index 8134f91e..12a31d92 100644 --- a/docs/ja/application/bala.md +++ b/docs/ja/app/bala.md @@ -60,23 +60,23 @@ - [M5Balaクイックスタート](/ja/quick_start/bala/bala_quick_start)
- +
- +
- +
- +
- +
## 関連情報 diff --git a/docs/ja/application/lidarbot.md b/docs/ja/app/lidarbot.md similarity index 87% rename from docs/ja/application/lidarbot.md rename to docs/ja/app/lidarbot.md index 976f543e..9eb2e498 100644 --- a/docs/ja/application/lidarbot.md +++ b/docs/ja/app/lidarbot.md @@ -75,23 +75,23 @@ ESP-NOWを利用したリアルタイム通信により、リモコンでLidarBO - 近日公開予定
- +
- +
- +
- +
- +
## 関連情報 diff --git a/docs/ja/m5stack_cases.md b/docs/ja/case.md similarity index 100% rename from docs/ja/m5stack_cases.md rename to docs/ja/case.md diff --git a/docs/ja/core/face_kit.md b/docs/ja/core/face_kit.md index b202729c..6e69fa66 100644 --- a/docs/ja/core/face_kit.md +++ b/docs/ja/core/face_kit.md @@ -4,7 +4,7 @@ ## 概要 -**FACES Kit** は M5Core GRAY、ファンクショナルキーボード, FACESベース, FACESチャージャー、そしていくつかのアクセサリ（DuPont線、ストラップ、M3ネジなど）で構成されたキットです。 現在、ファンクショナルキーボードはGameBoy、 電卓、 QWERTYの3つがあります。今後、さらに別のキーボードがFACESキットに追加される予定です。Arduino IDEまたはMicroPythonを使用してプログラムすることができます。異なるアプリケーションに対し、それぞれ対応したキーボードをFACESベースにスタックして、利用することができます。[FACES Base](ja/product_documents/bases/face_base)のページで詳細を確認できます。 +**FACES Kit** は M5Core GRAY、ファンクショナルキーボード, FACESベース, FACESチャージャー、そしていくつかのアクセサリ（DuPont線、ストラップ、M3ネジなど）で構成されたキットです。 現在、ファンクショナルキーボードはGameBoy、 電卓、 QWERTYの3つがあります。今後、さらに別のキーボードがFACESキットに追加される予定です。Arduino IDEまたはMicroPythonを使用してプログラムすることができます。異なるアプリケーションに対し、それぞれ対応したキーボードをFACESベースにスタックして、利用することができます。[FACES Base](ja/base/face_base)のページで詳細を確認できます。 *それぞれのキーボードには、**MEGA328**チップが統合されており、ボタンを押した時に対応した値(**16進フォーマット**)がキーボードからM5Coreに送信されます。それぞれI2Cを使って通信しており、各キーボードのI2Cアドレスは**0x08**です。* diff --git a/docs/ja/file_delet_line.py b/docs/ja/file_delet_line.py deleted file mode 100644 index 981c59b5..00000000 --- a/docs/ja/file_delet_line.py +++ /dev/null @@ -1,222 +0,0 @@ -#-*-coding:utf-8-*- - -""" -1. 将模板env文件拷贝到新建文件夹中 -2. 拷贝旧文件的中间部分内容（描述，特性...），插入到新建文件夹中的模板文件env -3. 替换模板文件env中的unit名字为旧文件的，替换“购买链接”为速卖通，删除多余旧文件拷贝过来的“原理图”“购买链接” -4. 把改好的文件重命名，再拷贝到上一层目录中替换旧文件 -""" - -import os -import sys -import re -import shutil - -cur_path = os.getcwd() -# newFolderName = 'newFolder' -target_path = "" -files_list = []# 保存所有文件到这个列表中 -flag_find_desc = 0 -flag_find_picture = 0 -flag_file_exit_picture = 0 -pattern_desc = re.compile(r'^\[中文\]\([(/zh_CN)(zh_CN)]') -pos_example = 0 -count = 0 -count_example = 0 -data_to_write = [] -link_list = [] -add_related_links = ["- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)**", "\n", "\n", "- **[Forum](http://forum.m5stack.com/)**", "\n"] - -def delet_line(path): - # filename = os.path.split(path)[1] - # print("path: %s, filename: %s"%(path, filename)) - content_list = [] - with open(path,"r",encoding="utf-8") as f_r: - for line in f_r.readlines(): - # print(line) - match_desc = pattern_desc.match(line) - if match_desc: - # print(line) - content_list.append("\n") - continue - content_list.append(line) - f_r.close() - # print(content_list) - with open(path,"w",encoding="utf-8") as f_w: - for content in content_list: - f_w.write(content) - f_w.close() - print(path) - -def make_dir(path, new_folder): - global target_path - target_path = cur_path+os.path.sep+new_folder - if not os.path.exists(target_path): - os.makedirs(target_path) - else: - print('路径已经存在') -# file_list = os.listdir(cur_path) -# print(file_list) -# print("length of file_list: %d"%(len(file_list))) - -def get_filepath_shotname_extension(filename): - (filepath, tempfilename) = os.path.split(filename) - (shotname, extension) = os.path.splitext(tempfilename) - # print("filepath: %s, shotname: %s, extension: %s"%(filepath, shotname, extension)) - return (shotname, extension) - -def get_all_files(path): - files_list = [] - for i in os.listdir(path): - if os.path.isdir(path+'\\'+i): - # recurseDir(path+'\\'+i) # 注释这条语句，不处理目录 - print("dir: %s"%(path+'\\'+i)) - else: - p=path+'\\'+i - # print(p) - extension = get_filepath_shotname_extension(p)[1] - if extension == ".md": - files_list.append(os.path.split(p)[1])# 把所有文件都放进这个列表中保存 - # print(os.path.split(p)[1]) - return files_list - -def extract_content(filename): - global flag_find_desc - global flag_find_picture - global flag_file_exit_picture - global data_to_write - - # filename = get_filepath_shotname_extension(filename) - with open(filename,"r",encoding="utf-8") as f_r: - for line in f_r.readlines(): - match_desc = pattern_desc.match(line) - match_picture = pattern_picture.match(line) - if match_desc or match_picture: - if match_desc: - flag_find_desc = 1 # get a flag - if match_picture: - flag_find_picture = 1 - if flag_find_picture: # end - flag_file_exit_picture = 1 - flag_find_picture = 0 - flag_find_desc = 0 - print(count) - f_r.close() - if flag_find_desc: - data_to_write.append(line) # add data to a list - # count+=1 - if flag_file_exit_picture: - flag_file_exit_picture = 0 - else: # this file doesn't have pictures - # print("this file doesn't have pictures: %s"%filename) - flag_find_desc = 0 - f_r.close() - # print(data_to_write) - os.chdir(target_path) # 切换到临时文件夹，并把列表写入到临时文件中（如果文件不存在，则创建） - with open("temp.md","w",encoding="utf-8") as temp_f_w: - for i in data_to_write: - temp_f_w.write(i)# 保存要拷贝的内容到临时文件中 - temp_f_w.close() - -def add_data_to_file(des_file, src_file):# 插入到中文文件 - fp = open(des_file, "r", encoding="utf-8") - fp_add = open(src_file,"r", encoding="utf-8") - content = fp.read() - content_add = fp_add.read() - fp.close() - fp_add.close() - post = content.find("## Example")# 寻找待插入位置所在的字符串 - if post != 1: - content = content[:post] + content_add + content[post:] - # print(content) - fp = open(des_file, "w", encoding="utf-8") - fp.write(content) - fp.close() - -def get_device_name(filename): - shotname = get_filepath_shotname_extension(filename)[0] - dev_name = shotname - # print(dev_name) - return dev_name - -def delect_replace_content(filename): - """ - 先通过正则表达式匹配出两个网址，然后将第一个匹配到的网址替换成第二个网址 - 替换文件中的内容为对应unit名字 - 删除多余的内容 - """ - global link_list - # filename = get_filepath_shotname_extension(filename) - with open(filename,"r",encoding="utf-8") as fp: - lines = fp.readlines() - for line in lines: - match_purchase = pattern_purchase.search(line) - if match_purchase: - link_list.append(match_purchase.group(2))# 找到两个购买链接，以备后面替换 - print(link_list) - with open(filename,"w",encoding="utf-8") as f_w: - for line in lines: - if "ENV" in line: - line = line.replace("ENV", get_device_name(filename).upper()) - if "env" in line: - line = line.replace("env", get_device_name(filename)) - if link_list[0] in line: - line = line.replace(link_list[0], link_list[1]) - print(line) - # if ("- **Example**" or "- **Example**" or "- **[Purchase]" or "- **[Purchase]") in line: - # # print(line) - # continue # 删除多余的 - f_w.write(line) - fp.close() - f_w.close() - with open(filename,"r+",encoding="utf-8") as fp: - global add_related_links - links_index = 0 - count = 0 - lines = fp.readlines() - for line in lines: - if ("## Related Link") in line: - links_index = count - print(links_index) - count = count + 1 - fp.seek(0) - for i in range(len(add_related_links)): - lines.insert(links_index+i+2, add_related_links[i]) - for line in lines: - fp.write(line) - fp.close() - -def recursive_exect_file(path): - # files_list = os.listdir(path) - for root, dirs, files in os.walk(path): - for file in files: - # print(old_path) - old_path = os.path.join(root, file) - filetype = get_filepath_shotname_extension(old_path)[1] - if filetype == '.md': - delet_line(old_path) - # print(file) - # if os.path.isfile(old_path): - # filetype = get_filepath_shotname_extension(old_path)[1] - # if filetype == '.md': - # # delet_line(file) - # print(file) - # else: - # recursive_exect_file(old_path) - -if __name__ == "__main__": - # make_dir(cur_path, "temp_folder") - # files_list = get_all_files(cur_path) - # for filename in files_list: - # if not filename == "env_template.md": - # print(filename) - # shutil.copyfile(cur_path+"\\env_template.md", target_path+"\\"+filename) - # extract_content(filename)# make a temp file at cur_path - # add_data_to_file(filename, "temp.md") - # delect_replace_content(filename) - # data_to_write.clear()# 清空列表 - # link_list.clear() - # # print(data_to_write) - # os.chdir(cur_path) - - recursive_exect_file('.') \ No newline at end of file diff --git a/docs/ja/product_documents.md b/docs/ja/product_documents.md deleted file mode 100644 index e6cd5f4c..00000000 --- a/docs/ja/product_documents.md +++ /dev/null @@ -1,88 +0,0 @@ -# 製品ドキュメント - - - -?> 各製品の使用方法は、製品の詳細情報の中に記載されています。 - - - - - -| M5Core | MiniCore | -|:------:|:--------:| -| [BASIC](ja/product_documents/m5stack-core/m5core_basic) | [Stick](ja/product_documents/m5stack-core/minicore_stick) | -| [GRAY](ja/product_documents/m5stack-core/m5core_gray) | / | -| [WHITE(M5GO Main Board)](ja/product_documents/m5stack-core/m5core_white) | / | -| [FIRE](ja/product_documents/m5stack-core/m5core_fire) | / | -| [FACES Kit](ja/product_documents/m5stack-core/face_kit) | / | -| [M5GO IoT Kit](ja/product_documents/m5stack-core/m5go_iot_starter_kit)| / | - - - - - -| 無線通信 | アクセサリ | 制御 | -|:---------------:|:-----------------:|:-----------:| -| [GPS](ja/product_documents/modules/module_gps) | [PROTO](ja/product_documents/modules/module_proto) | [STEPMOTOR](ja/product_documents/modules/module_stepmotor) | -| [LORA](ja/product_documents/modules/module_lora) | [BATTERY](ja/product_documents/modules/module_battery) | [SERVO](ja/product_documents/modules/module_servo) | -| [SIM800/GPRS/GSM](ja/product_documents/modules/module_sim800) | [BTC](ja/product_documents/modules/module_btc) | [COMMU](ja/product_documents/modules/module_commu) | -| [LoRaWAN](ja/product_documents/modules/module_lorawan) | [PLUS](ja/product_documents/modules/module_plus) | [LEGO+](ja/product_documents/modules/module_lego_plus) | -| / | [USB](ja/product_documents/modules/module_usb) | / | - - - - - -| | | | -|:---:|:---:|:---:| -| [M5GO-Base](ja/product_documents/bases/m5go_base) | [PLC-Base](ja/product_documents/bases/plc_base) | [FACE-Base](ja/product_documents/bases/face_base) | -| [LAN](ja/product_documents/bases/lan_base)| / | / | -| [Node-Base](ja/product_documents/bases/node_base)| / | / | - - - - - -| | | | -|:---:|:---:|:---:| -| [LEGO-CABLE](ja/product_documents/accessories/cables/lego_cable) | [FRAME](ja/product_documents/accessories/frame) | [Headers Socket](ja/product_documents/accessories/headers_socket) | -| [GROVE-CABLE](ja/product_documents/accessories/cables/grove_cable) | [USB-TTL UART Serial Adapter](ja/product_documents/accessories/usb_uart_adapter) | / | - - - - - -| 入力/センシング | 出力/コントロール | インターフェース | -|:-------------:|:--------------:|:-------------:| -| [ENV](ja/product_documents/units/unit_env) | [RGB](ja/product_documents/units/unit_rgb) | [HUB](ja/product_documents/units/unit_hub) | -| [IR](ja/product_documents/units/unit_ir) | [RELAY](ja/product_documents/units/unit_relay) | [3.96PORT](ja/product_documents/units/unit_396port) | -| [PIR](ja/product_documents/units/unit_pir) | [NeoPixel](ja/product_documents/units/unit_neopixel) | [PROTO](ja/product_documents/units/unit_proto) | -| [ANGLE](ja/product_documents/units/unit_angle) | / | / | -| [EARTH](ja/product_documents/units/unit_earth) | / | / | -| [LIGHT](ja/product_documents/units/unit_light) | / | / | -| [MAKEY](ja/product_documents/units/unit_makey) | / | / | -| [BUTTON](ja/product_documents/units/unit_button) | / | / | -| [Dual BUTTON](ja/product_documents/units/unit_dual_button) | / | / | -| [JOYSTICK](ja/product_documents/units/unit_joystick) | / | / | -| [THERMAL](ja/product_documents/units/unit_thermal) | / | / | -| [ADC](ja/product_documents/units/unit_adc) | / | / | -| [DAC](ja/product_documents/units/unit_dac) | / | / | -| [COLOR](ja/product_documents/units/unit_color) | / | / | -| [ToF](ja/product_documents/units/unit_tof) | / | / | -| [ESP32Cam](ja/product_documents/units/unit_esp32cam) | / | / | -| [M5Camera](ja/product_documents/units/unit_m5camera) | / | / | -| [NCIR](ja/product_documents/units/unit_ncir) | / | / | - - - - - -| | | | -|:--|:--|:--| -| [BALA](ja/product_documents/applications/application_bala) | [LidarBOT](ja/product_documents/applications/application_lidarbot) | / | - - - - - -- [M5Stack USB Downloader](ja/product_documents/tools/tool_usb_downloader) diff --git a/docs/ja/quick_start.md b/docs/ja/qs.md similarity index 100% rename from docs/ja/quick_start.md rename to docs/ja/qs.md diff --git a/docs/ja/sidebar.md b/docs/ja/sidebar.md index cd87dbec..1a58a9e7 100644 --- a/docs/ja/sidebar.md +++ b/docs/ja/sidebar.md @@ -1,6 +1,6 @@ - [製品ドキュメント](ja/) -- [API リファレンス](ja/api_reference) -- [M5Stack アプリケーション](ja/m5stack_cases) +- [API リファレンス](ja/api) +- [M5Stack アプリケーション](ja/case) - [その他のドキュメント](ja/related_documents) - [よくある質問](ja/faq) diff --git a/docs/sidebar.md b/docs/sidebar.md index ab619cad..1af02ce7 100644 --- a/docs/sidebar.md +++ b/docs/sidebar.md @@ -1,6 +1,6 @@ - [Product Documents](en/) -- [API Reference](en/api_reference) -- [M5Stack Cases](en/m5stack_cases) +- [API Reference](en/api) +- [M5Stack Cases](en/case) - [Related Documents](en/related_documents) - [FAQ](en/faq) diff --git a/docs/zh_CN/README.md b/docs/zh_CN/README.md index 1410c5ef..11b416cb 100644 --- a/docs/zh_CN/README.md +++ b/docs/zh_CN/README.md @@ -79,7 +79,7 @@ -[![bala_1.png](https://i.loli.net/2018/12/13/5c1224ba208bc.png)](zh_CN/application/bala) [![lidarbot.png](https://i.loli.net/2018/12/13/5c1224dbe9609.png)](zh_CN/application/lidarbot) +[![bala_1.png](https://i.loli.net/2018/12/13/5c1224ba208bc.png)](zh_CN/app/bala) [![lidarbot.png](https://i.loli.net/2018/12/13/5c1224dbe9609.png)](zh_CN/app/lidarbot) - - - -**输出/控制类Unit** - -[![unit_rgb.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/docs/assets/img/product_pics/pictures_for_homepage/units/unit_rgb.png)](zh_CN/unit/rgb)[![unit_relay.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/docs/assets/img/product_pics/pictures_for_homepage/units/unit_relay.png)](zh_CN/unit/relay) - - - -**接口类Unit** - -[![unit_hub.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/docs/assets/img/product_pics/pictures_for_homepage/units/unit_hub.png)](zh_CN/unit/hub)[![unit_3.96.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/docs/assets/img/product_pics/pictures_for_homepage/units/unit_396port.png)](zh_CN/unit/396port) -[![unit_proto.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/docs/assets/img/product_pics/pictures_for_homepage/units/unit_proto.png)](zh_CN/unit/proto) - -*** - - - -[![bala_1.png](https://i.loli.net/2018/12/13/5c1224ba208bc.png)](zh_CN/application/bala) [![lidarbot.png](https://i.loli.net/2018/12/13/5c1224dbe9609.png)](zh_CN/application/lidarbot) - - diff --git a/docs/zh_CN/quick_start.md b/docs/zh_CN/qs.md similarity index 93% rename from docs/zh_CN/quick_start.md rename to docs/zh_CN/qs.md index a3101005..d9b131d4 100644 --- a/docs/zh_CN/quick_start.md +++ b/docs/zh_CN/qs.md @@ -1,7 +1,5 @@ # 快速上手(Quick Start) -中文 | [English](/en/quick_start) | [日本語](/ja/quick_start) - *这篇文章主要帮助你搭建M5Stack系列产品中Arduino，MicroPython的开发环境，并通过简单的例子引导你学会使用和开发M5Stack的所有产品，实现自己的创意作品。* | diff --git a/docs/zh_CN/related_documents.md b/docs/zh_CN/related_documents.md index 59e2ae0d..19569630 100644 --- a/docs/zh_CN/related_documents.md +++ b/docs/zh_CN/related_documents.md @@ -1,7 +1,5 @@ # 相关文档 -中文 | [English](/en/related_documents) | [日本語](/ja/related_documents) - 1. [如何安装USB驱动并建立与PC的串口通讯](zh_CN/related_documents/establish_serial_connection) 2. [如何安装Git和Arduino](zh_CN/related_documents/how_to_install_git_and_arduino) diff --git a/docs/zh_CN/sidebar.md b/docs/zh_CN/sidebar.md index 5daa880f..5b368e80 100644 --- a/docs/zh_CN/sidebar.md +++ b/docs/zh_CN/sidebar.md @@ -1,6 +1,6 @@ - [产品介绍](zh_CN/) -- [API参考](zh_CN/api_reference) -- [M5Stack案例](zh_CN/m5stack_cases) +- [API参考](zh_CN/api) +- [M5Stack案例](zh_CN/case) - [相关文档](zh_CN/related_documents) - [常见问题解答](zh_CN/faq) diff --git a/docs/zh_CN/unit/env.md b/docs/zh_CN/unit/env.md index f8b15031..72ff2066 100644 --- a/docs/zh_CN/unit/env.md +++ b/docs/zh_CN/unit/env.md @@ -44,7 +44,7 @@ float pressure = bme.readPressure();//pressure ### 2. UIFlow - + 具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ENV/UIFlow)。