update en doc

sipeed · Apr 29, 2024 · 37275cd · 37275cd
1 parent 08f6417
commit 37275cd
Show file tree

Hide file tree

Showing 139 changed files with 17,940 additions and 408 deletions.
diff --git a/maixpy/api/api.json b/maixpy/api/api.json
diff --git a/maixpy/api/index.html b/maixpy/api/index.html
@@ -114,7 +114,10 @@ <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/network.html"><span class="label">network</span><span class="sub_indicator"></span></a><ul class="show">
+<li class="not_active with_link"><a href="/maixpy/api/maix/network/wifi.html"><span class="label">wifi</span><span class=""></span></a></li>
+</ul>
+</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>

diff --git a/maixpy/api/maix/app.html b/maixpy/api/maix/app.html
@@ -114,7 +114,10 @@ <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/network.html"><span class="label">network</span><span class="sub_indicator"></span></a><ul class="show">
+<li class="not_active with_link"><a href="/maixpy/api/maix/network/wifi.html"><span class="label">wifi</span><span class=""></span></a></li>
+</ul>
+</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>

diff --git a/maixpy/api/maix/camera.html b/maixpy/api/maix/camera.html
@@ -114,7 +114,10 @@ <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/network.html"><span class="label">network</span><span class="sub_indicator"></span></a><ul class="show">
+<li class="not_active with_link"><a href="/maixpy/api/maix/network/wifi.html"><span class="label">wifi</span><span class=""></span></a></li>
+</ul>
+</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>
@@ -1059,6 +1062,37 @@ <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="get_channel">get_channel</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>Get channel of camera</td>
+</tr>
+<tr>
+  <td><strong>return</strong></td>
+  <td>channel number</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">int get_channel()
+</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

diff --git a/maixpy/api/maix/comm.html b/maixpy/api/maix/comm.html
@@ -114,7 +114,10 @@ <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/network.html"><span class="label">network</span><span class="sub_indicator"></span></a><ul class="show">
+<li class="not_active with_link"><a href="/maixpy/api/maix/network/wifi.html"><span class="label">wifi</span><span class=""></span></a></li>
+</ul>
+</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>

diff --git a/maixpy/api/maix/display.html b/maixpy/api/maix/display.html
@@ -114,7 +114,10 @@ <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/network.html"><span class="label">network</span><span class="sub_indicator"></span></a><ul class="show">
+<li class="not_active with_link"><a href="/maixpy/api/maix/network/wifi.html"><span class="label">wifi</span><span class=""></span></a></li>
+</ul>
+</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>
@@ -700,6 +703,37 @@ <h4 id="set_backlight">set_backlight</h4>
 
 <pre class="language-cpp"><code class="language-cpp">void set_backlight(float value)
 </code></pre>
+<h4 id="get_backlight">get_backlight</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>Get display backlight</td>
+</tr>
+<tr>
+  <td><strong>return</strong></td>
+  <td>value backlight value, float type, range is [0, 100]</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">float get_backlight()
+</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

diff --git a/maixpy/api/maix/err.html b/maixpy/api/maix/err.html
@@ -114,7 +114,10 @@ <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/network.html"><span class="label">network</span><span class="sub_indicator"></span></a><ul class="show">
+<li class="not_active with_link"><a href="/maixpy/api/maix/network/wifi.html"><span class="label">wifi</span><span class=""></span></a></li>
+</ul>
+</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>

diff --git a/maixpy/api/maix/example.html b/maixpy/api/maix/example.html
@@ -114,7 +114,10 @@ <h2>MaixPy</h2>
 <li class="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/network.html"><span class="label">network</span><span class="sub_indicator"></span></a><ul class="show">
+<li class="not_active with_link"><a href="/maixpy/api/maix/network/wifi.html"><span class="label">wifi</span><span class=""></span></a></li>
+</ul>
+</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>

diff --git a/maixpy/api/maix/fs.html b/maixpy/api/maix/fs.html
@@ -114,7 +114,10 @@ <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/network.html"><span class="label">network</span><span class="sub_indicator"></span></a><ul class="show">
+<li class="not_active with_link"><a href="/maixpy/api/maix/network/wifi.html"><span class="label">wifi</span><span class=""></span></a></li>
+</ul>
+</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>

diff --git a/maixpy/api/maix/i18n.html b/maixpy/api/maix/i18n.html
@@ -114,7 +114,10 @@ <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/network.html"><span class="label">network</span><span class="sub_indicator"></span></a><ul class="show">
+<li class="not_active with_link"><a href="/maixpy/api/maix/network/wifi.html"><span class="label">wifi</span><span class=""></span></a></li>
+</ul>
+</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>

diff --git a/maixpy/api/maix/image.html b/maixpy/api/maix/image.html
@@ -114,7 +114,10 @@ <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/network.html"><span class="label">network</span><span class="sub_indicator"></span></a><ul class="show">
+<li class="not_active with_link"><a href="/maixpy/api/maix/network/wifi.html"><span class="label">wifi</span><span class=""></span></a></li>
+</ul>
+</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>

diff --git a/maixpy/api/maix/network.html b/maixpy/api/maix/network.html
@@ -114,7 +114,10 @@ <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="active with_link"><a href="/maixpy/api/maix/network.html"><span class="label">network</span><span class=""></span></a></li>
+<li class="active with_link"><a href="/maixpy/api/maix/network.html"><span class="label">network</span><span class="sub_indicator"></span></a><ul class="show">
+<li class="not_active with_link"><a href="/maixpy/api/maix/network/wifi.html"><span class="label">wifi</span><span class=""></span></a></li>
+</ul>
+</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>
@@ -191,7 +194,20 @@ <h1>maix.network</h1>
 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>
+<table>
+<thead>
+<tr>
+  <th>module</th>
+  <th>brief</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+  <td><a href="./network/wifi.html"  >wifi</a></td>
+  <td>maix.network.wifi module</td>
+</tr>
+</tbody>
+</table>
 <h2 id="Enum">Enum</h2>
 <h2 id="Variable">Variable</h2>
 <h2 id="Function">Function</h2>
@@ -234,8 +250,8 @@ <h2 id="Class">Class</h2>
                     </div>
                     <div id="next">
 
-                        <a href="/maixpy/api/maix/nn.html">
-                            <span class="label">nn</span>
+                        <a href="/maixpy/api/maix/network/wifi.html">
+                            <span class="label">wifi</span>
                             <span class="icon"></span>
                         </a>