Loading files
This file is pinned to the selected release. Download the original to open it in your design tool.
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>IoT-MBBR (masterthesis): firmware/EFM32HG222F64_iot-mbbr/VL53L1X_API/VL53L1X_api.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">IoT-MBBR (masterthesis)
</div>
<div id="projectbrief">Masterthesis upgrading a Moving Bed BioReactor with extra sensors and cloud connectivity.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('VL53L1X__api_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">VL53L1X_api.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="VL53L1X__api_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">* Copyright (c) 2017, STMicroelectronics - All Rights Reserved</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">*</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">* This file : part of VL53L1 Core and : dual licensed,</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">* either 'STMicroelectronics</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">* Proprietary license'</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">* or 'BSD 3-clause "New" or "Revised" License' , at your option.</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">*</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">********************************************************************************</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">*</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">* 'STMicroelectronics Proprietary license'</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">*</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">********************************************************************************</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">*</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">* License terms: STMicroelectronics Proprietary in accordance with licensing</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">* terms at www.st.com/sla0081</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">* STMicroelectronics confidential</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">* Reproduction and Communication of this document : strictly prohibited unless</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">* specifically authorized in writing by STMicroelectronics.</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">*</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">*</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">********************************************************************************</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">*</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">* Alternatively, VL53L1 Core may be distributed under the terms of</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">* 'BSD 3-clause "New" or "Revised" License', in which case the following</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">* provisions apply instead of the ones mentioned above :</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">*</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">********************************************************************************</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">*</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">* License terms: BSD 3-clause "New" or "Revised" License.</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">*</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">* Redistribution and use in source and binary forms, with or without</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">* modification, are permitted provided that the following conditions are met:</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">*</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">* 1. Redistributions of source code must retain the above copyright notice, this</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">* list of conditions and the following disclaimer.</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">*</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">* 2. Redistributions in binary form must reproduce the above copyright notice,</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">* this list of conditions and the following disclaimer in the documentation</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">* and/or other materials provided with the distribution.</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">*</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">* 3. Neither the name of the copyright holder nor the names of its contributors</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">* may be used to endorse or promote products derived from this software</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">* without specific prior written permission.</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">*</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">*</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">*</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">********************************************************************************</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">*</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">*/</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"></span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">/**</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * @file vl53l1x_api.h</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * @brief Functions definition</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> */</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor">#ifndef _API_H_</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">#define _API_H_</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#include "<a class="code" href="vl53l1__platform_8h.html">vl53l1_platform.h</a>"</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#a542371c8c3204d2a190bebed741a741e"> 73</a></span> <span class="preprocessor">#define VL53L1X_IMPLEMENTATION_VER_MAJOR 3</span></div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#aeb992f2c9bfd1c73dcfae9ebc7180fad"> 74</a></span> <span class="preprocessor">#define VL53L1X_IMPLEMENTATION_VER_MINOR 3</span></div><div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#abccaf6e0c198fe271bde715a90f23b34"> 75</a></span> <span class="preprocessor">#define VL53L1X_IMPLEMENTATION_VER_SUB 0</span></div><div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#aede005dde2f068571499b6f56a2e191f"> 76</a></span> <span class="preprocessor">#define VL53L1X_IMPLEMENTATION_VER_REVISION 0000</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc"> 78</a></span> <span class="keyword">typedef</span> <a class="code" href="vl53l1__types_8h.html#aef44329758059c91c76d334e8fc09700">int8_t</a> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a>;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#a74625341a79e3484830c401d8947443c"> 80</a></span> <span class="preprocessor">#define SOFT_RESET 0x0000</span></div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#af09585764ab1dde6627bad6098cd5e6e"> 81</a></span> <span class="preprocessor">#define VL53L1_I2C_SLAVE__DEVICE_ADDRESS 0x0001</span></div><div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#a0b554c56b9617df6b957f26e407ce54d"> 82</a></span> <span class="preprocessor">#define VL53L1_VHV_CONFIG__TIMEOUT_MACROP_LOOP_BOUND 0x0008</span></div><div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#a55aa3ef1d347f822cc5f6028f2ddf56f"> 83</a></span> <span class="preprocessor">#define ALGO__CROSSTALK_COMPENSATION_PLANE_OFFSET_KCPS 0x0016</span></div><div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#af25151d720c6f6d003e61d92ad738c4c"> 84</a></span> <span class="preprocessor">#define ALGO__CROSSTALK_COMPENSATION_X_PLANE_GRADIENT_KCPS 0x0018</span></div><div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#a25a78b1dc1070a5e72e19645f8f52d33"> 85</a></span> <span class="preprocessor">#define ALGO__CROSSTALK_COMPENSATION_Y_PLANE_GRADIENT_KCPS 0x001A</span></div><div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#a2ab0e4617017e0bd940200ba07be4d34"> 86</a></span> <span class="preprocessor">#define ALGO__PART_TO_PART_RANGE_OFFSET_MM 0x001E</span></div><div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#a88617357dbed400268cfc2ee563f5396"> 87</a></span> <span class="preprocessor">#define MM_CONFIG__INNER_OFFSET_MM 0x0020</span></div><div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#a3f7f279509c4971c0027dd4004007c2f"> 88</a></span> <span class="preprocessor">#define MM_CONFIG__OUTER_OFFSET_MM 0x0022</span></div><div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#ac2b6c32911c2c553477f19bb3c25ce89"> 89</a></span> <span class="preprocessor">#define GPIO_HV_MUX__CTRL 0x0030</span></div><div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#a2806961b4373aaf95b11489324e8f84b"> 90</a></span> <span class="preprocessor">#define GPIO__TIO_HV_STATUS 0x0031</span></div><div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#a97207a2ee20535cd0102a4bb05779127"> 91</a></span> <span class="preprocessor">#define SYSTEM__INTERRUPT_CONFIG_GPIO 0x0046</span></div><div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#ab27d045e59238e549647e80fae3573f8"> 92</a></span> <span class="preprocessor">#define PHASECAL_CONFIG__TIMEOUT_MACROP 0x004B</span></div><div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#a02495d4260afeb98fc3ad68be4fe3c42"> 93</a></span> <span class="preprocessor">#define RANGE_CONFIG__TIMEOUT_MACROP_A_HI 0x005E</span></div><div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#a18bc9ac87e860bbc9106f09d8f35491e"> 94</a></span> <span class="preprocessor">#define RANGE_CONFIG__VCSEL_PERIOD_A 0x0060</span></div><div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#ab18472732f386d61b67e5fa6e35a57e9"> 95</a></span> <span class="preprocessor">#define RANGE_CONFIG__VCSEL_PERIOD_B 0x0063</span></div><div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#ae73e835209b048757aab1021f6a72e41"> 96</a></span> <span class="preprocessor">#define RANGE_CONFIG__TIMEOUT_MACROP_B_HI 0x0061</span></div><div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#abcec89cc9a8ff7a7392266f8470a2605"> 97</a></span> <span class="preprocessor">#define RANGE_CONFIG__TIMEOUT_MACROP_B_LO 0x0062</span></div><div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#ab72c85000f194caedd5a9137e962fde4"> 98</a></span> <span class="preprocessor">#define RANGE_CONFIG__SIGMA_THRESH 0x0064</span></div><div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#aad0f40d4cfe841c8ea1df480bda90151"> 99</a></span> <span class="preprocessor">#define RANGE_CONFIG__MIN_COUNT_RATE_RTN_LIMIT_MCPS 0x0066</span></div><div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#ad7f3c335c97795f0220d04a8feadc3ca"> 100</a></span> <span class="preprocessor">#define RANGE_CONFIG__VALID_PHASE_HIGH 0x0069</span></div><div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#afaf7ce8aa0b5888276751194bcf5f931"> 101</a></span> <span class="preprocessor">#define VL53L1_SYSTEM__INTERMEASUREMENT_PERIOD 0x006C</span></div><div class="line"><a name="l00102"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#aa430f8d2f8ee1a40476f5202f16807ae"> 102</a></span> <span class="preprocessor">#define SYSTEM__THRESH_HIGH 0x0072</span></div><div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#a9ff4642b47201d4d821fecc72ff8513c"> 103</a></span> <span class="preprocessor">#define SYSTEM__THRESH_LOW 0x0074</span></div><div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#a6a16e9c2ee589cd21957f1302d6654f1"> 104</a></span> <span class="preprocessor">#define SD_CONFIG__WOI_SD0 0x0078</span></div><div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#aea5e68cc5ce6336be7979caf62305db2"> 105</a></span> <span class="preprocessor">#define SD_CONFIG__INITIAL_PHASE_SD0 0x007A</span></div><div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#a706cd1aa011becfc35c7b496f599a30f"> 106</a></span> <span class="preprocessor">#define ROI_CONFIG__USER_ROI_CENTRE_SPAD 0x007F</span></div><div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#a279ad59723f100caf9bf056bbde528fa"> 107</a></span> <span class="preprocessor">#define ROI_CONFIG__USER_ROI_REQUESTED_GLOBAL_XY_SIZE 0x0080</span></div><div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#ae05b913fc1e0f18186c4a2bd44ff49b2"> 108</a></span> <span class="preprocessor">#define SYSTEM__SEQUENCE_CONFIG 0x0081</span></div><div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#a01651ee9d6f60f7829478d87cf82b3da"> 109</a></span> <span class="preprocessor">#define VL53L1_SYSTEM__GROUPED_PARAMETER_HOLD 0x0082</span></div><div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#a0151356cafc31665554f71d408c248a0"> 110</a></span> <span class="preprocessor">#define SYSTEM__INTERRUPT_CLEAR 0x0086</span></div><div class="line"><a name="l00111"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#aa430923f7d8ebfb9281163d17df1cc1e"> 111</a></span> <span class="preprocessor">#define SYSTEM__MODE_START 0x0087</span></div><div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#a795c007a11b10559317dc29d6dd5b43e"> 112</a></span> <span class="preprocessor">#define VL53L1_RESULT__RANGE_STATUS 0x0089</span></div><div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#afa93dea9a0d4065a9c4e246ee26daef0"> 113</a></span> <span class="preprocessor">#define VL53L1_RESULT__DSS_ACTUAL_EFFECTIVE_SPADS_SD0 0x008C</span></div><div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#a8fec1c1688c009c83fd1729042522710"> 114</a></span> <span class="preprocessor">#define RESULT__AMBIENT_COUNT_RATE_MCPS_SD 0x0090</span></div><div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#a7ac26737f5a5eb4915af98c2be6fb7c2"> 115</a></span> <span class="preprocessor">#define VL53L1_RESULT__FINAL_CROSSTALK_CORRECTED_RANGE_MM_SD0 0x0096</span></div><div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#aa80215477cc3130e21769999b9a2cfd4"> 116</a></span> <span class="preprocessor">#define VL53L1_RESULT__PEAK_SIGNAL_COUNT_RATE_CROSSTALK_CORRECTED_MCPS_SD0 0x0098</span></div><div class="line"><a name="l00117"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#a80678a1ebe27c577e592c271e92194fe"> 117</a></span> <span class="preprocessor">#define VL53L1_RESULT__OSC_CALIBRATE_VAL 0x00DE</span></div><div class="line"><a name="l00118"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#a095d61baf5e40ecde589a5dbf17b391a"> 118</a></span> <span class="preprocessor">#define VL53L1_FIRMWARE__SYSTEM_STATUS 0x00E5</span></div><div class="line"><a name="l00119"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#a6a27dfef0795b6688aacd6cd158939be"> 119</a></span> <span class="preprocessor">#define VL53L1_IDENTIFICATION__MODEL_ID 0x010F</span></div><div class="line"><a name="l00120"></a><span class="lineno"><a class="line" href="VL53L1X__api_8h.html#af64a6267f55a636775a99c6c32b098b7"> 120</a></span> <span class="preprocessor">#define VL53L1_ROI_CONFIG__MODE_ROI_CENTRE_SPAD 0x013E</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment">/****************************************</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> * PRIVATE define do not edit</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> ****************************************/</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"></span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment">/**</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> * @brief defines SW Version</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> */</span></div><div class="line"><a name="l00129"></a><span class="lineno"><a class="line" href="structVL53L1X__Version__t.html"> 129</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div><div class="line"><a name="l00130"></a><span class="lineno"><a class="line" href="structVL53L1X__Version__t.html#a9c8962c09fa41401d393b28237062450"> 130</a></span>  <a class="code" href="vl53l1__types_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> <a class="code" href="structVL53L1X__Version__t.html#a9c8962c09fa41401d393b28237062450">major</a>; <span class="comment">/*!< major number */</span></div><div class="line"><a name="l00131"></a><span class="lineno"><a class="line" href="structVL53L1X__Version__t.html#a6093fa9bbeaa6844ad571a842f4c0345"> 131</a></span>  <a class="code" href="vl53l1__types_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> <a class="code" href="structVL53L1X__Version__t.html#a6093fa9bbeaa6844ad571a842f4c0345">minor</a>; <span class="comment">/*!< minor number */</span></div><div class="line"><a name="l00132"></a><span class="lineno"><a class="line" href="structVL53L1X__Version__t.html#a03c80c16cb2de79265289251f14a1643"> 132</a></span>  <a class="code" href="vl53l1__types_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> <a class="code" href="structVL53L1X__Version__t.html#a03c80c16cb2de79265289251f14a1643">build</a>; <span class="comment">/*!< build number */</span></div><div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="structVL53L1X__Version__t.html#a863c15a6ed6b8fca8cbd5b17c36e5f61"> 133</a></span>  <a class="code" href="vl53l1__types_8h.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> <a class="code" href="structVL53L1X__Version__t.html#a863c15a6ed6b8fca8cbd5b17c36e5f61">revision</a>; <span class="comment">/*!< revision number */</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> } <a class="code" href="structVL53L1X__Version__t.html">VL53L1X_Version_t</a>;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"></span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment">/**</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> * @brief defines packed reading results type</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> */</span></div><div class="line"><a name="l00139"></a><span class="lineno"><a class="line" href="structVL53L1X__Result__t.html"> 139</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div><div class="line"><a name="l00140"></a><span class="lineno"><a class="line" href="structVL53L1X__Result__t.html#ab728a6f4521ca376d9dbe0710158b2b5"> 140</a></span>  <a class="code" href="vl53l1__types_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> <a class="code" href="structVL53L1X__Result__t.html#ab728a6f4521ca376d9dbe0710158b2b5">Status</a>; <span class="comment">/*!< ResultStatus */</span></div><div class="line"><a name="l00141"></a><span class="lineno"><a class="line" href="structVL53L1X__Result__t.html#a23ecdffefa85822a03fdad882408165d"> 141</a></span>  <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> <a class="code" href="structVL53L1X__Result__t.html#a23ecdffefa85822a03fdad882408165d">Distance</a>; <span class="comment">/*!< ResultDistance */</span></div><div class="line"><a name="l00142"></a><span class="lineno"><a class="line" href="structVL53L1X__Result__t.html#a25f7a69860763da776f6e4e678f00d8d"> 142</a></span>  <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> <a class="code" href="structVL53L1X__Result__t.html#a25f7a69860763da776f6e4e678f00d8d">Ambient</a>; <span class="comment">/*!< ResultAmbient */</span></div><div class="line"><a name="l00143"></a><span class="lineno"><a class="line" href="structVL53L1X__Result__t.html#a16cf31b3d24f20e85321bcfef7ecb5b7"> 143</a></span>  <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> <a class="code" href="structVL53L1X__Result__t.html#a16cf31b3d24f20e85321bcfef7ecb5b7">SigPerSPAD</a>;<span class="comment">/*!< ResultSignalPerSPAD */</span></div><div class="line"><a name="l00144"></a><span class="lineno"><a class="line" href="structVL53L1X__Result__t.html#a549c2710b0f17a249a84ecee103daf93"> 144</a></span>  <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> <a class="code" href="structVL53L1X__Result__t.html#a549c2710b0f17a249a84ecee103daf93">NumSPADs</a>; <span class="comment">/*!< ResultNumSPADs */</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> } <a class="code" href="structVL53L1X__Result__t.html">VL53L1X_Result_t</a>;</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"></span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment">/**</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * @brief This function returns the SW driver version</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> */</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a936f75dcf79520d291fca86d1ca1a8ef">VL53L1X_GetSWVersion</a>(<a class="code" href="structVL53L1X__Version__t.html">VL53L1X_Version_t</a> *pVersion);</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"></span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment">/**</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> * @brief This function sets the sensor I2C address used in case multiple devices application, default address 0x52</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> */</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#aa51394a17fcffda8918a9e14cce9ad9e">VL53L1X_SetI2CAddress</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a>, <a class="code" href="vl53l1__types_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> new_address);</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"></span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment">/**</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> * @brief This function loads the 135 bytes default values to initialize the sensor.</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> * @param dev Device address</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> * @return 0:success, != 0:failed</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> */</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#af0bf25a9ea2d412a2314be795411bbfb">VL53L1X_SensorInit</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev);</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"></span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment">/**</span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> * @brief This function clears the interrupt, to be called after a ranging data reading</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> * to arm the interrupt for the next data ready event.</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> */</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#ab4bae81bb4a10d4bba7ff1849d10cf5c">VL53L1X_ClearInterrupt</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev);</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"></span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment">/**</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> * @brief This function programs the interrupt polarity\n</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> * 1=active high (default), 0=active low</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> */</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#ae20f224bdf2a9e5cab862084b0fe0005">VL53L1X_SetInterruptPolarity</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> IntPol);</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"></span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment">/**</span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> * @brief This function returns the current interrupt polarity\n</span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> * 1=active high (default), 0=active low</span></div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> */</span></div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#abb5bbbc8841002c408d89e54f79b8f50">VL53L1X_GetInterruptPolarity</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *pIntPol);</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"></span></div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment">/**</span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> * @brief This function starts the ranging distance operation\n</span></div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> * The ranging operation is continuous. The clear interrupt has to be done after each get data to allow the interrupt to raise when the next data is ready\n</span></div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> * 1=active high (default), 0=active low, use SetInterruptPolarity() to change the interrupt polarity if required.</span></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> */</span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a59adb6ca7cf8cf1744dda9223e060d7a">VL53L1X_StartRanging</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev);</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"></span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment">/**</span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> * @brief This function stops the ranging.</span></div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> */</span></div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a39198465d18ebd1159a5378bf974ba85">VL53L1X_StopRanging</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev);</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"></span></div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment">/**</span></div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> * @brief This function checks if the new ranging data is available by polling the dedicated register.</span></div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> * @param : isDataReady==0 -> not ready; isDataReady==1 -> ready</span></div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> */</span></div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a51f7cace95b9d5d8e1bd093ddb19a7dd">VL53L1X_CheckForDataReady</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *isDataReady);</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"></span></div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment">/**</span></div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> * @brief This function programs the timing budget in ms.</span></div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> * Predefined values = 15, 20, 33, 50, 100(default), 200, 500.</span></div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> */</span></div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#ac64d76b7addc2d0f1144b3e903e90c35">VL53L1X_SetTimingBudgetInMs</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> TimingBudgetInMs);</div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"></span></div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment">/**</span></div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> * @brief This function returns the current timing budget in ms.</span></div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> */</span></div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#ad8b0bde5821b2db422c9c04741d420ba">VL53L1X_GetTimingBudgetInMs</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> *pTimingBudgetInMs);</div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"></span></div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment">/**</span></div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"> * @brief This function programs the distance mode (1=short, 2=long(default)).</span></div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"> * Short mode max distance is limited to 1.3 m but better ambient immunity.\n</span></div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> * Long mode can range up to 4 m in the dark with 200 ms timing budget.</span></div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> */</span></div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#acb5e44d02a44e0d878c306f32dd89bb2">VL53L1X_SetDistanceMode</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> DistanceMode);</div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"></span></div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment">/**</span></div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> * @brief This function returns the current distance mode (1=short, 2=long).</span></div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> */</span></div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a8785a4399732fe2b438e1ff83d431e05">VL53L1X_GetDistanceMode</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> *pDistanceMode);</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"></span></div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment">/**</span></div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> * @brief This function programs the Intermeasurement period in ms\n</span></div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"> * Intermeasurement period must be >/= timing budget. This condition is not checked by the API,</span></div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment"> * the customer has the duty to check the condition. Default = 100 ms</span></div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment"> */</span></div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#aafd7028e9b18f32dcc6f80477e3c9556">VL53L1X_SetInterMeasurementInMs</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev,</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  <a class="code" href="vl53l1__types_8h.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> InterMeasurementInMs);</div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment"></span></div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment">/**</span></div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"> * @brief This function returns the Intermeasurement period in ms.</span></div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"> */</span></div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a8ea2aeadbf3f07b4f147a201cdc5b14a">VL53L1X_GetInterMeasurementInMs</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> * pIM);</div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"></span></div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment">/**</span></div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment"> * @brief This function returns the boot state of the device (1:booted, 0:not booted)</span></div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment"> */</span></div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#ab92b2593ea9db5c1b39fcaaff474ee16">VL53L1X_BootState</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *state);</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"></span></div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment">/**</span></div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"> * @brief This function returns the sensor id, sensor Id must be 0xEEAC</span></div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment"> */</span></div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a2f85db4303998bd09d9732701559b7bb">VL53L1X_GetSensorId</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> *<span class="keywordtype">id</span>);</div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment"></span></div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment">/**</span></div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment"> * @brief This function returns the distance measured by the sensor in mm</span></div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="comment"> */</span></div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a06745c308363ee18e041ea8fa3c24eb5">VL53L1X_GetDistance</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> *distance);</div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="comment"></span></div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="comment">/**</span></div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="comment"> * @brief This function returns the returned signal per SPAD in kcps/SPAD.</span></div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment"> * With kcps stands for Kilo Count Per Second</span></div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment"> */</span></div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a61d1ed3aa852150c583c2f24ed4f822b">VL53L1X_GetSignalPerSpad</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> *signalPerSp);</div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment"></span></div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment">/**</span></div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="comment"> * @brief This function returns the ambient per SPAD in kcps/SPAD</span></div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment"> */</span></div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a04aa56326334ed04b8c74f76e39cdcb2">VL53L1X_GetAmbientPerSpad</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> *amb);</div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="comment"></span></div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="comment">/**</span></div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="comment"> * @brief This function returns the returned signal in kcps.</span></div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment"> */</span></div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#ae5dadde07f182a952a7c864037e5e345">VL53L1X_GetSignalRate</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> *signalRate);</div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="comment"></span></div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment">/**</span></div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment"> * @brief This function returns the current number of enabled SPADs</span></div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment"> */</span></div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a3a31d70330fb9cfc607eb53e9ccf0aba">VL53L1X_GetSpadNb</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> *spNb);</div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment"></span></div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment">/**</span></div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment"> * @brief This function returns the ambient rate in kcps</span></div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment"> */</span></div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#aeca17868ef2662357e6daf2c41fc5e27">VL53L1X_GetAmbientRate</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> *ambRate);</div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment"></span></div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="comment">/**</span></div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment"> * @brief This function returns the ranging status error \n</span></div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="comment"> * (0:no error, 1:sigma failed, 2:signal failed, ..., 7:wrap-around)</span></div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="comment"> */</span></div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a4841930f2a37b1d6fbb962f7511ba06c">VL53L1X_GetRangeStatus</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *rangeStatus);</div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="comment"></span></div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="comment">/**</span></div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="comment"> * @brief This function returns measurements and the range status in a single read access</span></div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="comment"> */</span></div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a527349738cae7da4384574cbbf1a3ecf">VL53L1X_GetResult</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="structVL53L1X__Result__t.html">VL53L1X_Result_t</a> *pResult);</div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment"></span></div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment">/**</span></div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment"> * @brief This function programs the offset correction in mm</span></div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment"> * @param OffsetValue:the offset correction value to program in mm</span></div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment"> */</span></div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a511e76c692a3f6d2a64fa30b674eaa6b">VL53L1X_SetOffset</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#aa343fa3b3d06292b959ffdd4c4703b06">int16_t</a> OffsetValue);</div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="comment"></span></div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="comment">/**</span></div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="comment"> * @brief This function returns the programmed offset correction value in mm</span></div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="comment"> */</span></div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a0f1c1da2494ddf9e68d909cc15b725b4">VL53L1X_GetOffset</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#aa343fa3b3d06292b959ffdd4c4703b06">int16_t</a> *Offset);</div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="comment"></span></div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="comment">/**</span></div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="comment"> * @brief This function programs the xtalk correction value in cps (Count Per Second).\n</span></div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="comment"> * This is the number of photons reflected back from the cover glass in cps.</span></div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="comment"> */</span></div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a8206a5ce1126b00d1d96dd6373ba6171">VL53L1X_SetXtalk</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> XtalkValue);</div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span> <span class="comment"></span></div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span> <span class="comment">/**</span></div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="comment"> * @brief This function returns the current programmed xtalk correction value in cps</span></div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="comment"> */</span></div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a2f9abff4c02b7c00c27980a9563b5983">VL53L1X_GetXtalk</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> *Xtalk);</div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment"></span></div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="comment">/**</span></div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="comment"> * @brief This function programs the threshold detection mode\n</span></div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="comment"> * Example:\n</span></div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="comment"> * VL53L1X_SetDistanceThreshold(dev,100,300,0,1): Below 100 \n</span></div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="comment"> * VL53L1X_SetDistanceThreshold(dev,100,300,1,1): Above 300 \n</span></div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="comment"> * VL53L1X_SetDistanceThreshold(dev,100,300,2,1): Out of window \n</span></div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="comment"> * VL53L1X_SetDistanceThreshold(dev,100,300,3,1): In window \n</span></div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="comment"> * @param dev : device address</span></div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment"> * @param ThreshLow(in mm) : the threshold under which one the device raises an interrupt if Window = 0</span></div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="comment"> * @param ThreshHigh(in mm) : the threshold above which one the device raises an interrupt if Window = 1</span></div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <span class="comment"> * @param Window detection mode : 0=below, 1=above, 2=out, 3=in</span></div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="comment"> * @param IntOnNoTarget = 1 (No longer used - just use 1)</span></div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <span class="comment"> */</span></div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a93effb186a00a1c05b82829d4e8a2e6e">VL53L1X_SetDistanceThreshold</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> ThreshLow,</div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span>  <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> ThreshHigh, <a class="code" href="vl53l1__types_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> Window,</div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span>  <a class="code" href="vl53l1__types_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> IntOnNoTarget);</div><div class="line"><a name="l00326"></a><span class="lineno"> 326</span> <span class="comment"></span></div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="comment">/**</span></div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment"> * @brief This function returns the window detection mode (0=below; 1=above; 2=out; 3=in)</span></div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment"> */</span></div><div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#ac10c1d2f6d7357ec86bcb0574c8885cd">VL53L1X_GetDistanceThresholdWindow</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> *window);</div><div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="comment"></span></div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="comment">/**</span></div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="comment"> * @brief This function returns the low threshold in mm</span></div><div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="comment"> */</span></div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a9cc838791d06a457f4ba318286d7192d">VL53L1X_GetDistanceThresholdLow</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> *low);</div><div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="comment"></span></div><div class="line"><a name="l00337"></a><span class="lineno"> 337</span> <span class="comment">/**</span></div><div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="comment"> * @brief This function returns the high threshold in mm</span></div><div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="comment"> */</span></div><div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#acc4c76b0f8ca23a0846a8acf5d18376d">VL53L1X_GetDistanceThresholdHigh</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> *high);</div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="comment"></span></div><div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="comment">/**</span></div><div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="comment"> * @brief This function programs the ROI (Region of Interest)\n</span></div><div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="comment"> * The ROI position is centered, only the ROI size can be reprogrammed.\n</span></div><div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="comment"> * The smallest acceptable ROI size = 4\n</span></div><div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="comment"> * @param X:ROI Width; Y=ROI Height</span></div><div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="comment"> */</span></div><div class="line"><a name="l00348"></a><span class="lineno"> 348</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#ab8103f06b26a3748336375e1c6381ab6">VL53L1X_SetROI</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> X, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> Y);</div><div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="comment"></span></div><div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="comment">/**</span></div><div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <span class="comment"> *@brief This function returns width X and height Y</span></div><div class="line"><a name="l00352"></a><span class="lineno"> 352</span> <span class="comment"> */</span></div><div class="line"><a name="l00353"></a><span class="lineno"> 353</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a5907eab052463c151a31e7223698f680">VL53L1X_GetROI_XY</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> *ROI_X, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> *ROI_Y);</div><div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="comment"></span></div><div class="line"><a name="l00355"></a><span class="lineno"> 355</span> <span class="comment">/**</span></div><div class="line"><a name="l00356"></a><span class="lineno"> 356</span> <span class="comment"> *@brief This function programs the new user ROI center, please to be aware that there is no check in this function.</span></div><div class="line"><a name="l00357"></a><span class="lineno"> 357</span> <span class="comment"> *if the ROI center vs ROI size is out of border the ranging function return error #13</span></div><div class="line"><a name="l00358"></a><span class="lineno"> 358</span> <span class="comment"> */</span></div><div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a17e282e05c4929f630590d556a412b81">VL53L1X_SetROICenter</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> ROICenter);</div><div class="line"><a name="l00360"></a><span class="lineno"> 360</span> <span class="comment"></span></div><div class="line"><a name="l00361"></a><span class="lineno"> 361</span> <span class="comment">/**</span></div><div class="line"><a name="l00362"></a><span class="lineno"> 362</span> <span class="comment"> *@brief This function returns the current user ROI center</span></div><div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="comment"> */</span></div><div class="line"><a name="l00364"></a><span class="lineno"> 364</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a910b60acd6238719079fcfedd49b513e">VL53L1X_GetROICenter</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *ROICenter);</div><div class="line"><a name="l00365"></a><span class="lineno"> 365</span> <span class="comment"></span></div><div class="line"><a name="l00366"></a><span class="lineno"> 366</span> <span class="comment">/**</span></div><div class="line"><a name="l00367"></a><span class="lineno"> 367</span> <span class="comment"> * @brief This function programs a new signal threshold in kcps (default=1024 kcps\n</span></div><div class="line"><a name="l00368"></a><span class="lineno"> 368</span> <span class="comment"> */</span></div><div class="line"><a name="l00369"></a><span class="lineno"> 369</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#af3d8367a6cdfd21d98685c3b6df2b8cf">VL53L1X_SetSignalThreshold</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> signal);</div><div class="line"><a name="l00370"></a><span class="lineno"> 370</span> <span class="comment"></span></div><div class="line"><a name="l00371"></a><span class="lineno"> 371</span> <span class="comment">/**</span></div><div class="line"><a name="l00372"></a><span class="lineno"> 372</span> <span class="comment"> * @brief This function returns the current signal threshold in kcps</span></div><div class="line"><a name="l00373"></a><span class="lineno"> 373</span> <span class="comment"> */</span></div><div class="line"><a name="l00374"></a><span class="lineno"> 374</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a70eee98d23fb77355574e3b14ff6c731">VL53L1X_GetSignalThreshold</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> *signal);</div><div class="line"><a name="l00375"></a><span class="lineno"> 375</span> <span class="comment"></span></div><div class="line"><a name="l00376"></a><span class="lineno"> 376</span> <span class="comment">/**</span></div><div class="line"><a name="l00377"></a><span class="lineno"> 377</span> <span class="comment"> * @brief This function programs a new sigma threshold in mm (default=15 mm)</span></div><div class="line"><a name="l00378"></a><span class="lineno"> 378</span> <span class="comment"> */</span></div><div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a3698367048ae3bb29b772b8969fd8043">VL53L1X_SetSigmaThreshold</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> sigma);</div><div class="line"><a name="l00380"></a><span class="lineno"> 380</span> <span class="comment"></span></div><div class="line"><a name="l00381"></a><span class="lineno"> 381</span> <span class="comment">/**</span></div><div class="line"><a name="l00382"></a><span class="lineno"> 382</span> <span class="comment"> * @brief This function returns the current sigma threshold in mm</span></div><div class="line"><a name="l00383"></a><span class="lineno"> 383</span> <span class="comment"> */</span></div><div class="line"><a name="l00384"></a><span class="lineno"> 384</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#a237827b94dec1ddb9f18ac78fee702b2">VL53L1X_GetSigmaThreshold</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev, <a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> *signal);</div><div class="line"><a name="l00385"></a><span class="lineno"> 385</span> <span class="comment"></span></div><div class="line"><a name="l00386"></a><span class="lineno"> 386</span> <span class="comment">/**</span></div><div class="line"><a name="l00387"></a><span class="lineno"> 387</span> <span class="comment"> * @brief This function performs the temperature calibration.</span></div><div class="line"><a name="l00388"></a><span class="lineno"> 388</span> <span class="comment"> * It is recommended to call this function any time the temperature might have changed by more than 8 deg C</span></div><div class="line"><a name="l00389"></a><span class="lineno"> 389</span> <span class="comment"> * without sensor ranging activity for an extended period.</span></div><div class="line"><a name="l00390"></a><span class="lineno"> 390</span> <span class="comment"> */</span></div><div class="line"><a name="l00391"></a><span class="lineno"> 391</span> <a class="code" href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a> <a class="code" href="VL53L1X__api_8h.html#ae51c4079082446707d3fdffb8da65e7b">VL53L1X_StartTemperatureUpdate</a>(<a class="code" href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> dev);</div><div class="line"><a name="l00392"></a><span class="lineno"> 392</span> </div><div class="line"><a name="l00393"></a><span class="lineno"> 393</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="VL53L1X__api_8h_html_a04aa56326334ed04b8c74f76e39cdcb2"><div class="ttname"><a href="VL53L1X__api_8h.html#a04aa56326334ed04b8c74f76e39cdcb2">VL53L1X_GetAmbientPerSpad</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_GetAmbientPerSpad(uint16_t dev, uint16_t *amb)</div><div class="ttdoc">This function returns the ambient per SPAD in kcps/SPAD. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00570">VL53L1X_api.c:570</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_aa2cba6efa144107fcf97e81be52802fc"><div class="ttname"><a href="VL53L1X__api_8h.html#aa2cba6efa144107fcf97e81be52802fc">VL53L1X_ERROR</a></div><div class="ttdeci">int8_t VL53L1X_ERROR</div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8h_source.html#l00078">VL53L1X_api.h:78</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_a936f75dcf79520d291fca86d1ca1a8ef"><div class="ttname"><a href="VL53L1X__api_8h.html#a936f75dcf79520d291fca86d1ca1a8ef">VL53L1X_GetSWVersion</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_GetSWVersion(VL53L1X_Version_t *pVersion)</div><div class="ttdoc">This function returns the SW driver version. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00206">VL53L1X_api.c:206</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_a61d1ed3aa852150c583c2f24ed4f822b"><div class="ttname"><a href="VL53L1X__api_8h.html#a61d1ed3aa852150c583c2f24ed4f822b">VL53L1X_GetSignalPerSpad</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_GetSignalPerSpad(uint16_t dev, uint16_t *signalPerSp)</div><div class="ttdoc">This function returns the returned signal per SPAD in kcps/SPAD. With kcps stands for Kilo Count Per ...</div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00557">VL53L1X_api.c:557</a></div></div>
<div class="ttc" id="vl53l1__platform_8h_html"><div class="ttname"><a href="vl53l1__platform_8h.html">vl53l1_platform.h</a></div><div class="ttdoc">Those platform functions are platform dependent and have to be implemented by the user...</div></div>
<div class="ttc" id="VL53L1X__api_8h_html_a0f1c1da2494ddf9e68d909cc15b725b4"><div class="ttname"><a href="VL53L1X__api_8h.html#a0f1c1da2494ddf9e68d909cc15b725b4">VL53L1X_GetOffset</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_GetOffset(uint16_t dev, int16_t *Offset)</div><div class="ttdoc">This function returns the programmed offset correction value in mm. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00658">VL53L1X_api.c:658</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_ae20f224bdf2a9e5cab862084b0fe0005"><div class="ttname"><a href="VL53L1X__api_8h.html#ae20f224bdf2a9e5cab862084b0fe0005">VL53L1X_SetInterruptPolarity</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_SetInterruptPolarity(uint16_t dev, uint8_t IntPol)</div><div class="ttdoc">This function programs the interrupt polarity 1=active high (default), 0=active low. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00253">VL53L1X_api.c:253</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_a51f7cace95b9d5d8e1bd093ddb19a7dd"><div class="ttname"><a href="VL53L1X__api_8h.html#a51f7cace95b9d5d8e1bd093ddb19a7dd">VL53L1X_CheckForDataReady</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_CheckForDataReady(uint16_t dev, uint8_t *isDataReady)</div><div class="ttdoc">This function checks if the new ranging data is available by polling the dedicated register...</div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00291">VL53L1X_api.c:291</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_a511e76c692a3f6d2a64fa30b674eaa6b"><div class="ttname"><a href="VL53L1X__api_8h.html#a511e76c692a3f6d2a64fa30b674eaa6b">VL53L1X_SetOffset</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_SetOffset(uint16_t dev, int16_t OffsetValue)</div><div class="ttdoc">This function programs the offset correction in mm. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00645">VL53L1X_api.c:645</a></div></div>
<div class="ttc" id="structVL53L1X__Result__t_html_a25f7a69860763da776f6e4e678f00d8d"><div class="ttname"><a href="structVL53L1X__Result__t.html#a25f7a69860763da776f6e4e678f00d8d">VL53L1X_Result_t::Ambient</a></div><div class="ttdeci">uint16_t Ambient</div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8h_source.html#l00142">VL53L1X_api.h:142</a></div></div>
<div class="ttc" id="vl53l1__types_8h_html_aef44329758059c91c76d334e8fc09700"><div class="ttname"><a href="vl53l1__types_8h.html#aef44329758059c91c76d334e8fc09700">int8_t</a></div><div class="ttdeci">signed char int8_t</div><div class="ttdoc">Typedef defining 8 bit char type. The developer should modify this to suit the platform being deploye...</div><div class="ttdef"><b>Definition:</b> <a href="vl53l1__types_8h_source.html#l00103">vl53l1_types.h:103</a></div></div>
<div class="ttc" id="structVL53L1X__Version__t_html_a863c15a6ed6b8fca8cbd5b17c36e5f61"><div class="ttname"><a href="structVL53L1X__Version__t.html#a863c15a6ed6b8fca8cbd5b17c36e5f61">VL53L1X_Version_t::revision</a></div><div class="ttdeci">uint32_t revision</div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8h_source.html#l00133">VL53L1X_api.h:133</a></div></div>
<div class="ttc" id="vl53l1__types_8h_html_aa343fa3b3d06292b959ffdd4c4703b06"><div class="ttname"><a href="vl53l1__types_8h.html#aa343fa3b3d06292b959ffdd4c4703b06">int16_t</a></div><div class="ttdeci">short int16_t</div><div class="ttdoc">Typedef defining 16 bit short type. The developer should modify this to suit the platform being deplo...</div><div class="ttdef"><b>Definition:</b> <a href="vl53l1__types_8h_source.html#l00093">vl53l1_types.h:93</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_ab8103f06b26a3748336375e1c6381ab6"><div class="ttname"><a href="VL53L1X__api_8h.html#ab8103f06b26a3748336375e1c6381ab6">VL53L1X_SetROI</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_SetROI(uint16_t dev, uint16_t X, uint16_t Y)</div><div class="ttdoc">This function programs the ROI (Region of Interest) The ROI position is centered, only the ROI size c...</div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00761">VL53L1X_api.c:761</a></div></div>
<div class="ttc" id="structVL53L1X__Version__t_html"><div class="ttname"><a href="structVL53L1X__Version__t.html">VL53L1X_Version_t</a></div><div class="ttdoc">defines SW Version </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8h_source.html#l00129">VL53L1X_api.h:129</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_a06745c308363ee18e041ea8fa3c24eb5"><div class="ttname"><a href="VL53L1X__api_8h.html#a06745c308363ee18e041ea8fa3c24eb5">VL53L1X_GetDistance</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_GetDistance(uint16_t dev, uint16_t *distance)</div><div class="ttdoc">This function returns the distance measured by the sensor in mm. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00546">VL53L1X_api.c:546</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_aafd7028e9b18f32dcc6f80477e3c9556"><div class="ttname"><a href="VL53L1X__api_8h.html#aafd7028e9b18f32dcc6f80477e3c9556">VL53L1X_SetInterMeasurementInMs</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_SetInterMeasurementInMs(uint16_t dev, uint32_t InterMeasurementInMs)</div><div class="ttdoc">This function programs the Intermeasurement period in ms Intermeasurement period must be >/= timing b...</div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00499">VL53L1X_api.c:499</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_a8206a5ce1126b00d1d96dd6373ba6171"><div class="ttname"><a href="VL53L1X__api_8h.html#a8206a5ce1126b00d1d96dd6373ba6171">VL53L1X_SetXtalk</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_SetXtalk(uint16_t dev, uint16_t XtalkValue)</div><div class="ttdoc">This function programs the xtalk correction value in cps (Count Per Second). This is the number of ph...</div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00670">VL53L1X_api.c:670</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_ae5dadde07f182a952a7c864037e5e345"><div class="ttname"><a href="VL53L1X__api_8h.html#ae5dadde07f182a952a7c864037e5e345">VL53L1X_GetSignalRate</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_GetSignalRate(uint16_t dev, uint16_t *signalRate)</div><div class="ttdoc">This function returns the returned signal in kcps. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00581">VL53L1X_api.c:581</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_a70eee98d23fb77355574e3b14ff6c731"><div class="ttname"><a href="VL53L1X__api_8h.html#a70eee98d23fb77355574e3b14ff6c731">VL53L1X_GetSignalThreshold</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_GetSignalThreshold(uint16_t dev, uint16_t *signal)</div><div class="ttdoc">This function returns the current signal threshold in kcps. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00799">VL53L1X_api.c:799</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_a5907eab052463c151a31e7223698f680"><div class="ttname"><a href="VL53L1X__api_8h.html#a5907eab052463c151a31e7223698f680">VL53L1X_GetROI_XY</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_GetROI_XY(uint16_t dev, uint16_t *ROI_X, uint16_t *ROI_Y)</div><div class="ttdoc">This function returns width X and height Y. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00780">VL53L1X_api.c:780</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_a17e282e05c4929f630590d556a412b81"><div class="ttname"><a href="VL53L1X__api_8h.html#a17e282e05c4929f630590d556a412b81">VL53L1X_SetROICenter</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_SetROICenter(uint16_t dev, uint8_t ROICenter)</div><div class="ttdoc">This function programs the new user ROI center, please to be aware that there is no check in this fun...</div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00745">VL53L1X_api.c:745</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_a8ea2aeadbf3f07b4f147a201cdc5b14a"><div class="ttname"><a href="VL53L1X__api_8h.html#a8ea2aeadbf3f07b4f147a201cdc5b14a">VL53L1X_GetInterMeasurementInMs</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_GetInterMeasurementInMs(uint16_t dev, uint16_t *pIM)</div><div class="ttdoc">This function returns the Intermeasurement period in ms. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00512">VL53L1X_api.c:512</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_a4841930f2a37b1d6fbb962f7511ba06c"><div class="ttname"><a href="VL53L1X__api_8h.html#a4841930f2a37b1d6fbb962f7511ba06c">VL53L1X_GetRangeStatus</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_GetRangeStatus(uint16_t dev, uint8_t *rangeStatus)</div><div class="ttdoc">This function returns the ranging status error (0:no error, 1:sigma failed, 2:signal failed...</div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00613">VL53L1X_api.c:613</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_af3d8367a6cdfd21d98685c3b6df2b8cf"><div class="ttname"><a href="VL53L1X__api_8h.html#af3d8367a6cdfd21d98685c3b6df2b8cf">VL53L1X_SetSignalThreshold</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_SetSignalThreshold(uint16_t dev, uint16_t signal)</div><div class="ttdoc">This function programs a new signal threshold in kcps (default=1024 kcps . </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00791">VL53L1X_api.c:791</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_a59adb6ca7cf8cf1744dda9223e060d7a"><div class="ttname"><a href="VL53L1X__api_8h.html#a59adb6ca7cf8cf1744dda9223e060d7a">VL53L1X_StartRanging</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_StartRanging(uint16_t dev)</div><div class="ttdoc">This function starts the ranging distance operation The ranging operation is continuous. The clear interrupt has to be done after each get data to allow the interrupt to raise when the next data is ready 1=active high (default), 0=active low, use SetInterruptPolarity() to change the interrupt polarity if required. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00275">VL53L1X_api.c:275</a></div></div>
<div class="ttc" id="structVL53L1X__Version__t_html_a03c80c16cb2de79265289251f14a1643"><div class="ttname"><a href="structVL53L1X__Version__t.html#a03c80c16cb2de79265289251f14a1643">VL53L1X_Version_t::build</a></div><div class="ttdeci">uint8_t build</div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8h_source.html#l00132">VL53L1X_api.h:132</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_a237827b94dec1ddb9f18ac78fee702b2"><div class="ttname"><a href="VL53L1X__api_8h.html#a237827b94dec1ddb9f18ac78fee702b2">VL53L1X_GetSigmaThreshold</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_GetSigmaThreshold(uint16_t dev, uint16_t *signal)</div><div class="ttdoc">This function returns the current sigma threshold in mm. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00822">VL53L1X_api.c:822</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_a3a31d70330fb9cfc607eb53e9ccf0aba"><div class="ttname"><a href="VL53L1X__api_8h.html#a3a31d70330fb9cfc607eb53e9ccf0aba">VL53L1X_GetSpadNb</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_GetSpadNb(uint16_t dev, uint16_t *spNb)</div><div class="ttdoc">This function returns the current number of enabled SPADs. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00592">VL53L1X_api.c:592</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_aa51394a17fcffda8918a9e14cce9ad9e"><div class="ttname"><a href="VL53L1X__api_8h.html#aa51394a17fcffda8918a9e14cce9ad9e">VL53L1X_SetI2CAddress</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_SetI2CAddress(uint16_t, uint8_t new_address)</div><div class="ttdoc">This function sets the sensor I2C address used in case multiple devices application, default address 0x52. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00217">VL53L1X_api.c:217</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_acb5e44d02a44e0d878c306f32dd89bb2"><div class="ttname"><a href="VL53L1X__api_8h.html#acb5e44d02a44e0d878c306f32dd89bb2">VL53L1X_SetDistanceMode</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_SetDistanceMode(uint16_t dev, uint16_t DistanceMode)</div><div class="ttdoc">This function programs the distance mode (1=short, 2=long(default)). Short mode max distance is limit...</div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00452">VL53L1X_api.c:452</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_a527349738cae7da4384574cbbf1a3ecf"><div class="ttname"><a href="VL53L1X__api_8h.html#a527349738cae7da4384574cbbf1a3ecf">VL53L1X_GetResult</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_GetResult(uint16_t dev, VL53L1X_Result_t *pResult)</div><div class="ttdoc">This function returns measurements and the range status in a single read access. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00626">VL53L1X_api.c:626</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_acc4c76b0f8ca23a0846a8acf5d18376d"><div class="ttname"><a href="VL53L1X__api_8h.html#acc4c76b0f8ca23a0846a8acf5d18376d">VL53L1X_GetDistanceThresholdHigh</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_GetDistanceThresholdHigh(uint16_t dev, uint16_t *high)</div><div class="ttdoc">This function returns the high threshold in mm. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00735">VL53L1X_api.c:735</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_a3698367048ae3bb29b772b8969fd8043"><div class="ttname"><a href="VL53L1X__api_8h.html#a3698367048ae3bb29b772b8969fd8043">VL53L1X_SetSigmaThreshold</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_SetSigmaThreshold(uint16_t dev, uint16_t sigma)</div><div class="ttdoc">This function programs a new sigma threshold in mm (default=15 mm) </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00810">VL53L1X_api.c:810</a></div></div>
<div class="ttc" id="structVL53L1X__Version__t_html_a6093fa9bbeaa6844ad571a842f4c0345"><div class="ttname"><a href="structVL53L1X__Version__t.html#a6093fa9bbeaa6844ad571a842f4c0345">VL53L1X_Version_t::minor</a></div><div class="ttdeci">uint8_t minor</div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8h_source.html#l00131">VL53L1X_api.h:131</a></div></div>
<div class="ttc" id="structVL53L1X__Result__t_html_a16cf31b3d24f20e85321bcfef7ecb5b7"><div class="ttname"><a href="structVL53L1X__Result__t.html#a16cf31b3d24f20e85321bcfef7ecb5b7">VL53L1X_Result_t::SigPerSPAD</a></div><div class="ttdeci">uint16_t SigPerSPAD</div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8h_source.html#l00143">VL53L1X_api.h:143</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_a910b60acd6238719079fcfedd49b513e"><div class="ttname"><a href="VL53L1X__api_8h.html#a910b60acd6238719079fcfedd49b513e">VL53L1X_GetROICenter</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_GetROICenter(uint16_t dev, uint8_t *ROICenter)</div><div class="ttdoc">This function returns the current user ROI center. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00752">VL53L1X_api.c:752</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_abb5bbbc8841002c408d89e54f79b8f50"><div class="ttname"><a href="VL53L1X__api_8h.html#abb5bbbc8841002c408d89e54f79b8f50">VL53L1X_GetInterruptPolarity</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_GetInterruptPolarity(uint16_t dev, uint8_t *pIntPol)</div><div class="ttdoc">This function returns the current interrupt polarity 1=active high (default), 0=active low...</div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00264">VL53L1X_api.c:264</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_ab4bae81bb4a10d4bba7ff1849d10cf5c"><div class="ttname"><a href="VL53L1X__api_8h.html#ab4bae81bb4a10d4bba7ff1849d10cf5c">VL53L1X_ClearInterrupt</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_ClearInterrupt(uint16_t dev)</div><div class="ttdoc">This function clears the interrupt, to be called after a ranging data reading to arm the interrupt fo...</div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00245">VL53L1X_api.c:245</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_aeca17868ef2662357e6daf2c41fc5e27"><div class="ttname"><a href="VL53L1X__api_8h.html#aeca17868ef2662357e6daf2c41fc5e27">VL53L1X_GetAmbientRate</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_GetAmbientRate(uint16_t dev, uint16_t *ambRate)</div><div class="ttdoc">This function returns the ambient rate in kcps. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00603">VL53L1X_api.c:603</a></div></div>
<div class="ttc" id="structVL53L1X__Result__t_html_a23ecdffefa85822a03fdad882408165d"><div class="ttname"><a href="structVL53L1X__Result__t.html#a23ecdffefa85822a03fdad882408165d">VL53L1X_Result_t::Distance</a></div><div class="ttdeci">uint16_t Distance</div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8h_source.html#l00141">VL53L1X_api.h:141</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_ae51c4079082446707d3fdffb8da65e7b"><div class="ttname"><a href="VL53L1X__api_8h.html#ae51c4079082446707d3fdffb8da65e7b">VL53L1X_StartTemperatureUpdate</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_StartTemperatureUpdate(uint16_t dev)</div><div class="ttdoc">This function performs the temperature calibration. It is recommended to call this function any time ...</div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00833">VL53L1X_api.c:833</a></div></div>
<div class="ttc" id="structVL53L1X__Result__t_html"><div class="ttname"><a href="structVL53L1X__Result__t.html">VL53L1X_Result_t</a></div><div class="ttdoc">defines packed reading results type </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8h_source.html#l00139">VL53L1X_api.h:139</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_a2f85db4303998bd09d9732701559b7bb"><div class="ttname"><a href="VL53L1X__api_8h.html#a2f85db4303998bd09d9732701559b7bb">VL53L1X_GetSensorId</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_GetSensorId(uint16_t dev, uint16_t *id)</div><div class="ttdoc">This function returns the sensor id, sensor Id must be 0xEEAC. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00536">VL53L1X_api.c:536</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_ad8b0bde5821b2db422c9c04741d420ba"><div class="ttname"><a href="VL53L1X__api_8h.html#ad8b0bde5821b2db422c9c04741d420ba">VL53L1X_GetTimingBudgetInMs</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_GetTimingBudgetInMs(uint16_t dev, uint16_t *pTimingBudgetInMs)</div><div class="ttdoc">This function returns the current timing budget in ms. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00411">VL53L1X_api.c:411</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_a2f9abff4c02b7c00c27980a9563b5983"><div class="ttname"><a href="VL53L1X__api_8h.html#a2f9abff4c02b7c00c27980a9563b5983">VL53L1X_GetXtalk</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_GetXtalk(uint16_t dev, uint16_t *Xtalk)</div><div class="ttdoc">This function returns the current programmed xtalk correction value in cps. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00685">VL53L1X_api.c:685</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_a93effb186a00a1c05b82829d4e8a2e6e"><div class="ttname"><a href="VL53L1X__api_8h.html#a93effb186a00a1c05b82829d4e8a2e6e">VL53L1X_SetDistanceThreshold</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_SetDistanceThreshold(uint16_t dev, uint16_t ThreshLow, uint16_t ThreshHigh, uint8_t Window, uint8_t IntOnNoTarget)</div><div class="ttdoc">This function programs the threshold detection mode Example: VL53L1X_SetDistanceThreshold(dev,100,300,0,1): Below 100 VL53L1X_SetDistanceThreshold(dev,100,300,1,1): Above 300 VL53L1X_SetDistanceThreshold(dev,100,300,2,1): Out of window VL53L1X_SetDistanceThreshold(dev,100,300,3,1): In window . </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00695">VL53L1X_api.c:695</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_a8785a4399732fe2b438e1ff83d431e05"><div class="ttname"><a href="VL53L1X__api_8h.html#a8785a4399732fe2b438e1ff83d431e05">VL53L1X_GetDistanceMode</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_GetDistanceMode(uint16_t dev, uint16_t *pDistanceMode)</div><div class="ttdoc">This function returns the current distance mode (1=short, 2=long). </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00487">VL53L1X_api.c:487</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_ab92b2593ea9db5c1b39fcaaff474ee16"><div class="ttname"><a href="VL53L1X__api_8h.html#ab92b2593ea9db5c1b39fcaaff474ee16">VL53L1X_BootState</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_BootState(uint16_t dev, uint8_t *state)</div><div class="ttdoc">This function returns the boot state of the device (1:booted, 0:not booted) </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00526">VL53L1X_api.c:526</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_af0bf25a9ea2d412a2314be795411bbfb"><div class="ttname"><a href="VL53L1X__api_8h.html#af0bf25a9ea2d412a2314be795411bbfb">VL53L1X_SensorInit</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_SensorInit(uint16_t dev)</div><div class="ttdoc">This function loads the 135 bytes default values to initialize the sensor. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00225">VL53L1X_api.c:225</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_ac64d76b7addc2d0f1144b3e903e90c35"><div class="ttname"><a href="VL53L1X__api_8h.html#ac64d76b7addc2d0f1144b3e903e90c35">VL53L1X_SetTimingBudgetInMs</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_SetTimingBudgetInMs(uint16_t dev, uint16_t TimingBudgetInMs)</div><div class="ttdoc">This function programs the timing budget in ms. Predefined values = 15, 20, 33, 50, 100(default), 200, 500. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00309">VL53L1X_api.c:309</a></div></div>
<div class="ttc" id="structVL53L1X__Version__t_html_a9c8962c09fa41401d393b28237062450"><div class="ttname"><a href="structVL53L1X__Version__t.html#a9c8962c09fa41401d393b28237062450">VL53L1X_Version_t::major</a></div><div class="ttdeci">uint8_t major</div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8h_source.html#l00130">VL53L1X_api.h:130</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_ac10c1d2f6d7357ec86bcb0574c8885cd"><div class="ttname"><a href="VL53L1X__api_8h.html#ac10c1d2f6d7357ec86bcb0574c8885cd">VL53L1X_GetDistanceThresholdWindow</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_GetDistanceThresholdWindow(uint16_t dev, uint16_t *window)</div><div class="ttdoc">This function returns the window detection mode (0=below; 1=above; 2=out; 3=in) </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00716">VL53L1X_api.c:716</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_a39198465d18ebd1159a5378bf974ba85"><div class="ttname"><a href="VL53L1X__api_8h.html#a39198465d18ebd1159a5378bf974ba85">VL53L1X_StopRanging</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_StopRanging(uint16_t dev)</div><div class="ttdoc">This function stops the ranging. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00283">VL53L1X_api.c:283</a></div></div>
<div class="ttc" id="vl53l1__types_8h_html_a273cf69d639a59973b6019625df33e30"><div class="ttname"><a href="vl53l1__types_8h.html#a273cf69d639a59973b6019625df33e30">uint16_t</a></div><div class="ttdeci">unsigned short uint16_t</div><div class="ttdoc">Typedef defining 16 bit unsigned short type. The developer should modify this to suit the platform be...</div><div class="ttdef"><b>Definition:</b> <a href="vl53l1__types_8h_source.html#l00088">vl53l1_types.h:88</a></div></div>
<div class="ttc" id="VL53L1X__api_8h_html_a9cc838791d06a457f4ba318286d7192d"><div class="ttname"><a href="VL53L1X__api_8h.html#a9cc838791d06a457f4ba318286d7192d">VL53L1X_GetDistanceThresholdLow</a></div><div class="ttdeci">VL53L1X_ERROR VL53L1X_GetDistanceThresholdLow(uint16_t dev, uint16_t *low)</div><div class="ttdoc">This function returns the low threshold in mm. </div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8c_source.html#l00725">VL53L1X_api.c:725</a></div></div>
<div class="ttc" id="vl53l1__types_8h_html_aba7bc1797add20fe3efdf37ced1182c5"><div class="ttname"><a href="vl53l1__types_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a></div><div class="ttdeci">unsigned char uint8_t</div><div class="ttdoc">Typedef defining 8 bit unsigned char type. The developer should modify this to suit the platform bein...</div><div class="ttdef"><b>Definition:</b> <a href="vl53l1__types_8h_source.html#l00098">vl53l1_types.h:98</a></div></div>
<div class="ttc" id="structVL53L1X__Result__t_html_ab728a6f4521ca376d9dbe0710158b2b5"><div class="ttname"><a href="structVL53L1X__Result__t.html#ab728a6f4521ca376d9dbe0710158b2b5">VL53L1X_Result_t::Status</a></div><div class="ttdeci">uint8_t Status</div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8h_source.html#l00140">VL53L1X_api.h:140</a></div></div>
<div class="ttc" id="vl53l1__types_8h_html_a435d1572bf3f880d55459d9805097f62"><div class="ttname"><a href="vl53l1__types_8h.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a></div><div class="ttdeci">unsigned int uint32_t</div><div class="ttdoc">Typedef defining 32 bit unsigned int type. The developer should modify this to suit the platform bein...</div><div class="ttdef"><b>Definition:</b> <a href="vl53l1__types_8h_source.html#l00078">vl53l1_types.h:78</a></div></div>
<div class="ttc" id="structVL53L1X__Result__t_html_a549c2710b0f17a249a84ecee103daf93"><div class="ttname"><a href="structVL53L1X__Result__t.html#a549c2710b0f17a249a84ecee103daf93">VL53L1X_Result_t::NumSPADs</a></div><div class="ttdeci">uint16_t NumSPADs</div><div class="ttdef"><b>Definition:</b> <a href="VL53L1X__api_8h_source.html#l00144">VL53L1X_api.h:144</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d9edf6c004b4a7ff14fe9ae7a92214ee.html">firmware</a></li><li class="navelem"><a class="el" href="dir_9a5a365c58dea0dc152d55f461feaba5.html">EFM32HG222F64_iot-mbbr</a></li><li class="navelem"><a class="el" href="dir_0060e6410b4221bd784218667f19287e.html">VL53L1X_API</a></li><li class="navelem"><a class="el" href="VL53L1X__api_8h.html">VL53L1X_api.h</a></li>
<li class="footer">Generated on Thu Sep 3 2020 04:44:25 for IoT-MBBR (masterthesis) by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>
48241ad08This file is pinned to the selected release. Download the original to open it in your design tool.