mirror of
https://github.com/kou029w/megabit.git
synced 2025-01-31 06:08:03 +00:00
277 lines
No EOL
11 KiB
HTML
277 lines
No EOL
11 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>vl53l0x | megabit</title>
|
|
<meta name="description" content="Documentation for megabit">
|
|
<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">megabit</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">megabit</a>
|
|
</li>
|
|
<li>
|
|
<a href="vl53l0x.html">vl53l0x</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Module vl53l0x</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>References</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-reference tsd-parent-kind-module"><a href="vl53l0x.html#default" class="tsd-kind-icon">default</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="vl53l0x.html#Distance" class="tsd-kind-icon">Distance</a></li>
|
|
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="vl53l0x.html#EnableLongRangeMode" class="tsd-kind-icon">Enable<wbr>Long<wbr>Range<wbr>Mode</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Functions</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="vl53l0x.html#vl53l0x-1" class="tsd-kind-icon">vl53l0x</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>References</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module">
|
|
<a name="default" class="tsd-anchor"></a>
|
|
<h3>default</h3>
|
|
Renames and exports <a href="vl53l0x.html#vl53l0x-1">vl53l0x</a>
|
|
</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="Distance" class="tsd-anchor"></a>
|
|
<h3>Distance</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Distance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/kou029w/megabit/blob/76a2a76/src/vl53l0x.ts#L9">src/vl53l0x.ts:9</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Distance (mm)</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a name="EnableLongRangeMode" class="tsd-anchor"></a>
|
|
<h3>Enable<wbr>Long<wbr>Range<wbr>Mode</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Enable<wbr>Long<wbr>Range<wbr>Mode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Boolean</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/kou029w/megabit/blob/76a2a76/src/vl53l0x.ts#L6">src/vl53l0x.ts:6</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Enable long range mode (max 2200mm)</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Functions</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="vl53l0x-1" class="tsd-anchor"></a>
|
|
<h3>vl53l0x</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">vl53l0x<span class="tsd-signature-symbol">(</span>bus<span class="tsd-signature-symbol">?: </span><a href="../classes/i2c.I2C.html" class="tsd-signature-type" data-tsd-kind="Class">I2C</a>, address<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, enableLongRangeMode<span class="tsd-signature-symbol">?: </span><a href="vl53l0x.html#EnableLongRangeMode" class="tsd-signature-type" data-tsd-kind="Type alias">EnableLongRangeMode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Device.ReadableDevice.html" class="tsd-signature-type" data-tsd-kind="Interface">ReadableDevice</a><span class="tsd-signature-symbol"><</span><a href="vl53l0x.html#Distance" class="tsd-signature-type" data-tsd-kind="Type alias">Distance</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/kou029w/megabit/blob/76a2a76/src/vl53l0x.ts#L12">src/vl53l0x.ts:12</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>max 1200 mm / 2200 mm (long range mode)</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>bus: <a href="../classes/i2c.I2C.html" class="tsd-signature-type" data-tsd-kind="Class">I2C</a><span class="tsd-signature-symbol"> = ...</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>address: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0x29</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> enableLongRangeMode: <a href="vl53l0x.html#EnableLongRangeMode" class="tsd-signature-type" data-tsd-kind="Type alias">EnableLongRangeMode</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Device.ReadableDevice.html" class="tsd-signature-type" data-tsd-kind="Interface">ReadableDevice</a><span class="tsd-signature-symbol"><</span><a href="vl53l0x.html#Distance" class="tsd-signature-type" data-tsd-kind="Type alias">Distance</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</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="Device.html">Device</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="ads1015.html">ads1015</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="adt7410.html">adt7410</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="adxl345.html">adxl345</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="gp2y0e03.html">gp2y0e03</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="gpio.html">gpio</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="i2c.html">i2c</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="index.html">index</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="mpr121.html">mpr121</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="paj7620.html">paj7620</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="pca9685.html">pca9685</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="s11059.html">s11059</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="sht30.html">sht30</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="ssd1306.html">ssd1306</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="ssd1308.html">ssd1308</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="tsl2561.html">tsl2561</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="veml6070.html">veml6070</a>
|
|
</li>
|
|
<li class="current tsd-kind-module">
|
|
<a href="vl53l0x.html">vl53l0x</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
<li class=" tsd-kind-reference tsd-parent-kind-module">
|
|
<a href="vl53l0x.html#default" class="tsd-kind-icon">default</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="vl53l0x.html#Distance" class="tsd-kind-icon">Distance</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="vl53l0x.html#EnableLongRangeMode" class="tsd-kind-icon">Enable<wbr>Long<wbr>Range<wbr>Mode</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="vl53l0x.html#vl53l0x-1" class="tsd-kind-icon">vl53l0x</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-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-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</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> |