mirror of
https://github.com/esp8266/Arduino.git
synced 2025-06-13 13:01:55 +03:00
Add code-spell spelling checks to CI (#8067)
Help find and fix silly spelling errors as they are added to the repo.
This commit is contained in:
committed by
GitHub
parent
78a2ed6bd8
commit
60fe7b4ca8
@ -5,7 +5,7 @@ Intro
|
||||
-----
|
||||
|
||||
PROGMEM is a Arduino AVR feature that has been ported to ESP8266 to
|
||||
ensure compatability with existing Arduino libraries, as well as, saving
|
||||
ensure compatibility with existing Arduino libraries, as well as, saving
|
||||
RAM. On the esp8266 declaring a string such as ``const char * xyz =
|
||||
"this is a string"`` will place this string in RAM, not flash. It is
|
||||
possible to place a String into flash, and then load it into RAM when
|
||||
@ -283,7 +283,7 @@ generate as they are basically ``const char *``. On the other hand
|
||||
conversions from, very useful when overloading functions, and doing
|
||||
implicit type conversions. It is worth adding that if you wish to store
|
||||
an ``int``, ``float`` or pointer these can be stored and read back
|
||||
directly as they are 4 bytes in size and therefor will be always
|
||||
directly as they are 4 bytes in size and therefore will be always
|
||||
aligned!
|
||||
|
||||
Hope this helps.
|
||||
|
@ -44,8 +44,8 @@ Usage
|
||||
|
||||
5. Check the Serial Output
|
||||
|
||||
Informations
|
||||
------------
|
||||
Information
|
||||
-----------
|
||||
|
||||
It work with every sketch that enables the Serial interface that is
|
||||
selected as debug port.
|
||||
|
@ -51,7 +51,7 @@ Example:
|
||||
<<<stack<<<
|
||||
|
||||
The first number after ``Exception`` gives the cause of the reset. a
|
||||
full ist of all causes can be found `here <../exception_causes.rst>`__
|
||||
full list of all causes can be found `here <../exception_causes.rst>`__
|
||||
the hex after are the stack dump.
|
||||
|
||||
Decode
|
||||
|
@ -6,13 +6,13 @@ Generic ESP8266 Module
|
||||
|
||||
These modules come in different form factors and pinouts. See the page at ESP8266 community wiki for more info: `ESP8266 Module Family <http://www.esp8266.com/wiki/doku.php?id=esp8266-module-family>`__.
|
||||
|
||||
Usually these modules have no bootstapping resistors on board, insufficient decoupling capacitors, no voltage regulator, no reset circuit, and no USB-serial adapter. This makes using them somewhat tricky, compared to development boards which add these features.
|
||||
Usually these modules have no bootstrapping resistors on board, insufficient decoupling capacitors, no voltage regulator, no reset circuit, and no USB-serial adapter. This makes using them somewhat tricky, compared to development boards which add these features.
|
||||
|
||||
In order to use these modules, make sure to observe the following:
|
||||
|
||||
- **Provide sufficient power to the module.** For stable use of the ESP8266 a power supply with 3.3V and >= 250mA is required. Using the power available from USB to Serial adapter is not recommended, these adapters typically do not supply enough current to run ESP8266 reliably in every situation. An external supply or regulator alongwith filtering capacitors is preferred.
|
||||
|
||||
- **Connect bootstapping resistors** to GPIO0, GPIO2, GPIO15 according to the schematics below.
|
||||
- **Connect bootstrapping resistors** to GPIO0, GPIO2, GPIO15 according to the schematics below.
|
||||
|
||||
- **Put ESP8266 into bootloader mode** before uploading code.
|
||||
|
||||
|
@ -31,8 +31,8 @@ example private hardware path
|
||||
Windows: C:\Users\[username]\AppData\Roaming\Arduino15\packages\esp8266\hardware
|
||||
Linux: /home/[username]/.arduino15/packages/esp8266/hardware
|
||||
|
||||
Eclipse wont build
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Eclipse won't build
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
if eclipse dont find the path to the Compiler add to the platform.txt
|
||||
after:
|
||||
|
@ -36,7 +36,7 @@ Sets an elliptic curve certificate and key for the server. Needs to be called b
|
||||
Client sessions (Resuming connections fast)
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The TLS handshake process takes a long time because of all the back and forth between the client and the server. You can shorten it by caching the clients' sessions which will skip a few steps in the TLS handshake. In order for this to work, your client also needs to cache the session. `BearSSL::WiFiClientSecure <bearssl-client-secure-class.rst#sessions-resuming-connections-fast>`__ can do that as well as modern web browers.
|
||||
The TLS handshake process takes a long time because of all the back and forth between the client and the server. You can shorten it by caching the clients' sessions which will skip a few steps in the TLS handshake. In order for this to work, your client also needs to cache the session. `BearSSL::WiFiClientSecure <bearssl-client-secure-class.rst#sessions-resuming-connections-fast>`__ can do that as well as modern web browsers.
|
||||
|
||||
Here are the kind of performance improvements that you'll be able to see for TLS handshakes with an ESP8266 with it's clock set at 160MHz on a network with fairly low latency:
|
||||
|
||||
|
@ -47,7 +47,7 @@ and WiFi does not start automatically at boot** (see PR `#7902 <https://github.c
|
||||
|
||||
Previously, SDK was automatically starting WiFi at boot. This was probably
|
||||
intended for the Espressif AT FW which is interactive and preserves WiFi
|
||||
state accross reboots. This behavior is generally irrelevant with the
|
||||
state across reboots. This behavior is generally irrelevant with the
|
||||
Arduino API because sketches start with ``WiFi.begin()`` or
|
||||
``WiFi.softAP()``.
|
||||
|
||||
|
@ -127,7 +127,7 @@ when updgrading core versions.
|
||||
SPIFFS file system limitations
|
||||
------------------------------
|
||||
|
||||
The SPIFFS implementation for ESP8266 had to accomodate the
|
||||
The SPIFFS implementation for ESP8266 had to accommodate the
|
||||
constraints of the chip, among which its limited RAM.
|
||||
`SPIFFS <https://github.com/pellepl/spiffs>`__ was selected because it
|
||||
is designed for small systems, but that comes at the cost of some
|
||||
|
@ -172,7 +172,7 @@ Libraries that don't rely on low-level access to AVR registers should work well.
|
||||
- `RTC <https://github.com/Makuna/Rtc>`__ - Arduino Library for Ds1307 & Ds3231 compatible with ESP8266.
|
||||
- `Souliss, Smart Home <https://github.com/souliss/souliss>`__ - Framework for Smart Home based on Arduino, Android and openHAB.
|
||||
- `ST7735 <https://github.com/nzmichaelh/Adafruit-ST7735-Library>`__ - Adafruit's ST7735 library modified to be compatible with ESP8266. Just make sure to modify the pins in the examples as they are still AVR specific.
|
||||
- `Task <https://github.com/Makuna/Task>`__ - Arduino Nonpreemptive multitasking library. While similiar to the included Ticker library in the functionality provided, this library was meant for cross Arduino compatibility.
|
||||
- `Task <https://github.com/Makuna/Task>`__ - Arduino Nonpreemptive multitasking library. While similar to the included Ticker library in the functionality provided, this library was meant for cross Arduino compatibility.
|
||||
- `TickerScheduler <https://github.com/Toshik/TickerScheduler>`__ - Library provides simple scheduler for ``Ticker`` to avoid WDT reset
|
||||
- `Teleinfo <https://github.com/hallard/LibTeleinfo>`__ - Generic French Power Meter library to read Teleinfo energy monitoring data such as consuption, contract, power, period, ... This library is cross platform, ESP8266, Arduino, Particle, and simple C++. French dedicated `post <https://hallard.me/libteleinfo/>`__ on author's blog and all related information about `Teleinfo <https://hallard.me/category/tinfo/>`__ also available.
|
||||
- `UTFT-ESP8266 <https://github.com/gnulabis/UTFT-ESP8266>`__ - UTFT display library with support for ESP8266. Only serial interface (SPI) displays are supported for now (no 8-bit parallel mode, etc). Also includes support for the hardware SPI controller of the ESP8266.
|
||||
|
@ -50,7 +50,7 @@ Signed updates are updates whose compiled binaries are signed with a private key
|
||||
|
||||
Cryptographic signing only protects against tampering with binaries delivered via OTA. If someone has physical access, they will always be able to flash the device over the serial port. Signing also does not encrypt anything but the hash (so that it can't be modified), so this does not protect code inside the device: if a user has physical access they can read out your program.
|
||||
|
||||
**Securing your private key is paramount. The same private/public keypair that was used with the original upload must also be used to sign later binaries. Loss of the private key associated with a binary means that you will not be able to OTA-update any of your devices in the field. Alternatively, if someone else copies the private key, then they will be able to use it to sign binaries which will be accepted by the ESP.**
|
||||
**Securing your private key is paramount. The same private/public key pair that was used with the original upload must also be used to sign later binaries. Loss of the private key associated with a binary means that you will not be able to OTA-update any of your devices in the field. Alternatively, if someone else copies the private key, then they will be able to use it to sign binaries which will be accepted by the ESP.**
|
||||
|
||||
Signed Binary Format
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
@ -68,7 +68,7 @@ Signed Binary Prerequisites
|
||||
|
||||
OpenSSL is required to run the standard signing steps, and should be available on any UNIX-like or Windows system. As usual, the latest stable version of OpenSSL is recommended.
|
||||
|
||||
Signing requires the generation of an RSA-2048 key (other bit lengths are supported as well, but 2048 is a good selection today) using any appropriate tool. The following shell commands will generate a new public/private keypair. Run them in the sketch directory:
|
||||
Signing requires the generation of an RSA-2048 key (other bit lengths are supported as well, but 2048 is a good selection today) using any appropriate tool. The following shell commands will generate a new public/private key pair. Run them in the sketch directory:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
|
@ -362,7 +362,7 @@ Arduino API
|
||||
}
|
||||
}
|
||||
|
||||
One will notice that in the network to serial direction, data are transfered
|
||||
One will notice that in the network to serial direction, data are transferred
|
||||
byte by byte while data are available. In the other direction, a temporary
|
||||
buffer is created on stack, filled with available serial data, then
|
||||
transferred to network.
|
||||
|
Reference in New Issue
Block a user