doc: rebuild

esp-cpp · Feb 13, 2024 · e587624 · e587624
1 parent ff46ee8
commit e587624
Show file tree

Hide file tree

Showing 91 changed files with 784 additions and 351 deletions.
diff --git a/docs/adc/adc_types.html b/docs/adc/adc_types.html
@@ -148,7 +148,7 @@
           <li><a href="index.html">ADC APIs</a> &raquo;</li>
       <li>ADC Types</li>
       <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/esp-cpp/espp/blob/37f664e/docs/en/adc/adc_types.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/esp-cpp/espp/blob/ff46ee8/docs/en/adc/adc_types.rst" class="fa fa-github"> Edit on GitHub</a>
       </li>
   </ul>
   <hr/>
@@ -165,7 +165,7 @@ <h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
 <section id="header-file">
 <h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this headline"></a></h3>
 <ul class="simple">
-<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/e14a4b5/components/adc/include/adc_types.hpp">components/adc/include/adc_types.hpp</a></p></li>
+<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/ff46ee8/components/adc/include/adc_types.hpp">components/adc/include/adc_types.hpp</a></p></li>
 </ul>
 </section>
 </section>

diff --git a/docs/adc/ads1x15.html b/docs/adc/ads1x15.html
@@ -149,7 +149,7 @@
           <li><a href="index.html">ADC APIs</a> &raquo;</li>
       <li>ADS1x15 I2C ADC</li>
       <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/esp-cpp/espp/blob/37f664e/docs/en/adc/ads1x15.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/esp-cpp/espp/blob/ff46ee8/docs/en/adc/ads1x15.rst" class="fa fa-github"> Edit on GitHub</a>
       </li>
   </ul>
   <hr/>
@@ -166,14 +166,14 @@ <h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
 <section id="header-file">
 <h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this headline"></a></h3>
 <ul class="simple">
-<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/37f664e/components/ads1x15/include/ads1x15.hpp">components/ads1x15/include/ads1x15.hpp</a></p></li>
+<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/ff46ee8/components/ads1x15/include/ads1x15.hpp">components/ads1x15/include/ads1x15.hpp</a></p></li>
 </ul>
 </section>
 <section id="classes">
 <h3>Classes<a class="headerlink" href="#classes" title="Permalink to this headline"></a></h3>
 <dl class="cpp class">
 <dt class="sig sig-object cpp" id="_CPPv4N4espp7Ads1x15E">
-<span id="_CPPv3N4espp7Ads1x15E"></span><span id="_CPPv2N4espp7Ads1x15E"></span><span id="espp::Ads1x15"></span><span class="target" id="classespp_1_1_ads1x15"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">espp</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">Ads1x15</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">espp</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">BasePeripheral</span></span><span class="p"><span class="pre">&lt;</span></span><span class="p"><span class="pre">&gt;</span></span><a class="headerlink" href="#_CPPv4N4espp7Ads1x15E" title="Permalink to this definition"></a><br /></dt>
+<span id="_CPPv3N4espp7Ads1x15E"></span><span id="_CPPv2N4espp7Ads1x15E"></span><span id="espp::Ads1x15"></span><span class="target" id="classespp_1_1_ads1x15"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">espp</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">Ads1x15</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">espp</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="../base_peripheral.html#_CPPv4I_NSt8integralEEN4espp14BasePeripheralE" title="espp::BasePeripheral"><span class="n"><span class="pre">BasePeripheral</span></span></a><span class="p"><span class="pre">&lt;</span></span><span class="p"><span class="pre">&gt;</span></span><a class="headerlink" href="#_CPPv4N4espp7Ads1x15E" title="Permalink to this definition"></a><br /></dt>
 <dd><p>Class for reading values from the ADS1x15 family of ADC chips. </p>
 <section id="classespp_1_1_ads1x15_1ads1x15_ex1">
 <h4>ADS1X15 Example<a class="headerlink" href="#classespp_1_1_ads1x15_1ads1x15_ex1" title="Permalink to this headline"></a></h4>
