Skip to content

Commit be3abb3

Browse files
committed
Update rst docs with latest changes in master
- 9fd270f Documenting a few Esp.cpp methods (#3057) - 2881e91 Fix typo in client-class.md (#3045) - 97373e7 Add instructions how to re-enable DHCP (#2600) - af0f5ed Issue #1062: Implement support for HSPI overlap mode. - ca3a172 Addition of gen4-IoD Range boards (#3202) - d2b370b add AsyncPing library to libraries.md (#2889) - adeed6b Updated arduino-esp8266fs-plugin link to 0.3.0 (#2846) - b701b98 Update libraries.md (#2808) - 898d280 Update readme.md (#2809) - remove newlines from ota_updates/readme.rst
1 parent e63e772 commit be3abb3

File tree

6 files changed

+106
-198
lines changed

6 files changed

+106
-198
lines changed

doc/boards.rst

+14
Original file line numberDiff line numberDiff line change
@@ -360,3 +360,17 @@ Dimensions:
360360
http://thaieasyelec.com/downloads/ETEE052/ETEE052\_ESPino\_Dimension.pdf
361361
- Pinouts:
362362
http://thaieasyelec.com/downloads/ETEE052/ETEE052\_ESPino\_User\_Manual\_TH\_v1\_0\_20160204.pdf (Please see pg. 8)
363+
364+
365+
gen4-IoD Range by 4D Systems
366+
----------------------------
367+
368+
gen4-IoD Range of ESP8266 powered Display Modules by 4D Systems.
369+
370+
2.4", 2.8" and 3.2" TFT LCD with uSD card socket and Resistive Touch. Chip Antenna + uFL Connector.
371+
372+
Datasheet and associated downloads can be found on the 4D Systems product page.
373+
374+
The gen4-IoD range can be programmed using the Arduino IDE and also the 4D Systems Workshop4 IDE, which incorporates many additional graphics benefits. GFX4d library is available, along with a number of demo applications.
375+
376+
- Product page: http://www.4dsystems.com.au/product/gen4-IoD

doc/esp8266wifi/client-class.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ This algorithm is intended to reduce TCP/IP traffic of small packets sent over t
3333

3434
.. code:: cpp
3535
36-
clinet.setNoDelay(true);
36+
client.setNoDelay(true);
3737
3838
Other Function Calls
3939
~~~~~~~~~~~~~~~~~~~~

doc/esp8266wifi/station-class.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,8 @@ The following IP configuration may be provided:
147147
.
148148
Connected, IP address: 192.168.1.22
149149

150-
Please note that station with static IP configuration usually connects to the network faster. In the above example it took about 500ms (one dot ``.`` displayed). This is because obtaining of IP configuration by DHCP client takes time and in this case this step is skipped.
150+
Please note that station with static IP configuration usually connects to the network faster. In the above example it took about 500ms (one dot `.` displayed). This is because obtaining of IP configuration by DHCP client takes time and in this case this step is skipped. If you pass all three parameter as 0.0.0.0 (local_ip, gateway and subnet), it will re enable DHCP. You need to re-connect the device to get new IPs.
151+
151152

152153
Manage Connection
153154
~~~~~~~~~~~~~~~~~

doc/filesystem.rst

+1-2
Original file line numberDiff line numberDiff line change
@@ -105,8 +105,7 @@ Uploading files to file system
105105
menu item to *Tools* menu for uploading the contents of sketch data
106106
directory into ESP8266 flash file system.
107107

108-
- Download the tool:
109-
https://github.com./esp8266/arduino-esp8266fs-plugin/releases/download/0.2.0/ESP8266FS-0.2.0.zip.
108+
- Download the tool: https://github.com./esp8266/arduino-esp8266fs-plugin/releases/download/0.3.0/ESP8266FS-0.3.0.zip.
110109
- In your Arduino sketchbook directory, create ``tools`` directory if
111110
it doesn't exist yet
112111
- Unpack the tool into ``tools`` directory (the path will look like

doc/libraries.rst

+37-4
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,28 @@ SPI
3939

4040
SPI library supports the entire Arduino SPI API including transactions, including setting phase (CPHA). Setting the Clock polarity (CPOL) is not supported, yet (SPI\_MODE2 and SPI\_MODE3 not working).
4141

42+
The usual SPI pins are:
43+
44+
- ``MOSI`` = GPIO13
45+
- ``MISO`` = GPIO12
46+
- ``SCLK`` = GPIO14
47+
48+
There's an extended mode where you can swap the normal pins to the SPI0 hardware pins.
49+
This is enabled by calling ``SPI.pins(6, 7, 8, 0)`` before the call to ``SPI.begin()``. The pins would
50+
change to:
51+
52+
- ``MOSI`` = SD1
53+
- ``MISO`` = SD0
54+
- ``SCLK`` = CLK
55+
- ``HWCS`` = GPIO0
56+
57+
This mode shares the SPI pins with the controller that reads the program code from flash and is
58+
controlled by a hardware arbiter (the flash has always higher priority). For this mode the CS
59+
will be controlled by hardware as you can't handle the CS line with a GPIO, you never actually
60+
know when the arbiter is going to grant you access to the bus so you must let it handle CS
61+
automatically.
62+
63+
4264
SoftwareSerial
4365
--------------
4466

@@ -55,13 +77,23 @@ Some ESP-specific APIs related to deep sleep, RTC and flash memories are availab
5577

5678
``ESP.restart()`` restarts the CPU.
5779

58-
``ESP.getResetReason()`` returns String containing the last reset resaon in human readable format.
80+
``ESP.getResetReason()`` returns a String containing the last reset reason in human readable format.
5981

6082
``ESP.getFreeHeap()`` returns the free heap size.
6183

6284
``ESP.getChipId()`` returns the ESP8266 chip ID as a 32-bit integer.
6385

64-
Several APIs may be used to get flash chip info:
86+
``ESP.getCoreVersion()`` returns a String containing the core version.
87+
88+
``ESP.getSdkVersion()`` returns the SDK version as a char.
89+
90+
``ESP.getCpuFreqMHz()`` returns the CPU frequency in MHz as an unsigned 8-bit integer.
91+
92+
``ESP.getSketchSize()`` returns the size of the current sketch as an unsigned 32-bit integer.
93+
94+
``ESP.getFreeSketchSpace()`` returns the free sketch space as an unsigned 32-bit integer.
95+
96+
``ESP.getSketchMD5()`` returns a lowercase String containing the MD5 of the current sketch.
6597

6698
``ESP.getFlashChipId()`` returns the flash chip ID as a 32-bit integer.
6799

@@ -86,7 +118,7 @@ Note that by default ADC is configured to read from TOUT pin using ``analogRead(
86118
mDNS and DNS-SD responder (ESP8266mDNS library)
87119
-----------------------------------------------
88120

89-
Allows the sketch to respond to multicast DNS queries for domain names like "foo.local", and DNS-SD (service dicovery) queries. See attached example for details.
121+
Allows the sketch to respond to multicast DNS queries for domain names like "foo.local", and DNS-SD (service discovery) queries. See attached example for details.
90122

91123
SSDP responder (ESP8266SSDP)
92124
----------------------------
@@ -96,7 +128,7 @@ SSDP is another service discovery protocol, supported on Windows out of the box.
96128
DNS server (DNSServer library)
97129
------------------------------
98130

99-
Implements a simple DNS server that can be used in both STA and AP modes. The DNS server currently supports only one domain (for all other domains it will reply with NXDOMAIN or custom status code). With it clients can open a web server running on ESP8266 using a domain name, not an IP address. See attached example for details.
131+
Implements a simple DNS server that can be used in both STA and AP modes. The DNS server currently supports only one domain (for all other domains it will reply with NXDOMAIN or custom status code). With it, clients can open a web server running on ESP8266 using a domain name, not an IP address.
100132

101133
Servo
102134
-----
@@ -141,3 +173,4 @@ Libraries that don't rely on low-level access to AVR registers should work well.
141173
- `OLED <https://github.com./klarsys/esp8266-OLED>`__ - a library for controlling I2C connected OLED displays. Tested with 0.96 inch OLED graphics display.
142174
- `MFRC522 <https://github.com./miguelbalboa/rfid>`__ - A library for using the Mifare RC522 RFID-tag reader/writer.
143175
- `Ping <https://github.com./dancol90/ESP8266Ping>`__ - lets the ESP8266 ping a remote machine.
176+
- `AsyncPing <https://github.com./akaJes/AsyncPing>`__ - fully asynchronous Ping library (have full ping statistic and hardware MAC address).

0 commit comments

Comments
 (0)