Skip to content

Commit

Permalink
update api doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@Neutree
Neutree committed Apr 24, 2024
1 parent 6765328 commit c204dfa
Show file tree
Hide file tree
Showing 41 changed files with 2,079 additions and 453 deletions.
907 changes: 665 additions & 242 deletions maixpy/api/api.json
View file

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions maixpy/api/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ <h2>MaixPy</h2>
<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/network.html"><span class="label">network</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 Down Expand Up @@ -258,6 +259,10 @@ <h1>MaixPy API -- Maix AI machine vision platform Python API</h1>
<td><a href="./maix/util.html" >maix.util</a></td>
<td>maix.util module</td>
</tr>
<tr>
<td><a href="./maix/network.html" >maix.network</a></td>
<td>maix.network module</td>
</tr>
<tr>
<td><a href="./maix/nn.html" >maix.nn</a></td>
<td>maix.nn module</td>
Expand Down
5 changes: 3 additions & 2 deletions maixpy/api/maix/app.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ <h2>MaixPy</h2>
<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/network.html"><span class="label">network</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 Down Expand Up @@ -186,8 +187,8 @@ <h1>maix.app</h1>

<p>maix.app module</p>
<blockquote>
<p>This module is generated from <a href="https://github.com/sipeed/MaixCDK" target="_blank">MaixCDK</a><br />
You can use <code>maix.app</code> to access this module.</p>
<p>You can use <code>maix.app</code> to access this module with MaixPy<br />
This module is generated from <a href="https://github.com/sipeed/MaixCDK" target="_blank">MaixCDK</a></p>
</blockquote>
<h2 id="Module">Module</h2>
<p>No module</p>
Expand Down
92 changes: 90 additions & 2 deletions maixpy/api/maix/camera.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ <h2>MaixPy</h2>
<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/network.html"><span class="label">network</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 Down Expand Up @@ -186,8 +187,8 @@ <h1>maix.camera</h1>

<p>maix.camera module, access camera device and get image from it</p>
<blockquote>
<p>This module is generated from <a href="https://github.com/sipeed/MaixCDK" target="_blank">MaixCDK</a><br />
You can use <code>maix.camera</code> to access this module.</p>
<p>You can use <code>maix.camera</code> to access this module with MaixPy<br />
This module is generated from <a href="https://github.com/sipeed/MaixCDK" target="_blank">MaixCDK</a></p>
</blockquote>
<h2 id="Module">Module</h2>
<p>No module</p>
Expand Down Expand Up @@ -261,6 +262,9 @@ <h3 id="Camera">Camera</h3>
<pre class="language-cpp"><code class="language-cpp">class Camera
</code></pre>
<h4 id="__init__">__init__</h4>

<pre class="language-python"><code class="language-python">def __init__(self, width: int = -1, height: int = -1, format: maix.image.Format = ..., device: str = None, fps: int = -1, buff_num: int = 3, open: bool = True) -&gt; None
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -292,6 +296,9 @@ <h4 id="__init__">__init__</h4>
<pre class="language-cpp"><code class="language-cpp">Camera(int width = -1, int height = -1, image::Format format = image::FMT_RGB888, const char *device = nullptr, int fps = -1, int buff_num = 3, bool open = true)
</code></pre>
<h4 id="get_ch_nums">get_ch_nums</h4>

<pre class="language-python"><code class="language-python">def get_ch_nums(self) -&gt; int
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -323,6 +330,9 @@ <h4 id="get_ch_nums">get_ch_nums</h4>
<pre class="language-cpp"><code class="language-cpp">int get_ch_nums()
</code></pre>
<h4 id="open">open</h4>

<pre class="language-python"><code class="language-python">def open(self, width: int = -1, height: int = -1, format: maix.image.Format = ..., fps: int = -1, buff_num: int = -1) -&gt; maix.err.Err
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -358,6 +368,9 @@ <h4 id="open">open</h4>
<pre class="language-cpp"><code class="language-cpp">err::Err open(int width = -1, int height = -1, image::Format format = image::FMT_INVALID, int fps = -1, int buff_num = -1)
</code></pre>
<h4 id="read">read</h4>

<pre class="language-python"><code class="language-python">def read(self, buff: capsule = None, buff_size: int = 0, block: bool = True) -&gt; maix.image.Image
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -393,6 +406,9 @@ <h4 id="read">read</h4>
<pre class="language-cpp"><code class="language-cpp">image::Image *read(void *buff = nullptr, size_t buff_size = 0, bool block = true)
</code></pre>
<h4 id="clear_buff">clear_buff</h4>

