arduino/esp8266
1
0
Fork 0
mirror of https://github.com/esp8266/Arduino.git synced 2025-04-19 23:22:16 +03:00
Code
esp8266/versions/2.3.0/doc/installing.html
Ivan Grokhotkov abb4ce01f4 Add 2.3.0
2016-06-23 15:44:06 +08:00

370 lines
8.1 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<html lang="en-us">
<head>
<link href="http://gmpg.org/xfn/11" rel="profile">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<!-- Enable responsiveness on mobile devices-->
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
<title>
Installation &middot; ESP8266 Arduino Core
</title>
<!-- CSS -->
<link rel="stylesheet" href="/Arduino/versions/2.3.0/public/css/poole.css">
<link rel="stylesheet" href="/Arduino/versions/2.3.0/public/css/syntax.css">
<link rel="stylesheet" href="/Arduino/versions/2.3.0/public/css/hyde.css">
<link rel="stylesheet" href="/Arduino/versions/2.3.0/public/css/icons.css">
<link rel="stylesheet" href="http://fonts.googleapis.com/css?family=PT+Sans:400,400italic,700|Abril+Fatface">
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.4.0/css/font-awesome.min.css">
<!-- Icons -->
<link rel="shortcut icon" href="/Arduino/versions/2.3.0/public/favicon.ico">
<!-- RSS -->
<link rel="alternate" type="application/rss+xml" title="RSS" href="/atom.xml">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
<script src="/Arduino/versions/2.3.0/public/js/toc.js"></script>
<script type="text/javascript">
$(document).ready(function() {
$('#toc').toc({ listType: 'ul', showSpeed: 0, title: '', headers: 'h1, h2', minimumHeaders: 2 });
});
</script>
</head>
<body>
<div class="version-bar">
This documentation is for version 2.3.0. <a href="http://esp8266.github.io/Arduino/versions">Other versions.</a>
</div>
<div class="sidebar">
<div class="container">
<div class="sidebar-about">
<h2>
<a href="http://esp8266.github.io/Arduino">
ESP8266 Arduino Core
</a>
</h2>
</div>
<nav class="sidebar-nav">
<a class="sidebar-nav-item" href="/Arduino/versions/2.3.0/doc/installing.html">Installation</a>
<div id="toc"></div>
<a class="sidebar-nav-item" href="/Arduino/versions/2.3.0/doc/reference.html">Reference</a>
<a class="sidebar-nav-item" href="/Arduino/versions/2.3.0/doc/libraries.html">Libraries</a>
<a class="sidebar-nav-item" href="/Arduino/versions/2.3.0/doc/filesystem.html">File System</a>
<a class="sidebar-nav-item" href="/Arduino/versions/2.3.0/doc/ota_updates/readme.html">OTA Update</a>
<a class="sidebar-nav-item" href="/Arduino/versions/2.3.0/doc/boards.html">Supported Hardware</a>
<a class="sidebar-nav-item" href="/Arduino/versions/2.3.0/doc/changes.html">Change Log</a>
</nav>
<p>
<a href="https://github.com/esp8266/Arduino"><div id="gh-icon"></div>esp8266/Arduino</a>
</p>
<p class="lead">Documentation for ESP8266 Arduino Core. Installation instructions, functions and classes reference.
</p>
</div>
</div>
<div class="content container">
<h2 id="boards-manager">Boards Manager</h2>
<p>This is the suggested installation method for end users.</p>
<h3 id="prerequisites">Prerequisites</h3>
<ul>
<li>Arduino 1.6.8, get it from <a href="https://www.arduino.cc/en/Main/OldSoftwareReleases#previous">Arduino website</a>.</li>
<li>Internet connection</li>
</ul>
<h3 id="instructions">Instructions</h3>
<ul>
<li>Start Arduino and open Preferences window.</li>
<li>Enter <code>http://arduino.esp8266.com/stable/package_esp8266com_index.json</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 &gt; 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&#39;t forget to select your ESP8266 board from Tools &gt; Board menu after installation.</li>
</ul>
<p>You may optionally use <em>staging</em> boards manager package link:
<code>http://arduino.esp8266.com/staging/package_esp8266com_index.json</code>. This may contain some new features, but at the same time, some things might be broken.</p>
<h2 id="using-git-version">Using git version</h2>
<p>This is the suggested installation method for contributors and library developers.</p>
<h3 id="prerequisites">Prerequisites</h3>
<ul>
<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>
<h3 id="instructions">Instructions</h3>
<ul>
<li>Open the console and go to Arduino directory. This can be either your <em>sketchbook</em> directory (usually <code>&lt;Documents&gt;/Arduino</code>), or the directory of Arduino application itself, the choice is up to you.</li>
<li><p>Clone this repository into hardware/esp8266com/esp8266 directory. Alternatively, clone it elsewhere and create a symlink, if your OS supports them.</p>
<div class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nb">cd </span>hardware
mkdir esp8266com
<span class="nb">cd </span>esp8266com
git clone https://github.com/esp8266/Arduino.git esp8266
</code></pre></div>
<p>You should end up with the following directory structure:</p>
<div class="highlight"><pre><code class="language-bash" data-lang="bash">Arduino
<span class="p">|</span>
--- hardware
<span class="p">|</span>
--- esp8266com
<span class="p">|</span>
--- esp8266
<span class="p">|</span>
--- bootloaders
--- cores
--- doc
--- libraries
--- package
--- tests
--- tools
--- variants
--- platform.txt
--- programmers.txt
--- README.md
--- boards.txt
--- LICENSE
</code></pre></div></li>
<li><p>Download binary tools</p>
<div class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nb">cd </span>esp8266/tools
python get.py
</code></pre></div></li>
<li><p>Restart Arduino</p></li>
</ul>
</div>
</body>
</html>
View Git Blame Copy Permalink