Fixed code block hilighting

pull/197/head
Hieromon Ikasamo 5 years ago
parent 7694283111
commit 62b53a31f7
  1. 2
      mkdocs.yml
  2. 2
      mkdocs/achandling.md
  3. 2
      mkdocs/advancedusage.md
  4. 6
      mkdocs/api.md
  5. 2
      mkdocs/apiaux.md
  6. 2
      mkdocs/changelabel.md
  7. 4
      mkdocs/credit.md
  8. 1
      mkdocs/css/paragraph.css
  9. 10
      mkdocs/datatips.md
  10. 10
      mkdocs/faq.md
  11. 4
      mkdocs/menu.md
  12. 8
      mkdocs/otaserver.md
  13. 2
      mkdocs/wojson.md

@ -72,7 +72,7 @@ theme:
extra_css:
- 'css/paragraph.css'
- 'css/extra.css'
- 'https://use.fontawesome.com/releases/v5.6.1/css/all.css'
- 'https://use.fontawesome.com/releases/v5.6.3/css/all.css'
extra_javascript:
- 'js/gifffer.min.js'
extra:

@ -543,7 +543,7 @@ String append(AutoConnectAux& aux, PageArgument& args) {
### <i class="fa fa-wrench"></i> How you can reach the values
AutoConnectSubmit uses the POST method to send HTTP requests. A value of AutoConnectInput sent to the ESP8266 or ESP32 with POST is stored in the request body of the HTTP request:
```
```powershell
POST /feels HTTP/1.1
Host: ESP8266_IP_ADDRESS
name1=value1&name2=value2&name3=value3

@ -307,7 +307,7 @@ By default, the credentials saving area is occupied from the beginning of EEPROM
> The following diagram illustrates flash layout used in Arduino environment:
> ```
> ```powershell
> |--------------|-------|---------------|--|--|--|--|--|
> ^ ^ ^ ^ ^
> Sketch OTA update File system EEPROM WiFi config (SDK)

@ -13,16 +13,16 @@ They contain in ```AutoConnectDefs.h```.
```cpp
#define AC_DEBUG // Monitor message output activation
#define AC_DEBUG_PORT Serial // Default message output device
#define AUTOCONNECT_AP_IP 0x01F4A8C0 // Default SoftAP IP
#define AUTOCONNECT_AP_GW 0x01F4A8C0 // Default SoftAP Gateway IP
#define AUTOCONNECT_AP_IP 0x011CD9AC // Default SoftAP IP
#define AUTOCONNECT_AP_GW 0x011CD9AC // Default SoftAP Gateway IP
#define AUTOCONNECT_AP_NM 0x00FFFFFF // Default subnet mask
#define AUTOCONNECT_DNSPORT 53 // Default DNS port at captive portal
#define AUTOCONNECT_HTTPPORT 80 // Default HTTP
#define AUTOCONNECT_MENU_TITLE "AutoConnect" // Default AutoConnect menu title
#define AUTOCONNECT_STARTUPTIME 10 // Default waiting time[s] for after reset
#define AUTOCONNECT_URI "/_ac" // Default AutoConnect root path
#define AUTOCONNECT_TIMEOUT 30000 // Default connection timeout[ms]
#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
```

@ -188,7 +188,7 @@ Load specified element from JSON document into AutoConnectAux. The JSON document
!!! caution "Maybe it is an array"
Please note that the JSON document that is the input for loadElement is an array syntax of AutoConnectElements when there are multiple elements. For example, the following JSON document has a syntax error:
```json
```js
{
"name": "Caption",
"type": "ACText",

@ -88,7 +88,7 @@ You prepare its header file and place it in the `src` folder of the project fold
When you store `mylabels.h` containing the new label text definition in the `src` folder, your Arduino project folder structure should look like this:
```
```javascript
<Project folder>
|-- <pio>
|-- <.vscode>

@ -207,6 +207,6 @@ There may be 0xff as an invalid data in the credential saving area. The 0xff are
!!! note "AutoConnectCredential has changed"
It was lost AutoConnectCredential backward compatibility. Credentials saved by AutoConnect v1.0.3 (or earlier) will not work properly with AutoConnect v1.1.0. You need to erase the flash of the ESP module using the esptool before the sketch uploading.
```
esptool -c esp8266 (or esp32) - p [COM_PORT] erase_flash
```powershell
esptool -c esp8266 (or esp32) -p [COM_PORT] erase_flash
```

@ -9,6 +9,7 @@
}
.md-typeset pre {
background-color: #272822 !important;
font-size: 12px;
}

@ -149,31 +149,31 @@ Here, represent examples the typical regular expression for the input validation
### <img src="images/regexp.png" align="top"> URL
```
```powershell
^\w+([-+.]\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$
```
### <img src="images/regexp.png" align="top"> DNS hostname
```
```powershell
^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$
```
### <img src="images/regexp.png" align="top"> email address [^2]
```
```powershell
^[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*$
```
### <img src="images/regexp.png" align="top"> IP Address
```
```powershell
^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
```
### <img src="images/regexp.png" align="top"> Date as MM/DD/YYYY [^3]
```
```powershell
^(0[1-9]|1[012])[- \/.](0[1-9]|[12][0-9]|3[01])[- \/.](19|20)\d\d$
```

@ -115,7 +115,7 @@ If ESP8266 hang up after reset by AutoConnect menu, perhaps manual reset is not
If you received the following message, the boot mode is still sketch uploaded. It needs to the manual reset once.
```
```powershell
ets Jan 8 2013,rst cause:2, boot mode:(1,6) or (1,7)
ets Jan 8 2013,rst cause:4, boot mode:(1,6) or (1,7)
wdt reset
@ -124,7 +124,7 @@ wdt reset
The correct boot mode for starting the sketch is **(3, x)**.
!!! info "ESP8266 Boot Messages"
It is described by [ESP8266 Non-OS SDK API Reference](view-source:https://www.espressif.com/en/products/hardware/esp8266ex/resources), section A.5.
It is described by [ESP8266 Non-OS SDK API Reference](https://www.espressif.com/en/products/hardware/esp8266ex/resources), section A.5.
| Messages | Description |
|----------|-------------|
@ -154,7 +154,7 @@ To completely remove ArduinoJson at compile-time from the binary, you need to de
To exclude ArduinoJson at compile-time, give the following `#define` directive as a compiler option such as the [arduino-cli](https://github.com/arduino/arduino-cli) or [PlatformIO](https://platformio.org/).
```
```cpp
#define AUTOCONNECT_NOUSE_JSON
```
@ -200,7 +200,7 @@ If the sketch is correct, a JSON syntax error may have occurred. In this case, a
## <i class="fa fa-question-circle"></i> Saved credentials are wrong or lost.
A structure of AutoConnect saved credentials has changed two times throughout enhancement with v1.0.3 and v1.1.0. In particular, due to enhancements in v1.1.0, AutoConnectCredential data structure has lost the backward compatibility with previous versions. You must erase the flash of the ESP module using the esptool completely to save the credentials correctly with v1.1.0.
```
```powershell
esptool -c esp8266 (or esp32) -p [COM_PORT] erase_flash
```
@ -216,7 +216,7 @@ Also, you can check the memory running out status by rebuilding the sketch with
If the heap memory is insufficient, the following message is displayed on the serial console.
```
```powershell
[PB] Failed building, free heap:<Size of free heap>
```

@ -43,8 +43,8 @@ After WiFi connected, AutoConnect will automatically save the established SSID a
!!! note "Saved credentials data structure has changed"
A structure of AutoConnect saved credentials has changed in v1.1.0 and was lost backward compatibility. Credentials saved by AutoConnect v1.0.3 (or earlier) will not display properly with AutoConnect v1.1.0. You need to erase the flash of the ESP module using the esptool before the sketch uploading.
```
esptool -c esp8266 (or esp32) - p [COM_PORT] erase_flash
```powershell
esptool -c esp8266 (or esp32) -p [COM_PORT] erase_flash
```
## <i class="fa fa-bars"></i> Disconnect

@ -70,7 +70,7 @@ In the OTA platform, you can place the update server operated by the script in a
For Python2: *AUTOCONNECT\_LIBRARY\_PATH*/src/updateserver/python2
For Python3: *AUTOCONNECT\_LIBRARY\_PATH*/src/updateserver/python3
```bash
```powershell
updateserver.py [-h] [--port PORT] [--bind IP_ADDRESS] [--catalog CATALOG] [--log LOG_LEVEL]
```
<dl class="apidl">
@ -91,7 +91,7 @@ updateserver.py [-h] [--port PORT] [--bind IP_ADDRESS] [--catalog CATALOG] [--lo
3. Start updateserver.py
For example, to start the update server on the host with IP address 172.16.1.10 using 8080 port[^4], execute the following command:
```bash
```powershell
python updateserver.py --port 8080 --bind 172.16.1.10 --catalog bin --log debug
```
In this example assumes that the binary sketch files are deployed under the path `bin` from the current directory.
@ -118,7 +118,7 @@ Above requirements will be implemented on along the HTTP protocol. The AutoConne
#### 1. HTTP URL query for the catalog list of the updatable
```
```powershell
[address]/_catalog?op=list&path=[path]
```
<dl class="apidl">
@ -159,7 +159,7 @@ The above JSON object is one entry. The actual catalog list is an array of this
The AutoConnectUpdate class issues a HTTP GET request with the specified host address and URI. The update server responds by sending back a binary sketch file with the following header:
```
```powershell
Content-Type: application/octet-stream
Content-Disposition: attachment; filename="BINARY_SKETCH_FILE_NAME"
Content-Length: LENGTH_OF_CONTENT

@ -35,7 +35,7 @@ In addition to the above procedure, to completely cut off for binding with the A
The code excluding JSON processing from the mqttRSSI sketch attached to the library is as follows. <small>(It is a part of code. Refer to mqttRSSI_NA.ino for the whole sketch.)</small>
<i class="fa fa-code"></i> The JSON document for mqttRSSI
<i class="fab fa-js-square"></i> The JSON document for mqttRSSI
```json
[

Loading…
Cancel
Save