arduino/esp8266
1
0
Fork 0
mirror of https://github.com/esp8266/Arduino.git synced 2025-06-15 00:02:49 +03:00
Code Activity

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
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.
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
~~~~~~~~~~~~~~~~~~~~~~
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
~~~~~~~~~~~~~~~
@ -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.
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.
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
-------------
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
-----------------
@ -71,7 +71,7 @@ We can obtain the ``fingerprint`` for specific ``host`` using a web browser. For
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
~~~~~~~~~~~~~~~~~~~~~
@ -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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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

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

@ -27,7 +27,7 @@ WiFiEventHandler
WiFiEventHandler onSoftAPModeStationConnected (std::function< void(const WiFiEventSoftAPModeStationConnected &)>)
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
~~~~~~~~~~

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

@ -3,7 +3,7 @@
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
-----------------
@ -29,7 +29,7 @@ We would like to write a code that will inform us that connection to Wi-Fi netwo
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.
@ -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.
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
~~~~~~~~~~~~~~~~~~~~~~~
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?
--------------

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
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.
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
-------
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?
@ -19,7 +19,7 @@ Table of Contents
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
@ -100,7 +100,7 @@ Function ``monitorWiFi()`` is in place to show when connection is lost by displa
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:

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
~~~~~~~~~~~~~~~~
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
~~~~~~~~~