arduino/esp8266
1
0
Fork 0
mirror of https://github.com/esp8266/Arduino.git synced 2025-07-30 16:24:09 +03:00
Code Activity

Improve the compatibility of the doc between Github and RTD... (#4800)

Browse Source 
* Update requirements.txt

* Update conf.py

* Update libraries.rst

* Update libraries.rst

* Update libraries.rst

* Update stack_dump.rst

* Update client-examples.rst

* Update readme.rst

* Update readme.rst

* Update server-class.rst

* Update server-examples.rst

* Update soft-access-point-class.rst

* Update station-class.rst

* Update station-examples.rst

* Update udp-class.rst

* Update udp-examples.rst

* Update a04-board-generic-is-unknown.rst

* Update readme.rst

* Update readme.rst

* Update readme.rst
This commit is contained in:
ZaPpInG
2018-06-28 16:58:33 +02:00
committed by Develo
parent 0f34bd85d8
commit 1eb0645dcb
16 changed files with 40 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -11,8 +11,6 @@ This error may pop up after switching between
.. figure:: pictures/a04-board-is-unknown-error.png
:alt: Board nodemcu2 (platform esp8266, package esp8266) is unknown error
alt text
If you face this issue, you will not be able to compile any sketch for
any ESP8266 module type.
@ -34,16 +32,12 @@ installation.
.. figure:: pictures/a04-remove-package-yes.png
:alt: If changing between staging and stable, remove currently installed package
alt text
There is no need to remove the installed package if you are changing it
to another version (without switching between staging and stable).
.. figure:: pictures/a04-remove-package-no.png
:alt: No need to remove installed package if changing its version
alt text
Depending on selected module the error message is slightly different.
For instance, if you choose *Generic ESP8266 Module*, it will look as
follows:
@ -101,16 +95,12 @@ Example below shows the path for Windows.
.. figure:: pictures/a04-arduino-ide-preferences.png
:alt: Checking of Arduino IDE Preferences
alt text
2. Click provided link to open the folder. For Windows 7 it will look as
follows:
.. figure:: pictures/a04-contents-of-preferences-folder.png
:alt: Contents of Arduino IDE preferences folder
alt text
3. Navigate further down to
``Arduino15\packages\esp8266\hardware\esp8266`` directory. Inside you
will find two folders with different esp8266 / Arduino package
@ -119,8 +109,6 @@ Example below shows the path for Windows.
.. figure:: pictures/a04-contents-of-package-folder.png
:alt: Checking of contents of esp8266 / Arduino package folder
alt text
4. Delete the older folder. Restart Arduino IDE, select your ESP module
and the error should be gone.

8
doc/faq/readme.rst
View File

@ -20,7 +20,7 @@ This message indicates issue with uploading ESP module over a serial
connection. There are couple of possible causes, that depend on the type
of your module, if you use separate USB to serial converter.
:doc:`Read more <a01-espcomm_sync-failed>`.
`Read more <a01-espcomm_sync-failed.rst>`__.
Why esptool is not listed in "Programmer" menu? How do I upload ESP without it?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -38,7 +38,7 @@ My ESP crashes running some code. How to troubleshoot it?
The code may crash because of s/w bug or issue with your h/w. Before
entering an issue report, please perform initial troubleshooting.
:doc:`Read more <a02-my-esp-crashes>`.
`Read more <a02-my-esp-crashes.rst>`__.
This Arduino library doesn't work on ESP. How do I make it work?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -46,7 +46,7 @@ This Arduino library doesn't work on ESP. How do I make it work?
You would like to use this Arduino library with ESP8266 and it does not
perform. It is not listed among libraries verified to work with ESP8266.
:doc:`Read more <a03-library-does-not-work>`.
`Read more <a03-library-does-not-work.rst>`__.
In the IDE, for ESP-12E that has 4M flash, I can choose 4M (1M SPIFFS) or 4M (3M SPIFFS). No matter what I select, the IDE tells me the maximum code space is about 1M. Where does my flash go?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -87,7 +87,7 @@ This error may pop up after switching between
`staging <https://github.com/esp8266/Arduino#staging-version->`__ and
`stable <https://github.com/esp8266/Arduino#stable-version->`__ esp8266
/ Arduino package installations, or after upgrading the package version
:doc:`Read more <a04-board-generic-is-unknown>`.
`Read more <a04-board-generic-is-unknown.rst>`__.
How to clear TCP PCBs in time-wait state ?