@@ -653,6 +653,29 @@ <h4>ADS1X15 Example<a class="headerlink" href="#classespp_1_1_ads1x15_1ads1x15_e
 </dl>
 </dd></dl>
 
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4N4espp7Ads1x1534set_separate_write_then_read_delayENSt6chrono12millisecondsE">
+<span id="_CPPv3N4espp7Ads1x1534set_separate_write_then_read_delayENSt6chrono12millisecondsE"></span><span id="_CPPv2N4espp7Ads1x1534set_separate_write_then_read_delayENSt6chrono12millisecondsE"></span><span id="espp::Ads1x15::set_separate_write_then_read_delay__std::chrono::milliseconds"></span><span class="target" id="classespp_1_1_base_peripheral_1a1a04f84a0cba679ba0b7ab0a2aabf611"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">set_separate_write_then_read_delay</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">chrono</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">milliseconds</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">delay</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N4espp7Ads1x1534set_separate_write_then_read_delayENSt6chrono12millisecondsE" title="Permalink to this definition"></a><br /></dt>
+<dd><p>Set the delay between the write and read operations in write_then_read </p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>This function is thread safe </p>
+</div>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>This should rarely be used, as the delay is usually set in the constructor. If you need to change the delay, consider using the set_config function instead. </p>
+</div>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>This delay is only used if the write_then_read function is not set to a custom function and the write and read functions are separate functions. </p>
+</div>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><p><strong>delay</strong> – The delay between the write and read operations in write_then_read </p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="cpp function">
 <dt class="sig sig-object cpp" id="_CPPv4N4espp7Ads1x1510set_configERK6Config">
 <span id="_CPPv3N4espp7Ads1x1510set_configERK6Config"></span><span id="_CPPv2N4espp7Ads1x1510set_configERK6Config"></span><span id="espp::Ads1x15::set_config__ConfigCR"></span><span class="target" id="classespp_1_1_base_peripheral_1a3df4d5f24494ee8d60699f9a7f6e6c51"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">set_config</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">Config</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">config</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N4espp7Ads1x1510set_configERK6Config" title="Permalink to this definition"></a><br /></dt>
@@ -791,13 +814,13 @@ <h4>ADS1X15 Example<a class="headerlink" href="#classespp_1_1_ads1x15_1ads1x15_e
 
 <dl class="cpp var">
 <dt class="sig sig-object cpp" id="_CPPv4N4espp7Ads1x1513Ads1015Config5writeE">
-<span id="_CPPv3N4espp7Ads1x1513Ads1015Config5writeE"></span><span id="_CPPv2N4espp7Ads1x1513Ads1015Config5writeE"></span><span id="espp::Ads1x15::Ads1015Config::write__BasePeripheral::write_fn"></span><span class="target" id="structespp_1_1_ads1x15_1_1_ads1015_config_1ab87696499c1b07e7335f0a78144d9278"></span><span class="n"><span class="pre">BasePeripheral</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">write_fn</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">write</span></span></span><a class="headerlink" href="#_CPPv4N4espp7Ads1x1513Ads1015Config5writeE" title="Permalink to this definition"></a><br /></dt>
+<span id="_CPPv3N4espp7Ads1x1513Ads1015Config5writeE"></span><span id="_CPPv2N4espp7Ads1x1513Ads1015Config5writeE"></span><span id="espp::Ads1x15::Ads1015Config::write__BasePeripheral::write_fn"></span><span class="target" id="structespp_1_1_ads1x15_1_1_ads1015_config_1ab87696499c1b07e7335f0a78144d9278"></span><a class="reference internal" href="../base_peripheral.html#_CPPv4I_NSt8integralEEN4espp14BasePeripheralE" title="espp::BasePeripheral"><span class="n"><span class="pre">BasePeripheral</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="../base_peripheral.html#_CPPv4N4espp14BasePeripheral8write_fnE" title="espp::BasePeripheral::write_fn"><span class="n"><span class="pre">write_fn</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">write</span></span></span><a class="headerlink" href="#_CPPv4N4espp7Ads1x1513Ads1015Config5writeE" title="Permalink to this definition"></a><br /></dt>
 <dd><p>Function to write to the ADC. </p>
 </dd></dl>
 
 <dl class="cpp var">
 <dt class="sig sig-object cpp" id="_CPPv4N4espp7Ads1x1513Ads1015Config4readE">
-<span id="_CPPv3N4espp7Ads1x1513Ads1015Config4readE"></span><span id="_CPPv2N4espp7Ads1x1513Ads1015Config4readE"></span><span id="espp::Ads1x15::Ads1015Config::read__BasePeripheral::read_fn"></span><span class="target" id="structespp_1_1_ads1x15_1_1_ads1015_config_1aa81d8487630c88d150a4d6dd8b5fdf0a"></span><span class="n"><span class="pre">BasePeripheral</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">read_fn</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">read</span></span></span><a class="headerlink" href="#_CPPv4N4espp7Ads1x1513Ads1015Config4readE" title="Permalink to this definition"></a><br /></dt>
+<span id="_CPPv3N4espp7Ads1x1513Ads1015Config4readE"></span><span id="_CPPv2N4espp7Ads1x1513Ads1015Config4readE"></span><span id="espp::Ads1x15::Ads1015Config::read__BasePeripheral::read_fn"></span><span class="target" id="structespp_1_1_ads1x15_1_1_ads1015_config_1aa81d8487630c88d150a4d6dd8b5fdf0a"></span><a class="reference internal" href="../base_peripheral.html#_CPPv4I_NSt8integralEEN4espp14BasePeripheralE" title="espp::BasePeripheral"><span class="n"><span class="pre">BasePeripheral</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="../base_peripheral.html#_CPPv4N4espp14BasePeripheral7read_fnE" title="espp::BasePeripheral::read_fn"><span class="n"><span class="pre">read_fn</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">read</span></span></span><a class="headerlink" href="#_CPPv4N4espp7Ads1x1513Ads1015Config4readE" title="Permalink to this definition"></a><br /></dt>
 <dd><p>Function to read from the ADC. </p>
 </dd></dl>
 
