ebook img

ESP8266 Arduino Core Documentation PDF

79 Pages·2017·3.26 MB·English
by  
Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.

Preview ESP8266 Arduino Core Documentation

ESP8266 Arduino Core Documentation Release 2.4.0 Ivan Grokhotkov May 14, 2017 Contents: 1 Installing 1 1.1 BoardsManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.2 Usinggitversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 2 Reference 5 2.1 DigitalIO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 2.2 Analoginput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 2.3 Analogoutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 2.4 Timinganddelays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 2.5 Serial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 2.6 Progmem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 3 Libraries 9 3.1 WiFi(ESP8266WiFilibrary) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 3.2 Ticker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 3.3 EEPROM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 3.4 I2C(Wirelibrary) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 3.5 SPI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 3.6 SoftwareSerial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 3.7 ESP-specificAPIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 3.8 mDNSandDNS-SDresponder(ESP8266mDNSlibrary). . . . . . . . . . . . . . . . . . . . . . . . 11 3.9 SSDPresponder(ESP8266SSDP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 3.10 DNSserver(DNSServerlibrary). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 3.11 Servo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 3.12 Otherlibraries(notincludedwiththeIDE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 4 Filesystem 15 4.1 Flashlayout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 4.2 Filesystemlimitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 4.3 Uploadingfilestofilesystem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 4.4 Filesystemobject(SPIFFS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 4.5 Filesysteminformationstructure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 4.6 Directoryobject(Dir) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 4.7 Fileobject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 5 ESP8266WiFilibrary 21 5.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 i 5.2 ClassDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 5.3 Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 5.4 What’sInside? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 6 OTAUpdates 33 6.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 6.2 ArduinoIDE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 6.3 WebBrowser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 6.4 HTTPServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 6.5 StreamInterface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 6.6 Updaterclass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 7 Boards 49 7.1 AdafruitHUZZAHESP8266(ESP-12) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 7.2 ESPressoLite1.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 7.3 ESPressoLite2.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 7.4 Phoenix1.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 7.5 Phoenix2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 7.6 NodeMCU0.9 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 7.7 NodeMCU1.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 7.8 OlimexMOD-WIFI-ESP8266-DEV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 7.9 OlimexMOD-WIFI-ESP8266 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 7.10 OlimexESP8266-EVB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 7.11 SparkFunESP8266Thing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 7.12 SweetPeaESP-210 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 7.13 ESPino . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 7.14 WifInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 7.15 GenericESP8266modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 7.16 SerialAdapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 7.17 MinimalHardwareSetupforBootloadingandUsage . . . . . . . . . . . . . . . . . . . . . . . . . . 53 7.18 ESPtoSerial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 7.19 Minimal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 7.20 ImprovedStability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 7.21 BootMessagesandModes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 7.22 GenericESP8285modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 7.23 WeMosD1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 7.24 WeMosD1mini . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 7.25 ESPino(WROOM-02Module)byThaiEasyElec . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 7.26 gen4-IoDRangeby4DSystems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 8 FAQ 59 8.1 Iamgetting“espcomm_syncfailed”errorwhentryingtouploadmyESP.Howtoresolvethisissue? 59 8.2 Whyesptoolisnotlistedin“Programmer”menu? HowdoIuploadESPwithoutit? . . . . . . . . . 59 8.3 MyESPcrashesrunningsomecode. Howtotroubleshootit? . . . . . . . . . . . . . . . . . . . . . 59 8.4 ThisArduinolibrarydoesn’tworkonESP.HowdoImakeitworking? . . . . . . . . . . . . . . . . 60 8.5 IntheIDE,forESP-12Ethathas4Mflash,Icanchoose4M(1MSPIFFS)or4M(3MSPIFFS).No matterwhatIselect,theIDEtellsmethemaximumcodespaceisabout1M.Wheredoesmyflashgo? 60 8.6 IhaveobservedacasewhenESP.restart()doesn’twork. Whatisthereasonforthat? . . . . . . . . . 60 8.7 Howtoresolve“Boardgeneric(platformesp8266,packageesp8266)isunknown”error?. . . . . . . 60 9 ExceptionCauses(EXCCAUSE) 61 10 Debugging 63 10.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 10.2 Informations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 ii 11 StackDumps 67 11.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 12 UsingEclipsewithArduinoESP8266 69 12.1 WhattoDownload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 12.2 SetupArduino . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 12.3 SetupEclipse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 12.4 Eclipsewontbuild . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 13 Changelog 71 13.1 2.3.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 13.2 2.2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 13.3 2.0.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 13.4 1.6.4-673-g8cd3697 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 13.5 1.6.4-628-g545ffde . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 iii iv 1 CHAPTER Installing Boards Manager Thisisthesuggestedinstallationmethodforendusers. Prerequisites • Arduino1.6.8,getitfromArduinowebsite. • Internetconnection Instructions • StartArduinoandopenPreferenceswindow. • Enterhttp://arduino.esp8266.com/stable/package_esp8266com_index.jsonintoAddi- tionalBoardManagerURLsfield. YoucanaddmultipleURLs,separatingthemwithcommas. • OpenBoardsManagerfromTools>Boardmenuandfindesp8266platform. • Selecttheversionyouneedfromadrop-downbox. • Clickinstallbutton. • Don’tforgettoselectyourESP8266boardfromTools>Boardmenuafterinstallation. You may optionally use staging boards manager package link: http://arduino.esp8266.com/staging/ package_esp8266com_index.json. Thismaycontainsomenewfeatures,butatthesametime,somethings mightbebroken. 1 ESP8266ArduinoCoreDocumentation,Release2.4.0 Using git version Thisisthesuggestedinstallationmethodforcontributorsandlibrarydevelopers. Prerequisites • Arduino1.6.8(ornewer,ifyouknowwhatyouaredoing) • git • python2.7 • terminal,console,orcommandprompt(dependingonyouOS) • Internetconnection Instructions • Open the console and go to Arduino directory. This can be either your sketchbook directory (usually <Documents>/Arduino),orthedirectoryofArduinoapplicationitself,thechoiceisuptoyou. • Clonethisrepositoryintohardware/esp8266com/esp8266directory. Alternatively,cloneitelsewhereandcreate asymlink,ifyourOSsupportsthem. cd hardware mkdir esp8266com cd esp8266com git clone https://github.com/esp8266/Arduino.git esp8266 Youshouldendupwiththefollowingdirectorystructure: Arduino | --- hardware | --- esp8266com | --- esp8266 | --- bootloaders --- cores --- doc --- libraries --- package --- tests --- tools --- variants --- platform.txt --- programmers.txt --- README.md --- boards.txt --- LICENSE • Downloadbinarytools cd esp8266/tools python get.py 2 Chapter1. Installing ESP8266ArduinoCoreDocumentation,Release2.4.0 • RestartArduino 1.2. Usinggitversion 3 ESP8266ArduinoCoreDocumentation,Release2.4.0 4 Chapter1. Installing

Description:
ESP8266 Arduino Core Documentation, Release 2.4.0. By default the diagnostic output from WiFi libraries is disabled when you call Serial.begin.
See more

The list of books you might like

book image

Corrupt (Devil's Night #1)

Penelope Douglas
·518 Pages
·2015
·0.74 MB

book image

Believe Me

Tahereh Mafi
·177 Pages
·2021
·2.19 MB

book image

The Subtle Art of Not Giving a F*ck

Mark Manson
·224 Pages
·2016
·1.26 MB

book image

What Happened to You?

Bruce D. Perry
·2021
·4.38 MB

book image

Suddenly Psychic: a Skeptic''s Journey

Caudill, Maureen
·2006
·0.976 MB

book image

Glencoe Literature: Reading With Purpose, Course 3

Jeffrey D. Wilhelm, Douglas Fisher, Kathleen A. Hinchman, David O'Brien, Taffy Raphael
·1326 Pages
·2006
·81.47 MB

book image

Calendar of the Bristol Apprentice Book 1532-1565

E. Ralph (ed.)
·167 Pages
·2015
·27.55 MB

book image

alumnidirectoryo00yalerich_bw

1000 Pages
·2021
·51.79 MB

book image

Extraordinary Gazette of India, 2006, No. 477

Directorate of Printing, Government of India
·2 MB

book image

California Department of Public Health Office of AIDS, AIDS Drug

Magellan Rx Management
·878 Pages
·2016
·2.07 MB

book image

El arte de la ficción

David Lodge
·1992
·0.497 MB

book image

Odisha Gazette, 2012-12-13, No. 65

Government of Odisha
·0.08 MB