<pre class="language-python"><code class="language-python">def clear_buff(self) -&gt; None
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -420,6 +436,9 @@ <h4 id="clear_buff">clear_buff</h4>
<pre class="language-cpp"><code class="language-cpp">void clear_buff()
</code></pre>
<h4 id="skip_frames">skip_frames</h4>

<pre class="language-python"><code class="language-python">def skip_frames(self, num: int) -&gt; None
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -451,6 +470,9 @@ <h4 id="skip_frames">skip_frames</h4>
<pre class="language-cpp"><code class="language-cpp">void skip_frames(int num)
</code></pre>
<h4 id="close">close</h4>

<pre class="language-python"><code class="language-python">def close(self) -&gt; None
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -478,6 +500,9 @@ <h4 id="close">close</h4>
<pre class="language-cpp"><code class="language-cpp">void close()
</code></pre>
<h4 id="add_channel">add_channel</h4>

<pre class="language-python"><code class="language-python">def add_channel(self, width: int = -1, height: int = -1, format: maix.image.Format = ..., fps: int = -1, buff_num: int = 3, open: bool = True) -&gt; Camera
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -513,6 +538,9 @@ <h4 id="add_channel">add_channel</h4>
<pre class="language-cpp"><code class="language-cpp">camera::Camera *add_channel(int width = -1, int height = -1, image::Format format = image::FMT_RGB888, int fps = -1, int buff_num = 3, bool open = true)
</code></pre>
<h4 id="is_opened">is_opened</h4>

<pre class="language-python"><code class="language-python">def is_opened(self) -&gt; bool
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -544,6 +572,9 @@ <h4 id="is_opened">is_opened</h4>
<pre class="language-cpp"><code class="language-cpp">bool is_opened()
</code></pre>
<h4 id="is_closed">is_closed</h4>

<pre class="language-python"><code class="language-python">def is_closed(self) -&gt; bool
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -575,6 +606,9 @@ <h4 id="is_closed">is_closed</h4>
<pre class="language-cpp"><code class="language-cpp">bool is_closed()
</code></pre>
<h4 id="width">width</h4>

<pre class="language-python"><code class="language-python">def width(self) -&gt; int
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -606,6 +640,9 @@ <h4 id="width">width</h4>
<pre class="language-cpp"><code class="language-cpp">int width()
</code></pre>
<h4 id="height">height</h4>

<pre class="language-python"><code class="language-python">def height(self) -&gt; int
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -637,6 +674,9 @@ <h4 id="height">height</h4>
<pre class="language-cpp"><code class="language-cpp">int height()
</code></pre>
<h4 id="fps">fps</h4>

<pre class="language-python"><code class="language-python">def fps(self) -&gt; int
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -668,6 +708,9 @@ <h4 id="fps">fps</h4>
<pre class="language-cpp"><code class="language-cpp">int fps()
</code></pre>
<h4 id="format">format</h4>

<pre class="language-python"><code class="language-python">def format(self) -&gt; maix.image.Format
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -699,6 +742,9 @@ <h4 id="format">format</h4>
<pre class="language-cpp"><code class="language-cpp">image::Format format()
</code></pre>
<h4 id="buff_num">buff_num</h4>

<pre class="language-python"><code class="language-python">def buff_num(self) -&gt; int
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -730,6 +776,9 @@ <h4 id="buff_num">buff_num</h4>
<pre class="language-cpp"><code class="language-cpp">int buff_num()
</code></pre>
<h4 id="hmirror">hmirror</h4>

<pre class="language-python"><code class="language-python">def hmirror(self, value: int = -1) -&gt; int
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -761,6 +810,9 @@ <h4 id="hmirror">hmirror</h4>
<pre class="language-cpp"><code class="language-cpp">int hmirror(int value = -1)
</code></pre>
<h4 id="vflip">vflip</h4>

<pre class="language-python"><code class="language-python">def vflip(self, value: int = -1) -&gt; int
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -792,6 +844,9 @@ <h4 id="vflip">vflip</h4>
<pre class="language-cpp"><code class="language-cpp">int vflip(int value = -1)
</code></pre>
<h4 id="exposure">exposure</h4>

<pre class="language-python"><code class="language-python">def exposure(self, value: int = -1) -&gt; float
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -823,6 +878,9 @@ <h4 id="exposure">exposure</h4>
<pre class="language-cpp"><code class="language-cpp">float exposure(int value = -1)
</code></pre>
<h4 id="gain">gain</h4>