@@ -836,13 +859,13 @@ <h4>ADS1X15 Example<a class="headerlink" href="#classespp_1_1_ads1x15_1ads1x15_e
 
 <dl class="cpp var">
 <dt class="sig sig-object cpp" id="_CPPv4N4espp7Ads1x1513Ads1115Config5writeE">
-<span id="_CPPv3N4espp7Ads1x1513Ads1115Config5writeE"></span><span id="_CPPv2N4espp7Ads1x1513Ads1115Config5writeE"></span><span id="espp::Ads1x15::Ads1115Config::write__BasePeripheral::write_fn"></span><span class="target" id="structespp_1_1_ads1x15_1_1_ads1115_config_1a5d99371c84c8fffe580f5da02e881c02"></span><span class="n"><span class="pre">BasePeripheral</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">write_fn</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">write</span></span></span><a class="headerlink" href="#_CPPv4N4espp7Ads1x1513Ads1115Config5writeE" title="Permalink to this definition"></a><br /></dt>
+<span id="_CPPv3N4espp7Ads1x1513Ads1115Config5writeE"></span><span id="_CPPv2N4espp7Ads1x1513Ads1115Config5writeE"></span><span id="espp::Ads1x15::Ads1115Config::write__BasePeripheral::write_fn"></span><span class="target" id="structespp_1_1_ads1x15_1_1_ads1115_config_1a5d99371c84c8fffe580f5da02e881c02"></span><a class="reference internal" href="../base_peripheral.html#_CPPv4I_NSt8integralEEN4espp14BasePeripheralE" title="espp::BasePeripheral"><span class="n"><span class="pre">BasePeripheral</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="../base_peripheral.html#_CPPv4N4espp14BasePeripheral8write_fnE" title="espp::BasePeripheral::write_fn"><span class="n"><span class="pre">write_fn</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">write</span></span></span><a class="headerlink" href="#_CPPv4N4espp7Ads1x1513Ads1115Config5writeE" title="Permalink to this definition"></a><br /></dt>
 <dd><p>Function to write to the ADC. </p>
 </dd></dl>
 
 <dl class="cpp var">
 <dt class="sig sig-object cpp" id="_CPPv4N4espp7Ads1x1513Ads1115Config4readE">
-<span id="_CPPv3N4espp7Ads1x1513Ads1115Config4readE"></span><span id="_CPPv2N4espp7Ads1x1513Ads1115Config4readE"></span><span id="espp::Ads1x15::Ads1115Config::read__BasePeripheral::read_fn"></span><span class="target" id="structespp_1_1_ads1x15_1_1_ads1115_config_1ae5708f934a46736f3f0faf7460c44af8"></span><span class="n"><span class="pre">BasePeripheral</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">read_fn</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">read</span></span></span><a class="headerlink" href="#_CPPv4N4espp7Ads1x1513Ads1115Config4readE" title="Permalink to this definition"></a><br /></dt>
+<span id="_CPPv3N4espp7Ads1x1513Ads1115Config4readE"></span><span id="_CPPv2N4espp7Ads1x1513Ads1115Config4readE"></span><span id="espp::Ads1x15::Ads1115Config::read__BasePeripheral::read_fn"></span><span class="target" id="structespp_1_1_ads1x15_1_1_ads1115_config_1ae5708f934a46736f3f0faf7460c44af8"></span><a class="reference internal" href="../base_peripheral.html#_CPPv4I_NSt8integralEEN4espp14BasePeripheralE" title="espp::BasePeripheral"><span class="n"><span class="pre">BasePeripheral</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="../base_peripheral.html#_CPPv4N4espp14BasePeripheral7read_fnE" title="espp::BasePeripheral::read_fn"><span class="n"><span class="pre">read_fn</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">read</span></span></span><a class="headerlink" href="#_CPPv4N4espp7Ads1x1513Ads1115Config4readE" title="Permalink to this definition"></a><br /></dt>
 <dd><p>Function to read from the ADC. </p>
 </dd></dl>