arduino/esp8266
1
0
Fork 0
mirror of https://github.com/esp8266/Arduino.git synced 2025-04-19 23:22:16 +03:00
Code

Merge pull request #1113 from esp8266/doc-formatting-fix

Browse Source 
Documentation updates
This commit is contained in:
Ivan Grokhotkov 2015-11-30 09:27:41 +03:00
commit abd98f1ff8
5 changed files with 96 additions and 91 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
doc/boards.md
View File

@ -3,27 +3,27 @@ title: Supported Hardware
--- ---
## Table of contents ## Table of contents
* [Adafruit HUZZAH ESP8266 (ESP\-12)](#adafruit-huzzah-esp8266-esp-12) * [Adafruit HUZZAH ESP8266 (ESP\-12)](#adafruit-huzzah-esp8266-esp-12)
* [NodeMCU 0\.9 <a name="user\-content\-nodemcu\-0\-9"></a>](#nodemcu-09-) * [NodeMCU 0\.9 <a name="user\-content\-nodemcu\-0\-9"></a>](#nodemcu-09-)
* [Pin mapping](#pin-mapping) * [Pin mapping](#pin-mapping)
* [NodeMCU 1\.0](#nodemcu-10) * [NodeMCU 1\.0](#nodemcu-10)
* [Olimex MOD\-WIFI\-ESP8266\-DEV](#olimex-mod-wifi-esp8266-dev) * [Olimex MOD\-WIFI\-ESP8266\-DEV](#olimex-mod-wifi-esp8266-dev)
* [Olimex MOD\-WIFI\-ESP8266](#olimex-mod-wifi-esp8266) * [Olimex MOD\-WIFI\-ESP8266](#olimex-mod-wifi-esp8266)
* [SparkFun ESP8266 Thing](#sparkfun-esp8266-thing) * [SparkFun ESP8266 Thing](#sparkfun-esp8266-thing)
* [SweetPea ESP\-210](#sweetpea-esp-210) * [SweetPea ESP\-210](#sweetpea-esp-210)
* [Generic ESP8266 modules](#generic-esp8266-modules) * [Generic ESP8266 modules](#generic-esp8266-modules)
* [Serial Adapter](#serial-adapter) * [Serial Adapter](#serial-adapter)
* [Minimal Hardware Setup for Bootloading and Usage](#minimal-hardware-setup-for-bootloading-and-usage) * [Minimal Hardware Setup for Bootloading and Usage](#minimal-hardware-setup-for-bootloading-and-usage)
* [ESP to Serial](#esp-to-serial) * [ESP to Serial](#esp-to-serial)
* [Minimal Hardware Setup for Bootloading only](#minimal-hardware-setup-for-bootloading-only) * [Minimal Hardware Setup for Bootloading only](#minimal-hardware-setup-for-bootloading-only)
* [Minimal Hardware Setup for Running only](#minimal-hardware-setup-for-running-only) * [Minimal Hardware Setup for Running only](#minimal-hardware-setup-for-running-only)
* [Minimal](#minimal) * [Minimal](#minimal)
* [Improved Stability](#improved-stability) * [Improved Stability](#improved-stability)
* [Boot Messages and Modes](#boot-messages-and-modes) * [Boot Messages and Modes](#boot-messages-and-modes)
* [rst cause](#rst-cause) * [rst cause](#rst-cause)
* [boot mode](#boot-mode) * [boot mode](#boot-mode)
* [WeMos D1](#wemos-d1) * [WeMos D1](#wemos-d1)
* [WeMos D1 mini](#wemos-d1-mini) * [WeMos D1 mini](#wemos-d1-mini)
## Adafruit HUZZAH ESP8266 (ESP-12) ## Adafruit HUZZAH ESP8266 (ESP-12)

42
doc/filesystem.md
View File

@ -3,25 +3,25 @@ title: File System
--- ---
## Table of Contents ## Table of Contents
* [Flash layout](#flash-layout) * [Flash layout](#flash-layout)
* [Uploading files to file system](#uploading-files-to-file-system) * [Uploading files to file system](#uploading-files-to-file-system)
* [File system object (SPIFFS)](#file-system-object-spiffs) * [File system object (SPIFFS)](#file-system-object-spiffs)
* [begin](#begin) * [begin](#begin)
* [format](#format) * [format](#format)
* [open](#open) * [open](#open)
* [exists](#exists) * [exists](#exists)
* [openDir](#opendir) * [openDir](#opendir)
* [remove](#remove) * [remove](#remove)
* [rename](#rename) * [rename](#rename)
* [info](#info) * [info](#info)
* [Filesystem information structure](#filesystem-information-structure) * [Filesystem information structure](#filesystem-information-structure)
* [Directory object (Dir)](#directory-object-dir) * [Directory object (Dir)](#directory-object-dir)
* [File object](#file-object) * [File object](#file-object)
* [seek](#seek) * [seek](#seek)
* [position](#position) * [position](#position)
* [size](#size) * [size](#size)
* [name](#name) * [name](#name)
* [close](#close) * [close](#close)
## Flash layout ## Flash layout
@ -127,9 +127,7 @@ Returns *true* if a file with given path exists, *false* otherwise.
SPIFFS.openDir(path) SPIFFS.openDir(path)
``` ```
Opens a directory given its absolute path. Returns a *Dir* object. To check if Opens a directory given its absolute path. Returns a *Dir* object.
directory was opened successfully, use the boolean operator, similar to opening
a file.
### remove ### remove

26
doc/libraries.md
View File

@ -3,19 +3,19 @@ title: Libraries
--- ---
## Table of Contents ## Table of Contents
* [WiFi(ESP8266WiFi library)](#wifiesp8266wifi-library) * [WiFi(ESP8266WiFi library)](#wifiesp8266wifi-library)
* [Ticker](#ticker) * [Ticker](#ticker)
* [EEPROM](#eeprom) * [EEPROM](#eeprom)
* [I2C (Wire library)](#i2c-wire-library) * [I2C (Wire library)](#i2c-wire-library)
* [SPI](#spi) * [SPI](#spi)
* [SoftwareSerial](#softwareserial) * [SoftwareSerial](#softwareserial)
* [ESP\-specific APIs](#esp-specific-apis) * [ESP\-specific APIs](#esp-specific-apis)
* [OneWire](#onewire) * [OneWire](#onewire)
* [mDNS and DNS\-SD responder (ESP8266mDNS library)](#mdns-and-dns-sd-responder-esp8266mdns-library) * [mDNS and DNS\-SD responder (ESP8266mDNS library)](#mdns-and-dns-sd-responder-esp8266mdns-library)
* [SSDP responder (ESP8266SSDP)](#ssdp-responder-esp8266ssdp) * [SSDP responder (ESP8266SSDP)](#ssdp-responder-esp8266ssdp)
* [DNS server (DNSServer library)](#dns-server-dnsserver-library) * [DNS server (DNSServer library)](#dns-server-dnsserver-library)
* [Servo](#servo) * [Servo](#servo)
* [Other libraries (not included with the IDE)](#other-libraries-not-included-with-the-ide) * [Other libraries (not included with the IDE)](#other-libraries-not-included-with-the-ide)
## WiFi(ESP8266WiFi library) ## WiFi(ESP8266WiFi library)

63
doc/ota_updates/ota_updates.md
View File

@ -3,29 +3,29 @@ title: OTA Update
--- ---
## Table of Contents ## Table of Contents
* [Introduction](#introduction) * [Introduction](#introduction)
* [Security](#security) * [Security](#security)
* [Safety](#safety) * [Safety](#safety)
* [Basic Requirements](#basic-requirements) * [Basic Requirements](#basic-requirements)
* [Arduino IDE](#arduino-ide) * [Arduino IDE](#arduino-ide)
* [Requirements](#requirements) * [Requirements](#requirements)
* [Application Example](#application-example) * [Application Example](#application-example)
* [Classic OTA](#classic-ota) * [Classic OTA](#classic-ota)
* [ArduinoOTA](#arduinoota) * [ArduinoOTA](#arduinoota)
* [Web Browser](#web-browser) * [Web Browser](#web-browser)
* [Requirements](#requirements-1) * [Requirements](#requirements-1)
* [Implementation Overview](#implementation-overview) * [Implementation Overview](#implementation-overview)
* [Application Example](#application-example-1) * [Application Example](#application-example-1)
* [HTTP Server](#http-server) * [HTTP Server](#http-server)
* [Requirements](#requirements-2) * [Requirements](#requirements-2)
* [Arduino code](#arduino-code) * [Arduino code](#arduino-code)
* [Simple updater](#simple-updater) * [Simple updater](#simple-updater)
* [Advanced updater](#advanced-updater) * [Advanced updater](#advanced-updater)
* [Server request handling](#server-request-handling) * [Server request handling](#server-request-handling)
* [Simple updater](#simple-updater-1) * [Simple updater](#simple-updater-1)
* [Advanced updater](#advanced-updater-1) * [Advanced updater](#advanced-updater-1)
* [Stream Interface](#stream-interface) * [Stream Interface](#stream-interface)
* [Updater class](#updater-class) * [Updater class](#updater-class)
## Introduction ## Introduction
@ -121,8 +121,9 @@ Instructions below demonstrate how to configure both [Classic OTA](#classic-ota-
2. Now prepare the sketch and configuration for the upload over a serial port. 2. Now prepare the sketch and configuration for the upload over a serial port.
- Start Arduino IDE and load sketch DNS_SD_Arduino_OTA.ino available under File > Examples > ESP8266mDNS - Start Arduino IDE and load sketch DNS_SD_Arduino_OTA.ino available under File > Examples > ESP8266mDNS
![OTA sketch selection](ota-ide-sketch-selection.png) ![OTA sketch selection](ota-ide-sketch-selection.png)
**Note:** This sketch is available only for 1.6.5-947-g39819f0 (of July 23, 2015) and 1.6.5-1160-gef26c5f (of Sep 30, 2015) versions of platform packages installed in Arduino IDE using https://github.com/esp8266/Arduino#installing-with-boards-manager. It was removed in [#980](https://github.com/esp8266/Arduino/pull/980) from GitHub repository. **Note:** This sketch is available only for 1.6.5-947-g39819f0 (of July 23, 2015) and 1.6.5-1160-gef26c5f (of Sep 30, 2015) versions of platform packages installed in Arduino IDE using https://github.com/esp8266/Arduino#installing-with-boards-manager. It was removed in [#980](https://github.com/esp8266/Arduino/pull/980) from GitHub repository.
- Update ssid and pass in the sketch so the module can join your Wi-Fi network - Update SSID and password in the sketch so the module can join your Wi-Fi network
![ssid and pass entry](ota-ide-ssid-pass-entry.png) ![ssid and pass entry](ota-ide-ssid-pass-entry.png)
- Configure upload parameters as below (you may need to adjust configuration if you are using a different module): - Configure upload parameters as below (you may need to adjust configuration if you are using a different module):
![configuration of serial upload](ota-ide-serial-upload-configuration.png) ![configuration of serial upload](ota-ide-serial-upload-configuration.png)
@ -133,7 +134,7 @@ Instructions below demonstrate how to configure both [Classic OTA](#classic-ota-
4. Only if module is connected to network, after a couple of seconds, the esp8266-ota port will show up in Arduino IDE: 4. Only if module is connected to network, after a couple of seconds, the esp8266-ota port will show up in Arduino IDE:
![selection og OTA port](ota-ide-ota-port-selection.png) ![selection of OTA port](ota-ide-ota-port-selection.png)
5. Now get ready for your first OTA upload by changing configuration settings as follows: 5. Now get ready for your first OTA upload by changing configuration settings as follows:
@ -145,7 +146,7 @@ Instructions below demonstrate how to configure both [Classic OTA](#classic-ota-
![OTA upload complete](ota-ide-ota-upload-complete.png) ![OTA upload complete](ota-ide-ota-upload-complete.png)
**Note** To be able to upload your sketch over and over again using OTA, you need to embed OTA routines inside. Please use DNS_SD_Arduino_OTA.ino as an example. **Note:** To be able to upload your sketch over and over again using OTA, you need to embed OTA routines inside. Please use DNS_SD_Arduino_OTA.ino as an example.
#### ArduinoOTA #### ArduinoOTA
@ -217,15 +218,21 @@ You can use another module if it meets “Flash chip size is 2x the size of the
- Start Arduino IDE and load sketch WebUpdater.ino available under File > Examples > ESP8266HTTPUpdateServer. - Start Arduino IDE and load sketch WebUpdater.ino available under File > Examples > ESP8266HTTPUpdateServer.
- Update ssid and pass in the sketch so the module can join your Wi-Fi network. - Update ssid and pass in the sketch so the module can join your Wi-Fi network.
- Open File > Preferences, look for “Show verbose output during:” and check out “compilation” option. - Open File > Preferences, look for “Show verbose output during:” and check out “compilation” option.
![Preferences - enablig verbose output during compilation](ota-web-show-verbose-compilation.png) ![Preferences - enablig verbose output during compilation](ota-web-show-verbose-compilation.png)
**Note:** This setting will be required in step 5 below. You can uncheck this setting afterwards. **Note:** This setting will be required in step 5 below. You can uncheck this setting afterwards.
3. Upload sketch (Ctrl+U). Once done open Serial Monitor (Ctrl+Shift+M) and check if you see the following message displayed, that contains url for OTA update. 3. Upload sketch (Ctrl+U). Once done open Serial Monitor (Ctrl+Shift+M) and check if you see the following message displayed, that contains url for OTA update.
![Serial Monitor - after first load using serial](ota-web-serial-monitor-ready.png) ![Serial Monitor - after first load using serial](ota-web-serial-monitor-ready.png)
**Note:** Such message will be shown only after module successfully joins network and is ready for an OTA upload:
**Note:** Such message will be shown only after module successfully joins network and is ready for an OTA upload.
4. Now open web browser and enter the url provided on Serial Monitor, i.e. http://esp8266-webupdate.local/update. Once entered, browser should display a form like below that has been served by your module. The form invites you to choose a file for update. 4. Now open web browser and enter the url provided on Serial Monitor, i.e. http://esp8266-webupdate.local/update. Once entered, browser should display a form like below that has been served by your module. The form invites you to choose a file for update.
![OTA update form in web browser](ota-web-browser-form.png) ![OTA update form in web browser](ota-web-browser-form.png)
**Note:** If entering “http://esp8266-webupdate.local/update” does not work, try replacing “esp8266-webupdate” with module’s IP address. For example, if your module IP is “192.168.1.100” then url should be “http://192.168.1.100/update”. This workaround is useful in case the host software installed in step 2 does not work. If still nothing works and there are no clues on Serial Monitor, try to diagnose issue by opening provided url in Google Chrome, pressing F12 and checking contents of “Console” and “Network” tabs. Chrome provides some advanced logging on these tabs. **Note:** If entering “http://esp8266-webupdate.local/update” does not work, try replacing “esp8266-webupdate” with module’s IP address. For example, if your module IP is “192.168.1.100” then url should be “http://192.168.1.100/update”. This workaround is useful in case the host software installed in step 2 does not work. If still nothing works and there are no clues on Serial Monitor, try to diagnose issue by opening provided url in Google Chrome, pressing F12 and checking contents of “Console” and “Network” tabs. Chrome provides some advanced logging on these tabs.
@ -241,7 +248,7 @@ You can use another module if it meets “Flash chip size is 2x the size of the
![Serial Monitor - after OTA update](ota-web-serial-monitor-reboot.png) ![Serial Monitor - after OTA update](ota-web-serial-monitor-reboot.png)
Just after reboot you should see exactly the same message “HTTPUpdateServer ready! Open http:// esp8266-webupdate.local /update in your browser” like in step 3. This is because module has been loaded again with the same code – first using serial port, and then using OTA. Just after reboot you should see exactly the same message “HTTPUpdateServer ready! Open http:// esp8266-webupdate.local /update in your browser” like in step 3. This is because module has been loaded again with the same code – first using serial port, and then using OTA.
Once you are comfortable with this procedure go ahead and modify WebUpdater.ino sketch to print some additional messages, compile it, locate new binary file and upload it using web browser to see entered changes on a Serial Monitor. Once you are comfortable with this procedure go ahead and modify WebUpdater.ino sketch to print some additional messages, compile it, locate new binary file and upload it using web browser to see entered changes on a Serial Monitor.

14
doc/reference.md
View File

@ -3,13 +3,13 @@ title: Reference
--- ---
## Table of Contents ## Table of Contents
* [Table of Contents](#table-of-contents) * [Table of Contents](#table-of-contents)
* [Digital IO](#digital-io) * [Digital IO](#digital-io)
* [Analog input](#analog-input) * [Analog input](#analog-input)
* [Analog output](#analog-output) * [Analog output](#analog-output)
* [Timing and delays](#timing-and-delays) * [Timing and delays](#timing-and-delays)
* [Serial](#serial) * [Serial](#serial)
* [Progmem](#progmem) * [Progmem](#progmem)
## Digital IO ## Digital IO