Skip to content

Commit a497a95

Browse files
finger563finger563
committed
doc: rebuild
1 parent bbb6d3b commit a497a95

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

95 files changed

+2165
-228
lines changed

‎docs/_sources/battery/bldc_driver.rst.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
BLDC Driver
2+
***********
3+
4+
The `BldcDriver` component wraps around the `ESP MCPWM Peripheral
5+
<https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/peripherals/mcpwm.html>`_
6+
to provide full 6 PWM control over a 3 phase brushless dc motor.
7+
8+
.. ---------------------------- API Reference ----------------------------------
9+
10+
API Reference
11+
-------------
12+
13+
.. include-build-file:: inc/bldc_driver.inc

‎docs/_sources/battery/bldc_motor.rst.txt

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
BLDC Motor
2+
**********
3+
4+
The `BldcMotor` implements the Field-Oriented Control (FOC) algorithm with
5+
support for multiple transforms to drive voltage (such as Sinusoidal and Space
6+
Vector). It supports the following motion control configurations (which can be
7+
changed dynamically):
8+
9+
* Closed-loop angle
10+
* Closed-loop velocity
11+
* Open-loop angle
12+
* Open-loop velocity
13+
14+
Note: currently the code has some support for Torque control, but that requires
15+
current sense - for which I don't yet have the hardware to support the
16+
development of.
17+
18+
The `BldcMotor` should be configured with a `BldcDriver` and optional `Sensor`
19+
(for angle & speed of the motor), and optional `CurrentSensor` (for measuring
20+
the phase currents of the motor and providing torque control).
21+
22+
.. ---------------------------- API Reference ----------------------------------
23+
24+
API Reference
25+
-------------
26+
27+
.. include-build-file:: inc/bldc_motor.inc
28+
.. include-build-file:: inc/bldc_types.inc
29+
.. include-build-file:: inc/sensor_direction.inc

‎docs/_sources/battery/index.rst.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Battery APIs
2+
************
3+
4+
.. toctree::
5+
:maxdepth: 1
6+
7+
max1704x
8+
9+
These components provide a common interface to battery devices. They provide
10+
functions for monitoring the battery level and charging status, and for
11+
configuring the battery charging parameters.

‎docs/_sources/battery/max1704x.rst.txt

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
MAX1704X
2+
********
3+
4+
The MAX17048/MAX17049 ICs are tiny, micropower current fuel gauges for
5+
lithium-ion (Li+) batteries in handheld and portable equipment. The MAX17048
6+
operates with a single lithium cell and the MAX17049 with two lithium cells in
7+
series.
8+
9+
The ICs use the sophisticated Li+ battery-modeling algorithm ModelGauge™ to
10+
track the battery relative state-of-charge (SOC) continuously over widely varying
11+
charge and discharge conditions. The ModelGauge algorithm eliminates
12+
current-sense resistor and battery-learn cycles required in traditional fuel
13+
gauges. Temperature compensation is implemented using the system
14+
microcontroller.
15+
16+
The ICs automatically detect when the battery enters a low-current state and
17+
enters low-power 3µA hibernate mode, while still providing accurate fuel
18+
gauging. The ICs automatically exit hibernate mode when the system returns to
19+
active state.
20+
21+
On battery insertion, the ICs debounce initial voltage measurements to improve
22+
the initial SOC estimate, thus allowing them to be located on system side. SOC,
23+
voltage, and rate information is accessed using the I2C interface. The ICs are
24+
available in a tiny 0.9mm x 1.7mm, 8-bump wafer-level package (WLP), or a 2mm x
25+
2mm, 8-pin TDFN package.
26+
27+
.. ---------------------------- API Reference ----------------------------------
28+
29+
API Reference
30+
-------------
31+
32+
.. include-build-file:: inc/max1704x.inc