<pre class="language-python"><code class="language-python">def gain(self, value: int = -1) -&gt; float
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -854,6 +912,9 @@ <h4 id="gain">gain</h4>
<pre class="language-cpp"><code class="language-cpp">float gain(int value = -1)
</code></pre>
<h4 id="device">device</h4>

<pre class="language-python"><code class="language-python">def device(self) -&gt; str
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -885,6 +946,9 @@ <h4 id="device">device</h4>
<pre class="language-cpp"><code class="language-cpp">std::string device()
</code></pre>
<h4 id="write_reg">write_reg</h4>

<pre class="language-python"><code class="language-python">def write_reg(self, addr: int, data: int, bit_width: int = 8) -&gt; maix.err.Err
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -920,6 +984,9 @@ <h4 id="write_reg">write_reg</h4>
<pre class="language-cpp"><code class="language-cpp">err::Err write_reg(int addr, int data, int bit_width = 8)
</code></pre>
<h4 id="read_reg">read_reg</h4>

<pre class="language-python"><code class="language-python">def read_reg(self, addr: int, bit_width: int = 8) -&gt; int
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -955,6 +1022,9 @@ <h4 id="read_reg">read_reg</h4>
<pre class="language-cpp"><code class="language-cpp">int read_reg(int addr, int bit_width = 8)
</code></pre>
<h4 id="show_colorbar">show_colorbar</h4>

<pre class="language-python"><code class="language-python">def show_colorbar(self, enable: bool) -&gt; maix.err.Err
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -990,6 +1060,9 @@ <h4 id="show_colorbar">show_colorbar</h4>
<pre class="language-cpp"><code class="language-cpp">err::Err show_colorbar(bool enable)
</code></pre>
<h4 id="set_resolution">set_resolution</h4>

<pre class="language-python"><code class="language-python">def set_resolution(self, width: int, height: int) -&gt; maix.err.Err
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -1021,6 +1094,9 @@ <h4 id="set_resolution">set_resolution</h4>
<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>

<pre class="language-python"><code class="language-python">def set_hmirror(self, en: bool) -&gt; maix.err.Err
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -1052,6 +1128,9 @@ <h4 id="set_hmirror">set_hmirror</h4>
<pre class="language-cpp"><code class="language-cpp">err::Err set_hmirror(bool en)
</code></pre>
<h4 id="set_vflip">set_vflip</h4>

<pre class="language-python"><code class="language-python">def set_vflip(self, en: bool) -&gt; maix.err.Err
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -1083,6 +1162,9 @@ <h4 id="set_vflip">set_vflip</h4>
<pre class="language-cpp"><code class="language-cpp">err::Err set_vflip(bool en)
</code></pre>
<h4 id="set_luma">set_luma</h4>

<pre class="language-python"><code class="language-python">def set_luma(self, value: int) -&gt; maix.err.Err
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -1114,6 +1196,9 @@ <h4 id="set_luma">set_luma</h4>
<pre class="language-cpp"><code class="language-cpp">err::Err set_luma(int value)
</code></pre>
<h4 id="set_constrast">set_constrast</h4>

<pre class="language-python"><code class="language-python">def set_constrast(self, value: int) -&gt; maix.err.Err
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -1145,6 +1230,9 @@ <h4 id="set_constrast">set_constrast</h4>
<pre class="language-cpp"><code class="language-cpp">err::Err set_constrast(int value)
</code></pre>
<h4 id="set_saturation">set_saturation</h4>

<pre class="language-python"><code class="language-python">def set_saturation(self, value: int) -&gt; maix.err.Err
</code></pre>
<table>
<thead>
<tr>
Expand Down
5 changes: 3 additions & 2 deletions maixpy/api/maix/comm.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ <h2>MaixPy</h2>
<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/network.html"><span class="label">network</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 Down Expand Up @@ -186,8 +187,8 @@ <h1>maix.comm</h1>

<p>maix.comm module</p>
<blockquote>
<p>This module is generated from <a href="https://github.com/sipeed/MaixCDK" target="_blank">MaixCDK</a><br />
You can use <code>maix.comm</code> to access this module.</p>
<p>You can use <code>maix.comm</code> to access this module with MaixPy<br />
This module is generated from <a href="https://github.com/sipeed/MaixCDK" target="_blank">MaixCDK</a></p>
</blockquote>
<h2 id="Module">Module</h2>
<p>No module</p>
Expand Down
Loading

0 comments on commit c204dfa

Please sign in to comment.