From 300ac8a83eaa468b90beda827bc025d44cd3e254 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=A1=A9=E5=85=A5=E5=AD=94=E7=AB=A0?=
 <salty_good@icloud.com>
Date: Wed, 27 Feb 2019 14:11:30 +0800
Subject: [PATCH] update api tf card

---
 docs/en/api.md       |  4 +--
 docs/en/api/tf.md    | 80 +++++++++++++++++++++++++-------------------
 docs/ja/api/tf.md    | 80 +++++++++++++++++++++++++-------------------
 docs/zh_CN/api/tf.md | 36 ++++++++++----------
 4 files changed, 110 insertions(+), 90 deletions(-)

diff --git a/docs/en/api.md b/docs/en/api.md
index 68a8f758..fae0ae40 100644
--- a/docs/en/api.md
+++ b/docs/en/api.md
@@ -5,8 +5,8 @@
 |||
 |:---:|:---:|
 |**[System](en/api/system)** | **[Speaker](en/api/speaker)** |
-|**[LCD](en/api/lcd)** | **[ボタン](en/api/button)** |
-|**[IMU sensor(MPU9250)](en/api/mpu9250)** | **[TF Card](en/api/tf)** |
+|**[LCD](en/api/lcd)** | **[Button](en/api/button)** |
+|**[IMU sensor(MPU9250)](en/api/mpu9250)** | **[TF card](en/api/tf)** |
 
 <!-- ## [LCD](en/api_reference/micropython/api_lcd) -->
 <!-- ## [Peripherals](en/api_reference/peripherals/api_gpio)
diff --git a/docs/en/api/tf.md b/docs/en/api/tf.md
index 37292231..0f9acb1d 100644
--- a/docs/en/api/tf.md
+++ b/docs/en/api/tf.md
@@ -1,62 +1,72 @@
-# TF 卡
+# TF card
 
 ## begin()
 
-**函数原型：**
+**Syntax:**
 
-<mark>begin(cspin);</mark>
+```arduino
+boolean begin(uint8_t cspin);
+```
 
-**功能：TF 卡初始化。**
+**Description:**
 
-| 参数 | 描述 |
-| --- | --- |
-| cspin | TF 的片选引脚 (默认是 SPI 的 SS 引脚)，可选 |
+This function initialize TF card.
+
+| Argument | Description | Type |
+| --- | --- | -- |
+| cspin | chip select line (defaults SS line of SPI bus) | uint8_t |
+
+**Sample:**
 
-**例程**
 ```arduino
 #include <M5Stack.h>
 
-M5.begin();
-
-SD.begin();
+void setup() {
+  SD.begin();
+}
 ```
 
 ## open()
 
-**函数原型：**
+**Syntax:**
 