‎docs/_sources/index.rst.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ This is the documentation for esp-idf c++ components, ESPP (`espp <https://githu
1111
:maxdepth: 2
1212

1313
adc/index
14+
battery/index
1415
bldc/index
1516
button
1617
controller

‎docs/adc/adc_types.html

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
<script type="text/javascript" src="https://dl.espressif.com/dl/esp-idf/idf_versions.js"></script>
3939
<link rel="index" title="Index" href="../genindex.html" />
4040
<link rel="search" title="Search" href="../search.html" />
41-
<link rel="next" title="BLDC APIs" href="../bldc/index.html" />
41+
<link rel="next" title="Battery APIs" href="../battery/index.html" />
4242
<link rel="prev" title="TLA2528 I2C ADC" href="tla2528.html" />
4343
</head>
4444

@@ -90,6 +90,7 @@
9090
</li>
9191
</ul>
9292
</li>
93+
<li class="toctree-l1"><a class="reference internal" href="../battery/index.html">Battery APIs</a></li>
9394
<li class="toctree-l1"><a class="reference internal" href="../bldc/index.html">BLDC APIs</a></li>
9495
<li class="toctree-l1"><a class="reference internal" href="../button.html">Button APIs</a></li>
9596
<li class="toctree-l1"><a class="reference internal" href="../controller.html">Controller APIs</a></li>
@@ -145,7 +146,7 @@
145146
<li><a href="index.html">ADC APIs</a> &raquo;</li>
146147
<li>ADC Types</li>
147148
<li class="wy-breadcrumbs-aside">
148-
<a href="https://github.com/esp-cpp/espp/blob/1fada75/docs/en/adc/adc_types.rst" class="fa fa-github"> Edit on GitHub</a>
149+
<a href="https://github.com/esp-cpp/espp/blob/bbb6d3b/docs/en/adc/adc_types.rst" class="fa fa-github"> Edit on GitHub</a>
149150
</li>
150151
</ul>
151152
<hr/>
@@ -173,7 +174,7 @@ <h3>Header File<a class="headerlink" href="#header-file" title="Permalink to thi
173174
</div>
174175
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
175176
<a href="tla2528.html" class="btn btn-neutral float-left" title="TLA2528 I2C ADC" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
176-
<a href="../bldc/index.html" class="btn btn-neutral float-right" title="BLDC APIs" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
177+
<a href="../battery/index.html" class="btn btn-neutral float-right" title="Battery APIs" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
177178
</div>
178179

179180
<hr/>

‎docs/adc/ads1x15.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@
9191
<li class="toctree-l2"><a class="reference internal" href="adc_types.html">ADC Types</a></li>
9292
</ul>
9393
</li>
94+
<li class="toctree-l1"><a class="reference internal" href="../battery/index.html">Battery APIs</a></li>
9495
<li class="toctree-l1"><a class="reference internal" href="../bldc/index.html">BLDC APIs</a></li>
9596
<li class="toctree-l1"><a class="reference internal" href="../button.html">Button APIs</a></li>
9697
<li class="toctree-l1"><a class="reference internal" href="../controller.html">Controller APIs</a></li>
@@ -146,7 +147,7 @@
146147
<li><a href="index.html">ADC APIs</a> &raquo;</li>
147148
<li>ADS1x15 I2C ADC</li>
148149
<li class="wy-breadcrumbs-aside">
149-
<a href="https://github.com/esp-cpp/espp/blob/1fada75/docs/en/adc/ads1x15.rst" class="fa fa-github"> Edit on GitHub</a>
150+
<a href="https://github.com/esp-cpp/espp/blob/bbb6d3b/docs/en/adc/ads1x15.rst" class="fa fa-github"> Edit on GitHub</a>
150151
</li>
151152
</ul>
152153
<hr/>
@@ -163,7 +164,7 @@ <h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
163164
<section id="header-file">
164165
<h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this headline"></a></h3>
165166
<ul class="simple">
166-
<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/1fada75/components/ads1x15/include/ads1x15.hpp">components/ads1x15/include/ads1x15.hpp</a></p></li>
167+
<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/bbb6d3b/components/ads1x15/include/ads1x15.hpp">components/ads1x15/include/ads1x15.hpp</a></p></li>
167168
</ul>
168169
</section>
169170
<section id="classes">

‎docs/adc/ads7138.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@
9191
<li class="toctree-l2"><a class="reference internal" href="adc_types.html">ADC Types</a></li>
9292
</ul>
9393
</li>
94+
<li class="toctree-l1"><a class="reference internal" href="../battery/index.html">Battery APIs</a></li>
9495
<li class="toctree-l1"><a class="reference internal" href="../bldc/index.html">BLDC APIs</a></li>
9596
<li class="toctree-l1"><a class="reference internal" href="../button.html">Button APIs</a></li>
9697
<li class="toctree-l1"><a class="reference internal" href="../controller.html">Controller APIs</a></li>
@@ -146,7 +147,7 @@
146147
<li><a href="index.html">ADC APIs</a> &raquo;</li>
147148
<li>ADS7138 I2C ADC</li>
148149
<li class="wy-breadcrumbs-aside">
149-
<a href="https://github.com/esp-cpp/espp/blob/1fada75/docs/en/adc/ads7138.rst" class="fa fa-github"> Edit on GitHub</a>
150+
<a href="https://github.com/esp-cpp/espp/blob/bbb6d3b/docs/en/adc/ads7138.rst" class="fa fa-github"> Edit on GitHub</a>
150151
</li>
151152
</ul>
152153
<hr/>
@@ -168,7 +169,7 @@ <h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
168169
<section id="header-file">
169170
<h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this headline"></a></h3>
170171
<ul class="simple">
171-
<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/1fada75/components/ads7138/include/ads7138.hpp">components/ads7138/include/ads7138.hpp</a></p></li>
172+
<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/bbb6d3b/components/ads7138/include/ads7138.hpp">components/ads7138/include/ads7138.hpp</a></p></li>
172173
</ul>
173174
</section>
174175
<section id="classes">

‎docs/adc/continuous_adc.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@
9191
<li class="toctree-l2"><a class="reference internal" href="adc_types.html">ADC Types</a></li>
9292
</ul>
9393
</li>
94+
<li class="toctree-l1"><a class="reference internal" href="../battery/index.html">Battery APIs</a></li>
9495
<li class="toctree-l1"><a class="reference internal" href="../bldc/index.html">BLDC APIs</a></li>
9596
<li class="toctree-l1"><a class="reference internal" href="../button.html">Button APIs</a></li>
9697
<li class="toctree-l1"><a class="reference internal" href="../controller.html">Controller APIs</a></li>
@@ -146,7 +147,7 @@
146147
<li><a href="index.html">ADC APIs</a> &raquo;</li>
147148
<li>Continuous ADC</li>
148149
<li class="wy-breadcrumbs-aside">
149-
<a href="https://github.com/esp-cpp/espp/blob/1fada75/docs/en/adc/continuous_adc.rst" class="fa fa-github"> Edit on GitHub</a>
150+
<a href="https://github.com/esp-cpp/espp/blob/bbb6d3b/docs/en/adc/continuous_adc.rst" class="fa fa-github"> Edit on GitHub</a>
150151
</li>
151152
</ul>
152153
<hr/>
@@ -168,7 +169,7 @@ <h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
168169
<section id="header-file">
169170
<h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this headline"></a></h3>
170171
<ul class="simple">
171-
<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/1fada75/components/adc/include/continuous_adc.hpp">components/adc/include/continuous_adc.hpp</a></p></li>
172+
<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/bbb6d3b/components/adc/include/continuous_adc.hpp">components/adc/include/continuous_adc.hpp</a></p></li>
172173
</ul>
173174
</section>
174175
<section id="classes">

‎docs/adc/index.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@
8484
<li class="toctree-l2"><a class="reference internal" href="adc_types.html">ADC Types</a></li>
8585
</ul>
8686
</li>
87+
<li class="toctree-l1"><a class="reference internal" href="../battery/index.html">Battery APIs</a></li>
8788
<li class="toctree-l1"><a class="reference internal" href="../bldc/index.html">BLDC APIs</a></li>
8889
<li class="toctree-l1"><a class="reference internal" href="../button.html">Button APIs</a></li>
8990
<li class="toctree-l1"><a class="reference internal" href="../controller.html">Controller APIs</a></li>
@@ -138,7 +139,7 @@
138139
<li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
139140
<li>ADC APIs</li>
140141
<li class="wy-breadcrumbs-aside">
141-
<a href="https://github.com/esp-cpp/espp/blob/1fada75/docs/en/adc/index.rst" class="fa fa-github"> Edit on GitHub</a>
142+
<a href="https://github.com/esp-cpp/espp/blob/bbb6d3b/docs/en/adc/index.rst" class="fa fa-github"> Edit on GitHub</a>
142143
</li>
143144
</ul>
144145
<hr/>

‎docs/adc/oneshot_adc.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@
9191
<li class="toctree-l2"><a class="reference internal" href="adc_types.html">ADC Types</a></li>
9292
</ul>
9393
</li>
94+
<li class="toctree-l1"><a class="reference internal" href="../battery/index.html">Battery APIs</a></li>
9495
<li class="toctree-l1"><a class="reference internal" href="../bldc/index.html">BLDC APIs</a></li>
9596
<li class="toctree-l1"><a class="reference internal" href="../button.html">Button APIs</a></li>
9697
<li class="toctree-l1"><a class="reference internal" href="../controller.html">Controller APIs</a></li>
@@ -146,7 +147,7 @@
146147
<li><a href="index.html">ADC APIs</a> &raquo;</li>
147148
<li>Oneshot ADC</li>
148149
<li class="wy-breadcrumbs-aside">
149-
<a href="https://github.com/esp-cpp/espp/blob/1fada75/docs/en/adc/oneshot_adc.rst" class="fa fa-github"> Edit on GitHub</a>
150+
<a href="https://github.com/esp-cpp/espp/blob/bbb6d3b/docs/en/adc/oneshot_adc.rst" class="fa fa-github"> Edit on GitHub</a>
150151
</li>
151152
</ul>
152153
<hr/>
@@ -167,7 +168,7 @@ <h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
167168
<section id="header-file">
168169
<h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this headline"></a></h3>
169170
<ul class="simple">
170-
<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/1fada75/components/adc/include/oneshot_adc.hpp">components/adc/include/oneshot_adc.hpp</a></p></li>
171+
<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/bbb6d3b/components/adc/include/oneshot_adc.hpp">components/adc/include/oneshot_adc.hpp</a></p></li>
171172
</ul>
172173
</section>
173174
<section id="classes">

‎docs/adc/tla2528.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@
9191
<li class="toctree-l2"><a class="reference internal" href="adc_types.html">ADC Types</a></li>
9292
</ul>
9393
</li>
94+
<li class="toctree-l1"><a class="reference internal" href="../battery/index.html">Battery APIs</a></li>
9495
<li class="toctree-l1"><a class="reference internal" href="../bldc/index.html">BLDC APIs</a></li>
9596
<li class="toctree-l1"><a class="reference internal" href="../button.html">Button APIs</a></li>
9697
<li class="toctree-l1"><a class="reference internal" href="../controller.html">Controller APIs</a></li>
@@ -146,7 +147,7 @@
146147
<li><a href="index.html">ADC APIs</a> &raquo;</li>
147148
<li>TLA2528 I2C ADC</li>
148149
<li class="wy-breadcrumbs-aside">
149-
<a href="https://github.com/esp-cpp/espp/blob/1fada75/docs/en/adc/tla2528.rst" class="fa fa-github"> Edit on GitHub</a>
150+
<a href="https://github.com/esp-cpp/espp/blob/bbb6d3b/docs/en/adc/tla2528.rst" class="fa fa-github"> Edit on GitHub</a>
150151
</li>
151152
</ul>
152153
<hr/>
@@ -168,7 +169,7 @@ <h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
168169
<section id="header-file">
169170
<h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this headline"></a></h3>
170171
<ul class="simple">
171-
<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/1fada75/components/tla2528/include/tla2528.hpp">components/tla2528/include/tla2528.hpp</a></p></li>
172+
<li><p><a class="reference external" href="https://github.com/esp-cpp/espp/blob/bbb6d3b/components/tla2528/include/tla2528.hpp">components/tla2528/include/tla2528.hpp</a></p></li>
172173
</ul>
173174
</section>
174175
<section id="classes">

0 commit comments

Comments
 (0)