@toit/esptool.js
Version:
TypeScript port of the esptool
219 lines • 9.25 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>index | @toit/esptool.js</title>
<meta name="description" content="Documentation for @toit/esptool.js">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@toit/esptool.js</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">@toit/esptool.js</a>
</li>
<li>
<a href="index.html">index</a>
</li>
</ul>
<h1>Module index</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Enumerations</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/index.ChipFamily.html" class="tsd-kind-icon">Chip<wbr>Family</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/index.EspLoader.html" class="tsd-kind-icon">Esp<wbr>Loader</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/index.Logger.html" class="tsd-kind-icon">Logger</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Type aliases</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="index.html#EspLoaderOptions" class="tsd-kind-icon">Esp<wbr>Loader<wbr>Options</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Variables</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="index.html#ESP_ROM_BAUD" class="tsd-kind-icon">ESP_<wbr>ROM_<wbr>BAUD</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Type aliases</h2>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
<a name="EspLoaderOptions" class="tsd-anchor"></a>
<h3>Esp<wbr>Loader<wbr>Options</h3>
<div class="tsd-signature tsd-kind-icon">Esp<wbr>Loader<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>debug<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>flashSize<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>logger<span class="tsd-signature-symbol">: </span><a href="../interfaces/index.Logger.html" class="tsd-signature-type" data-tsd-kind="Interface">Logger</a><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/index.ts#L61">index.ts:61</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>debug<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
<li class="tsd-parameter">
<h5>flash<wbr>Size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>logger<span class="tsd-signature-symbol">: </span><a href="../interfaces/index.Logger.html" class="tsd-signature-type" data-tsd-kind="Interface">Logger</a></h5>
</li>
</ul>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
<a name="ESP_ROM_BAUD" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> ESP_<wbr>ROM_<wbr>BAUD</h3>
<div class="tsd-signature tsd-kind-icon">ESP_<wbr>ROM_<wbr>BAUD<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">115200</span><span class="tsd-signature-symbol"> = 115200</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/index.ts#L22">index.ts:22</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="errors.html">errors</a>
</li>
<li class="current tsd-kind-module">
<a href="index.html">index</a>
</li>
<li class=" tsd-kind-module">
<a href="reader.html">reader</a>
</li>
<li class=" tsd-kind-module">
<a href="stubs.html">stubs</a>
</li>
<li class=" tsd-kind-module">
<a href="util.html">util</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum tsd-parent-kind-module">
<a href="../enums/index.ChipFamily.html" class="tsd-kind-icon">Chip<wbr>Family</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/index.EspLoader.html" class="tsd-kind-icon">Esp<wbr>Loader</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/index.Logger.html" class="tsd-kind-icon">Logger</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="index.html#EspLoaderOptions" class="tsd-kind-icon">Esp<wbr>Loader<wbr>Options</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-module">
<a href="index.html#ESP_ROM_BAUD" class="tsd-kind-icon">ESP_<wbr>ROM_<wbr>BAUD</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>