-<mark>File open(const char *filepath, uint8_t mode;</mark>
+```arduino
+File open(const char *filename, uint8_t mode = FILE_READ);
+```
 
-**功能：以指定模式打开指定文件。返回值：文件句柄。**
+**Description:**
 
-| 参数 | 描述 |
-| --- | --- |
-| filepath | 文件路径 |
-| mode | 打开模式 |
+This function open the file.
+
+| Argument | Description | Type |
+| --- | --- | -- |
+| filepath | path to file | const char * |
+| mode | read / write / rw (optional) | uint8_t |
+
+**Sample:**
 
-**例程**
 ```arduino
 /*
-    提前通过 PC 将 datalog.txt 文件拷贝到 TF 卡内
+display contents of hello.txt in TF card to M5 screen.
 */
 #include <M5Stack.h>
 
-void setup(){
-    M5.begin();
-    Serial.begin(115200);
-    if (!SD.begin(chipSelect)) {
-        Serial.println("Card failed, or not present");
-        while(1);
-    }
-    Serial.println("card initialized.");
-    File dataFile = SD.open("/datalog.txt", FILE_WRITE);
-    if (dataFile)
-        Serial.println("open datalog.txt successfully");
-    else
-        Serial.println("error opening datalog.txt");
+void setup() {
+  M5.begin();
+  if (!SD.begin()) {
+    M5.Lcd.println("Card failed, or not present");
+    while (1);
+  }
+  Serial.println("TF card initialized.");
+  File f = SD.open("/hello.txt", FILE_READ);
+  if (f) {
+    M5.Lcd.print(f.read());
+    f.close();
+  } else {
+    M5.Lcd.println("open error hello.txt");
+  }
 }
 
-void loop(){
-
+void loop() {
 }
 ```
diff --git a/docs/ja/api/tf.md b/docs/ja/api/tf.md
index 37292231..ce8b55ba 100644
--- a/docs/ja/api/tf.md
+++ b/docs/ja/api/tf.md
@@ -1,62 +1,72 @@
-# TF 卡
+# TF card
 
 ## begin()
 
-**函数原型：**
+**説明:**
 
-<mark>begin(cspin);</mark>
+TFカード機能が使用可能になります。
 
-**功能：TF 卡初始化。**
+**構文:**
 
-| 参数 | 描述 |
-| --- | --- |
-| cspin | TF 的片选引脚 (默认是 SPI 的 SS 引脚)，可选 |
+```arduino
+boolean begin(uint8_t cspin);
+```
+
+| 引数 | 説明 | 型 |
+| --- | --- | -- |
+| cspin | chip select line (defaults SS line of SPI bus) | uint8_t |
+
+**使用例:**
 
-**例程**
 ```arduino
 #include <M5Stack.h>
 
-M5.begin();
-
-SD.begin();
+void setup() {
+  SD.begin();
+}
 ```
 
 ## open()
 
-**函数原型：**
+**説明:**
 
-<mark>File open(const char *filepath, uint8_t mode;</mark>
+ファイルを開きます。
 
-**功能：以指定模式打开指定文件。返回值：文件句柄。**
+**構文:**
 
-| 参数 | 描述 |
-| --- | --- |
-| filepath | 文件路径 |
-| mode | 打开模式 |
+```arduino
+File open(const char *filename, uint8_t mode = FILE_READ);
+```
+
+| 引数 | 説明 | 型 |
+| --- | --- | -- |
+| filepath | path to file | const char * |
+| mode | read / write / rw (optional) | uint8_t |
+
+**使用例:**
 
-**例程**
 ```arduino
 /*
-    提前通过 PC 将 datalog.txt 文件拷贝到 TF 卡内
+M5にTFカードのhello.txtの中身を表示する。
 */
 #include <M5Stack.h>
 
-void setup(){
-    M5.begin();
-    Serial.begin(115200);
-    if (!SD.begin(chipSelect)) {
-        Serial.println("Card failed, or not present");
-        while(1);
-    }
-    Serial.println("card initialized.");
-    File dataFile = SD.open("/datalog.txt", FILE_WRITE);
-    if (dataFile)
-        Serial.println("open datalog.txt successfully");
-    else
-        Serial.println("error opening datalog.txt");
+void setup() {
+  M5.begin();
+  if (!SD.begin()) {
+    M5.Lcd.println("Card failed, or not present");
+    while (1);
+  }
+  Serial.println("TF card initialized.");
+  File f = SD.open("/hello.txt", FILE_READ);
+  if (f) {
+    M5.Lcd.print(f.read());
+    f.close();
+  } else {
+    M5.Lcd.println("open error hello.txt");
+  }
 }
 
-void loop(){
-
+void loop() {
 }
 ```
diff --git a/docs/zh_CN/api/tf.md b/docs/zh_CN/api/tf.md
index 37292231..afdf04ac 100644
--- a/docs/zh_CN/api/tf.md
+++ b/docs/zh_CN/api/tf.md
@@ -16,9 +16,9 @@
 ```arduino
 #include <M5Stack.h>
 
-M5.begin();
-
-SD.begin();
+void setup() {
+  SD.begin();
+}
 ```
 
 ## open()
@@ -41,22 +41,22 @@ SD.begin();
 */
 #include <M5Stack.h>
 
-void setup(){
-    M5.begin();
-    Serial.begin(115200);
-    if (!SD.begin(chipSelect)) {
-        Serial.println("Card failed, or not present");
-        while(1);
-    }
-    Serial.println("card initialized.");
-    File dataFile = SD.open("/datalog.txt", FILE_WRITE);
-    if (dataFile)
-        Serial.println("open datalog.txt successfully");
-    else
-        Serial.println("error opening datalog.txt");
+void setup() {
+  M5.begin();
+  if (!SD.begin()) {
+    M5.Lcd.println("Card failed, or not present");
+    while (1);
+  }
+  Serial.println("TF card initialized.");
+  File f = SD.open("/hello.txt", FILE_READ);
+  if (f) {
+    M5.Lcd.print(f.read());
+    f.close();
+  } else {
+    M5.Lcd.println("open error hello.txt");
+  }
 }
 
-void loop(){
-
+void loop() {
 }
 ```