Skip to content

Commit e3a3507

Browse files
Update more documentation http: refs to https:
1 parent e4f2f3e commit e3a3507

10 files changed

+28
-28
lines changed

doc/eclipse/eclipse.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ What to Download
66

77
- `arduino IDE <https://www.arduino.cc/en/Main/Software>`__
88
- `Eclipse IDE for C/C++
9-
Developers <http://www.eclipse.org/downloads/packages/eclipse-ide-cc-developers/oxygen3a>`__
10-
- `Java <http://www.java.com/>`__
9+
Developers <https://www.eclipse.org/downloads/packages/eclipse-ide-cc-developers/oxygen3a>`__
10+
- `Java <https://www.java.com/>`__
1111

1212
Setup Arduino
1313
~~~~~~~~~~~~~
@@ -18,8 +18,8 @@ See the
1818
Setup Eclipse
1919
~~~~~~~~~~~~~
2020

21-
- `step 1 <http://www.baeyens.it/eclipse/how_to.shtml#/c>`__
22-
- `step 2 <http://www.baeyens.it/eclipse/how_to.shtml#/e>`__
21+
- `step 1 <https://www.baeyens.it/eclipse/how_to.shtml#/c>`__
22+
- `step 2 <https://www.baeyens.it/eclipse/how_to.shtml#/e>`__
2323
- go to Window --> preferences --> Arduino
2424
- add as private hardware path the Part to the ESP8266
2525

doc/esp8266wifi/client-examples.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ End of header is marked with an empty line and then you should see the HTML code
230230
<h1>Example Domain</h1>
231231
<p>This domain is established to be used for illustrative examples in documents. You may use this
232232
domain in examples without prior coordination or asking for permission.</p>
233-
<p><a href="http://www.iana.org/domains/example">More information...</a></p>
233+
<p><a href="https://www.iana.org/domains/example">More information...</a></p>
234234
</div>
235235
</body>
236236
</html>

doc/esp8266wifi/readme.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ESP8266 is all about Wi-Fi. If you are eager to connect your new ESP8266 module
77
Introduction
88
------------
99

10-
The `Wi-Fi library for ESP8266 <https://github.com/esp8266/Arduino/tree/master/libraries/ESP8266WiFi>`__ has been developed based on `ESP8266 SDK <http://bbs.espressif.com/viewtopic.php?f=51&t=1023>`__, using naming convention and overall functionality philosophy of `Arduino WiFi library <https://www.arduino.cc/en/Reference/WiFi>`__. Over time the wealth Wi-Fi features ported from ESP9266 SDK to `esp8266 /
10+
The `Wi-Fi library for ESP8266 <https://github.com/esp8266/Arduino/tree/master/libraries/ESP8266WiFi>`__ has been developed based on `ESP8266 SDK <https://bbs.espressif.com/viewtopic.php?f=51&t=1023>`__, using naming convention and overall functionality philosophy of `Arduino WiFi library <https://www.arduino.cc/en/Reference/WiFi>`__. Over time the wealth Wi-Fi features ported from ESP9266 SDK to `esp8266 /
1111
Arduino <https://github.com/esp8266/Arduino>`__ outgrew `Arduino WiFi library <https://www.arduino.cc/en/Reference/WiFi>`__ and it became apparent that we need to provide separate documentation on what is new and extra.
1212

1313
This documentation will walk you through several classes, methods and properties of `ESP8266WiFi <https://github.com/esp8266/Arduino/tree/master/libraries/ESP8266WiFi>`__ library. If you are new to C++ and Arduino, don't worry. We will start from general concepts and then move to detailed description of members of each particular class including usage examples.
@@ -72,7 +72,7 @@ Connection process can take couple of seconds and we are checking for this to co
7272
7373
The ``while()`` loop will keep looping while ``WiFi.status()`` is other than ``WL_CONNECTED``. The loop will exit only if the status changes to ``WL_CONNECTED``.
7474

75-
The last line will then print out IP address assigned to ESP module by `DHCP <http://whatismyipaddress.com/dhcp>`__:
75+
The last line will then print out IP address assigned to ESP module by `DHCP <https://whatismyipaddress.com/dhcp>`__:
7676

