arduino/esp8266
1
0
Fork 0
mirror of https://github.com/esp8266/Arduino.git synced 2025-04-21 10:26:06 +03:00
Code

fix dead link docs (#4221)

Browse Source
This commit is contained in:
Doanh Văn Lương 2018-02-05 10:57:58 +07:00 committed by Develo
parent 29c9ebea32
commit 4e115917ae
16 changed files with 32 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/esp8266wifi/client-class.rst
View File

@ -59,4 +59,4 @@ Other Function Calls
Documentation for the above functions is not yet prepared. Documentation for the above functions is not yet prepared.
For code samples please refer to separate section with `examples For code samples please refer to separate section with `examples
:arrow\_right: <client-examples.md>`__ dedicated specifically to the Client Class. :arrow\_right: <client-examples.rst>`__ dedicated specifically to the Client Class.

4
doc/esp8266wifi/client-examples.rst
View File

@ -28,7 +28,7 @@ This time we are going to concentrate just on retrieving a web page contents sen
Get Connected to Wi-Fi Get Connected to Wi-Fi
~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~
We should start with connecting the module to an access point to obtain an access to internet. The code to provide this functionality has been already discussed in chapter `Quick Start <readme.md#quick-start>`__. Please refer to it for details. We should start with connecting the module to an access point to obtain an access to internet. The code to provide this functionality has been already discussed in chapter `Quick Start <readme.rst#quick-start>`__. Please refer to it for details.
Select a Server Select a Server
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
@ -257,4 +257,4 @@ For more client examples please check
- `WiFiClient.ino <https://github.com/esp8266/Arduino/blob/master/libraries/ESP8266WiFi/examples/WiFiClient/WiFiClient.ino>`__ - this sketch sends data via HTTP GET requests to data.sparkfun.com service. - `WiFiClient.ino <https://github.com/esp8266/Arduino/blob/master/libraries/ESP8266WiFi/examples/WiFiClient/WiFiClient.ino>`__ - this sketch sends data via HTTP GET requests to data.sparkfun.com service.
For the list of functions provided to manage clients, please refer to the `Client Class :arrow\_right: <client-class.md>`__ documentation. For the list of functions provided to manage clients, please refer to the `Client Class :arrow\_right: <client-class.rst>`__ documentation.

2
doc/esp8266wifi/client-secure-class.rst
View File

@ -98,4 +98,4 @@ Other Function Calls
Documentation for the above functions is not yet prepared. Documentation for the above functions is not yet prepared.
For code samples please refer to separate section with `examples <client-secure-examples.md>`__ dedicated specifically to the Client Secure Class. For code samples please refer to separate section with `examples <client-secure-examples.rst>`__ dedicated specifically to the Client Secure Class.

6
doc/esp8266wifi/client-secure-examples.rst
View File

@ -3,7 +3,7 @@
Client Secure Client Secure
------------- -------------
The client secure is a `client <#client>`__ but secure. Application example below will be easier to follow if you check similar and simpler `example <client-examples.md>`__ for the "ordinary" client. That being said we will concentrate on discussing the code that is specific to the client secure. The client secure is a `client <#client>`__ but secure. Application example below will be easier to follow if you check similar and simpler `example <client-examples.rst>`__ for the "ordinary" client. That being said we will concentrate on discussing the code that is specific to the client secure.
Table of Contents Table of Contents
----------------- -----------------
@ -71,7 +71,7 @@ We can obtain the ``fingerprint`` for specific ``host`` using a web browser. For
alt text alt text
Remaining steps look almost identical as for the `non-secure client example <client-examples.md>`__. Remaining steps look almost identical as for the `non-secure client example <client-examples.rst>`__.
Connect to the Server Connect to the Server
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
@ -106,7 +106,7 @@ If this check fails, it is up to you to decide if to proceed further or abort co
GET Response from the Server GET Response from the Server
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In the next steps we should execute GET command. This is done is similar way as discussed in `non-secure client example <client-examples.md>`__. In the next steps we should execute GET command. This is done is similar way as discussed in `non-secure client example <client-examples.rst>`__.
.. code:: cpp .. code:: cpp

2
doc/esp8266wifi/generic-class.rst
View File

@ -27,7 +27,7 @@ WiFiEventHandler
WiFiEventHandler onSoftAPModeStationConnected (std::function< void(const WiFiEventSoftAPModeStationConnected &)>) WiFiEventHandler onSoftAPModeStationConnected (std::function< void(const WiFiEventSoftAPModeStationConnected &)>)
WiFiEventHandler onSoftAPModeStationDisconnected (std::function< void(const WiFiEventSoftAPModeStationDisconnected &)>) WiFiEventHandler onSoftAPModeStationDisconnected (std::function< void(const WiFiEventSoftAPModeStationDisconnected &)>)
To see a sample application with ``WiFiEventHandler``, please check separate section with `examples :arrow\_right: <generic-examples.md>`__ dedicated specifically to the Generic Class.. To see a sample application with ``WiFiEventHandler``, please check separate section with `examples :arrow\_right: <generic-examples.rst>`__ dedicated specifically to the Generic Class..
persistent persistent
~~~~~~~~~~ ~~~~~~~~~~

6
doc/esp8266wifi/generic-examples.rst
View File

@ -3,7 +3,7 @@
Generic Generic
------- -------
In the first `example <readme.md#quick-start>`__ of the ESP8266WiFi library documentation we have discussed how to check when module connects to the Wi-Fi network. We were waiting until connection is established. If network is not available, the module could wait like that for ever doing nothing else. Another `example <scan-examples.md#async-scan>`__ on the Wi-Fi asynchronous scan mode demonstrated how to wait for scan result and do in parallel something else - blink a LED not disturbing the blink pattern. Let's apply similar functionality when connecting the module to an access point. In the first `example <readme.rst#quick-start>`__ of the ESP8266WiFi library documentation we have discussed how to check when module connects to the Wi-Fi network. We were waiting until connection is established. If network is not available, the module could wait like that for ever doing nothing else. Another `example <scan-examples.rst#async-scan>`__ on the Wi-Fi asynchronous scan mode demonstrated how to wait for scan result and do in parallel something else - blink a LED not disturbing the blink pattern. Let's apply similar functionality when connecting the module to an access point.
Table of Contents Table of Contents
----------------- -----------------
@ -29,7 +29,7 @@ We would like to write a code that will inform us that connection to Wi-Fi netwo
Event Driven Methods Event Driven Methods
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
The list of all such methods is provided in `Generic Class <generic-class.md>`__ documentation. The list of all such methods is provided in `Generic Class <generic-class.rst>`__ documentation.
We would like to use two of them: \* ``onStationModeGotIP`` called when station is assigned IP address. This assignment may be done by DHCP client or by executing ``WiFi.config(...)``. \* ``onStationModeDisconnected`` called when station is disconnected from Wi-Fi network. The reason of disconnection does not matter. Event will be triggered both if disconnection is done from the code by executing ``WiFi.disconnect()``, because the Wi-Fi signal is weak, or because the access point is switched off. We would like to use two of them: \* ``onStationModeGotIP`` called when station is assigned IP address. This assignment may be done by DHCP client or by executing ``WiFi.config(...)``. \* ``onStationModeDisconnected`` called when station is disconnected from Wi-Fi network. The reason of disconnection does not matter. Event will be triggered both if disconnection is done from the code by executing ``WiFi.disconnect()``, because the Wi-Fi signal is weak, or because the access point is switched off.
@ -122,4 +122,4 @@ Conclusion
Check out events from generic class. They will help you to write more compact code. Use them to practice splitting your code into separate tasks that are executed asynchronously. Check out events from generic class. They will help you to write more compact code. Use them to practice splitting your code into separate tasks that are executed asynchronously.
For review of functions included in generic class, please refer to the `Generic Class <generic-class.md>`__ documentation. For review of functions included in generic class, please refer to the `Generic Class <generic-class.rst>`__ documentation.

2
doc/esp8266wifi/readme.rst
View File

@ -302,7 +302,7 @@ The same sketch without ``Serial.setDebugOutput(true)`` will print out only the
Enable Debugging in IDE Enable Debugging in IDE
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~
Arduino IDE provides convenient method to `enable debugging <https://github.com/esp8266/Arduino/blob/master/doc/Troubleshooting/debugging.md>`__ for specific libraries. Arduino IDE provides convenient method to `enable debugging <https://github.com/esp8266/Arduino/blob/master/doc/Troubleshooting/debugging.rst>`__ for specific libraries.
What's Inside? What's Inside?
-------------- --------------

2
doc/esp8266wifi/scan-class.rst
View File

@ -235,4 +235,4 @@ The ``networkItem`` is a zero based index of network discovered during scan. All
5: , Ch:11 (-77dBm) hidden 5: , Ch:11 (-77dBm) hidden
6: UPC Wi-Free, Ch:11 (-79dBm) 6: UPC Wi-Free, Ch:11 (-79dBm)
For code samples please refer to separate section with `examples <scan-examples.md>`__ dedicated specifically to the Scan Class. For code samples please refer to separate section with `examples <scan-examples.rst>`__ dedicated specifically to the Scan Class.

2
doc/esp8266wifi/scan-examples.rst
View File

@ -240,4 +240,4 @@ Conclusion
The scan class API provides comprehensive set of methods to do scanning in both synchronous as well as in asynchronous mode. Therefore we can easy implement code that is doing scanning in background without disturbing other processes running on ESP8266 module. The scan class API provides comprehensive set of methods to do scanning in both synchronous as well as in asynchronous mode. Therefore we can easy implement code that is doing scanning in background without disturbing other processes running on ESP8266 module.
For the list of functions provided to manage scan mode please refer to the `Scan Class <scan-class.md>`__ documentation. For the list of functions provided to manage scan mode please refer to the `Scan Class <scan-class.rst>`__ documentation.

6
doc/esp8266wifi/station-examples.rst
View File

@ -3,7 +3,7 @@
Station Station
------- -------
Example of connecting to an access point has been shown in chapter `Quick Start <readme.md#quick-start>`__. In case connection is lost, ESP8266 will automatically reconnect to the last used access point, once it is again available. Example of connecting to an access point has been shown in chapter `Quick Start <readme.rst#quick-start>`__. In case connection is lost, ESP8266 will automatically reconnect to the last used access point, once it is again available.
Can we provide more robust connection to Wi-Fi than that? Can we provide more robust connection to Wi-Fi than that?
@ -19,7 +19,7 @@ Table of Contents
Introduction Introduction
~~~~~~~~~~~~ ~~~~~~~~~~~~
Following the example in\ `Quick Start <readme.md#quick-start>`__, we would like to go one step further and made ESP connect to next available access point if current connection is lost. This functionality is provided with 'ESP8266WiFiMulti' class and demonstrated in sketch below. Following the example in\ `Quick Start <readme.rst#quick-start>`__, we would like to go one step further and made ESP connect to next available access point if current connection is lost. This functionality is provided with 'ESP8266WiFiMulti' class and demonstrated in sketch below.
.. code:: cpp .. code:: cpp
@ -100,7 +100,7 @@ Function ``monitorWiFi()`` is in place to show when connection is lost by displa
Can we Make it Simpler? Can we Make it Simpler?
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~
Please note that you may simplify this sketch by removing function ``monitorWiFi()`` and putting inside ``loop()`` only ``wifiMulti.run()``. ESP will still reconnect between configured access points if required. Now you won't be able to see it on serial monitor unless you add ``Serial.setDebugOutput(true)`` as described in point `Enable Wi-Fi Diagnostic <readme.md#enable-wi-fi-diagnostic>`__. Please note that you may simplify this sketch by removing function ``monitorWiFi()`` and putting inside ``loop()`` only ``wifiMulti.run()``. ESP will still reconnect between configured access points if required. Now you won't be able to see it on serial monitor unless you add ``Serial.setDebugOutput(true)`` as described in point `Enable Wi-Fi Diagnostic <readme.rst#enable-wi-fi-diagnostic>`__.
Updated sketch for such scenario will look as follows: Updated sketch for such scenario will look as follows:

2
doc/esp8266wifi/udp-examples.rst
View File

@ -41,7 +41,7 @@ Once we have libraries in place we need to create a ``WiFiUDP`` object. Then we
Wi-Fi Connection Wi-Fi Connection
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
At the beginning of ``setup()`` let's implement typical code to connect to an access point. This has been discussed in `Quick Start <readme.md#quick-start>`__. Please refer to it if required. At the beginning of ``setup()`` let's implement typical code to connect to an access point. This has been discussed in `Quick Start <readme.rst#quick-start>`__. Please refer to it if required.
UDP Setup UDP Setup
~~~~~~~~~ ~~~~~~~~~

10
doc/faq/a01-espcomm_sync-failed.rst
View File

@ -42,7 +42,7 @@ following three things right: 1. Module is provided with enough power,
resistors, 3. Module is put into boot loader mode. resistors, 3. Module is put into boot loader mode.
For specific details please refer to section on `Generic ESP8266 For specific details please refer to section on `Generic ESP8266
modules <../boards.md#generic-esp8266-modules>`__. Example modules modules <../boards.rst#generic-esp8266-modules>`__. Example modules
without USB to serial converter on board are shown below. without USB to serial converter on board are shown below.
.. figure:: pictures/a01-example-boards-without-usb.png .. figure:: pictures/a01-example-boards-without-usb.png
@ -128,7 +128,7 @@ follows:
``ets Jan 8 2013,rst cause:2, boot mode:(1,7)`` ``ets Jan 8 2013,rst cause:2, boot mode:(1,7)``
If you see similar message but different values then decode them using If you see similar message but different values then decode them using
`Boot Messages and Modes <../boards.md#boot-messages-and-modes>`__. The `Boot Messages and Modes <../boards.rst#boot-messages-and-modes>`__. The
key information is contained in first digit / three right-most bits of key information is contained in first digit / three right-most bits of
the boot mode message as shown below. the boot mode message as shown below.
@ -140,9 +140,9 @@ the boot mode message as shown below.
For instance message ``boot mode (3,3)`` indicates that pins GPIO2 and For instance message ``boot mode (3,3)`` indicates that pins GPIO2 and
GPIO0 are set HIGH and GPIO15 is set LOW. This is configuration for GPIO0 are set HIGH and GPIO15 is set LOW. This is configuration for
`normal `normal
operation <../boards.md#minimal-hardware-setup-for-running-only>`__ of operation <../boards.rst#minimal-hardware-setup-for-running-only>`__ of
module (to execute application from flash), not for `boot module (to execute application from flash), not for `boot
loading <../boards.md#minimal-hardware-setup-for-bootloading-only>`__ loading <../boards.rst#minimal-hardware-setup-for-bootloading-only>`__
(flash programming). (flash programming).
Note: Without having this step right you will not be able to upload Note: Without having this step right you will not be able to upload
@ -391,4 +391,4 @@ Test stand used for checking of ck reset method is shown above.
No any ESP module has been harmed during preparation of this FAQ item. No any ESP module has been harmed during preparation of this FAQ item.
`FAQ list :back: <readme.md>`__ `FAQ list :back: <readme.rst>`__

6
doc/faq/a02-my-esp-crashes.rst
View File

@ -83,7 +83,7 @@ is wrong, it restarts itself to tell you about it.
There are two typical scenarios that trigger ESP restarts: There are two typical scenarios that trigger ESP restarts:
- **Exception** - when code is performing `illegal - **Exception** - when code is performing `illegal
operation <https://github.com/esp8266/Arduino/blob/master/doc/exception_causes.md>`__, operation <https://github.com/esp8266/Arduino/blob/master/doc/exception_causes.rst>`__,
like trying to write to non-existent memory location. like trying to write to non-existent memory location.
- **Watchdog** - if code is `locked - **Watchdog** - if code is `locked
up <https://en.wikipedia.org/wiki/Watchdog_timer>`__ staying too long up <https://en.wikipedia.org/wiki/Watchdog_timer>`__ staying too long
@ -104,7 +104,7 @@ Typical restart because of exception looks like follows:
Exception cause decoding Exception cause decoding
Start with looking up exception code in the `Exception Causes Start with looking up exception code in the `Exception Causes
(EXCCAUSE) <https://github.com/esp8266/Arduino/blob/master/doc/exception_causes.md>`__ (EXCCAUSE) <https://github.com/esp8266/Arduino/blob/master/doc/exception_causes.rst>`__
table to understand what kind of issue it is. If you have no clues what table to understand what kind of issue it is. If you have no clues what
it's about and where it happens, then use `Arduino ESP8266/ESP32 it's about and where it happens, then use `Arduino ESP8266/ESP32
Exception Stack Trace Exception Stack Trace
@ -361,4 +361,4 @@ Be specific and isolate the issue. Then ask community for support. There
are plenty of people that like to work with ESP and willing to help with are plenty of people that like to work with ESP and willing to help with
your problem. your problem.
`FAQ list :back: <readme.md>`__ `FAQ list :back: <readme.rst>`__

6
doc/faq/a03-library-does-not-work.rst
View File

@ -16,7 +16,7 @@ Introduction
You would like to use this Arduino library with ESP8266 and it doesn't You would like to use this Arduino library with ESP8266 and it doesn't
perform. It is not listed among `libraries verified to work with perform. It is not listed among `libraries verified to work with
ESP8266 <../doc/libraries.md#other-libraries-not-included-with-the-ide>`__. ESP8266 <../libraries.rst#other-libraries-not-included-with-the-ide>`__.
You couldn't find any evidence on internet that it is compatible. You couldn't find any evidence on internet that it is compatible.
What are the odds to make it working? What are the odds to make it working?
@ -77,7 +77,7 @@ Exceptions / Watchdog Resets
^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To troubleshoot resets follow FAQ item `My ESP crashes running some To troubleshoot resets follow FAQ item `My ESP crashes running some
code <a02-my-esp-crashes.md>`__. code <a02-my-esp-crashes.rst>`__.
Functionality Issues Functionality Issues
^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^
@ -109,4 +109,4 @@ the ESP8266 is shrinking. Community of ESP8266 enthusiasts is growing.
If you are unable to resolve the issues yourself, there are very good If you are unable to resolve the issues yourself, there are very good
odds that you will be able to find somebody else to help you. odds that you will be able to find somebody else to help you.
`FAQ list :back: <readme.md>`__ `FAQ list :back: <readme.rst>`__

4
doc/faq/a04-board-generic-is-unknown.rst
View File

@ -54,7 +54,7 @@ follows:
Error compiling for board Generic ESP8266 Module. Error compiling for board Generic ESP8266 Module.
Below is an example messages for Below is an example messages for
`WeMos <https://github.com/esp8266/Arduino/blob/master/doc/boards.md#wemos-d1>`__: `WeMos <https://github.com/esp8266/Arduino/blob/master/doc/boards.rst#wemos-d1>`__:
:: ::
@ -62,7 +62,7 @@ Below is an example messages for
Error compiling for board WeMos D1 R2 & mini. Error compiling for board WeMos D1 R2 & mini.
... and another one for `Adafruit ... and another one for `Adafruit
HUZZAH <https://github.com/esp8266/Arduino/blob/master/doc/boards.md#adafruit-huzzah-esp8266-esp-12>`__: HUZZAH <https://github.com/esp8266/Arduino/blob/master/doc/boards.rst#adafruit-huzzah-esp8266-esp-12>`__:
:: ::

2
doc/reference.rst
View File

@ -149,7 +149,7 @@ current speed. For example
| ``Serial`` and ``Serial1`` objects are both instances of the | ``Serial`` and ``Serial1`` objects are both instances of the
``HardwareSerial`` class. ``HardwareSerial`` class.
| I've done this also for official ESP8266 `Software | I've done this also for official ESP8266 `Software
Serial <https://github.com/esp8266/Arduino/blob/master/doc/libraries.md#softwareserial>`__ Serial <https://github.com/esp8266/Arduino/blob/master/doc/libraries.rst#softwareserial>`__
library, see this `pull library, see this `pull
request <https://github.com/plerup/espsoftwareserial/pull/22>`__. request <https://github.com/plerup/espsoftwareserial/pull/22>`__.
| Note that this implementation is **only for ESP8266 based boards**, | Note that this implementation is **only for ESP8266 based boards**,