diff --git a/docs/en/api_reference.md b/docs/en/api_reference.md index f03d9d6d..4fe65b0c 100644 --- a/docs/en/api_reference.md +++ b/docs/en/api_reference.md @@ -1 +1,5 @@ -[LCD](/en/api_reference/api_lcd) \ No newline at end of file +# API Reference + +[中文](/zh_CN/api_reference) | English | [日本語](/ja/api_reference) + +- [LCD](/en/api_reference/api_lcd) \ No newline at end of file diff --git a/docs/en/faq.md b/docs/en/faq.md index 209f143a..53dbb51f 100644 --- a/docs/en/faq.md +++ b/docs/en/faq.md @@ -1,3 +1,5 @@ # FAQ +[中文](/zh_CN/faq) | English | [日本語](/ja/faq) + ## (coming soon...) \ No newline at end of file diff --git a/docs/en/file_to_display_null.md b/docs/en/file_to_display_null.md index cb25f62a..266736c3 100644 --- a/docs/en/file_to_display_null.md +++ b/docs/en/file_to_display_null.md @@ -1,2 +1 @@ ### Coming soon... - diff --git a/docs/en/m5stack_cases.md b/docs/en/m5stack_cases.md index 19aff0b6..25beb765 100644 --- a/docs/en/m5stack_cases.md +++ b/docs/en/m5stack_cases.md @@ -1,5 +1,7 @@ # M5Stack Cases +[中文](/zh_CN/m5stack_cases) | English | [日本語](/ja/m5stack_cases) + ## STEM Education Cases ## M5Stack Awesome diff --git a/docs/en/practice.md b/docs/en/practice.md index 558dd916..77ee8d88 100644 --- a/docs/en/practice.md +++ b/docs/en/practice.md @@ -1,5 +1,7 @@ # Practice +[中文](/zh_CN/practice) | English | [日本語](/ja/practice) + | | ---|---|--- [M5StackCore](establish_serial_connection) | [M5Camera](establish_serial_connection) | [M5BALA](establish_serial_connection) \ No newline at end of file diff --git a/docs/en/practice/practice_arduino.md b/docs/en/practice/practice_arduino.md index d6210c09..bdbbf4cc 100644 --- a/docs/en/practice/practice_arduino.md +++ b/docs/en/practice/practice_arduino.md @@ -1,3 +1,5 @@ # Practice for Arduino +[中文](/zh_CN/practice/practice_arduino) | English | [日本語](/ja/practice/practice_arduino) + ## (coming soon...) \ No newline at end of file diff --git a/docs/en/practice/practice_blockly.md b/docs/en/practice/practice_blockly.md index f00c7e32..b8a60980 100644 --- a/docs/en/practice/practice_blockly.md +++ b/docs/en/practice/practice_blockly.md @@ -1,3 +1,5 @@ # Practice for M5Flow(Blockly) +[中文](/zh_CN/practice/practice_blockly) | English | [日本語](/ja/practice/practice_blockly) + ## (coming soon...) \ No newline at end of file diff --git a/docs/en/practice/practice_micropython.md b/docs/en/practice/practice_micropython.md index 0bbb18ea..35fc9b29 100644 --- a/docs/en/practice/practice_micropython.md +++ b/docs/en/practice/practice_micropython.md @@ -1,3 +1,5 @@ # Practice for M5Flow(MicroPython) +[中文](/zh_CN/practice/practice_micropython) | English | [日本語](/ja/practice/practice_micropython) + ## (coming soon...) \ No newline at end of file diff --git a/docs/en/quick_start.md b/docs/en/quick_start.md index c49891bb..09a15464 100644 --- a/docs/en/quick_start.md +++ b/docs/en/quick_start.md @@ -1,5 +1,7 @@ # 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.** ## Introduction diff --git a/docs/en/related_documents.md b/docs/en/related_documents.md index 79101044..9bed0108 100644 --- a/docs/en/related_documents.md +++ b/docs/en/related_documents.md @@ -1,5 +1,7 @@ # Related Documents +[中文](/zh_CN/related_documents) | English | [日本語](/ja/related_documents) + ### [1. Establish Serial Connection](en/related_documents/establish_serial_connection) ### [2. How to Burn Firmware](en/related_documents/how_to_burn_firmware) diff --git a/docs/ja/README_ja.md b/docs/ja/README_ja.md index 5874649a..1e413d4c 100644 --- a/docs/ja/README_ja.md +++ b/docs/ja/README_ja.md @@ -15,7 +15,7 @@ ## 製品紹介 -**M5Stackはモジュール積層型の開発デバイスです。M5Stackの名前はModuleのM、5x5cmサイズの5、積み重ねるを意味するStackからきています。** +**M5Stackはモジュール積み重ねるタイプの開発デバイスです。M5Stackの名前はModuleのM、5x5cmサイズの5、積み重ねるを意味するStackからきています。** **M5Stackは、開発の際の煩わしさやストレスを軽減し、あなたがあなた自身の新しい発明やアイデアを具現化することに集中出来るように設計されています。M5Stackはいくつかのセンサー、Wi-Fi、Bluetooth、スクリーン、電源を自身に備えており、従来のブレッドボードでの煩雑な配線作業を行わなくても、拡張モジュールを積み重ねたり、Groveコネクタを介して拡張ユニットを簡単に接続することが可能です。** diff --git a/docs/ja/api_reference.md b/docs/ja/api_reference.md index cff0d19f..ebd30e4a 100644 --- a/docs/ja/api_reference.md +++ b/docs/ja/api_reference.md @@ -1,3 +1,5 @@ # API リファレンス -[LCD](ja/api_reference/api_lcd) \ No newline at end of file +[中文](/zh_CN/api_reference) | [English](/en/api_reference) | 日本語 + +- [LCD](ja/api_reference/api_lcd) \ No newline at end of file diff --git a/docs/ja/api_reference/api_lcd.md b/docs/ja/api_reference/api_lcd.md index fde1128d..d94e2554 100644 --- a/docs/ja/api_reference/api_lcd.md +++ b/docs/ja/api_reference/api_lcd.md @@ -1,6 +1,6 @@ # LCD -### buildAllPlatforms + \ No newline at end of file diff --git a/docs/ja/faq.md b/docs/ja/faq.md index c2acf7c4..87dc014d 100644 --- a/docs/ja/faq.md +++ b/docs/ja/faq.md @@ -1,4 +1,4 @@ -# M5Stack +# よくある質問 [中文](/zh_CN/faq) | [English](/en/faq) | 日本語 diff --git a/docs/ja/m5stack_cases.md b/docs/ja/m5stack_cases.md index b5c5b505..c32e8d82 100644 --- a/docs/ja/m5stack_cases.md +++ b/docs/ja/m5stack_cases.md @@ -1,3 +1,96 @@ -# M5Stack Cases +# M5Stack アプリケーション -## (近日公開...) +[中文](/zh_CN/m5stack_cases) | [English](/en/m5stack_cases) | 日本語 + +## STEM 教育例 + +## M5Stack を利用した素晴らしいアプリケーション + +- [M5Stack-SD-Updater](https://github.com/tobozo/M5Stack-SD-Updater) + - M5Stack向けのカスタマイズ可能なメニューシステム + - メニューからマイクロSDカード内のアプリを読み込み + +- [TFT_eSPI](https://github.com/Bodmer/TFT_eSPI) + - ESP8266/ESP32 向けのTFTライブラリ + - さまざななドライバICに対応 + +- [M5Widgets](https://github.com/Kongduino/M5Widgets) + - M5Stack向けウィジェット + +- [M5StackSAM](https://github.com/tomsuch/M5StackSAM) + - M5Stack向けシンプルアプリケーションメニューライブラリ + +- [cfGUI](https://github.com/JF002/cfGUI) + - M5Stack向けシンプルGUIライブラリ + +- [GUIslice](https://github.com/ImpulseAdventure/GUIslice) + - 組み込み向け軽量GUIフレームワーク + +- [M5ez](https://github.com/ropg/M5ez) + - M5Stack向けインターフェースビルダーライブラリ + +- [M5Stack MultiApp Advanced](https://github.com/botofancalin/M5Stack-MultiApp-Advanced) + - 便利アプリコレクション + +- [M5Stack ESP32 Oscilloscope](https://github.com/botofancalin/M5Stack-ESP32-Oscilloscope) + - フル機能オシロスコープアプリ + +- [M5Stack-Avatar](https://github.com/meganetaaan/m5stack-avatar) + - M5Stack向けアバターアプリ + +- [M5Stack_CrackScreen](https://github.com/nomolk/M5Stack_CrackScreen) + - M5Stackの画面が割れるアプリ・・・ + +- [M5_Shuttle_Run](https://github.com/n0bisuke/M5_Shuttle_Run) + - シャトルランアプリ + +- [nixietubeM5](https://github.com/drayde/nixietubeM5) + - ニキシー管アプリ + +- [M5Stack_BTCTicker](https://github.com/dankelley2/M5Stack_BTCTicker) + - Coindesk APIを利用したBTCティッカーアプリ + +- [M5Stack_ETHPrice](https://github.com/donma/M5StackWifiSettingWithETHPrice) + - MaicoinのETH価格表示アプリ + +- [M5Stack-PacketMonitor](https://github.com/tobozo/M5Stack-PacketMonitor) + - パケットモニタアプリ + +- [M5-FFT](https://github.com/ElectroMagus/M5-FFT) + - グラフィックイコライザーアプリ + +- [M5Stack_ESP32_radio](https://github.com/anton-b/M5Stack_ESP32_radio) + - MP3ストリームプレイヤーアプリ + +- [mp3-player-m5stack](https://github.com/dsiberia9s/mp3-player-m5stack) + - MP3プレイヤーアプリ + +- [ArduinoWiFiPhotoBackup](https://github.com/moononournation/ArduinoWiFiPhotoBackup) + - 写真バックアップアプリ + +- [M5StackHIDCtrlAltDel](https://github.com/mhama/M5StackHIDCtrlAltDel) + - PCへ CTRL+ALT+DEL 送信アプリ + +- [M5Stack Markdown Web Server](https://github.com/PartsandCircuits/M5Stack-MarkdownWebServer) + - SDカードからマークダウンとアイコンを読み込めるWebサーバアプリ + +- [M5Stack-Tetris](https://github.com/PartsandCircuits/M5Stack-Tetris) + - テトリスアプリ - https://macsbug.wordpress.com/ + +- [M5Stack_FlappyBird_game](https://github.com/pcelli85/M5Stack_FlappyBird_game) + - フラッピーバードアプリ + +- [M5Stack-SpaceShooter](https://github.com/PartsandCircuits/M5Stack-SpaceShooter) + - スペースインベーダーアプリ + +- [M5Stack-Pacman-JoyPSP](https://github.com/tobozo/M5Stack-Pacman-JoyPSP) + - パックマンアプリ + +- [M5Stack-Thermal-Camera](https://github.com/hkoffer/M5Stack-Thermal-Camera-) + - AMG8833サーマルセンサカメラ用アプリ + +- [M5Stack-3DPrintFiles](https://github.com/PartsandCircuits/M5Stack-3DPrintFiles) + - M5Stack向けの3Dプリントデータ + +- [truetype2gfx](https://github.com/ropg/truetype2gfx) + - TrueType フォントを Adafruit GFX へコンバートするアプリ diff --git a/docs/ja/product_documents.md b/docs/ja/product_documents.md index 71555d0b..2c58117b 100644 --- a/docs/ja/product_documents.md +++ b/docs/ja/product_documents.md @@ -1,6 +1,6 @@ # 製品ドキュメント -[中文](zh_CN/product_documents) | [English](/en/product_documents) | 日本語 +[中文](/zh_CN/product_documents) | [English](/en/product_documents) | 日本語 ?> 各製品の使用方法は、製品の詳細情報の中に記載されています。 @@ -44,8 +44,8 @@ | | | | |:---:|:---:|:---:| -| [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) | / | +| [LEGO-CABLE](ja/product_documents/accessories/cables/accessory_lego_cable) | [FRAME](ja/product_documents/accessories/frame) | [Headers Socket](ja/product_documents/accessories/headers_socket) | +| [GROVE-CABLE](ja/product_documents/accessories/cables/accessory_grove_cable) | [USB-TTL UART Serial Adapter](ja/product_documents/accessories/usb_uart_adapter) | / | @@ -57,7 +57,7 @@ | [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) | / | / | +| [EARTH](ja/product_documents/units/unit_moisture) | / | / | | [LIGHT](ja/product_documents/units/unit_light) | / | / | | [MAKEY](ja/product_documents/units/unit_makey) | / | / | | [BUTTON](ja/product_documents/units/unit_button) | / | / | diff --git a/docs/ja/quick_start.md b/docs/ja/quick_start.md index 10efbe0d..22d22fa1 100644 --- a/docs/ja/quick_start.md +++ b/docs/ja/quick_start.md @@ -1,47 +1,49 @@ # クイックスタート -**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.** +[中文](/zh_CN/quick_start) | [English](/en/quick_start) | 日本語 + +**このページはM5Stack開発のためのソフトウェア環境（Arduino/MicroPython）構築支援のページです。開発方法や、ファームウェアやソースファイルをM5Stackに書き込む方法を簡単な例を通して説明していきます。** ## イントロダクション -**M5 stack is a modular stackable development device. The M stands for Modular and 5 stands for the the units compact 5 x 5 cm size.** +**M5Stackはモジュール積み重ねるタイプの開発デバイスです。M5Stackの名前はModuleのM、5x5cmサイズの5、積み重ねるを意味するStackからきています。** -## What You Need +## 必要なもの -To develop applications for M5Stack Core you need: +M5Stackを使った開発に必要なもの: -* **PC** loaded with either Windows, Linux or Mac operating system -* a **Type-C** cable +* **PC** Windows、Mac、LinuxいずれかのOSがインストールされていること +* **USB Type-C ケーブル** -Before setting development environment, the step below you need to follow: +開発環境構築の前に次の手順を行なってください。 -1. Establish **serial** connection +1. **シリアル接続** の確立 - [How to Establish serial connection](/en/related_documents/establish_serial_connection) + [シリアル接続の確立方法](ja/related_documents/establish_serial_connection) -## Quick Start +## クイックスタート -!> **Notice** Make sure you have installed USB driver so that your board can establish serial connection with PC. If not, please view this article [How to Establish serial connection](/en/related_documents/establish_serial_connection) for connection. +!> **注意** すでにシリアルドライバをインストールしている場合、PCとのシリアル接続が確立しているか確認してください。もしうまくいかない場合は次のページを参照してください。 [シリアル接続の確立方法](/en/related_documents/establish_serial_connection) -At the first time, you need to burn the specific firmware file(.bin) to your board following this article [How to burn firmware](/en/related_documents/how_to_burn_firmware) befor developing it. +最初に特定のファームウェアファイルを(.bin)をあなたのM5Stackに書き込む必要があります。 開発の前にこちらのページを参照してください。[ファームウェアの更新方法](/ja/related_documents/how_to_burn_firmware) -If you have one of ESP32 development boards listed below, click the corresponding one to start your development. +以下のリストから、あなたの持っているM5Stackに合わせてコースを選択してください。 | | ---|---|--- -[M5StackCore](/en/quick_start/m5core/m5stack_core_quick_start) | [M5Camera](/en/quick_start/m5camera/m5camera_quick_start) | [M5BALA](/en/quick_start/bala/bala_quick_start) +[M5StackCore](/ja/quick_start/m5core/m5stack_core_quick_start) | [M5Camera](/ja/quick_start/m5camera/m5camera_quick_start) | [M5BALA](/ja/quick_start/bala/bala_quick_start) - -## Related Documents +## 関連するドキュメント -- [establish_serial_connection](/en/related_documents/establish_serial_connection) -- [how_to_burn_firmware](/en/related_documents/how_to_burn_firmware) -- [how_to_connect_wifi_using_core](/en/related_documents/how_to_connect_wifi_using_core) -- [upgrade_m5stack_lib](/en/related_documents/upgrade_m5stack_lib) \ No newline at end of file +- [シリアル接続の確立方法](/ja/related_documents/establish_serial_connection) +- [ファームウェアの更新方法](/ja/related_documents/how_to_burn_firmware) +- [M5StackのWi-Fi接続方法](/ja/related_documents/how_to_connect_wifi_using_core) +- [Arduino IDE内のM5Stackライブラリの更新方法](/ja/related_documents/upgrade_m5stack_lib) \ No newline at end of file diff --git a/docs/ja/related_documents.md b/docs/ja/related_documents.md index 152edff9..32375884 100644 --- a/docs/ja/related_documents.md +++ b/docs/ja/related_documents.md @@ -1,11 +1,9 @@ # その他のドキュメント -### [1. シリアル接続の確立方法](ja/related_documents/establish_serial_connection) +[中文](/zh_CN/related_documents) | [English](/en/related_documents) | 日本語 -### [2. ファームウェアの更新方法](ja/related_documents/how_to_burn_firmware) - -### [3. M5StackのWi-Fi接続方法](ja/related_documents/how_to_connect_wifi_using_core) - -### [4. GitとArduino IDEのインストール方法](ja/related_documents/how_to_install_git_and_arduino) - -### [5. Arduino IDE内のM5Stackライブラリの更新方法](ja/related_documents/upgrade_m5stack_lib) +1. [シリアル接続の確立方法](ja/related_documents/establish_serial_connection) +2. [ファームウェアの更新方法](ja/related_documents/how_to_burn_firmware) +3. [M5StackのWi-Fi接続方法](ja/related_documents/how_to_connect_wifi_using_core) +4. [GitとArduino IDEのインストール方法](ja/related_documents/how_to_install_git_and_arduino) +5. [Arduino IDE内のM5Stackライブラリの更新方法](ja/related_documents/upgrade_m5stack_lib) diff --git a/docs/ja/sidebar.md b/docs/ja/sidebar.md index 811e9b9e..88d332ee 100644 --- a/docs/ja/sidebar.md +++ b/docs/ja/sidebar.md @@ -1,7 +1,7 @@ - [製品ドキュメント](ja/product_documents) - [クイックスタート](ja/quick_start) - [API リファレンス](ja/api_reference) -- [M5Stack 応用例](ja/m5stack_cases) +- [M5Stack アプリケーション](ja/m5stack_cases) - [その他のドキュメント](ja/related_documents) - [よくある質問](ja/faq) diff --git a/docs/zh_CN/api_reference.md b/docs/zh_CN/api_reference.md index e0d726d1..3e9361ea 100644 --- a/docs/zh_CN/api_reference.md +++ b/docs/zh_CN/api_reference.md @@ -1 +1,5 @@ -[LCD](zh_CN/api_reference/api_lcd) \ No newline at end of file +# API Reference + +中文 | [English](/en/api_reference) | [日本語](/ja/api_reference) + +- [LCD](zh_CN/api_reference/api_lcd) \ No newline at end of file diff --git a/docs/zh_CN/faq.md b/docs/zh_CN/faq.md index e6dc0d13..894ca90d 100644 --- a/docs/zh_CN/faq.md +++ b/docs/zh_CN/faq.md @@ -1,3 +1,5 @@ # 常见问题解答 +中文 | [English](/en/faq) | [日本語](/ja/faq) + ## （在编辑中...） \ No newline at end of file diff --git a/docs/zh_CN/m5stack_cases.md b/docs/zh_CN/m5stack_cases.md index d6ca2bee..d145673d 100644 --- a/docs/zh_CN/m5stack_cases.md +++ b/docs/zh_CN/m5stack_cases.md @@ -1,5 +1,7 @@ # M5Stack案例 +中文 | [English](/en/m5stack_cases) | [日本語](/ja/m5stack_cases) + ## STEM Education案例 ## M5Stack优秀作品 diff --git a/docs/zh_CN/practice.md b/docs/zh_CN/practice.md index 591b20a7..e929507d 100644 --- a/docs/zh_CN/practice.md +++ b/docs/zh_CN/practice.md @@ -1,5 +1,7 @@ # 练习(ractice) +中文 | [English](/en/practice) | [日本語](/ja/practice) + | | ---|---|--- [M5StackCore](establish_serial_connection) | [M5Camera](establish_serial_connection) | [M5BALA](establish_serial_connection) \ No newline at end of file diff --git a/docs/zh_CN/quick_start.md b/docs/zh_CN/quick_start.md index 3fa89a9f..8ef6ef4f 100644 --- a/docs/zh_CN/quick_start.md +++ b/docs/zh_CN/quick_start.md @@ -1,5 +1,7 @@ # 快速上手(Quick Start) +中文 | [English](/en/quick_start) | [日本語](/ja/quick_start) + **这篇文章主要帮助你搭建M5Stack系列产品中Arduino，MicroPython的开发环境，并通过简单的例子引导你学会使用和开发M5Stack的所有产品，实现自己的创意作品。** ## 介绍(Introduction) diff --git a/docs/zh_CN/related_documents.md b/docs/zh_CN/related_documents.md index be3ebbe0..19ca5b62 100644 --- a/docs/zh_CN/related_documents.md +++ b/docs/zh_CN/related_documents.md @@ -1,5 +1,7 @@ # 相关文档 +中文 | [English](/en/related_documents) | [日本語](/ja/related_documents) + ### [1. 如何安装USB驱动并建立与PC的串口通讯](zh_CN/related_documents/establish_serial_connection) ### [2. 如何通过M5Burner烧录固件](zh_CN/related_documents/how_to_burn_firmware)