7777
.. code:: cpp
7878
@@ -205,7 +205,7 @@ Check out separate section with `examples <udp-examples.rst>`__ / `list of funct
205205
Generic
206206
~~~~~~~
207207

208-
There are several functions offered by ESP8266's `SDK <http://bbs.espressif.com/viewtopic.php?f=51&t=1023>`__ and not present in `Arduino WiFi library <https://www.arduino.cc/en/Reference/WiFi>`__. If such function does not fit into one of classes discussed above, it will likely be in Generic Class. Among them is handler to manage Wi-Fi events like connection, disconnection or obtaining an IP, Wi-Fi mode changes, functions to manage module sleep mode, hostname to an IP address resolution, etc.
208+
There are several functions offered by ESP8266's `SDK <https://bbs.espressif.com/viewtopic.php?f=51&t=1023>`__ and not present in `Arduino WiFi library <https://www.arduino.cc/en/Reference/WiFi>`__. If such function does not fit into one of classes discussed above, it will likely be in Generic Class. Among them is handler to manage Wi-Fi events like connection, disconnection or obtaining an IP, Wi-Fi mode changes, functions to manage module sleep mode, hostname to an IP address resolution, etc.
209209

210210
Check out separate section with `examples <generic-examples.rst>`__ / `list of functions <generic-class.rst>`__.
211211

@@ -307,7 +307,7 @@ What's Inside?
307307

308308
If you like to analyze in detail what is inside of the ESP8266WiFi library, go directly to the `ESP8266WiFi <https://github.com/esp8266/Arduino/tree/master/libraries/ESP8266WiFi/src>`__ folder of esp8266 / Arduino repository on the GitHub.
309309

310-
To make the analysis easier, rather than looking into individual header or source files, use one of free tools to automatically generate documentation. The class index in chapter `Class Description`_ above has been prepared in no time using great `Doxygen <http://www.stack.nl/~dimitri/doxygen/>`__, that is the de facto standard tool for generating documentation from annotated C++ sources.
310+
To make the analysis easier, rather than looking into individual header or source files, use one of free tools to automatically generate documentation. The class index in chapter `Class Description`_ above has been prepared in no time using great `Doxygen <https://www.doxygen.nl/>`__, that is the de facto standard tool for generating documentation from annotated C++ sources.
311311

312312
.. figure:: pictures/doxygen-esp8266wifi-documentation.png
313313
:alt: Example of documentation prepared by Doxygen
@@ -325,4 +325,4 @@ If code is not annotated, you will still see the function prototype including ty
325325
.. figure:: pictures/doxygen-example-udp-begin.png
326326
:alt: Example of documentation for UDP begin method (not annotaed in code)by Doxygen
327327

328-
Several classes of `ESP8266WiFi <https://github.com/esp8266/Arduino/tree/master/libraries/ESP8266WiFi>`__ are not annotated. When preparing this document, `Doxygen <http://www.stack.nl/~dimitri/doxygen/>`__ has been tremendous help to quickly navigate through almost 30 files that make this library.
328+
Several classes of `ESP8266WiFi <https://github.com/esp8266/Arduino/tree/master/libraries/ESP8266WiFi>`__ are not annotated. When preparing this document, `Doxygen <https://www.doxygen.nl/>`__ has been tremendous help to quickly navigate through almost 30 files that make this library.

doc/esp8266wifi/server-examples.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Then let's write a short function ``prepareHtmlPage()``, that will return a ``St
5353
return htmlPage;
5454
}
5555
56-
The function does nothing fancy but just puts together a text header and `HTML <http://www.w3schools.com/html/>`__ contents of the page.
56+
The function does nothing fancy but just puts together a text header and `HTML <https://www.w3schools.com/html/>`__ contents of the page.
5757

5858
Header First
5959
~~~~~~~~~~~~
@@ -75,7 +75,7 @@ In our example the content type is ``text/html``, the connection will be closed
7575
Analog input: [Value]
7676
</html>
7777

78-
The content contains two basic `HTML <http://www.w3schools.com/html/>`__ tags, one to denote HTML document type ``<!DOCTYPE HTML>`` and another to mark beginning ``<html>`` and end ``</html>`` of the document. Inside there is a raw value read from ESP's analog input ``analogRead(A0)`` converted to the ``String`` type.
78+
The content contains two basic `HTML <https://www.w3schools.com/html/>`__ tags, one to denote HTML document type ``<!DOCTYPE HTML>`` and another to mark beginning ``<html>`` and end ``</html>`` of the document. Inside there is a raw value read from ESP's analog input ``analogRead(A0)`` converted to the ``String`` type.
7979

8080
.. code:: cpp
8181

doc/esp8266wifi/soft-access-point-class.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Function will return ``true`` or ``false`` depending on result of setting the so
6161
Notes:
6262

6363
- The network established by softAP will have default IP address of 192.168.4.1. This address may be changed using ``softAPConfig`` (see below).
64-
- Even though ESP8266 can operate in soft-AP + station mode, it actually has only one hardware channel. Therefore in soft-AP + station mode, the soft-AP channel will default to the number used by station. For more information how this may affect operation of stations connected to ESP8266's soft-AP, please check `this FAQ entry <http://bbs.espressif.com/viewtopic.php?f=10&t=324>`__ on Espressif forum.
64+
- Even though ESP8266 can operate in soft-AP + station mode, it actually has only one hardware channel. Therefore in soft-AP + station mode, the soft-AP channel will default to the number used by station. For more information how this may affect operation of stations connected to ESP8266's soft-AP, please check `this FAQ entry <https://bbs.espressif.com/viewtopic.php?f=10&t=324>`__ on Espressif forum.
6565

