Installing — ESP8266 Arduino Core 2.4.0 documentation

<!DOCTYPE html>   <html class="no-js" lang="en" >  <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Installing — ESP8266 Arduino Core 2.4.0 documentation</title> <link rel="stylesheet" href="https://media.readthedocs.org/css/sphinx_rtd_theme.css" type="text/css" /> <link rel="index" title="Index" href="genindex.html"/> <link rel="search" title="Search" href="search.html"/> <link rel="top" title="ESP8266 Arduino Core 2.4.0 documentation" href="index.html"/> <link rel="next" title="Reference" href="reference.html"/> <link rel="prev" title="Welcome to ESP8266 Arduino Core鈥檚 documentation!" href="index.html"/> <script src="_static/js/modernizr.min.js"></script>   <link rel="canonical" href="http://arduino-esp8266.readthedocs.io/en/latest/installing.html" /> <link rel="stylesheet" href="https://media.readthedocs.org/css/readthedocs-doc-embed.css" type="text/css" /> <script type="text/javascript" src="_static/readthedocs-data.js"></script>  <script type="text/javascript"> READTHEDOCS_DATA['page'] = 'installing' READTHEDOCS_DATA['source_suffix'] = '.rst' </script> <script type="text/javascript" src="_static/readthedocs-dynamic-include.js"></script>  <script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script><meta name="readthedocs-project-slug" content="arduino-esp8266" /><meta name="readthedocs-version-slug" content="2.4.1" /><meta name="readthedocs-resolver-filename" content="/installing.html" /><meta name="readthedocs-http-status" content="200" /></head> <body class="wy-body-for-nav" role="document"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search"> <a href="index.html" class="icon icon-home"> ESP8266 Arduino Core </a> <div class="version"> 2.4.1 </div> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div> <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> <p class="caption"><span class="caption-text">Contents:</span></p> <ul class="current"> <li class="toctree-l1 current"><a class="current reference internal" href="#">Installing</a><ul> <li class="toctree-l2"><a class="reference internal" href="#boards-manager">Boards Manager</a><ul> <li class="toctree-l3"><a class="reference internal" href="#prerequisites">Prerequisites</a></li> <li class="toctree-l3"><a class="reference internal" href="#instructions">Instructions</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="#using-git-version">Using git version</a><ul> <li class="toctree-l3"><a class="reference internal" href="#id1">Prerequisites</a></li> <li class="toctree-l3"><a class="reference internal" href="#id2">Instructions</a></li> </ul> </li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="libraries.html">Libraries</a></li> <li class="toctree-l1"><a class="reference internal" href="filesystem.html">File system</a></li> <li class="toctree-l1"><a class="reference internal" href="esp8266wifi/readme.html">ESP8266WiFi</a></li> <li class="toctree-l1"><a class="reference internal" href="ota_updates/readme.html">OTA Updates</a></li> <li class="toctree-l1"><a class="reference internal" href="PROGMEM.html">PROGMEM</a></li> <li class="toctree-l1"><a class="reference internal" href="boards.html">Boards</a></li> <li class="toctree-l1"><a class="reference internal" href="faq/readme.html">FAQ</a></li> <li class="toctree-l1"><a class="reference internal" href="exception_causes.html">Exception causes</a></li> <li class="toctree-l1"><a class="reference internal" href="Troubleshooting/debugging.html">Debugging</a></li> <li class="toctree-l1"><a class="reference internal" href="Troubleshooting/stack_dump.html">Stack Dump</a></li> <li class="toctree-l1"><a class="reference internal" href="eclipse/eclipse.html">Using with Eclipse</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="index.html">ESP8266 Arduino Core</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> <li><a href="index.html">Docs</a> »</li> <li>Installing</li> <li class="wy-breadcrumbs-aside"> <a href="https://github.com/esp8266/Arduino/blob/2.4.1/doc/installing.rst" class="fa fa-github"> Edit on GitHub</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <div class="section" id="installing"> <h1>Installing<a class="headerlink" href="#installing" title="Permalink to this headline">露</a></h1> <div class="section" id="boards-manager"> <h2>Boards Manager<a class="headerlink" href="#boards-manager" title="Permalink to this headline">露</a></h2> <p>This is the suggested installation method for end users.</p> <div class="section" id="prerequisites"> <h3>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline">露</a></h3> <ul class="simple"> <li>Arduino 1.6.8, get it from <a class="reference external" href="https://www.arduino.cc/en/Main/OldSoftwareReleases#previous">Arduino website</a>.</li> <li>Internet connection</li> </ul> </div> <div class="section" id="instructions"> <h3>Instructions<a class="headerlink" href="#instructions" title="Permalink to this headline">露</a></h3> <ul class="simple"> <li>Start Arduino and open Preferences window.</li> <li>Enter <code class="docutils literal notranslate"><span class="pre">http://arduino.esp8266.com/stable/package_esp8266com_index.json</span></code> into <em>Additional Board Manager URLs</em> field. You can add multiple URLs, separating them with commas.</li> <li>Open Boards Manager from Tools > Board menu and find <em>esp8266</em> platform.</li> <li>Select the version you need from a drop-down box.</li> <li>Click <em>install</em> button.</li> <li>Don鈥檛 forget to select your ESP8266 board from Tools > Board menu after installation.</li> </ul> <p>You may optionally use <em>staging</em> boards manager package link: <code class="docutils literal notranslate"><span class="pre">http://arduino.esp8266.com/staging/package_esp8266com_index.json</span></code>. This may contain some new features, but at the same time, some things might be broken.</p> </div> </div> <div class="section" id="using-git-version"> <h2>Using git version<a class="headerlink" href="#using-git-version" title="Permalink to this headline">露</a></h2> <p>This is the suggested installation method for contributors and library developers.</p> <div class="section" id="id1"> <h3>Prerequisites<a class="headerlink" href="#id1" title="Permalink to this headline">露</a></h3> <ul class="simple"> <li>Arduino 1.6.8 (or newer, if you know what you are doing)</li> <li>git</li> <li>python 2.7</li> <li>terminal, console, or command prompt (depending on you OS)</li> <li>Internet connection</li> </ul> </div> <div class="section" id="id2"> <h3>Instructions<a class="headerlink" href="#id2" title="Permalink to this headline">露</a></h3> <ul> <li><p class="first">Open the console and go to Arduino directory. This can be either your <em>sketchbook</em> directory (usually <code class="docutils literal notranslate"><span class="pre"><Documents>/Arduino</span></code>), or the directory of Arduino application itself, the choice is up to you.</p> </li> <li><p class="first">Clone this repository into hardware/esp8266com/esp8266 directory. Alternatively, clone it elsewhere and create a symlink, if your OS supports them.</p> <div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">hardware</span> <span class="n">mkdir</span> <span class="n">esp8266com</span> <span class="n">cd</span> <span class="n">esp8266com</span> <span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">esp8266</span><span class="o">/</span><span class="n">Arduino</span><span class="o">.</span><span class="n">git</span> <span class="n">esp8266</span> </pre></div> </div> <p>You should end up with the following directory structure:</p> <div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Arduino</span> <span class="o">|</span> <span class="o">---</span> <span class="n">hardware</span> <span class="o">|</span> <span class="o">---</span> <span class="n">esp8266com</span> <span class="o">|</span> <span class="o">---</span> <span class="n">esp8266</span> <span class="o">|</span> <span class="o">---</span> <span class="n">bootloaders</span> <span class="o">---</span> <span class="n">cores</span> <span class="o">---</span> <span class="n">doc</span> <span class="o">---</span> <span class="n">libraries</span> <span class="o">---</span> <span class="n">package</span> <span class="o">---</span> <span class="n">tests</span> <span class="o">---</span> <span class="n">tools</span> <span class="o">---</span> <span class="n">variants</span> <span class="o">---</span> <span class="n">platform</span><span class="o">.</span><span class="n">txt</span> <span class="o">---</span> <span class="n">programmers</span><span class="o">.</span><span class="n">txt</span> <span class="o">---</span> <span class="n">README</span><span class="o">.</span><span class="n">md</span> <span class="o">---</span> <span class="n">boards</span><span class="o">.</span><span class="n">txt</span> <span class="o">---</span> <span class="n">LICENSE</span> </pre></div> </div> </li> <li><p class="first">Download binary tools</p> <div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">esp8266</span><span class="o">/</span><span class="n">tools</span> <span class="n">python</span> <span class="n">get</span><span class="o">.</span><span class="n">py</span> </pre></div> </div> </li> <li><p class="first">Restart Arduino</p> </li> </ul> </div> </div> </div> </div> <div class="articleComments"> </div> </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <a href="reference.html" class="btn btn-neutral float-right" title="Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> <a href="index.html" class="btn btn-neutral" title="Welcome to ESP8266 Arduino Core鈥檚 documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> <hr/> <div role="contentinfo"> <p> © Copyright 2017, Ivan Grokhotkov. <span class="commit"> Revision <code>614f7c32</code>. </span> </p> </div> Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'2.4.0', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true, SOURCELINK_SUFFIX: '.txt' }; </script> <script type="text/javascript" src="https://media.readthedocs.org/javascript/jquery/jquery-2.0.3.min.js"></script> <script type="text/javascript" src="https://media.readthedocs.org/javascript/jquery/jquery-migrate-1.2.1.min.js"></script> <script type="text/javascript" src="https://media.readthedocs.org/javascript/underscore.js"></script> <script type="text/javascript" src="https://media.readthedocs.org/javascript/doctools.js"></script> <script type="text/javascript" src="https://media.readthedocs.org/javascript/readthedocs-doc-embed.js"></script> <script type="text/javascript"> jQuery(function () { SphinxRtdTheme.StickyNav.enable(); }); </script> </body> </html>

CINXE.COM

Installing — ESP8266 Arduino Core 2.4.0 documentation