m5/m5-docs
0
0
Fork 0
mirror of https://github.com/m5stack/m5-docs.git synced 2026-05-20 10:23:01 -07:00
Code Issues Packages Projects Releases Wiki Activity

Add related documents in Japanese

Browse Source
This commit is contained in:
塩入孔章
2018-11-27 19:11:58 +08:00
parent 8d76c8e649
commit 58716bfb5e
18 changed files with 741 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/assets/img/getting_started_pics/how_to_burn_firmware/mac_firmware_01.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 13 KiB

docs/assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/uiflow_01.jpg
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 280 KiB

docs/ja/quick_start/bala/bala_quick_start.md
+3
View File
@@ -0,0 +1,3 @@
# BALA Get Started
## (coming soon...)
docs/ja/quick_start/faces/gameboy_burn_a_nes_game.md
+45
View File
@@ -0,0 +1,45 @@
# Burn A NES Game
*This document will help you for burning a gameboy game(NES file) so that you can play a game with GameBoy Keyboard.*
## CONTENT
1. [Download firmware](#1-download-firmware)
2. [Burn Game file](#2-burn-Game-file)
3. [Reset you device](#3-reset-you-device)
## 1. Download firmware
Download the gameboy simulator firmware named `firmware.zip` from [Github](https://github.com/m5stack/M5Stack-nesemu). And unpack `firmware.zip`.
<figure>
<img src="assets/img/getting_started_pics/faces/download_from_github.png">
</figure>
<figure>
<img src="assets/img/getting_started_pics/faces/unpack_firmware.png">
</figure>
## 2. Burn Game file
Open Flash Download Tools[点击下载](https://www.espressif.com/sites/default/files/tools/flash_download_tools_v3.6.4.rar>) apply by Espressif, choose `ESP32 DownloadTool` option, choose 4 files, and execute **step 2-4** ( *choose firmware file, your serial port, erase and program flash* )
<figure>
<img src="assets/img/getting_started_pics/faces/chose_files.png">
</figure>
<figure>
<img src="assets/img/getting_started_pics/faces/download_it.png">
</figure>
## 3. Reset you device
After reset FACES, enjoy your game now.
<figure>
<img src="assets/img/product_pics/core/faces_kit/gameboy_01.jpg">
</figure>
?> Tip **If you want another game, please change the `Game file`(.nes)**
docs/ja/quick_start/m5camera/m5camera_quick_start.md
+31
View File
@@ -0,0 +1,31 @@
# ESP32Cam/M5Camera Quick Start
## 1. Out-of-the-box Demo
It is really really out of the box. Your ESP32Cam/M5Camera will immediately run without any code after you power it.
1. plug usb cable into ESP32Cam/M5Camera and open the serial terminal on your computer.
<figure>
<img src="assets/img/getting_started_pics/get_started_with_unit/ESP32CAM_Terminal.png">
</figure>
2. Then waitting a few seconds, you connect to a AP named "`M5CAM`" with your computer(or mobile phone).
<figure>
<img src="assets/img/getting_started_pics/get_started_with_unit/ESP32CAM_M5CAM.png">
</figure>
3. And you open the browser on the computer(or mobile phone), enter a URL `http://192.168.4.1`. At the moment, your can see the real-time transmission of video by ESP32Cam/M5Camera on the browser.
<figure>
<img src="assets/img/getting_started_pics/get_started_with_unit/ESP32CAM_Browser.png">
</figure>
Now, A WebCam you achieved successfully !
*Note:*
ESP32CAM AP only can connect with one device at a time.
docs/ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md
+133
View File
@@ -0,0 +1,133 @@
# M5Core Quick Start(macOS, Arudino)
?> **Tip** If your OS is Windows, please click [here](/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows).
## CONTENT
1. [Setting Environment](#setting-environment)
- [Step1. Install Arduino IDE](#step1-install-arduino-ide)
- [Step2. ESP32 Board Support](#step2-esp32-board-support)
- [Step3. Install M5Stack Lib](#step3-install-m5stack-lib)
2. [Example](#example)
!> **Note** *Before setting the development environment, we suggest you confirm whether the USB driver has installed. If not, please visit this link [establish serial connection](/en/related_documents/establish_serial_connection).*
## Setting Environment
### Step1. Install `Arduino IDE`
First, if Arudino IDE is not installed, install it. It's *download address* is https://www.arduino.cc/en/Main/Software
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/mac/macOS_download_arduino_ide.png">
</figure>
### Step2. ESP32 Board Support
Open Terminal and execute the following command (copy->paste and hit enter):
```
mkdir -p ~/Documents/Arduino/hardware/espressif && \
cd ~/Documents/Arduino/hardware/espressif && \
git clone https://github.com/espressif/arduino-esp32.git esp32 && \
cd esp32 && \
git submodule update --init --recursive && \
cd tools && \
python get.py
```
Where ~/Documents/Arduino represents your sketch book location as per "Arduino" > "Preferences" > "Sketchbook location" (in the IDE once started). Adjust the command above accordingly if necessary!
Where ~/Documents/Arduino represents your default sketch book location. If you encounter any problems it could be that your Arduino sketchbook folder is in a different location. This can be found by running arduino and navigating through the menu to "Arduino" > "Preferences" > "Sketchbook location". Adjust the command above accordingly if necessary!
?> **Tip** If you get the error below: `xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools),`
`missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun`, install the command line dev tools by typing `xcode-select --install` into the terminal and hit enter. once installed try the command above again and restart the Arduino IDE.
?> **Tip** If you get the error: `IOError: [Errno socket error] [SSL: TLSV1_ALERT_PROTOCOL_VERSION] tlsv1 alert protocol` `version (_ssl.c:590) when running python get.py`, try `python3` instead of `python` and restart the Arduino IDE.
### Step3. Install M5Stack Lib
Start up Arduino IDE, then Select `Sketch`->`Include Library`->`Manage Libraries...`
Type `M5Stack` into the search box, search it and install.
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/mac/macOS_install_m5stack_lib.png">
</figure>
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/mac/macOS_search_m5stack.png">
</figure>
## Example
The USB cable connects to M5Stack Core, then select your serial port which is connected M5Stack Core.
Select a demo example, compile and upload
### 1. Select your board and the serial port
Start up Arduino IDE, and click `Tools -> Boards -> M5Stack-Core-ESP32` to select your board
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/mac/macOS_select_board.png">
</figure>
Click `Tools -> Ports ->` to select the serial port which is connected with M5Stack Core
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/mac/macOS_select_serial_port.png">
</figure>
### 2. Select an example
Click `File-> Examples`. Here are some test programs in `M5Stack->`
Try to open a sketch called `HelloWorld` inside Basics.
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/mac/macOS_select_example.png">
</figure>
Compile it and upload, the M5Stack screen will show "Hello World!"
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/mac/display_hello_world.png">
</figure>
## Note
Although most versions of MacOS have no problem with detecting the COM port, on some newer versions of High Sierra sometimes Slab\_USBtoUART does not appear. If this is the case, after you connect the M5 open `security and privacy` in the system preferences and set it to `permit`.
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/mac/macOS_security_and_privacy.png">
</figure>
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/mac/macOS_security_and_privacy_01.png">
</figure>
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/mac/macOS_security_and_privacy_02.png">
</figure>
?> **Tip** **If you want to read more the permission about the CP2104 USB driver, visit the below link please.** https://developer.apple.com/library/archive/technotes/tn2459/\_index.html
docs/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md
+121
View File
@@ -0,0 +1,121 @@
# M5Core Quick Start(Windows, Arudino)
?> **Tip** If your OS is MacOS, please click [here](/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS).
## CONTENT
1. [Setting Environment](#setting-environment)
- [Step1. Download Arduino-ESP32 Support](#step1-download-arduino-esp32-suppord)
- [Step2. Download the M5Stack Lib](#step2-download-the-m5stack-lib)
2. [Example](#example)
?> **Tip** *If you want to upgrade the M5Stack Lib, please view this article [upgrade M5Stack Lib](/en/related_documents/upgrade_m5stack_lib).*
!> **Note** *We suggest you confirm whether the `USB driver`, `Git` and `Arduino IDE(Installation path: C:\Program Files\Arduino)` has installed first. If not, please view this two articles [establish serial connection](/en/related_documents/establish_serial_connection) and [Install Git and Arduino IDE](/en/related_documents/how_to_install_git_and_arduino). If your arduino installation path is not `C:\Program Files\Arduino`, reinstall this IDE please with default path setting.*
## 1. Setting Environment
#### (*Only two steps to complete setting*)
### Step1. Download Arduino-ESP32 Support
Download the batch file [download_arduino_esp32_support.bat](https://github.com/m5stack/m5stack-documentation/blob/master/en/get-started/download_arduino_esp32_support.bat), and execte it as Administrator.
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/execute_batch_file.png">
</figure>
Then this a new window will appear as shown below.
Please waiting for cloning...
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/execute_batch_file_for_downloading_arduino_esp32.png">
</figure>
When completed, it will show below.
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/download_arduino_esp32_completed.png">
</figure>
### Step2. Download the M5Stack Lib
Open Arduino IDE, then Select `Sketch`->`Include Library`->`Manage Libraries...`
Search `M5Stack` and install it
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/install_m5stack_lib_01.png">
</figure>
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/install_m5stack_lib_02.png">
</figure>
!> **Note:** *As shown below, it means you need update*
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/update_m5stack_lib.png">
</figure>
## Example
This section for verifying whether you can program with Arduino or not. Now, The USB cable connects to M5Stack Core, then select your serial port which is connected M5Stack Core.
Select a demo example, compile and upload
### 1. Execute a example likes `FactoryTest.ino`
Select your board name, baudrate, the specified serial port: M5Stack-Core-ESP32, 921600, COM4(Now, my serial port which is connected with PC is `COM4`)
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/select_board_baudrate_serial_port.png">
</figure>
Then select an example likes `FactoryTest.ino`
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/select_an_example.png">
</figure>
Upload it
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/arduino_upload.png">
</figure>
### 2. New a M5Stack program
Open Arduino IDE, then new a `.ino` file, rename it as `my_test.ino`
Copy the below code to my_test.ino
```cpp
#include <M5Stack.h>
// the setup routine runs once when M5Stack starts up
void setup(){tack
// Initialize the M5Stack object
M5.begin();
// LCD display
M5.Lcd.print("Hello World!");
M5.Lcd.print("M5Stack is running successfully!");
}
// the loop routine runs over and over again forever
void loop() {
}
```
compile it and upload, the M5Stack screen will show "Hello World!" "M5Stack is running successfully!"
docs/ja/quick_start/m5core/m5stack_core_get_started_MicroPython.md
+126
View File
@@ -0,0 +1,126 @@
# M5Flow Quick Start(Blockly/MicroPython)
!> **Note** *a. If it's first time to use M5Stack Core or you want to change the networkable AP that means the Core can't access [flow.m5stack.com](flow.m5stack.com), you need visit this article for setting wifi [How to connect wifi using Core](/en/related_documents/how_to_connect_wifi_using_core). b. If *
### **By default, we account your M5Core has been connected with the networkable AP. And the screen shows like this figure below after you pressed the `UPLOAD` button on the left.**
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/apikey.jpg">
</figure>
?> **Note** *After a few seconds if nothing is pressed the M5 will automatically run the code that was previously uploaded. If we want to upload new code we have to make sure we press the `upload` button on this menu before the M5 boots the code in it’s memory.*
## CONTENT
1. [Connect to M5Flow](#connect-to-m5flow)
2. [Program with Core](#program-with-core)
3. [Play a song now](#play-a-song-now)
## 1. Connect to M5Flow
1. Now you scan the QR code with your phone or tablet to start programming on your mobile device. If you want to program the M5 from your computer, enter the url shown at the top of the screen `flow.m5stack.com`
It will show as following figure.
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/webide.png">
</figure>
2. Whenever we want to upload code to the M5 from UI flow we need to make sure the device is paired.
So press the little gear in the top right corner of the screen and enter the `APIKEY` which shows on the screen of M5(Now, my APIKEY is `9C6469`) and click `SAVE`.
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/click_for_apikey.png">
</figure>
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/input_apikey.png">
</figure>
Then M5Flow will connect with this Core.
At the moment, you can draw a UI or program it through Blockly(or Python) as shown below.
## 2. Program with Core
### a. Draw a UI
Drag 4 kinds of elements into `M5Stack Core` UI and click `Run` buttom on M5UI.Flow
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/draw_ui.png">
</figure>
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/run_and_upload.png">
</figure>
### b. Program with Blockly
Drag a block named `Set emoji map in0` from `Emoji` class and click `Run` buttom on M5UI.Flow
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/draw_heart.png">
</figure>
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/run_and_upload.png">
</figure>
### c. Program with MicroPython
Copy the following codes, and paste them to `Python coding area`, and click `Run` button.
```Python
from m5stack import *
from m5ui import *
clear_bg(0x111111)
btnA = M5Button(name='ButtonA', text='ButtonA', visibility=False)
btnB = M5Button(name='ButtonB', text='ButtonB', visibility=False)
btnC = M5Button(name='ButtonC', text='ButtonC', visibility=False)
lcd.print("Hello M5Stack")
```
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/program_with_micropython.png">
</figure>
At that moment, the screen of M5Core will display `Hello M5Stack`.
## 3. Play a song now
Now, let's make a music player and play a song in a few minutes using M5Stack Core.
Drag a `loop`, `music` and `timer` block into the coding area from the components section.
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/drag_loop_block.png">
</figure>
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/drag_music_block.png">
</figure>
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/drag_timer_block.png">
</figure>
Then set parameters of `music block` and `timer block` as shown belown.
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/whole_program.png">
</figure>
Now, run it and enjoy your musical work!
## Complete
?> **Note** *Also, For being more familiar with M5, you can contact us for a WorkShop <support@m5stack.com>*
docs/ja/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md
+154
View File
@@ -0,0 +1,154 @@
# M5Cloud Quick Start(MicroPython)
?> **Note** *If it's first time to use M5Core or you want to change the networkable AP that means the Core can't access [http://cloud.m5stack.com](http://cloud.m5stack.com), you need visit this article for setting wifi [How to connect wifi using Core with M5Cloud](/en/related_documents/how_to_connect_wifi_using_core_with_m5cloud).*
*By default, we consider your M5Core has been connected with the networkable AP successfully. And the screen shows like this figure below.*
<figure>
<img src="assets/img/getting_started_pics/get_started_with_m5cloud/check_code_on_m5stack.png">
</figure>
## CONTENT
1. [Connect to M5Cloud](#connect-to-m5cloud)
2. [Binding device](#binding-device)
3. [Program with Core](#program-with-Core)
## 1. Connect to M5Cloud
Now If you want to program the M5 from your computer, enter the url shown at the top of the screen `cloud.m5stack.com`
It will show as following figure.
<figure>
<img src="assets/img/getting_started_pics/get_started_with_m5cloud/register_page_m5cloud.png">
</figure>
Now, register a account.
## 2. Binding device
Press `Device`->`Add` buttom on M5Cloud IDE for binding M5Stack board to your account.(Now, my check code is `052879`)
<figure>
<img src="assets/img/getting_started_pics/get_started_with_m5cloud/webIDE_binding_device_interface.png">
</figure>
<figure>
<img src="assets/img/getting_started_pics/get_started_with_m5cloud/WebIDE_check_code.png">
</figure>
At the moment, you can program it through Python as shown below.
## 2. Program with Core
### a. New a Project
<figure>
<img src="assets/img/getting_started_pics/get_started_with_m5cloud/new_a_faces_prj.png">
</figure>
### a. Code it
*Now, let's get started with FACES Kit.*
After creating a new project, add a file named `faces.py` as a python module.
<figure>
<img src="assets/img/getting_started_pics/get_started_with_m5cloud/add_file.png">
</figure>
<figure>
<img src="assets/img/getting_started_pics/get_started_with_m5cloud/rename_file.png">
</figure>
Then copy following code into faces.py and main.py, and save they.
```Python
"""
File name: faces.py
M5Stack MicroPython FACES keyboard I2C driver
"""
class Faces:
def __init__(self, i2c=None):
if i2c == None:
from machine import I2C, Pin
self.i2c = I2C(sda=21, scl=22)
else:
self.i2c = i2c
self.addr = 0x08
self.cb = None
def read(self):
return self.i2c.readfrom(self.addr, 1)
def _callback(self, pin):
from machine import Pin
if pin == Pin(5):
self.cb(self.read())
def callback(self, cb):
from machine import Pin
self.pin = Pin(5)
self.pin.init(Pin.IN)
self.pin.irq(trigger=Pin.IRQ_FALLING, handler=self._callback)
self.cb = cb
```
<figure>
<img src="assets/img/getting_started_pics/get_started_with_m5cloud/faces_py_file.png">
</figure>
```Python
"""
File name: main.py
"""
from m5stack import *
from faces import Faces
keyboard = Faces()
# read once
print("Key value:", end='')
print(keyboard.read())
# callback
def keyboard_cb(value):
print("Key value:", end='')
print(value)
lcd.print(value)
keyboard.callback(keyboard_cb)
```
<figure>
<img src="assets/img/getting_started_pics/get_started_with_m5cloud/final_result.png">
</figure>
<figure>
<img src="assets/img/getting_started_pics/get_started_with_m5cloud/save_file.png">
</figure>
Now, upload and run it!
<figure>
<img src="assets/img/getting_started_pics/get_started_with_m5cloud/upload_it.png">
</figure>
## Complete
The function of This demostration is that screen and serial terminal will display the value of the key you pressed.
Now, I press the first line of QWERTY Keyboard. ("q", "w", "e", "r", "t", "y", "u", "i", "o", "p")
<figure>
<img src="assets/img/getting_started_pics/get_started_with_m5cloud/result.png">
</figure>
docs/ja/quick_start/m5core/m5stack_core_quick_start.md
+7
View File
@@ -0,0 +1,7 @@
# M5Stack Core Get Started
## Pick up your programming mode below for getting started
<img src="assets/img/getting_started_pics/arduino_logo.png"> | <img src="assets/img/getting_started_pics/blockly_and_micropython.png">
---|---
[Arduino](/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [Blockly/MicroPython](/en/quick_start/m5core/m5stack_core_get_started_MicroPython)
docs/ja/quick_start/m5core/m5stick_get_started_arduino.md
+12
View File
@@ -0,0 +1,12 @@
# M5Stick Quick Start(Arduino)
## 1. Install `U8g2` library
If you have installed `U8g2`, then just run and upload your m5stick's poject.
If not, then open Arduino IDE, and click `Sketch`->`Include Library`->`Manage Libraries...` for installing `U8g2` library
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_m5stick/install_u8g2.png">
</figure>
## 2. Upload your project
docs/ja/related_documents.md
+5 -5
View File
@@ -1,11 +1,11 @@
# その他のドキュメント
### [1. シリアルドライバのインストール方法](ja/related_documents/establish_serial_connection)
### [1. シリアル接続の確立方法](ja/related_documents/establish_serial_connection)
### [2. M5Burnerの使用方法](ja/related_documents/how_to_burn_firmware)
### [2. ファームウェアの更新方法](ja/related_documents/how_to_burn_firmware)
### [3. M5CoreのWi-Fi接続方法](ja/related_documents/how_to_connect_wifi_using_core)
### [3. M5StackのWi-Fi接続方法](ja/related_documents/how_to_connect_wifi_using_core)
### [4. GitとArduinoのインストール方法](ja/related_documents/how_to_install_git_and_arduino)
### [4. GitとArduino IDEのインストール方法](ja/related_documents/how_to_install_git_and_arduino)
### [5. Arduino-M5Stack ライブラリの更新方法](ja/related_documents/upgrade_m5stack_lib)
### [5. Arduino IDE内のM5Stackライブラリの更新方法](ja/related_documents/upgrade_m5stack_lib)
docs/ja/related_documents/establish_serial_connection.md
+16 -18
View File
@@ -1,14 +1,14 @@
# Establish Serial Connection
# シリアル接続の確立方法
**This section provides guidance how to establish serial connection between your board and PC.**
**このページでは、M5StackとPCとの間でシリアル接続を確立するための方法を説明します。**
## For MacOS
## MacOS
### 1. Install the USB driver
### 1. USBドライバをインストール
**[Download the SiLabs CP2104 Driver](https://www.silabs.com/documents/public/software/Mac_OSX_VCP_Driver.zip)**
**[SiLabs CP2104 ドライバ ダウンロード](https://www.silabs.com/documents/public/software/Mac_OSX_VCP_Driver.zip)**
**As the disk image SiLabsUSBDriverDisk.dmg is downloaded, mount it. Proceed according to the instructions OK.**
**ダウンロードした SiLabsUSBDriverDisk.dmg ディスクイメージをクリックし、マウントします。そして、指示に従い、OKをクリックします。**
<figure>
<img src="assets/img/getting_started_pics/establish_serial_connection/macOS_CP2104_dmg.png">
@@ -50,29 +50,27 @@
<img src="assets/img/getting_started_pics/establish_serial_connection/9.png">
</figure>
### 2. Check port on MacOS
### 2. ポート確認
**To check the device name for the serial port of your your board board (or external converter dongle), open terminal and run this command two times, first with the board / dongle unplugged, then with plugged in. The port which appears the second time is the one you need:**
**あなたのPC（の外部コンバータドングル）のシリアルポートのデバイス名を確認するには、ターミナルを開き、M5Stackを取り外した状態で2回、次に接続した状態で2回ずつ実行します。**
**MacOS**
ls /dev/cu.*
## Windows
### 1. USBドライバをインストール
## For Windows
**ダウンロード [SiLabs CP2104 ドライバ ダウンロード](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)**
### 1.Install the USB driver
**Download the [SiLabs CP2104 Driver](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)**
**Choice the version of USB driver according to your windows version(Windows7/8/10).**
**あなたのWindowsのバージョンに合わせて(Windows7/8/10)ドライバをダウンロードしてください。**
<figure>
<img src="assets/img/getting_started_pics/establish_serial_connection/windows_download_CP2104_USB_driver.png">
</figure>
**Choice the right version installer(x64/x86), and install it.**
**自分の使用しているOSに合わせて64bit(x64)/32bit(x86)を選択し、インストーラをクリックします。**
<figure>
<img src="assets/img/getting_started_pics/establish_serial_connection/windows_install_usb_driver01.png">
@@ -86,11 +84,11 @@
<img src="assets/img/getting_started_pics/establish_serial_connection/windows_install_usb_driver03.png">
</figure>
### 2. Check port on Windows
### 2. ポート確認
**Check the list of identified COM ports in the Windows Device Manager. Disconnect your board and connect it back, to verify which port disappears from the list and then shows back again.**
**Windowsのデバイスマネージャからポートを確認することができます。まずデバイスマネージャを開きます。そしてM5Stackを接続すると、デバイスマネージャのリストが更新され、ポートが現れます。**
**Figures below show serial port for M5Stack Core board**
**図のようにシリアルポートが見えるようになります。**
<figure>
<img src="assets/img/getting_started_pics/establish_serial_connection/windows_m5stack_in_device_manager.png">
docs/ja/related_documents/how_to_burn_firmware.md
+55 -23
View File
@@ -1,71 +1,103 @@
# How to Burn Firmware
# ファームウェアの更新方法
**This article will guide you how to burn a right firmware to your board via M5Burner.**
**このページではM5Stackのファームウェアの更新方法を説明します。**
## For MacOS
## MacOS
***(Coming soon...)***
ターミナルを開き、以下のコマンドをコピペして実行していきます。
## For Windows
1. 初めに**pip**をインストールします。（２回目以降はこの作業は不要です）
### 1. Download M5Burner
sudo easy_install pip
For downloading M5Burner, visit the [offical website](http://www.m5stack.com) please.
2. 次に**esptool**をインストールします。（２回目以降はこの作業は不要です）
pip install esptool
3. 次にファームウェアをダウンロードし、解凍します。
mkdir m5burner && \
cd m5burner && \
curl -O http://res.m5stack.com/M5Burner/M5Burner.zip && \
unzip M5Burner.zip
4. 解凍が終わったら、リストを表示します。
ls
<figure class="thumbnails">
<img src="assets/img/getting_started_pics/how_to_burn_firmware/mac_firmware_01.png" alt="firmware_list" title="firmware_list">
</figure>
5. そして書き込みたいファームウェアを選び、ディレクトリを移動します。
cd path/to/firmware/version/
ls
6. flash.sh という名前のファイルがあるところまで移動したら、M5Stackとパソコンの接続を確認し、以下のコマンドを入力します。
sh flash.sh
7. 書き込みが完了したら、M5Stackのリセットボタンを押して、ファームウェアの更新の完了です。
## Windows
### 1. M5Burnerツールのダウンロード
M5Stackの公式サイトへアクセスし、**M5Burner**をダウンロードします。[offical website](http://www.m5stack.com)
<figure class="thumbnails">
<img src="assets/img/getting_started_pics/how_to_burn_firmware/download_M5Burner.png" alt="Screenshot of coverpage" title="Cover page">
</figure>
### 2. Burn the firmware
### 2. ファームウェアの書き込み
Unzip the M5Burner tool which you donwloaded for official website just now, then double click `M5Burner.exe`.
ダウンロードが完了したら、Zipファイルを解凍し、 `M5Burner.exe` をダブルクリックします。
<figure class="thumbnails">
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_01.png" alt="Screenshot of coverpage" title="Cover page">
</figure>
**Then choice the `serial port` which is connected with your board and the `Baud` which is 921600 following below steps.**
**適切な`シリアルポート`を選択し、`Baud`を*921600*に設定します。**
<figure class="thumbnails">
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_02.png" alt="Screenshot of coverpage" title="Cover page">
</figure>
!> **Notice** If it does not display any ``COMx`` port or only ``COM1`` exists at the option, you need to visit this article [establish_serial_connection](/en/related_documents/establish_serial_connection) and reinstall the USB driver.
!> **注意** もし `COMx` が表示されず、`COM1` だけしかない場合は、[シリアル接続の確立方法](/ja/related_documents/establish_serial_connection)を参照し、USBドライバを再インストールしてください。
**a. Choice a right firmware**
**a. ファームウェアを選択**
a. select `M5Flow-vx.x` option(the lastest version), if you want to program with [M5Flow](http://flow.m5stack.com)
例えば、もし[UiFlow](http://flow.m5stack.com)を試したい場合は、`M5Flow-vx.x`オプションを選択してください。
もしESP32CAM(またはM5CAMERA)を試したい場合は、`M5Cam-vx.x (/M5Cam-psram)`オプションを選択してください。
b. select `M5Cam-vx.x (/M5Cam-psram)` option, if you own a ESP32CAM (/ M5CAMERA)
**b. Click `Erase`**
**b. `Erase`をクリック**
<figure class="thumbnails">
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_06.png" alt="Screenshot of coverpage" title="Cover page">
</figure>
*If M5Burner shows the information `Hard resetting via RTS pin...` below, it means chip has been erased successfully.*
*もしM5Burnerに `Hard resetting via RTS pin...` と表示されたら、`Erase(削除)`成功です！*
<figure class="thumbnails">
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_04.png" alt="Screenshot of coverpage" title="Cover page">
</figure>
**c. Click `Burn`**
**c. `Burn`をクリック**
<figure class="thumbnails">
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_03.png" alt="Screenshot of coverpage" title="Cover page">
</figure>
*If M5Burner shows the information `Leaving... Staying in bootloader.` below, it means chip has been burnt successfully.*
*もしM5Burnerに `Leaving... Staying in bootloader.` と表示されたら、書き込み成功です！*
<figure class="thumbnails">
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_05.png" alt="Screenshot of coverpage" title="Cover page">
</figure>
### 3. Then reset your board
### 3. M5Stackをリセット
?> **Tip**
If M5Burner means be busy after clicking `Burn`, please wait for a few minutes. It'll be normal after the firmware has been burnt successfully.
もしM5Burner `Burn`ビジー状態になる場合は、少し時間をおいてください。 ファームウェアの書き込みが終了すると正常に戻ります。
?> **Tip** If the burning procedure has been interrupted(like `M5Burner has been closed suddenly...`), it's better to burn your board again.
?> **Tip** もし途中で書き込みが中断された場合、書き込みをやり直してください。(`M5Burner has been closed suddenly...` などと表示された場合)
docs/ja/related_documents/how_to_connect_wifi_using_core.md
+18 -19
View File
@@ -1,55 +1,54 @@
# How to Connect WIFI Using Core
# M5StackのWi-Fi接続方法
?> **Tip** *If your M5Stack Core was not burnt with a specific firmware named `M5Flow` in advance, please visit this article [How to burn firmware](/en/related_documents/how_to_burn_firmware) for burnning)*
?> **Tip** *もしあなたのM5Stackに`M5Flow`向けのファームウェアが書き込まれていない場合は、あらかじめ、こちらを参考にファームウェアを書き込んでください。[ファームウェアの更新方法](ja/related_documents/how_to_burn_firmware)*
**After powering on Core and pressing the red button on the left hand side of the M5，you will be greeted by this screen. Let's connect to networkable AP.**
**M5Stackの左側にある赤いボタンを押して電源をオンにすると、この画面に遷移します。さぁ、アクセスポイントに接続しましょう！**
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/core_home_page.png">
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/core_home_page.png" width="300">
</figure>
## CONTENT
## 接続の流れ
1. [Press UPLOAD Button](#press-upload-button)
1. [UPLOADボタンを押す](#press-upload-button)
2. [Select Networkable AP](#select-networkable-ap)
2. [アクセスポイントの選択](#select-networkable-ap)
3. [Reset Your Device](#reset-your-device)
3. [デバイスのリセット](#reset-your-device)
## 1. `UPLOAD`ボタンを押す
## 1. Press `UPLOAD` Button
**Now, press the `upload` buttom. The screen will show this message.**
**`UPLOAD`ボタンを押すと、以下のようなメッセージが表示されます。**
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/m5stack_connet_wifi.png">
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/uiflow_01.jpg" width="300">
</figure>
## 2. Select Networkable AP
## 2. アクセスポイントの選択
**Use Mobile Phone or PC for connectting to M5Core AP(like `M5Stack-a67c`), and then open brower to login 192.168.4.1 for setting your networkable WIFI name and password. (Now, my networkable wifi is named `MasterHax_5G`)**
**スマートフォンかPCを使用して、M5Core AP(like `M5Stack-03fc`)に接続します。 それからブラウザを開き、192.168.4.1 にアクセスし、あなたの使用しているネットワークのSSIDとパスワードを入力して`Configure`ボタンをクリックします。 (図の例ではネットワークのSSIDは `MasterHax_5G`です)**
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/input_wifi_password.png">
</figure>
## 3. Reset Your Device
## 3. デバイスのリセット
**After connected wifi successfully, reset your core according to the prompt on `192.168.4.1`**
**Wi-Fiの接続に成功したら、ブラウザの表示に従い、自動的にM5Stackが再起動します。**
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/connect_wifi_successfully.png">
</figure>
## Complete
## 完了
Once you've reset M5Stack Core, pressed the upload buttom, you will arrive at a screen with a QR code. Now, you can try to program with your core following this article [Quick Start with M5Flow](/en/quick_start/m5core/m5stack_core_get_started_MicroPython)
一度M5Stackをリセットして再起動したら、UPLOADボタンを押します。二次元コードが表示される画面に遷移するので、次の記事を参考にして、プログラムをしてみましょう！ [Quick Start with M5Flow](/ja/quick_start/m5core/m5stack_core_get_started_MicroPython)
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/apikey.jpg">
</figure>
?> **Note** Similarly, if you want another networkable WIFI AP to connect with Core, press the SETUP buttom while core was power-up.
?> **Note** もし別のネットワークに接続したい場合は、リセットボタンで再起動をしてから`SETUP`ボタンを押して、再度Wi-Fiの接続設定を行なってください。
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/change_wifi.jpg">
docs/ja/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md
+2 -2
View File
@@ -1,6 +1,6 @@
# How to Connect WIFI (For M5Cloud)
# M5StackのWi-Fi接続方法 (M5Cloud向け)
?> **Tip** *If your M5Stack Core was not burnt with a specific firmware named `M5Cloud` in advance, please visit this article [How to burn firmware](en/related_documents/how_to_burn_firmware) for burnning)*
?> **Tip** *もしあなたのM5Stackにあらかじめ`M5Cloud`向けのファームウェアが書き込まれていない場合は、こちらを参考にファームウェアを書き込んでください。[How to burn firmware](ja/related_documents/how_to_burn_firmware)*
**After powering on Core，you will be greeted by this screen. Let's connect to networkable AP.**
docs/ja/related_documents/how_to_install_git_and_arduino.md
+8 -6
View File
@@ -1,18 +1,20 @@
# How to install Git and Arduino IDE (Windows)
# GitとArduino IDEのインストール方法
## 1. Install `Git`
If you has installed `Git`, please following next setp 2 straight.Otherwise, download the client of [Git](https://git-scm.com/download/win) and install it.
## Windows
## 2. Install `Arduino IDE`
## 1. `Git`のインストール
もし既に `Git` がインストールされている場合は、次のステップへ進んでください。そうでなければ [Git](https://git-scm.com/download/win) をダウンロードし、インストールしてください。
*download address*
## 2. `Arduino IDE`のインストール
*Arduino IDEのダウンロードリンク*
https://www.arduino.cc/en/Main/Software
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/arduino_cc_package.png">
</figure>
Double click to install Arduino IDE
Arduino IDE をダウンロードしたら、インストーラをダブルクリックしてインストールします。
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/select_arduino_install_path.png">
docs/ja/related_documents/upgrade_m5stack_lib.md
+5 -5
View File
@@ -1,16 +1,16 @@
# Upgrade M5Stack Lib
# Arduino IDE内のM5Stackライブラリの更新方法
### 1. Start up Arduino IDE, then Select `Sketch`->`Include Library`->`Manage Libraries...`
### 1. Arduino IDEを起動し、`スケッチ`->`ライブラリをインクルード`->`ライブラリを管理...`
### 2. Type `M5Stack` into the search box, search it.
### 2. 検索ボックスに`M5Stack`と入力し、検索
<figure class="thumbnails">
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/mac/macOS_install_m5stack_lib.png" alt="Screenshot of coverpage" title="Cover page">
</figure>
### 3. If it shows as below figure, click `Update`.
### 3. もし以下のように表示されたら`アップデート`をクリック
**But if it shows `Install`, it means you has not installed M5Stack Lib. So, you need click `Install` for installing lib.**
**もし`インストール`と表示された場合は、まだあなたがM5Stackライブラリをインストールしていない事を意味します。**
<figure class="thumbnails">
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/mac/macOS_search_m5stack.png" alt="Screenshot of coverpage" title="Cover page">