6666
softAPConfig
6767
^^^^^^^^^^^^

doc/esp8266wifi/station-class.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -501,7 +501,7 @@ Basing on this example, when running above code, module is initially disconnecte
501501
SSID
502502
^^^^
503503

504-
Return the name of Wi-Fi network, formally called `Service Set Identification (SSID) <http://www.juniper.net/techpubs/en_US/network-director1.1/topics/concept/wireless-ssid-bssid-essid.html#jd0e34>`__.
504+
Return the name of Wi-Fi network, formally called `Service Set Identification (SSID) <https://www.juniper.net/techpubs/en_US/network-director1.1/topics/concept/wireless-ssid-bssid-essid.html#jd0e34>`__.
505505

506506
.. code:: cpp
507507
@@ -535,7 +535,7 @@ Function returns value of the ``String`` type.
535535
BSSID
536536
^^^^^
537537

538-
Return the mac address of the access point to which the ESP module was directed to connect to. This address is formally called `Basic Service Set Identification (BSSID) <http://www.juniper.net/techpubs/en_US/network-director1.1/topics/concept/wireless-ssid-bssid-essid.html#jd0e47>`__. The returned pointer is what the user configured when calling begin() with a bssid argument. It does _not_ necessarily reflect the mac address of the access point to which the ESP module's station interface is currently connected to.
538+
Return the mac address of the access point to which the ESP module was directed to connect to. This address is formally called `Basic Service Set Identification (BSSID) <https://www.juniper.net/techpubs/en_US/network-director1.1/topics/concept/wireless-ssid-bssid-essid.html#jd0e47>`__. The returned pointer is what the user configured when calling begin() with a bssid argument. It does _not_ necessarily reflect the mac address of the access point to which the ESP module's station interface is currently connected to.
539539

540540
.. code:: cpp
541541
@@ -587,12 +587,12 @@ Signal strength value is provided in dBm. The type of returned value is ``int32_
587587
Connect Different
588588
~~~~~~~~~~~~~~~~~
589589

590-
`ESP8266 SDK <http://bbs.espressif.com/viewtopic.php?f=51&t=1023>`__ provides alternate methods to connect ESP station to an access point. Out of them `esp8266 / Arduino <https://github.com/esp8266/Arduino>`__ core implements `WPS <#wps>`__ and `Smart Config <#smart-config>`__ as described in more details below.
590+
`ESP8266 SDK <https://bbs.espressif.com/viewtopic.php?f=51&t=1023>`__ provides alternate methods to connect ESP station to an access point. Out of them `esp8266 / Arduino <https://github.com/esp8266/Arduino>`__ core implements `WPS <#wps>`__ and `Smart Config <#smart-config>`__ as described in more details below.
591591

592592
WPS
593593
^^^
594594

595-
The following ``beginWPSConfig`` function allows connecting to a network using `Wi-Fi Protected Setup (WPS) <https://en.wikipedia.org/wiki/Wi-Fi_Protected_Setup>`__. Currently only `push-button configuration <http://www.wi-fi.org/knowledge-center/faq/how-does-wi-fi-protected-setup-work>`__ (``WPS_TYPE_PBC`` mode) is supported (SDK 1.5.4).
595+
The following ``beginWPSConfig`` function allows connecting to a network using `Wi-Fi Protected Setup (WPS) <https://en.wikipedia.org/wiki/Wi-Fi_Protected_Setup>`__. Currently only `push-button configuration <https://www.wi-fi.org/knowledge-center/faq/how-does-wi-fi-protected-setup-work>`__ (``WPS_TYPE_PBC`` mode) is supported (SDK 1.5.4).
596596

597597
.. code:: cpp
598598
@@ -661,4 +661,4 @@ Stop smart config, free the buffer taken by ``beginSmartConfig()``. Depending on
661661
662662
stopSmartConfig()
663663
664-
For additional details regarding Smart Config please refer to `ESP8266 API User Guide <http://bbs.espressif.com/viewtopic.php?f=51&t=1023>`__.
664+
For additional details regarding Smart Config please refer to `ESP8266 API User Guide <https://bbs.espressif.com/viewtopic.php?f=51&t=1023>`__.

