From 44efc546598cfd45f4be536b149d4b5302cc6dfd Mon Sep 17 00:00:00 2001 From: Hieromon Ikasamo Date: Fri, 10 Apr 2020 00:20:42 +0900 Subject: [PATCH] Correct description error --- mkdocs/acupload.md | 2 +- mkdocs/advancedusage.md | 5 +++-- mkdocs/api.md | 5 +++++ mkdocs/apiconfig.md | 4 ++-- mkdocs/apiupdate.md | 8 ++++---- mkdocs/faq.md | 4 ++-- 6 files changed, 17 insertions(+), 11 deletions(-) diff --git a/mkdocs/acupload.md b/mkdocs/acupload.md index 434ff12..3cb0d08 100644 --- a/mkdocs/acupload.md +++ b/mkdocs/acupload.md @@ -209,7 +209,7 @@ typedef struct { -The upload handler needs to implement processing based on the enumeration value of HTTPUpload.status as **HTTPUploadStatus** enum type. HTTPUploadStatus enumeration is as follows: +An upload handler needs to implement a procedure corresponding with **HTTPUploadStatus** enum value indicated by the uploading process of ESP8266WebServer class, which contained in HTTPUpload.status as following values: - **`UPLOAD_FILE_START`** : Invokes to the \_open. - **`UPLOAD_FILE_WRITE`** : Invokes to the \_write. diff --git a/mkdocs/advancedusage.md b/mkdocs/advancedusage.md index 75de822..5abc36c 100644 --- a/mkdocs/advancedusage.md +++ b/mkdocs/advancedusage.md @@ -224,7 +224,7 @@ Executing the above sketch will rewrite the menu title for the **FSBrowser** as ### Change the menu labels -You can change the label of the AutoConnect menu item by rewriting the default label letter in [AutoConnectLabels.h](https://github.com/Hieromon/AutoConnect/blob/master/src/AutoConnectLabels.h) macros. However, changing menu items letter influences all the sketch's build scenes. +You can change the label of the AutoConnect menu item by rewriting the default label letter in [AutoConnectLabels.h](https://github.com/Hieromon/AutoConnect/blob/master/src/AutoConnectLabels.h) macros. However, changing menu items letter influences all build scenes for the Sketch. ```cpp #define AUTOCONNECT_MENULABEL_CONFIGNEW "Configure new AP" @@ -234,6 +234,7 @@ You can change the label of the AutoConnect menu item by rewriting the default l #define AUTOCONNECT_MENULABEL_HOME "HOME" #define AUTOCONNECT_BUTTONLABEL_RESET "RESET" ``` +See also: [*Change label text*](changelabel.md) ### Combination with mDNS @@ -486,7 +487,7 @@ But this method is not recommended. The broadcast radio of SSID emitted from Sof ### Relocate the AutoConnect home path -A home path of AutoConnect is **/\_ac** by default. You can access from the browser with http://IPADDRESS/\_ac. You can change the home path by revising [**AUTOCONNECT_URI**](https://github.com/Hieromon/AutoConnect/blob/master/src/AutoConnectDefs.h#L62) macro in the include header file as [AutoConnectDef.h](https://github.com/Hieromon/AutoConnect/blob/master/src/AutoConnectDef.h). +A home path of AutoConnect is **/\_ac** by default. You can access from the browser with http://IPADDRESS/\_ac. You can change the home path by revising [**AUTOCONNECT_URI**](https://github.com/Hieromon/AutoConnect/blob/master/src/AutoConnectDefs.h#L69) macro in the include header file as [AutoConnectDef.h](https://github.com/Hieromon/AutoConnect/blob/master/src/AutoConnectDef.h). ```cpp #define AUTOCONNECT_URI "/_ac" diff --git a/mkdocs/api.md b/mkdocs/api.md index 04e4941..956933d 100644 --- a/mkdocs/api.md +++ b/mkdocs/api.md @@ -24,6 +24,11 @@ They contain in ```AutoConnectDefs.h```. #define AUTOCONNECT_CAPTIVEPORTAL_TIMEOUT 0 // Captive portal timeout value #define AUTOCONNECT_STARTUPTIME 30 // Default waiting time[s] for after reset #define AUTOCONNECT_USE_JSON // Allow AutoConnect elements to be handled by JSON format +#define AUTOCONNECT_USE_UPDATE // Indicator of whether to use the AutoConnectUpdate feature. +#define AUTOCONNECT_UPDATE_PORT 8000 // Available HTTP port number for the update +#define AUTOCONNECT_UPDATE_TIMEOUT 8000 // HTTP client timeout limitation for the update [ms] +#define AUTOCONNECT_TICKER_PORT LED_BUILTIN // Ticker port +#endif ``` !!! note "Macros placement moved" diff --git a/mkdocs/apiconfig.md b/mkdocs/apiconfig.md index f9cba0a..1d6c49f 100644 --- a/mkdocs/apiconfig.md +++ b/mkdocs/apiconfig.md @@ -97,7 +97,7 @@ Specify the location to be redirected after module reset in the AutoConnect menu
**Type**
AC_ONBOOTURI_t
**Value**
-
AC_ONBOOTURI_ROOT Resetting the module redirects it to the AutoConnect root path. The root path is assumed to be AUTOCONNECT_URI defined in AutoConnectDefs.h.
+
AC_ONBOOTURI_ROOT Resetting the module redirects it to the AutoConnect root path. The root path is assumed to be AUTOCONNECT_URI defined in [`AutoConnectDefs.h`](api.md#defined-macros).
AC_ONBOOTURI_HOME It is redirected to the URI specified by [**AutoConnectConfig::homeUri**](apiconfig.md#homeuri).
@@ -291,7 +291,7 @@ Set flicker signal output according to WiFi connection status during AutoConnect ### tickerPort -Specifies the GPIO port number to output the flicker signal of the ticker. The default assumes on the board dependent definition LED_BUILTIN macro redefined by **AUTOCONNECT_TICKER_PORT** in `AutoConnectDefs.h`. +Specifies the GPIO port number to output the flicker signal of the ticker. The default assumes on the board dependent definition LED_BUILTIN macro redefined by **AUTOCONNECT_TICKER_PORT** in [`AutoConnectDefs.h`](api.md#defined-macros).
**Type**
uint8_t
diff --git a/mkdocs/apiupdate.md b/mkdocs/apiupdate.md index 4056ca4..d41503c 100644 --- a/mkdocs/apiupdate.md +++ b/mkdocs/apiupdate.md @@ -8,9 +8,9 @@ AutoConnectUpdate(const String& host, const uint16_t port, const String& uri, co
**Parameters**
hostUpdate server address. Specifies IP address or FQDN.
-
portSpecifies HTTP port for the updating process. The default is defined as the **AUTOCONNECT_UPDATE_PORT** macro in the `AutoConnectDefs.h` header file.
+
portSpecifies HTTP port for the updating process. The default is defined as the **AUTOCONNECT_UPDATE_PORT** macro in the [`AutoConnectDefs.h`](api.md#defined-macros) header file.
uriSpecifies a URI on the update server that has deployed available binary sketch files.
-
timeoutSpecifies the maximum response time for the update server. The default is defined as the **AUTOCONNECT_UPDATE_TIMEOUT** macro in the `AutoConnectDefs.h` header file. +
timeoutSpecifies the maximum response time for the update server. The default is defined as the **AUTOCONNECT_UPDATE_TIMEOUT** macro in the [`AutoConnectDefs.h`](api.md#defined-macros) header file.
ledOnActive signal to light the LED ticker during the update. Specifies **HIGH** or **LOW**
@@ -82,7 +82,7 @@ void AutoConnectUpdate::setLedPin(int ledPin, uint8_t ledOn) Sets the port and the ON signal level of the externally connected LED that should act as a ticker during the update process.
**Parameter**
-
ledPinSpecifies the PIN connected external LED for the ticker. The default is defined as the **AUTOCONNECT_TICKER_PORT** macro in the `AutoConnectDefs.h` header file and it is derived from the board-specific **LED_BUILTIN**. By default, the AutoConnectUpdate class does not use the ticker for boards without the LED_BUILTIN definition. If you connect the ticker LED externally, you need to specify the PIN using the [setLedPin](#setledpin) function.
+
ledPinSpecifies the PIN connected external LED for the ticker. The default is defined as the **AUTOCONNECT_TICKER_PORT** macro in the [`AutoConnectDefs.h`](api.md#defined-macros) header file and it is derived from the board-specific **LED_BUILTIN**. By default, the AutoConnectUpdate class does not use the ticker for boards without the LED_BUILTIN definition. If you connect the ticker LED externally, you need to specify the PIN using the [setLedPin](#setledpin) function.
ledOnSpecifies the the ON signal level of the LED PIN port. It is **HIGH** or **LOW**.
@@ -123,7 +123,7 @@ Update server address. Specifies IP address or FQDN. HTTP port for the updating process.
**Type**
-
StringThe default is defined as the **AUTOCONNECT_UPDATE_PORT** macro in the `AutoConnectDefs.h` header file.
+
StringThe default is defined as the **AUTOCONNECT_UPDATE_PORT** macro in the [`AutoConnectDefs.h`](api.md#defined-macros) header file.
### uri diff --git a/mkdocs/faq.md b/mkdocs/faq.md index 1cd49e9..4cabb01 100644 --- a/mkdocs/faq.md +++ b/mkdocs/faq.md @@ -32,7 +32,7 @@ You can avoid a compile error in one of two ways: 1. Disable an AutoConnectUpdate feature if you don't need. - You can disable the AutoConnectUpdate feature by commenting out the **AUTOCONNECT_USE_UPDATE** macro in the `AutoConnectDefs.h` header file. + You can disable the AutoConnectUpdate feature by commenting out the [**AUTOCONNECT_USE_UPDATE**](https://github.com/Hieromon/AutoConnect/blob/master/src/AutoConnectDefs.h#L34) macro in the [`AutoConnectDefs.h`](api.md#defined-macros) header file. ```cpp #define AUTOCONNECT_USE_UPDATE ``` @@ -137,7 +137,7 @@ You can use the [AutoConnect::onDetect](api.md#ondetect) exit routine. For more ## How change HTTP port? -HTTP port number is defined as a macro in [AutoConnectDefs.h](https://github.com/Hieromon/AutoConnect/blob/master/src/AutoConnectDefs.h#L112) header file. You can change it directly with several editors and must re-compile. +HTTP port number is defined as a macro in [AutoConnectDefs.h](https://github.com/Hieromon/AutoConnect/blob/master/src/AutoConnectDefs.h#L123) header file. You can change it directly with several editors and must re-compile. ```cpp #define AUTOCONNECT_HTTPPORT 80