mirror of
https://github.com/esp8266/Arduino.git
synced 2025-04-21 10:26:06 +03:00
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.
This commit is contained in:
parent
04dc463153
commit
848fbf5b4a
@ -336,7 +336,7 @@ LOLIN(WEMOS) D1 mini Lite
|
|||||||
-------------------------
|
-------------------------
|
||||||
|
|
||||||
Parameters in Arduino IDE:
|
Parameters in Arduino IDE:
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
- Card: "WEMOS D1 Mini Lite"
|
- Card: "WEMOS D1 Mini Lite"
|
||||||
- Flash Size: "1M (512K SPIFFS)"
|
- Flash Size: "1M (512K SPIFFS)"
|
||||||
@ -344,14 +344,14 @@ Parameters in Arduino IDE:
|
|||||||
- Upload Speed: "230400"
|
- Upload Speed: "230400"
|
||||||
|
|
||||||
Power:
|
Power:
|
||||||
~~~~~
|
~~~~~~
|
||||||
|
|
||||||
- 5V pin : 4.7V 500mA output when the board is powered by USB ; 3.5V-6V input
|
- 5V pin : 4.7V 500mA output when the board is powered by USB ; 3.5V-6V input
|
||||||
- 3V3 pin : 3.3V 500mA regulated output
|
- 3V3 pin : 3.3V 500mA regulated output
|
||||||
- Digital pins : 3.3V 30mA.
|
- Digital pins : 3.3V 30mA.
|
||||||
|
|
||||||
links:
|
links:
|
||||||
~~~~~
|
~~~~~~
|
||||||
|
|
||||||
- Product page: https://www.wemos.cc/
|
- Product page: https://www.wemos.cc/
|
||||||
- Board schematic: https://wiki.wemos.cc/_media/products:d1:sch_d1_mini_lite_v1.0.0.pdf
|
- Board schematic: https://wiki.wemos.cc/_media/products:d1:sch_d1_mini_lite_v1.0.0.pdf
|
||||||
|
@ -16,6 +16,7 @@
|
|||||||
# add these directories to sys.path here. If the directory is relative to the
|
# add these directories to sys.path here. If the directory is relative to the
|
||||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||||
#
|
#
|
||||||
|
import re
|
||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
# sys.path.insert(0, os.path.abspath('.'))
|
# sys.path.insert(0, os.path.abspath('.'))
|
||||||
@ -55,10 +56,10 @@ author = u'Ivan Grokhotkov'
|
|||||||
# |version| and |release|, also used in various other places throughout the
|
# |version| and |release|, also used in various other places throughout the
|
||||||
# built documents.
|
# built documents.
|
||||||
#
|
#
|
||||||
|
# Tip from https://protips.readthedocs.io/git-tag-version.html to get version from tag
|
||||||
|
release = re.sub('^v', '', os.popen('git describe').read().strip())
|
||||||
# The short X.Y version.
|
# The short X.Y version.
|
||||||
version = u'2.5.0-beta3'
|
version = release
|
||||||
# The full version, including alpha/beta/rc tags.
|
|
||||||
release = u'2.5.0-beta3'
|
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
# for a list of supported languages.
|
# for a list of supported languages.
|
||||||
|
@ -125,22 +125,22 @@ Prior to connecting to a server, the `BearSSL::WiFiClientSecure` needs to be tol
|
|||||||
There are multiple modes to tell BearSSL how to verify the identity of the remote server. See the `BearSSL_Validation` example for real uses of the following methods:
|
There are multiple modes to tell BearSSL how to verify the identity of the remote server. See the `BearSSL_Validation` example for real uses of the following methods:
|
||||||
|
|
||||||
setInsecure()
|
setInsecure()
|
||||||
^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^
|
||||||
|
|
||||||
Don't verify any X509 certificates. There is no guarantee that the server connected to is the one you think it is in this case, but this call will mimic the behavior of the deprecated axTLS code.
|
Don't verify any X509 certificates. There is no guarantee that the server connected to is the one you think it is in this case, but this call will mimic the behavior of the deprecated axTLS code.
|
||||||
|
|
||||||
setKnownKey(const BearSSL::PublicKey *pk)
|
setKnownKey(const BearSSL::PublicKey \*pk)
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
Assume the server is using the specific public key. This does not verify the identity of the server or the X509 certificate it sends, it simply assumes that its public key is the one given. If the server updates its public key at a later point then connections will fail.
|
Assume the server is using the specific public key. This does not verify the identity of the server or the X509 certificate it sends, it simply assumes that its public key is the one given. If the server updates its public key at a later point then connections will fail.
|
||||||
|
|
||||||
setFingerprint(const uint8_t fp[20]) / setFingerprint(const char *fpStr)
|
setFingerprint(const uint8_t fp[20]) / setFingerprint(const char \*fpStr)
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
Verify the SHA1 fingerprint of the certificate returned matches this one. If the server certificate changes, it will fail. If an array of 20 bytes are sent in, it is assumed they are the binary SHA1 values. If a `char*` string is passed in, it is parsed as a series of human-readable hex values separated by spaces or colons (e.g. `setFingerprint("00:01:02:03:...:1f");`)
|
Verify the SHA1 fingerprint of the certificate returned matches this one. If the server certificate changes, it will fail. If an array of 20 bytes are sent in, it is assumed they are the binary SHA1 values. If a `char*` string is passed in, it is parsed as a series of human-readable hex values separated by spaces or colons (e.g. `setFingerprint("00:01:02:03:...:1f");`)
|
||||||
|
|
||||||
setTrustAnchors(BearSSL::X509List *ta)
|
setTrustAnchors(BearSSL::X509List \*ta)
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
Use the passed-in certificate(s) as a trust anchor, accepting remote certificates signed by any of these. If you have many trust anchors it may make sense to use a `BearSSL::CertStore` because it will only require RAM for a single trust anchor (while the `setTrustAnchors` call requires memory for all certificates in the list).
|
Use the passed-in certificate(s) as a trust anchor, accepting remote certificates signed by any of these. If you have many trust anchors it may make sense to use a `BearSSL::CertStore` because it will only require RAM for a single trust anchor (while the `setTrustAnchors` call requires memory for all certificates in the list).
|
||||||
|
|
||||||
@ -184,7 +184,7 @@ Sessions (Resuming connections fast)
|
|||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
setSession(BearSSL::Session &sess)
|
setSession(BearSSL::Session &sess)
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
If you are connecting to a server repeatedly in a fixed time period (usually 30 or 60 minutes, but normally configurable at the server), a TLS session can be used to cache crypto settings and speed up connections significantly.
|
If you are connecting to a server repeatedly in a fixed time period (usually 30 or 60 minutes, but normally configurable at the server), a TLS session can be used to cache crypto settings and speed up connections significantly.
|
||||||
|
|
||||||
@ -193,8 +193,8 @@ Errors
|
|||||||
|
|
||||||
BearSSL can fail in many more unique and interesting ways then the deprecated axTLS. Use these calls to get more information when something fails.
|
BearSSL can fail in many more unique and interesting ways then the deprecated axTLS. Use these calls to get more information when something fails.
|
||||||
|
|
||||||
getLastSSLError(char *dest = NULL, size_t len = 0)
|
getLastSSLError(char \*dest = NULL, size_t len = 0)
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
Returns the last BearSSL error code encountered and optionally set a user-allocated buffer to a human-readable form of the error. To only get the last error integer code, just call without any parameters (`int errCode = getLastSSLError();`).
|
Returns the last BearSSL error code encountered and optionally set a user-allocated buffer to a human-readable form of the error. To only get the last error integer code, just call without any parameters (`int errCode = getLastSSLError();`).
|
||||||
|
|
||||||
|
@ -17,19 +17,19 @@ TLS servers require a certificate identifying itself and containing its public k
|
|||||||
|
|
||||||
This example command will generate a RSA 2048-bit key and certificate:
|
This example command will generate a RSA 2048-bit key and certificate:
|
||||||
|
|
||||||
.. code::
|
.. code:: bash
|
||||||
|
|
||||||
openssl req -x509 -nodes -newkey rsa:2048 -keyout key.pem -out cert.pem -days 4096
|
openssl req -x509 -nodes -newkey rsa:2048 -keyout key.pem -out cert.pem -days 4096
|
||||||
|
|
||||||
Again, it is up to the application author to generate this certificate and key and keep the private key safe and **private.**
|
Again, it is up to the application author to generate this certificate and key and keep the private key safe and **private.**
|
||||||
|
|
||||||
setRSACert(const BearSSL::X509List *chain, const BearSSL::PrivateKey *sk)
|
setRSACert(const BearSSL::X509List \*chain, const BearSSL::PrivateKey \*sk)
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
Sets a RSA certificate and key to be used by the server when connections are received. Needs to be called before `begin()`
|
Sets a RSA certificate and key to be used by the server when connections are received. Needs to be called before `begin()`
|
||||||
|
|
||||||
setECCert(const BearSSL::X509List *chain, unsigned cert_issuer_key_type, const BearSSL::PrivateKey *sk)
|
setECCert(const BearSSL::X509List \*chain, unsigned cert_issuer_key_type, const BearSSL::PrivateKey \*sk)
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
Sets an elliptic curve certificate and key for the server. Needs to be called before `begin()`.
|
Sets an elliptic curve certificate and key for the server. Needs to be called before `begin()`.
|
||||||
|
|
||||||
@ -38,7 +38,7 @@ Requiring Client Certificates
|
|||||||
|
|
||||||
TLS servers can request the client to identify itself by transmitting a certificate during handshake. If the client cannot transmit the certificate, the connection will be dropped by the server.
|
TLS servers can request the client to identify itself by transmitting a certificate during handshake. If the client cannot transmit the certificate, the connection will be dropped by the server.
|
||||||
|
|
||||||
setClientTrustAnchor(const BearSSL::X509List *client_CA_ta)
|
setClientTrustAnchor(const BearSSL::X509List \*client_CA_ta)
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
Sets the trust anchor (normally a self-signing CA) that all received certificates will be verified against. Needs to be called before `begin()`.
|
Sets the trust anchor (normally a self-signing CA) that all received certificates will be verified against. Needs to be called before `begin()`.
|
||||||
|
@ -442,7 +442,6 @@ Return the status of Wi-Fi connection.
|
|||||||
.. code:: cpp
|
.. code:: cpp
|
||||||
|
|
||||||
WiFi.status()
|
WiFi.status()
|
||||||
::
|
|
||||||
|
|
||||||
Function returns one of the following connection statuses:
|
Function returns one of the following connection statuses:
|
||||||
|
|
||||||
|
46
doc/gdb.rst
46
doc/gdb.rst
@ -76,13 +76,13 @@ ELF format version of it (which includes needed debug symbols).
|
|||||||
|
|
||||||
Under Linux these files are stored in ``/tmp/arduino_build_*`` and the following command will help locate the right file for your app:
|
Under Linux these files are stored in ``/tmp/arduino_build_*`` and the following command will help locate the right file for your app:
|
||||||
|
|
||||||
.. code:: cpp
|
.. code:: bash
|
||||||
|
|
||||||
find /tmp -name "*.elf" -print
|
find /tmp -name "*.elf" -print
|
||||||
|
|
||||||
Under Windows these files are stored in ``%userprofile%\AppData\Local\Temp\arduino_build_*`` and the following command will help locate the right file for your app:
|
Under Windows these files are stored in ``%userprofile%\AppData\Local\Temp\arduino_build_*`` and the following command will help locate the right file for your app:
|
||||||
|
|
||||||
.. code:: cpp
|
.. code:: bash
|
||||||
|
|
||||||
dir %userprofile%\appdata\*.elf /s/b
|
dir %userprofile%\appdata\*.elf /s/b
|
||||||
|
|
||||||
@ -98,19 +98,19 @@ directory.
|
|||||||
|
|
||||||
Linux
|
Linux
|
||||||
|
|
||||||
.. code:: cpp
|
.. code:: bash
|
||||||
|
|
||||||
~/.arduino15/packages/esp8266/hardware/xtensa-lx106-elf/bin/xtensa-lx106-elf-gdb
|
~/.arduino15/packages/esp8266/hardware/xtensa-lx106-elf/bin/xtensa-lx106-elf-gdb
|
||||||
|
|
||||||
Windows (Using Board Manager version)
|
Windows (Using Board Manager version)
|
||||||
|
|
||||||
.. code:: cpp
|
.. code:: bash
|
||||||
|
|
||||||
%userprofile%\AppData\Local\Arduino15\packages\esp8266\tools\xtensa-lx106-elf-gcc\2.5.0-3-20ed2b9\bin\xtensa-lx106-elf-gdb.exe
|
%userprofile%\AppData\Local\Arduino15\packages\esp8266\tools\xtensa-lx106-elf-gcc\2.5.0-3-20ed2b9\bin\xtensa-lx106-elf-gdb.exe
|
||||||
|
|
||||||
Windows (Using Git version)
|
Windows (Using Git version)
|
||||||
|
|
||||||
.. code:: cpp
|
.. code:: bash
|
||||||
|
|
||||||
%userprofile%\Documents\Arduino\hardware\esp8266com\esp8266\tools\xtensa-lx106-elf\bin\xtensa-lx106-elf-gdb.exe
|
%userprofile%\Documents\Arduino\hardware\esp8266com\esp8266\tools\xtensa-lx106-elf\bin\xtensa-lx106-elf-gdb.exe
|
||||||
|
|
||||||
@ -124,7 +124,7 @@ Apply the GDB Configurations
|
|||||||
At the ``(gdb)`` prompt, enter the following options to configure GDB for the
|
At the ``(gdb)`` prompt, enter the following options to configure GDB for the
|
||||||
ESP8266 memory map and configuration:
|
ESP8266 memory map and configuration:
|
||||||
|
|
||||||
.. code:: cpp
|
.. code:: bash
|
||||||
|
|
||||||
set remote hardware-breakpoint-limit 1
|
set remote hardware-breakpoint-limit 1
|
||||||
set remote hardware-watchpoint-limit 1
|
set remote hardware-watchpoint-limit 1
|
||||||
@ -142,7 +142,7 @@ ESP8266 memory map and configuration:
|
|||||||
|
|
||||||
Now tell GDB where your compiled ELF file is located:
|
Now tell GDB where your compiled ELF file is located:
|
||||||
|
|
||||||
.. code:: cpp
|
.. code:: bash
|
||||||
|
|
||||||
file /tmp/arduino_build_257110/sketch_dec26a.ino.elf
|
file /tmp/arduino_build_257110/sketch_dec26a.ino.elf
|
||||||
|
|
||||||
@ -153,13 +153,13 @@ Once GDB has been configured properly and loaded your debugging symbols, connect
|
|||||||
it to the ESP with the command (replace the ttyUSB0 or COM9 with your ESP's serial
|
it to the ESP with the command (replace the ttyUSB0 or COM9 with your ESP's serial
|
||||||
port):
|
port):
|
||||||
|
|
||||||
.. code:: cpp
|
.. code:: bash
|
||||||
|
|
||||||
target remote /dev/ttyUSB0
|
target remote /dev/ttyUSB0
|
||||||
|
|
||||||
or
|
or
|
||||||
|
|
||||||
.. code:: cpp
|
.. code:: bash
|
||||||
|
|
||||||
target remote \\.\COM9
|
target remote \\.\COM9
|
||||||
|
|
||||||
@ -191,7 +191,7 @@ Create a new sketch and paste the following code into it:
|
|||||||
Save it and then build and upload to your ESP8266. On the Serial monitor you
|
Save it and then build and upload to your ESP8266. On the Serial monitor you
|
||||||
should see something like
|
should see something like
|
||||||
|
|
||||||
.. code:: cpp
|
.. code:: bash
|
||||||
|
|
||||||
1
|
1
|
||||||
2
|
2
|
||||||
@ -203,7 +203,7 @@ Now close the Serial Monitor.
|
|||||||
|
|
||||||
Open a command prompt and find the ELF file:
|
Open a command prompt and find the ELF file:
|
||||||
|
|
||||||
.. code:: cpp
|
.. code:: bash
|
||||||
|
|
||||||
earle@server:~$ find /tmp -name "*.elf" -print
|
earle@server:~$ find /tmp -name "*.elf" -print
|
||||||
/tmp/arduino_build_257110/testgdb.ino.elf
|
/tmp/arduino_build_257110/testgdb.ino.elf
|
||||||
@ -215,7 +215,7 @@ the one we just built, ``testgdb.ino.elf``.
|
|||||||
|
|
||||||
Open up the proper ESP8266-specific GDB
|
Open up the proper ESP8266-specific GDB
|
||||||
|
|
||||||
.. code:: cpp
|
.. code:: bash
|
||||||
|
|
||||||
earle@server:~$ ~/.arduino15/packages/esp8266/hardware/xtensa-lx106-elf/bin/xtensa-lx106-elf-gdb
|
earle@server:~$ ~/.arduino15/packages/esp8266/hardware/xtensa-lx106-elf/bin/xtensa-lx106-elf-gdb
|
||||||
GNU gdb (GDB) 8.2.50.20180723-git
|
GNU gdb (GDB) 8.2.50.20180723-git
|
||||||
@ -238,7 +238,7 @@ Open up the proper ESP8266-specific GDB
|
|||||||
We're now at the GDB prompt, but nothing has been set up for the ESP8266
|
We're now at the GDB prompt, but nothing has been set up for the ESP8266
|
||||||
and no debug information has been loaded. Cut-and-paste the setup options:
|
and no debug information has been loaded. Cut-and-paste the setup options:
|
||||||
|
|
||||||
.. code:: cpp
|
.. code:: bash
|
||||||
|
|
||||||
(gdb) set remote hardware-breakpoint-limit 1
|
(gdb) set remote hardware-breakpoint-limit 1
|
||||||
(gdb) set remote hardware-watchpoint-limit 1
|
(gdb) set remote hardware-watchpoint-limit 1
|
||||||
@ -257,14 +257,14 @@ and no debug information has been loaded. Cut-and-paste the setup options:
|
|||||||
|
|
||||||
And tell GDB where the debugging info ELF file is located:
|
And tell GDB where the debugging info ELF file is located:
|
||||||
|
|
||||||
.. code:: cpp
|
.. code:: bash
|
||||||
|
|
||||||
(gdb) file /tmp/arduino_build_257110/testgdb.ino.elf
|
(gdb) file /tmp/arduino_build_257110/testgdb.ino.elf
|
||||||
Reading symbols from /tmp/arduino_build_257110/testgdb.ino.elf...done.
|
Reading symbols from /tmp/arduino_build_257110/testgdb.ino.elf...done.
|
||||||
|
|
||||||
Now, connect to the running ESP8266:
|
Now, connect to the running ESP8266:
|
||||||
|
|
||||||
.. code:: cpp
|
.. code:: bash
|
||||||
|
|
||||||
(gdb) target remote /dev/ttyUSB0
|
(gdb) target remote /dev/ttyUSB0
|
||||||
Remote debugging using /dev/ttyUSB0
|
Remote debugging using /dev/ttyUSB0
|
||||||
@ -279,7 +279,7 @@ output will be displayed on the GDB console..
|
|||||||
|
|
||||||
Continue the running app to see the serial output:
|
Continue the running app to see the serial output:
|
||||||
|
|
||||||
.. code:: cpp
|
.. code:: bash
|
||||||
|
|
||||||
(gdb) cont
|
(gdb) cont
|
||||||
Continuing.
|
Continuing.
|
||||||
@ -291,7 +291,8 @@ Continue the running app to see the serial output:
|
|||||||
|
|
||||||
The app is back running and we can stop it at any time using ``Ctrl-C``:
|
The app is back running and we can stop it at any time using ``Ctrl-C``:
|
||||||
|
|
||||||
.. code:: cpp
|
.. code:: bash
|
||||||
|
|
||||||
113
|
113
|
||||||
^C
|
^C
|
||||||
Program received signal SIGINT, Interrupt.
|
Program received signal SIGINT, Interrupt.
|
||||||
@ -301,7 +302,7 @@ The app is back running and we can stop it at any time using ``Ctrl-C``:
|
|||||||
At this point we can set a breakpoint on the main ``loop()`` and restart
|
At this point we can set a breakpoint on the main ``loop()`` and restart
|
||||||
to get into our own code:
|
to get into our own code:
|
||||||
|
|
||||||
.. code:: cpp
|
.. code:: bash
|
||||||
|
|
||||||
(gdb) break loop
|
(gdb) break loop
|
||||||
Breakpoint 1 at 0x40202e33: file /home/earle/Arduino/sketch_dec26a/sketch_dec26a.ino, line 10.
|
Breakpoint 1 at 0x40202e33: file /home/earle/Arduino/sketch_dec26a/sketch_dec26a.ino, line 10.
|
||||||
@ -316,7 +317,8 @@ to get into our own code:
|
|||||||
|
|
||||||
Let's examine the local variable:
|
Let's examine the local variable:
|
||||||
|
|
||||||
.. code:: cpp
|
.. code:: bash
|
||||||
|
|
||||||
(gdb) next
|
(gdb) next
|
||||||
loop () at /home/earle/Arduino/sketch_dec26a/sketch_dec26a.ino:13
|
loop () at /home/earle/Arduino/sketch_dec26a/sketch_dec26a.ino:13
|
||||||
13 Serial.printf("%d\n", cnt++);
|
13 Serial.printf("%d\n", cnt++);
|
||||||
@ -326,7 +328,7 @@ Let's examine the local variable:
|
|||||||
|
|
||||||
And change it:
|
And change it:
|
||||||
|
|
||||||
.. code:: cpp
|
.. code:: bash
|
||||||
|
|
||||||
$2 = 114
|
$2 = 114
|
||||||
(gdb) set cnt = 2000
|
(gdb) set cnt = 2000
|
||||||
@ -336,7 +338,7 @@ And change it:
|
|||||||
|
|
||||||
And restart the app and see our changes take effect:
|
And restart the app and see our changes take effect:
|
||||||
|
|
||||||
.. code:: cpp
|
.. code:: bash
|
||||||
|
|
||||||
(gdb) cont
|
(gdb) cont
|
||||||
Continuing.
|
Continuing.
|
||||||
@ -352,7 +354,7 @@ And restart the app and see our changes take effect:
|
|||||||
|
|
||||||
Looks like we left the breakpoint on loop(), let's get rid of it and try again:
|
Looks like we left the breakpoint on loop(), let's get rid of it and try again:
|
||||||
|
|
||||||
.. code:: cpp
|
.. code:: bash
|
||||||
|
|
||||||
(gdb) delete
|
(gdb) delete
|
||||||
Delete all breakpoints? (y or n) y
|
Delete all breakpoints? (y or n) y
|
||||||
|
@ -48,12 +48,12 @@ Prerequisites
|
|||||||
|
|
||||||
- Arduino 1.6.8 (or newer, current working version is 1.8.5)
|
- Arduino 1.6.8 (or newer, current working version is 1.8.5)
|
||||||
- git
|
- git
|
||||||
- Python_ 2.7 (http://python.org)
|
- Python 2.7 (http://python.org)
|
||||||
- terminal, console, or command prompt (depending on your OS)
|
- terminal, console, or command prompt (depending on your OS)
|
||||||
- Internet connection
|
- Internet connection
|
||||||
|
|
||||||
Instructions - Windows 10
|
Instructions - Windows 10
|
||||||
~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
- First, make sure you don't already have the ESP8266 library installed using the Board Manager (see above)
|
- First, make sure you don't already have the ESP8266 library installed using the Board Manager (see above)
|
||||||
|
|
||||||
- Install git for Windows (if not already; see https://git-scm.com/download/win)
|
- Install git for Windows (if not already; see https://git-scm.com/download/win)
|
||||||
@ -133,7 +133,7 @@ Note that you could, in theory install in ``C:\Program Files (x86)\Arduino\hardw
|
|||||||
|
|
||||||
|
|
||||||
Instructions - Other OS
|
Instructions - Other OS
|
||||||
~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
- Open the console and go to Arduino directory. This can be either your
|
- Open the console and go to Arduino directory. This can be either your
|
||||||
*sketchbook* directory (usually ``<Documents>/Arduino``), or the
|
*sketchbook* directory (usually ``<Documents>/Arduino``), or the
|
||||||
|
@ -59,7 +59,7 @@ The format of a signed binary is compatible with the standard binary format, and
|
|||||||
|
|
||||||
As shown below, the signed hash is appended to the unsigned binary followed by the total length of the signed hash (i.e. if the signed hash was 64 bytes, then this uint32 will contain 64). This format allows for extensibility (such as adding in a CA-based validation scheme allowing multiple signing keys all based off of a trust anchor), and pull requests are always welcome.
|
As shown below, the signed hash is appended to the unsigned binary followed by the total length of the signed hash (i.e. if the signed hash was 64 bytes, then this uint32 will contain 64). This format allows for extensibility (such as adding in a CA-based validation scheme allowing multiple signing keys all based off of a trust anchor), and pull requests are always welcome.
|
||||||
|
|
||||||
.. code::
|
.. code:: bash
|
||||||
|
|
||||||
NORMAL-BINARY <SIGNED HASH> <uint32 LENGTH-OF-SIGNING-DATA-INCLUDING-THIS-32-BITS>
|
NORMAL-BINARY <SIGNED HASH> <uint32 LENGTH-OF-SIGNING-DATA-INCLUDING-THIS-32-BITS>
|
||||||
|
|
||||||
@ -84,19 +84,19 @@ To enable this mode, just include `private.key` and `public.key` in the sketch `
|
|||||||
|
|
||||||
When the signing process starts, the message:
|
When the signing process starts, the message:
|
||||||
|
|
||||||
.. code::
|
.. code:: bash
|
||||||
|
|
||||||
Enabling binary signing
|
Enabling binary signing
|
||||||
|
|
||||||
Will appear in the IDE window before a compile is launched, and at the completion of the build the signed binary file well be displayed in the IDE build window as:
|
Will appear in the IDE window before a compile is launched, and at the completion of the build the signed binary file well be displayed in the IDE build window as:
|
||||||
|
|
||||||
.. code::
|
.. code:: bash
|
||||||
|
|
||||||
Signed binary: /full/path/to/sketch.bin.signed
|
Signed binary: /full/path/to/sketch.bin.signed
|
||||||
|
|
||||||
If you receive either of the following messages in the IDE window, the signing was not completed and you will need to verify the `public.key` and `private.key`:
|
If you receive either of the following messages in the IDE window, the signing was not completed and you will need to verify the `public.key` and `private.key`:
|
||||||
|
|
||||||
.. code::
|
.. code:: bash
|
||||||
|
|
||||||
Not enabling binary signing
|
Not enabling binary signing
|
||||||
... or ...
|
... or ...
|
||||||
|
@ -138,7 +138,3 @@ The following points assume work in a direct clone of the repository, and not in
|
|||||||
* In main README.md:
|
* In main README.md:
|
||||||
|
|
||||||
- in "Latest release" section, change version number in the readthedocs link to the version which was just released, and verify that all links work.
|
- in "Latest release" section, change version number in the readthedocs link to the version which was just released, and verify that all links work.
|
||||||
|
|
||||||
* In doc/conf.py
|
|
||||||
|
|
||||||
- update version and release to the *next* milestone
|
|
||||||
|
@ -589,7 +589,7 @@ boards = collections.OrderedDict([
|
|||||||
'serial': '921',
|
'serial': '921',
|
||||||
'desc': [
|
'desc': [
|
||||||
'Parameters in Arduino IDE:',
|
'Parameters in Arduino IDE:',
|
||||||
'~~~~~~~~~~~~~~~~~~~~~~~~~',
|
'~~~~~~~~~~~~~~~~~~~~~~~~~~',
|
||||||
'',
|
'',
|
||||||
'- Card: "WEMOS D1 Mini Lite"',
|
'- Card: "WEMOS D1 Mini Lite"',
|
||||||
'- Flash Size: "1M (512K SPIFFS)"',
|
'- Flash Size: "1M (512K SPIFFS)"',
|
||||||
@ -597,14 +597,14 @@ boards = collections.OrderedDict([
|
|||||||
'- Upload Speed: "230400"',
|
'- Upload Speed: "230400"',
|
||||||
'',
|
'',
|
||||||
'Power:',
|
'Power:',
|
||||||
'~~~~~',
|
'~~~~~~',
|
||||||
'',
|
'',
|
||||||
'- 5V pin : 4.7V 500mA output when the board is powered by USB ; 3.5V-6V input',
|
'- 5V pin : 4.7V 500mA output when the board is powered by USB ; 3.5V-6V input',
|
||||||
'- 3V3 pin : 3.3V 500mA regulated output',
|
'- 3V3 pin : 3.3V 500mA regulated output',
|
||||||
'- Digital pins : 3.3V 30mA.',
|
'- Digital pins : 3.3V 30mA.',
|
||||||
'',
|
'',
|
||||||
'links:',
|
'links:',
|
||||||
'~~~~~',
|
'~~~~~~',
|
||||||
'',
|
'',
|
||||||
'- Product page: https://www.wemos.cc/',
|
'- Product page: https://www.wemos.cc/',
|
||||||
'- Board schematic: https://wiki.wemos.cc/_media/products:d1:sch_d1_mini_lite_v1.0.0.pdf',
|
'- Board schematic: https://wiki.wemos.cc/_media/products:d1:sch_d1_mini_lite_v1.0.0.pdf',
|
||||||
|
Loading…
x
Reference in New Issue
Block a user