From 20caa9b2f814ed40eccd131f798d7cfd90bc9318 Mon Sep 17 00:00:00 2001 From: vany5921 <908744431@qq.com> Date: Thu, 15 Aug 2019 20:41:29 +0800 Subject: [PATCH] Error modifying format --- docs/en/api.md | 4 +++- docs/en/api/wifi.md | 28 +++++++++++++++++++++++++++- 2 files changed, 30 insertions(+), 2 deletions(-) diff --git a/docs/en/api.md b/docs/en/api.md index 6ae59513..1e928503 100644 --- a/docs/en/api.md +++ b/docs/en/api.md @@ -8,7 +8,8 @@ |**[LCD](en/api/lcd)** | **[Button](en/api/button)** | |**[IMU Sensor(MPU9250)](en/api/mpu9250)** | **[TF Card](en/api/tf)** | |**[Power](en/api/power)** |**[I/O](en/api/gpio)** | -|**[I2C Communication](en/api/commutil)** | | +|**[I2C Communication](en/api/commutil)** | **[WIFI](en/api/wifi)**| +|**[Timer](en/api/ticker)**| ## M5StickC @@ -17,3 +18,4 @@ |:---:|:---:| |**[System](en/api/system_m5stickc)** | **[Power Management(AXP192)](en/api/axp192_m5stickc)** | |**[TFT Screen](en/api/lcd_m5stickc)** | **[IMU(SH200Q)](en/api/sh200q_m5stickc)** | +|**[RTC](en/api/rtc)**| diff --git a/docs/en/api/wifi.md b/docs/en/api/wifi.md index 395f6557..f552645d 100644 --- a/docs/en/api/wifi.md +++ b/docs/en/api/wifi.md @@ -7,6 +7,7 @@ **Description:** Load before use + Use this method to open AP mode and return true after successful opening **Function argument** @@ -46,6 +47,7 @@ set AP IP address **Description:** Load before use + Turn off the current AP and restore the network settings if wifioff is true **Function argument** @@ -63,6 +65,7 @@ Turn off the current AP and restore the network settings if wifioff is true **Description:** Load before use + Returns the number of clients connected to AP **Function argument** @@ -78,6 +81,7 @@ None **Description:** Load before use + Returns current IP of AP **Function argument** @@ -93,6 +97,7 @@ None **Description:** Load before use + Set Hostname if success return true **Function argument** @@ -110,6 +115,7 @@ Set Hostname if success return true **Description:** Load before use + Get Hostname if success return true **Function argument** @@ -126,6 +132,7 @@ None **Description:** Load before use + return MAC address **Function argument** @@ -141,6 +148,7 @@ None **Description:** Load before use + This method is used to access the network .If connect equals true, it will connect to ssid's WiFi hotspot,If connect equals false, WiFi hotspots that are not connected to SSID will be created to save the above parameters. **Function argument** @@ -184,6 +192,7 @@ set network addresses. **Description:** Load before use + If wifioff is true, the network settings will be restored. If eraseap is true, the network parameters saved in flash will be cleared. **Function argument** @@ -202,6 +211,7 @@ If wifioff is true, the network settings will be restored. If eraseap is true, t **Description:** Load before use + Returns whether the network has been accessed or not. **Function argument** @@ -217,7 +227,8 @@ None **Description:** Load before use -RSetting up automatic reconnection after disconnection. + +Setting up automatic reconnection after disconnection. **Function argument** @@ -232,6 +243,7 @@ None **Description:** Load before use + Setting up automatic reconnection after disconnection. **Function argument** @@ -247,6 +259,7 @@ None **Description:** Load before use + Return local IP address. **Function argument** @@ -262,6 +275,7 @@ None **Description:** Load before use + Return subnet mask. **Function argument** @@ -277,6 +291,7 @@ None **Description:** Load before use + Return gateway IP address. **Function argument** @@ -292,6 +307,7 @@ None **Description:** Load before use + Return DNS address. **Function argument** @@ -307,6 +323,7 @@ None **Description:** Load before use + Return MAC address. **Function argument** @@ -322,6 +339,7 @@ None **Description:** Load before use + Return Hostname. **Function argument** @@ -337,6 +355,7 @@ None **Description:** Load before use + Return WIFI status. **Function return value** @@ -362,6 +381,7 @@ Return WIFI status. **Description:** Load before use + scan wifi networks. **Function argument** @@ -382,6 +402,7 @@ scan wifi networks. **Description:** Load before use + Asynchronous mode is used to obtain the number of scanned networks. If the return value is - 1, it means that the scan is still in progress. If the return value is - 2, it means that the scan has not been done or failed. **Function argument** @@ -402,6 +423,7 @@ Asynchronous mode is used to obtain the number of scanned networks. If the retur **Description:** Load before use + Delete scan results in memory. **Function argument** @@ -417,6 +439,7 @@ None **Description:** Load before use + Returns the scanned network name. **Function argument** @@ -435,6 +458,7 @@ Returns the scanned network name. **Description:** Load before use + Returns the type of network encryption scanned. **Function argument** @@ -452,6 +476,7 @@ Returns the type of network encryption scanned. **Description:** Load before use + Return the scanned network signal strength. **Function argument** @@ -469,6 +494,7 @@ Return the scanned network signal strength. **Description:** Load before use + Return the scanned network channel number. **Function argument**