Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@Neutree
Neutree committed Apr 19, 2024
1 parent 8197605 commit 6765328
Show file tree
Hide file tree
Showing 88 changed files with 5,751 additions and 1,701 deletions.
2,129 changes: 1,498 additions & 631 deletions maixpy/api/api.json
View file

Large diffs are not rendered by default.

15 changes: 15 additions & 0 deletions maixpy/api/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ <h2>MaixPy</h2>
<li class="not_active with_link"><a href="/maixpy/api/maix/protocol.html"><span class="label">protocol</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/maixpy/api/maix/example.html"><span class="label">example</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/maixpy/api/maix/app.html"><span class="label">app</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/maixpy/api/maix/util.html"><span class="label">util</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/maixpy/api/maix/nn.html"><span class="label">nn</span><span class="sub_indicator"></span></a><ul class="show">
<li class="not_active with_link"><a href="/maixpy/api/maix/nn/F.html"><span class="label">F</span><span class=""></span></a></li>
</ul>
Expand All @@ -129,6 +130,8 @@ <h2>MaixPy</h2>
<li class="not_active with_link"><a href="/maixpy/api/maix/peripheral/adc.html"><span class="label">adc</span><span class=""></span></a></li>
</ul>
</li>
<li class="not_active with_link"><a href="/maixpy/api/maix/rtsp.html"><span class="label">rtsp</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/maixpy/api/maix/video.html"><span class="label">video</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/maixpy/api/maix/touchscreen.html"><span class="label">touchscreen</span><span class=""></span></a></li>
</ul>
</li>
Expand Down Expand Up @@ -251,6 +254,10 @@ <h1>MaixPy API -- Maix AI machine vision platform Python API</h1>
<td><a href="./maix/app.html" >maix.app</a></td>
<td>maix.app module</td>
</tr>
<tr>
<td><a href="./maix/util.html" >maix.util</a></td>
<td>maix.util module</td>
</tr>
<tr>
<td><a href="./maix/nn.html" >maix.nn</a></td>
<td>maix.nn module</td>
Expand All @@ -259,6 +266,14 @@ <h1>MaixPy API -- Maix AI machine vision platform Python API</h1>
<td><a href="./maix/peripheral.html" >maix.peripheral</a></td>
<td>Chip's peripheral driver</td>
</tr>
<tr>
<td><a href="./maix/rtsp.html" >maix.rtsp</a></td>
<td>maix.rtsp module</td>
</tr>
<tr>
<td><a href="./maix/video.html" >maix.video</a></td>
<td>maix.video module</td>
</tr>
<tr>
<td><a href="./maix/touchscreen.html" >maix.touchscreen</a></td>
<td>maix.touchscreen module</td>
Expand Down
7 changes: 5 additions & 2 deletions maixpy/api/maix/app.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ <h2>MaixPy</h2>
<li class="not_active with_link"><a href="/maixpy/api/maix/protocol.html"><span class="label">protocol</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/maixpy/api/maix/example.html"><span class="label">example</span><span class=""></span></a></li>
<li class="active with_link"><a href="/maixpy/api/maix/app.html"><span class="label">app</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/maixpy/api/maix/util.html"><span class="label">util</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/maixpy/api/maix/nn.html"><span class="label">nn</span><span class="sub_indicator"></span></a><ul class="show">
<li class="not_active with_link"><a href="/maixpy/api/maix/nn/F.html"><span class="label">F</span><span class=""></span></a></li>
</ul>
Expand All @@ -129,6 +130,8 @@ <h2>MaixPy</h2>
<li class="not_active with_link"><a href="/maixpy/api/maix/peripheral/adc.html"><span class="label">adc</span><span class=""></span></a></li>
</ul>
</li>
<li class="not_active with_link"><a href="/maixpy/api/maix/rtsp.html"><span class="label">rtsp</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/maixpy/api/maix/video.html"><span class="label">video</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/maixpy/api/maix/touchscreen.html"><span class="label">touchscreen</span><span class=""></span></a></li>
</ul>
</li>
Expand Down Expand Up @@ -1143,8 +1146,8 @@ <h4 id="descs">descs</h4>
</div>
<div id="next">

<a href="/maixpy/api/maix/nn.html">
<span class="label">nn</span>
<a href="/maixpy/api/maix/util.html">
<span class="label">util</span>
<span class="icon"></span>
</a>

Expand Down
189 changes: 189 additions & 0 deletions maixpy/api/maix/camera.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ <h2>MaixPy</h2>
<li class="not_active with_link"><a href="/maixpy/api/maix/protocol.html"><span class="label">protocol</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/maixpy/api/maix/example.html"><span class="label">example</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/maixpy/api/maix/app.html"><span class="label">app</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/maixpy/api/maix/util.html"><span class="label">util</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/maixpy/api/maix/nn.html"><span class="label">nn</span><span class="sub_indicator"></span></a><ul class="show">
<li class="not_active with_link"><a href="/maixpy/api/maix/nn/F.html"><span class="label">F</span><span class=""></span></a></li>
</ul>
Expand All @@ -129,6 +130,8 @@ <h2>MaixPy</h2>
<li class="not_active with_link"><a href="/maixpy/api/maix/peripheral/adc.html"><span class="label">adc</span><span class=""></span></a></li>
</ul>
</li>
<li class="not_active with_link"><a href="/maixpy/api/maix/rtsp.html"><span class="label">rtsp</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/maixpy/api/maix/video.html"><span class="label">video</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/maixpy/api/maix/touchscreen.html"><span class="label">touchscreen</span><span class=""></span></a></li>
</ul>
</li>
Expand Down Expand Up @@ -985,6 +988,192 @@ <h4 id="show_colorbar">show_colorbar</h4>
<p><strong>C++ defination code</strong>:</p>

