1
0
mirror of https://github.com/esp8266/Arduino.git synced 2025-04-22 21:23:07 +03:00

314 Commits

Author SHA1 Message Date
Earle F. Philhower, III
848fbf5b4a
Update conf.py from git tag, fix sphinx warnings (#5716)
Fixes #5671

Implements https://protips.readthedocs.io/git-tag-version.html

Fix a myriad of minor Sphinx warnings generated in the docs.
2019-02-04 20:19:23 +00:00
david gauchard
8aadd31bd5 back to dev (#5676) 2019-01-26 04:15:30 -03:00
Develo
eb6d31f572
Update conf.py (#5518)
version bump to 2.5.0-beta2
2019-01-25 18:12:14 -03:00
ZaPpInG
4d302f06c9 Fix missed backquote to make monospaced text in gdb.rst (#5663)
* Fix missed backquote to make monospaced text in gdb.rst
* Fix line spacing on example walkthrough
2019-01-24 23:04:56 +01:00
ZaPpInG
ece93908a8 Complete info how to find elf file in windows (#5660) 2019-01-24 18:56:08 +00:00
ZaPpInG
a9e89500e1 Correct path to GDB in Windows (#5659)
* Correct path to GDB in Windows

* Added Linux and Windows label

* Added using git version
2019-01-24 14:49:16 -03:00
Earle F. Philhower, III
bff3a6d963 GDB support w/new toolchain and UART driver (#5559)
* Add full gdb support with uart/Serial integration

* Fix GDB merge errors

* Update to unpatched GDB protocol specification

It appears that Espressif patched the open source xtensa GDB port in
order to build their old GDB executable and their old gdbstub (basically
removing any register in a generic xtensa and only leaving those
present in the chip they synthesized).  Their GDBStub also assumed this
behavior.

Unpatched upstream GNU GDB now expects all the registers in
xtensa-config.c to be sent/read on a 'g' command.  Change the GDB stub
to send "xxxxxxxx"s (legal per the spec) for unimplemented registers.
This makes the 'g' response much longer, but it's results are cached
and in an interactive debugger it isn't noticeable.

* Fix .iram.literal to come before .iram.text for GDB

* Move functions to flash, call using wrappers

All functions which are not interrupt or exception called are now in
flash. A small IRAM wrapper enables flash when processing main GDB ops
by calling Cache_Read_Enable_New() and then jumping to the main flash
code.  This seems to work for catching exceptions, data and code breaks,
and Ctrl-C.

The UART ISR handler and exception handler register-saving bits of
code in ASM are still in IRAM.

GDB IRAM usage is now about 670 bytes.

* Remove LWIP2 builder commit

* Add documentation and gdbstub_init header

Add some simple GDB documentation to the main tree showing a worked
example.

Adds the definition of `void gdbstub_init()` to <GDBStub.h>

* Clean up GDB include and library dir

Replace GDBstub.h with the version in the internal/ directory, and
adjust stub code accordingly.  This way, only one copy of a file called
"GDBstub.h" will exist.

Update the gdbcommands and replace the obsolete ESPRESSIF readme with
@kylefleming's version since we're mainly doing serial, not TCP,
connected debugging.

Bump the library rev. number since this is a pretty big functionality
change.

Minor documentation tweak.

* Undo much of UART refactoring, set fifo IRQ to 16

Remove the refactoring of pin control and other little things not directly
related to GDB processing.  Should greatly reduce the diff size in uart.c.
Should also remove any register value changes (intended or otherwise)
introduced in the original PR from @kylefleming.

Set the FIFO interrupt to 16 chars when in GDB mode, matching the latest
UART configuration for highest speed.

* Add architecture comments, cleanup uart.c code

Comments added to UART.c trying to explain (as best as I understand it)
the changes done to support GDB and how they interact with standard
operation.

Fix the uart_uninit to stop the ISR and then free appropriately.

Fix uart_isr_handle_data (GDB's shim for sending chars to the 8266 app)
to do the exact same thing as the standard UART handler including set
the overflow properly and either discard or overwrite in that case.

Fix serial reception when GDB enabled by enabling the user recv ISR.

Remove commented attributes from gdbstub, leftover from the move to
flash.

General logic cleanup per comments in the PR.

* Also set the UART flags for HW error in GDB

Ensure we also check the UART flags and set the uart status
appropriately when in GDB mode.
2019-01-23 17:51:35 -03:00
Peter
4657666319 Correct 'git submodule' syntax (#5654)
Should be singular, not plural (submodule, not submodules)
2019-01-23 16:41:09 +01:00
ZaPpInG
39e31b2352 Correct link to Arduino Board Manager info (#5650)
The link was pointing to Arduino Libraries Manager info and not to Arduino Board Manager info.
2019-01-22 17:29:44 +01:00
Philipp Reichmuth
324eb56d65 Add fix for SoftwareSerial submodule errors to documentation (#5602)
* Add fix for SoftwareSerial submodule errors to documentation

* Update installing.rst

Replaces and based on #5602
Fixes #5583

* Update installing.rst

Remove forgotten section
Add update section for Other OS
2019-01-18 17:55:20 -03:00
Max Prokhorov
e043806065 Mention eboot use of rtc memory (#5439) 2018-12-05 15:14:31 -03:00
Alwin Arrasyid
ca3678f7c1 ESPectro Core board support (#5419) 2018-12-03 15:27:06 +01:00
Earle F. Philhower, III
d8acfffdb0
Add cryptographically signed update support (#5213)
Using a pluggable architecture, allow updates delivered via the Update
class to be verified as signed by a certificate.  By using plugins, avoid
pulling either axTLS or BearSSL into normal builds.

A signature is appended to a binary image, followed by the size of the
signature as a 32-bit int.  The updater takes a verification function
and checks this signature using whatever method it chooses, and if it
fails the update is not applied.

A SHA256 hash class is presently implemented for the signing hash (since
MD5 is a busted algorithm).

A BearSSLPublicKey based verifier is implemented for RSA keys.  The
application only needs the Public Key, while to sign you can use
OpenSSL and your private key (which should never leave your control
or be deployed on any endpoints).

An example using automatic signing is included.

Update the docs to show the signing steps and how to use it in the
automatic and manual modes.

Also remove one debugging line from the signing tool.

Saves ~600 bytes when in debug mode by moving strings to PMEM

Windows can't run the signing script, nor does it normally have OpenSSL
installed.  When trying to build an automatically signed binary, warn
and don't run the python.
2018-12-02 19:57:47 -08:00
david gauchard
b504881be4 document wificlient loop (#5355)
fix #5257
2018-11-20 17:37:21 -02:00
Develo
979e5cebd9
Update generic-class.rst (#5338)
Fix link to WiFiEvents
Add note about WiFiClients and WiFiServers going down when a WiFi interface goes down, and that it's the user's responsibility to bring them back up.
2018-11-12 22:56:20 -03:00
dav1901
79a6f36a02 Fix doc for ESP8266WiFi (#5325)
* Fix WiFiAP doc

* Fix softAP doc

* Fix doc
2018-11-08 07:06:54 -08:00
Develo
53edcfd94d
Update libraries.rst with ESP-NOW (#5322)
Fixes #2227
2018-11-08 02:14:33 -03:00
A C SREEDHAR REDDY
4726a2501a typo fix (#5319) 2018-11-07 11:13:20 -03:00
Earle F. Philhower, III
233d3e3b5e
Move BearSSLHelpers into BearSSL namespace (#5315)
BearSSLX509List, BearSSLSession, BearSSLPublicKey, and BearSSLPrivateKey
were all in the global namespace and not in the BearSSL:: one, due to an
oversight when they were originally created.  Move them to the proper
namespace with the following mapping:
    BearSSLX509List => BearSSL::X509List
    BearSSLSession => BearSSL::Session
    BearSSLPublicKey => BearSSL::PublicKey
    BearSSLPrivateKey => BearSSL::PrivateKey
2018-11-06 19:27:40 -08:00
Earle F. Philhower, III
feb86cd4ff
Add BearSSL documentation (#5311)
Document the BearSSL::WiFiClientSecure, ::WiFiServerSecure, and the
helper classes required to use them.
2018-11-06 11:45:52 -08:00
Develo
8785143bff
Fix/update doc for dir object (#5291)
* Fix arg type in Wire to size_t

* Document dir.fileSize() and other nearby doc fixes
2018-10-29 14:53:50 -03:00
Invent Victor
d7ca884007 support new board (invent one) (#5286)
* add inventone to boards.txt.py

* add inventone pin mapping .h file to variants

* generate files running boards.txt.py via Python2

* delete .orig files
2018-10-28 15:44:31 -03:00
teo1978
2eb5b5600a Update debugging.rst (#5234)
* Update debugging.rst

PLEASE REVIEW
The current link definitely points to the wrong line, where there's nothing remotely resembling a list of DEBUG_ESP_* definitions. There's not an actual "full list" in the whole boards.txt really, but this is the closest thing that can be found in that file.
Some additional explanation is needed though, unless there is an actual list somewhere else.

* Update debugging.rst

requested change
2018-10-12 21:48:53 -03:00
david gauchard
8ef21ca3ae Update to the last version of nonos-sdk V2, WiFi addons (#5210)
* fwupdate

* fw update to latest version:
WPA working, WEP+Open disabled by default. Need API change.

* helpers to follow sdk updates

* remove compare scripts - made a separate PR for them

* add wep api, restore original espressif comment (wep enabled does not prevent wpa)

* libmain was not up to date

* experimental: DTIM setting in WiFi.setSleepMode(WIFI_LIGHT/MODEM_SLEEP, DTIM-value)
with new getter: .getListenInterval() / .isSleepLevelMax()

* fixes

* fix debug message

* when not using listenInterval, set wifi sleep level to min

* update documentation

* update doc
2018-10-09 10:21:23 -03:00
aerlon
24a1d22730 Make softAP documentation state the correct min value (0) for the max_connection argument. (#5165) 2018-10-01 14:27:16 -03:00
daud
7643e7b05b fix doc link (#5190) 2018-10-01 02:21:46 -03:00
david gauchard
83a8076db8 ClientContext (tcp) updates (#5089)
* +sync, get/set default nodelay, sync

* default nodelay=1

* update flush()

* fix return value

* ClientContext: put things together

* ClientContext: fix debugging messages

* WiFiClient: move static members out of the class, add comments

* remove circular dependency

* parameter and return value for Client::flush&stop, flush timeout raised to 300ms

* tcp flush: restart timer on ack receive

* OTA protocol needs setNoDelay(true)

* fix Ethernet with Client changes

* 1 line unredable -> 5 lines readable code

* doc

* Update client-class.rst

* Added details for getters
2018-09-25 10:47:27 -03:00
Earle F. Philhower, III
7e1bdb225d
Require sphinx 1.7 due to bugs with new v1.8 (#5132)
Sphinx 1.8.0 seems to always fail to build the docs due to interactions
with doctest.py.  This means no CI builds can pass and no new PRs can be
applied.

Fix the version at 1.7.9 for now until the dependencies get updated to with 1.8.

The error seen is:
  File "/home/travis/.local/lib/python2.7/site-packages/sphinx/highlighting.py", line 26, in <module>
    from sphinx.ext import doctest
SyntaxError: unqualified exec is not allowed in function 'run' it contains a nested function with free variables (doctest.py, line 97)
The full traceback has been saved in /tmp/sphinx-err-e8JyUQ.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
2018-09-12 14:20:02 -07:00
david gauchard
ce28a76a24 metric for heap fragmentation (#5090)
* +Esp.getHeapUnfragness()

* only in debug mode

* default value

* always enable, 64->32, light 32 integer square root, comments

* fix when debugging is disabled

* give credits

* cosmetics

* fragmentation metric updates (doc, better api, added getMaxFreeBlockSize())

* api reworked, +example

* fixe types, fix names

* coding style fix

* use astyle for example
2018-09-10 01:50:01 -03:00
aerlon
c33ef89f60 Fix formatting of bullet lists (#5098) 2018-08-31 14:03:37 -03:00
David Albert
3164af0f35 Update readme.rst (#5092)
Document additional build flag needed to support WPS under 2.4.2
2018-08-30 13:24:52 -03:00
David Albert
a917ad9941 Update a05-board-generator.rst (#5093)
Added additional information about where to find the core root directory (often deeply hidden) so users can run board generator
2018-08-29 23:52:44 -04:00
aerlon
1d841953ab Soft-AP documentation update (#5088)
* Add information about the max_connection constructor argument.

* Correct information about max soft-AP connections.

* Add information about what happens when max_connection is reached.

* Correct terminology

* - Correct the valid range of max_connection to 1 - 8.
- Include reference.
2018-08-29 11:17:44 -04:00
yoursunny
1ed7bee15e doc: improve WiFi.persistent documentation (#5081)
fixes #3641
2018-08-29 01:39:09 -04:00
jlpuder
9634f79f45 Format lists for readability (#5082)
Changed in-line style to bulleted lists for improved readability
2018-08-27 09:58:25 -04:00
david gauchard
85e68093e9
Automatic stack location selection (SYS or HEAP), enable per library AR-chive in arduino build system (#5018)
Automatic stack location selection (SYS or HEAP), enable per library AR-chive in arduino build system 

* enable dot_a_linkage on internal libraries
* add device tests
* boards generator: deprecate --noextra4k/--allowWPS and fix documentation
2018-08-20 14:35:52 +02:00
Anthony Elder
5c7dbf4e4b Add instantly option to deepSleep (#5052)
* Add instantly option to deepSleep

* Move system_deep_sleep_instant to a new deepSleepInstant function
2018-08-19 05:46:33 -03:00
SarenT
cbcefa7d3f Analog input voltage can be 3.3V (#5020)
* Analog input voltage can be 3.3V

According to this tutorial and my personal test with my Amica, 1.0V delivers 320 and 3.3V delivers 1024 at 10-bit resolution. I guess 3.3V is possible.

* Update reference.rst

Added warnings.

* Update reference.rst

* Update reference.rst

requested  changes
2018-08-13 22:53:39 -03:00
WEMOS Electronics
319adc6b8a Fix boards.txt.py compatible with python3 (#4998) 2018-08-03 10:45:03 +02:00
Jeroen88
e4d9c279ef Function added to detect baudrate (#4978)
* Function added to detect baudrate

* Added uart_start_detect_baudrate, detectBaudrate() wrappers for HardwareSerial and an example usage SerialDetectBaudrate.ino

* Some layout changes to pass Travis tests

* Some more nitty-gritty layout changes to pass Travis tests

* Some even more nitty-gritty layout changes to pass Travis tests

* renamed one function to testBaudrate() and updated doc/reference.rst

* Minor updates to doc/reference.rst

* New lines added
2018-08-01 15:33:25 -04:00
david gauchard
3ab38d690d board generator documentation (#4989)
* update "more flash" doc

* doc: try to emphasize OOM knowledge

* fighting with markdown?

* it seems I can't emphasize text in link

* board generator doc: need reviewers

* markdown formatting, typos

* typos

* add links

* + last memory failure allocation + emphasis exception decoder

* more emphasis on exception decoder

* repeat the board generator introduction

* fixes
2018-08-01 00:00:59 -04:00
WEMOS Electronics
b1f0435fb3 change "WeMos" to new brand name "LOLIN" (#4984)
* change "WeMos" to new brand name "LOLIN"
2018-07-31 20:55:35 -04:00
Steven Conaway
0899ae9d3e Update a03-library-does-not-work.rst (#4971) 2018-07-28 21:43:17 -04:00
Joseph Spencer
2ee744ecdd Adding Notes in WiFi.begin docs (closes #4949) (#4958)
* Also fixing formatting of unrelated link in station class docs.
2018-07-28 20:52:54 -04:00
Jack Shao
3906ee4d91 Add support for Seeed Wio Link board (#4943) 2018-07-20 14:51:32 -04:00
brendanvanbreda
e5648f3dfd Add support for XinaBox (#4929)
Add support for the XinaBox CW01;
2018-07-17 11:53:26 -07:00
A C SREEDHAR REDDY
79a7ff8263 Update stack_dump.rst (#4933) 2018-07-17 09:22:13 -04:00
david gauchard
e486887f18
optionally allow WPS (#4889) 2018-07-06 16:45:25 +02:00
david gauchard
672c3f8d79
boards updates: nodemcu doc update (@lrmoreno007 #4715) + 512k32spiffs (@carlymx #4871) (#4880)
* boards updates: nodemcu doc update (@lrmoreno007 #4715) + 512k32spiffs (@carlymx #4871)

* sometimes -> usually
2018-07-03 22:14:06 +02:00
ZaPpInG
1eb0645dcb Improve the compatibility of the doc between Github and RTD... (#4800)
* 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
2018-06-28 10:58:33 -04:00