Update documentation

Author: remibert

README.md

@@ -1,7 +1,7 @@
-Pycameresp is originally designed to be a completely standalone motion detector on ESP32-CAM, but all servers and other functionality also work on generic Esp32 and Pico PI, Pico PI W.
+Pycameresp is originally designed to be a completely standalone motion detector on ESP32-CAM, but all servers and other functionality also work on generic Esp32 and Pico PI W.
 
 ---
-The following features are available on all Esp32 and Pico Pi :
+The following features are available on all Esp32 and Pico Pi W :
 
  - WiFi network management with configuration via web interface. 
  - Automatic Wifi connection and reconnection in case of deconnection.

doc/CAMFLASHER.md

@@ -18,29 +18,29 @@ Camflasher with shell commands **upload** and **download**, allows to upload or
 
 - Download the firmware associated with your device :
 
-	- [ESP32-CAM, ESP32-CAM-MB, ESP32ONE, M5Stack Camera](https://github.com/remibert/pycameresp/releases/download/V17/ESP32CAM-firmware.bin)
+	- [ESP32-CAM, ESP32-CAM-MB, ESP32ONE, M5Stack Camera](https://github.com/remibert/pycameresp/releases/download/V18/ESP32CAM-firmware.bin)
 
-	- [ESP32-TTGO-T8 or ESP32 with SPIRAM ](https://github.com/remibert/pycameresp/releases/download/V17/GENERIC_SPIRAM-firmware.bin)
+	- [ESP32-TTGO-T8 or ESP32 with SPIRAM ](https://github.com/remibert/pycameresp/releases/download/V18/GENERIC_SPIRAM-firmware.bin)
 
 
 - Or download the zip for standard micropython firmware :
 
-	- [Shell with editor](https://github.com/remibert/pycameresp/releases/download/V17/shell.zip)
+	- [Shell with editor](https://github.com/remibert/pycameresp/releases/download/V18/shell.zip)
 
-	- [Wifi manager, Http server](https://github.com/remibert/pycameresp/releases/download/V17/server.zip)
+	- [Wifi manager, Http server](https://github.com/remibert/pycameresp/releases/download/V18/server.zip)
 
 - Text editor source files running on python3 and micropython :
 
-	- [Text editor](https://github.com/remibert/pycameresp/releases/download/V17/editor.zip)
+	- [Text editor](https://github.com/remibert/pycameresp/releases/download/V18/editor.zip)
 
 It is possible to run the shell with editor, or the servers on a standard micropython platform. The servers, the wifi manager, requires having enough ram and wifi support (ESP32 with SPIRAM for example). Unzip archive and install it with rshell.
 
 - Download the camflasher application and unzip it :
-	- [CamFlasher for Windows 10 64 bits](https://github.com/remibert/pycameresp/releases/download/V17/CamFlasher_windows_10_64.zip)
+	- [CamFlasher for Windows 10 64 bits](https://github.com/remibert/pycameresp/releases/download/V18/CamFlasher_windows_10_64.zip)
 
-	- [CamFlasher for OSX Ventura Intel](https://github.com/remibert/pycameresp/releases/download/V17/CamFlasher_osx_i386.zip)
+	- [CamFlasher for OSX Ventura Intel](https://github.com/remibert/pycameresp/releases/download/V18/CamFlasher_osx_i386.zip)
 
-	- [CamFlasher for OSX Ventura M1](https://github.com/remibert/pycameresp/releases/download/V17/CamFlasher_osx_arm.zip)
+	- [CamFlasher for OSX Ventura M1](https://github.com/remibert/pycameresp/releases/download/V18/CamFlasher_osx_arm.zip)
 
 - Connect the device to the USB port of your computer.
 
@@ -366,7 +366,7 @@ You must go to the shell prompt or the python prompt.
 
 ![Upload shell server](/images/16_CamFlasher_UploadShell.png "Upload shell or server")
 
-If you select **Upload shell**, it will only download the shell and the text editor. This case works perfectly on a Pico PI RP02 as well as all esp32.
+If you select **Upload shell**, it will only download the shell and the text editor. This case works perfectly on a Pico PI W RP02 as well as all esp32.
 
 If you select **Upload server**, you will also have the web server, ftp, wifimanager. **This download overwrites the main.py, so if you have modified it, you will have to save it first.**
 

doc/FIRMWARE.md

@@ -29,7 +29,7 @@ Help of this command :
 		-a, --all             install tools, get source, patch, and build selected firmwares
 		-c, --clean           clean micropython sources to remove all patch
 		-s, --s3              build Esp32 S3 without problem
-		-r, --rp2             build raspberry pico RP2 and RP2 W
+		-r, --rp2             build raspberry pico RP2 W
 		-z, --zippy           zip python modules
 		-o OUTPUTDIR, --outputdir OUTPUTDIR                    output directory
 
@@ -48,6 +48,6 @@ Or for all ESP32 S2
 To build ESP32 S3 you must clean all and add option --s3  :
 - **python3 build.py --clean --s3 --patch --build "GENERIC_S3_SPIRAM"**
 
-To build Pico PI and Pico PI W you must clean all and enter command :
-- **python3 build.py --clean --rp2 --patch --build "PICO" "PICO_W"**
+To build Pico PI W you must clean all and enter command :
+- **python3 build.py --clean --rp2 --patch --build "PICO_W"**
 

doc/REQUIREMENTS.md

@@ -19,6 +19,6 @@ Below are the devices compatible with pycameresp :
 
 ![NODEMCU](/images/Device_NODEMCU.jpg "NODE MCU")
 ![LOLIN32](/images/Device_LOLIN32.jpg "LOLIN32")
-![PicoPi](/images/Device_PicoPi.png "Pico PI and Pico PI W")
+![PicoPi](/images/Device_PicoPi.png "Pico PI W")
 ![SONOFF R3](/images/Device_SonoffR3.png "SONOFF R3")
 

doc/lib/device/index.html

@@ -0,0 +1,65 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
+<meta name="generator" content="pdoc 0.10.0" />
+<title>lib.device API documentation</title>
+<meta name="description" content="" />
+<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
+<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
+<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
+<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
+</head>
+<body>
+<main>
+<article id="content">
+<header>
+<h1 class="title">Namespace <code>lib.device</code></h1>
+</header>
+<section id="section-intro">
+</section>
+<section>
+<h2 class="section-title" id="header-submodules">Sub-modules</h2>
+<dl>
+<dt><code class="name"><a title="lib.device.uda1334" href="uda1334.html">lib.device.uda1334</a></code></dt>
+<dd>
+<div class="desc"><p>Class to drive DAC module uda1334a I2S, stereo audio decoder module board</p></div>
+</dd>
+</dl>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+</section>
+</article>
+<nav id="sidebar">
+<h1>Index</h1>
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3>Super-module</h3>
+<ul>
+<li><code><a title="lib" href="../index.html">lib</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-submodules">Sub-modules</a></h3>
+<ul>
+<li><code><a title="lib.device.uda1334" href="uda1334.html">lib.device.uda1334</a></code></li>
+</ul>
+</li>
+</ul>
+</nav>
+</main>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
+</footer>
+</body>
+</html>