doc/faq/a01-espcomm_sync-failed.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ by user [@mytrain](https://github.com/mytrain) and discussed in
264264

265265
If you prefer external terminal program, then for Windows users we can
266266
recommend free and handy
267-
`Termite <http://www.compuphase.com/software_termite.htm>`__.
267+
`Termite <https://www.compuphase.com/software_termite.htm>`__.
268268

269269
Nodemcu
270270
^^^^^^^
@@ -370,7 +370,7 @@ If this is still not the case, then review once more all discussed steps in the
370370

371371
* [ ] What is the name and version of your IDE and O/S?
372372

373-
If you are stuck at certain step, then post this list on `ESP8266 Community Forum <http://www.esp8266.com/>`__ asking for support.
373+
If you are stuck at certain step, then post this list on `ESP8266 Community Forum <https://www.esp8266.com/>`__ asking for support.
374374

375375
Conclusion
376376
~~~~~~~~~~
@@ -389,7 +389,7 @@ detailed upload log for inconsistencies with IDE settings.
389389
Verify your connection diagram and wave-form for consistency with
390390
selected reset method.
391391

392-
If you get stuck, then ask `community <http://www.esp8266.com/>`__ for
392+
If you get stuck, then ask `community <https://www.esp8266.com/>`__ for
393393
support providing summary of all completed checks.
394394

395395
.. figure:: pictures/a01-test-stand.jpg

doc/faq/a02-my-esp-crashes.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ ESP provides two watchdog timers (wdt) that observe application for lock
120120
up.
121121

122122
- **Software Watchdog** - provided by
123-
`SDK <http://bbs.espressif.com/viewforum.php?f=46>`__, that is part
123+
`SDK <https://bbs.espressif.com/viewforum.php?f=46>`__, that is part
124124
of `esp8266 / arduino <https://github.com/esp8266/Arduino>`__ core
125125
loaded to module together with your application.
126126
- **Hardware Watchdog** - build in ESP8266 hardware and acting if

doc/faq/readme.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ FAQ
33

44
The purpose of this FAQ / Troubleshooting is to respond to questions
55
commonly asked in `Issues <https://github.com/esp8266/Arduino/issues>`__
6-
section and on `ESP8266 Community forum <http://www.esp8266.com/>`__.
6+
section and on `ESP8266 Community forum <https://www.esp8266.com/>`__.
77

88
Where possible we are going right to the answer and provide it within
99
one or two paragraphs. If it takes more than that, you will see a link

doc/ota_updates/readme.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -291,9 +291,9 @@ If OTA update fails, first step is to check for error messages that may be shown
291291

292292
This window is for Arduino Yún and not yet implemented for esp8266/Arduino. It shows up because IDE is attempting to open Serial Monitor using network port you have selected for OTA upload.
293293

294-
Instead you need an external serial monitor. If you are a Windows user check out `Termite <http://www.compuphase.com/software_termite.htm>`__. This is handy, slick and simple RS232 terminal that does not impose RTS or DTR flow control. Such flow control may cause issues if you are using respective lines to toggle GPIO0 and RESET pins on ESP for upload.
294+
Instead you need an external serial monitor. If you are a Windows user check out `Termite <https://www.compuphase.com/software_termite.htm>`__. This is handy, slick and simple RS232 terminal that does not impose RTS or DTR flow control. Such flow control may cause issues if you are using respective lines to toggle GPIO0 and RESET pins on ESP for upload.
295295

296-
Select COM port and baud rate on external terminal program as if you were using Arduino Serial Monitor. Please see typical settings for `Termite <http://www.compuphase.com/software_termite.htm>`__ below:
296+
Select COM port and baud rate on external terminal program as if you were using Arduino Serial Monitor. Please see typical settings for `Termite <https://www.compuphase.com/software_termite.htm>`__ below:
297297

298298
.. figure:: termite-configuration.png
299299
:alt: Termite settings
@@ -380,8 +380,8 @@ You can use another module if it meets previously described `requirements <#basi
380380
https://github.com/esp8266/Arduino#installing-with-boards-manager
381381
- Host software depending on O/S you use:
382382

383-
1. Avahi http://avahi.org/ for Linux
384-
2. Bonjour http://www.apple.com/support/bonjour/ for Windows
383+
1. Avahi https://avahi.org/ for Linux
384+
2. Bonjour https://www.apple.com/support/bonjour/ for Windows
385385
3. Mac OSX and iOS - support is already built in / no any extra
386386
s/w is required
387387

@@ -451,7 +451,7 @@ You can use another module if it meets previously described `requirements <#basi
451451
:alt: Serial Monitor - after OTA update
452452

453453
Just after reboot you should see exactly the same message
454-
``HTTPUpdateServer ready! Open http:// esp8266-webupdate.local /update in your browser``
454+
``HTTPUpdateServer ready! Open http://esp8266-webupdate.local/update in your browser``
455455
like in step 3. This is because module has been loaded again with the
456456
same code – first using serial port, and then using OTA.
457457

0 commit comments

Comments
 (0)