<pre class="language-cpp"><code class="language-cpp">err::Err show_colorbar(bool enable)
</code></pre>
<h4 id="set_resolution">set_resolution</h4>
<table>
<thead>
<tr>
<th>item</th>
<th>doc</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>type</strong></td>
<td>func</td>
</tr>
<tr>
<td><strong>brief</strong></td>
<td>Set camera resolution</td>
</tr>
<tr>
<td><strong>param</strong></td>
<td><strong>width</strong>: new width<br><strong>height</strong>: new height<br></td>
</tr>
<tr>
<td><strong>static</strong></td>
<td>False</td>
</tr>
</tbody>
</table>
<p><strong>C++ defination code</strong>:</p>

<pre class="language-cpp"><code class="language-cpp">err::Err set_resolution(int width, int height)
</code></pre>
<h4 id="set_hmirror">set_hmirror</h4>
<table>
<thead>
<tr>
<th>item</th>
<th>doc</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>type</strong></td>
<td>func</td>
</tr>
<tr>
<td><strong>brief</strong></td>
<td>Set camera mirror</td>
</tr>
<tr>
<td><strong>param</strong></td>
<td><strong>en</strong>: enable/disable mirror<br></td>
</tr>
<tr>
<td><strong>static</strong></td>
<td>False</td>
</tr>
</tbody>
</table>
<p><strong>C++ defination code</strong>:</p>

<pre class="language-cpp"><code class="language-cpp">err::Err set_hmirror(bool en)
</code></pre>
<h4 id="set_vflip">set_vflip</h4>
<table>
<thead>
<tr>
<th>item</th>
<th>doc</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>type</strong></td>
<td>func</td>
</tr>
<tr>
<td><strong>brief</strong></td>
<td>Set camera flip</td>
</tr>
<tr>
<td><strong>param</strong></td>
<td><strong>en</strong>: enable/disable flip<br></td>
</tr>
<tr>
<td><strong>static</strong></td>
<td>False</td>
</tr>
</tbody>
</table>
<p><strong>C++ defination code</strong>:</p>

<pre class="language-cpp"><code class="language-cpp">err::Err set_vflip(bool en)
</code></pre>
<h4 id="set_luma">set_luma</h4>
<table>
<thead>
<tr>
<th>item</th>
<th>doc</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>type</strong></td>
<td>func</td>
</tr>
<tr>
<td><strong>brief</strong></td>
<td>Set camera constrast</td>
</tr>
<tr>
<td><strong>param</strong></td>
<td><strong>int</strong>: constrast value<br></td>
</tr>
<tr>
<td><strong>static</strong></td>
<td>False</td>
</tr>
</tbody>
</table>
<p><strong>C++ defination code</strong>:</p>

<pre class="language-cpp"><code class="language-cpp">err::Err set_luma(int value)
</code></pre>
<h4 id="set_constrast">set_constrast</h4>
<table>
<thead>
<tr>
<th>item</th>
<th>doc</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>type</strong></td>
<td>func</td>
</tr>
<tr>
<td><strong>brief</strong></td>
<td>Set camera constrast</td>
</tr>
<tr>
<td><strong>param</strong></td>
<td><strong>int</strong>: constrast value<br></td>
</tr>
<tr>
<td><strong>static</strong></td>
<td>False</td>
</tr>
</tbody>
</table>
<p><strong>C++ defination code</strong>:</p>

<pre class="language-cpp"><code class="language-cpp">err::Err set_constrast(int value)
</code></pre>
<h4 id="set_saturation">set_saturation</h4>
<table>
<thead>
<tr>
<th>item</th>
<th>doc</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>type</strong></td>
<td>func</td>
</tr>
<tr>
<td><strong>brief</strong></td>
<td>Set camera saturation</td>
</tr>
<tr>
<td><strong>param</strong></td>
<td><strong>int</strong>: saturation value<br></td>
</tr>
<tr>
<td><strong>static</strong></td>
<td>False</td>
</tr>
</tbody>
</table>
<p><strong>C++ defination code</strong>:</p>

<pre class="language-cpp"><code class="language-cpp">err::Err set_saturation(int value)
</code></pre>


Expand Down
3 changes: 3 additions & 0 deletions maixpy/api/maix/comm.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ <h2>MaixPy</h2>
<li class="not_active with_link"><a href="/maixpy/api/maix/protocol.html"><span class="label">protocol</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/maixpy/api/maix/example.html"><span class="label">example</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/maixpy/api/maix/app.html"><span class="label">app</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/maixpy/api/maix/util.html"><span class="label">util</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/maixpy/api/maix/nn.html"><span class="label">nn</span><span class="sub_indicator"></span></a><ul class="show">
<li class="not_active with_link"><a href="/maixpy/api/maix/nn/F.html"><span class="label">F</span><span class=""></span></a></li>
</ul>
Expand All @@ -129,6 +130,8 @@ <h2>MaixPy</h2>
<li class="not_active with_link"><a href="/maixpy/api/maix/peripheral/adc.html"><span class="label">adc</span><span class=""></span></a></li>
</ul>
</li>
<li class="not_active with_link"><a href="/maixpy/api/maix/rtsp.html"><span class="label">rtsp</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/maixpy/api/maix/video.html"><span class="label">video</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/maixpy/api/maix/touchscreen.html"><span class="label">touchscreen</span><span class=""></span></a></li>
</ul>
</li>
Expand Down
Loading

0 comments on commit 6765328

Please sign in to comment.