Skip to content

Commit

Permalink
Documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
@abratchik
abratchik committed Jan 8, 2023
1 parent da7c73d commit 2f19f4b
Show file tree
Hide file tree
Showing 41 changed files with 775 additions and 494 deletions.
16 changes: 9 additions & 7 deletions API.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,10 @@ the `<key>` parameter.
format.
* `http://<IP-ADDRESS>/status`
* Returns:
``` {"frame_rate":0,"framesize":9,"quality":10,"xclk":8,"brightness":0,"contrast":0,"saturation":0,"sharpness":0,"special_effect":0,"wb_mode":0,"awb":1,"awb_gain":1,"aec":1,"aec2":0,"ae_level":0,"aec_value":204,"agc":1,"agc_gain":0,"gainceiling":0,"bpc":0,"wpc":1,"raw_gma":1,"lenc":1,"vflip":1,"hmirror":1,"dcw":1,"colorbar":0,"cam_name":"ESP32 test camera","code_ver":"Mar 10 2022 @ 14:00:45","rotate":"0"}```

```json
{"cam_name":"ESP32 CAM Web Server","stream_url":"http://<ip:port>/view?mode=stream","code_ver":"Jan 7 2023 @ 19:16:55","lamp":0,"autolamp":false,"lamp":0,"flashlamp":0,"rotate":0,"xclk":8,"frame_rate":12,"framesize":8,"quality":12,"brightness":0,"contrast":0,"saturation":0,"sharpness":0,"denoise":0,"special_effect":0,"wb_mode":0,"awb":1,"awb_gain":1,"aec":1,"aec2":0,"ae_level":0,"aec_value":204,"agc":1,"agc_gain":0,"gainceiling":0,"bpc":0,"wpc":1,"raw_gma":1,"lenc":1,"vflip":0,"hmirror":0,"dcw":1,"colorbar":0,"cam_pid":38,"cam_ver":66,"debug_mode":false}
```
* Reboot the camera
* `http://<IP-ADDRESS>/control?var=reboot&val=0`

Expand Down Expand Up @@ -187,15 +190,15 @@ The following commands are supported:
## Attaching PWM to the GPIO pins
GPIO pins used for PWM can be defined in the `/httpd.json`, in the `pwm` parameter:
```
```json
{
"my_name": "ESP32 Web Server",
"lamp":0,
"autolamp":true,
"flashlamp":100,
"pwm": [{"pin":4, "frequency":50000, "resolution":9, "default":0}],
"mapping":[ {"uri":"/dump", "path": "/www/dump.html"},
{"uri":"/img", "path": "/www/img"},
"mapping":[ {"uri":"/img", "path": "/www/img"},
{"uri":"/css", "path": "/www/css"},
{"uri":"/js", "path": "/www/js"}],
"debug_mode": false
Expand All @@ -216,16 +219,15 @@ will be used for definition of flash lamp PWM. In the example above, the lamp PW

Here is another example of the PWM configuration, used for the popular SG90 servo motor on pin 12:

```
```json
{
"my_name": "ESP32 Web Server",
"lamp":0,
"autolamp":true,
"flashlamp":100,
"pwm": [{"pin":4, "frequency":50000, "resolution":9, "default":0},
{"pin":12, "frequency":50, "resolution":10, "default": 42}],
"mapping":[ {"uri":"/dump", "path": "/www/dump.html"},
{"uri":"/img", "path": "/www/img"},
"mapping":[ {"uri":"/img", "path": "/www/img"},
{"uri":"/css", "path": "/www/css"},
{"uri":"/js", "path": "/www/js"}],
"debug_mode": false
Expand Down
2 changes: 1 addition & 1 deletion Docs/html/annotated.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@
<div class="textblock">Here are the data structures with brief descriptions:</div><div class="directory">
<table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_c_l_app_cam.html" target="_self">CLAppCam</a></td><td class="desc">Camera Manager Manages all interactions with camera </td></tr>
<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_c_l_app_component.html" target="_self">CLAppComponent</a></td><td class="desc">Abstract root class for the appication components </td></tr>
<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_c_l_app_component.html" target="_self">CLAppComponent</a></td><td class="desc">Abstract root class for the application components </td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_c_l_app_conn.html" target="_self">CLAppConn</a></td><td class="desc">Connection Manager This class manages everything related to connectivity of the application: WiFi, OTA etc </td></tr>
<tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_c_l_app_httpd.html" target="_self">CLAppHttpd</a></td><td class="desc">WebServer Manager Class for handling web server requests. The web pages are assumed to be stored in the file system (can be SD card or LittleFS). <br />
</td></tr>
Expand Down
8 changes: 4 additions & 4 deletions Docs/html/app__cam_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,9 +108,9 @@
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="class_c_l_app_cam.html#a65918dca872c1d5bdcb0bb556451127f"> 39</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="class_c_l_app_cam.html#a65918dca872c1d5bdcb0bb556451127f">getRotation</a>() {<span class="keywordflow">return</span> myRotation;};</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordtype">int</span> <a class="code hl_function" href="class_c_l_app_cam.html#ab160cae01bb6ea313cbbb0aa1aa1cc03">snapToBuffer</a>();</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="class_c_l_app_cam.html#aac54409dcd9344abbbe434b237dc505f"> 42</a></span> uint8_t * <a class="code hl_function" href="class_c_l_app_cam.html#aac54409dcd9344abbbe434b237dc505f">getBuffer</a>() {<span class="keywordflow">return</span> fb-&gt;buf;};</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="class_c_l_app_cam.html#aa0f1c434be24055bab3abb459a071abd"> 43</a></span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="class_c_l_app_cam.html#aa0f1c434be24055bab3abb459a071abd">getBufferSize</a>() {<span class="keywordflow">return</span> fb-&gt;len;};</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="class_c_l_app_cam.html#a1f01a309f73eb36142ab8b449c81a381"> 44</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_c_l_app_cam.html#a1f01a309f73eb36142ab8b449c81a381">isJPEGinBuffer</a>() {<span class="keywordflow">return</span> fb-&gt;format == PIXFORMAT_JPEG;};</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="class_c_l_app_cam.html#aac54409dcd9344abbbe434b237dc505f"> 42</a></span> uint8_t * <a class="code hl_function" href="class_c_l_app_cam.html#aac54409dcd9344abbbe434b237dc505f">getBuffer</a>() {<span class="keywordflow">return</span> (fb?fb-&gt;buf:<span class="keyword">nullptr</span>);};</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="class_c_l_app_cam.html#aa0f1c434be24055bab3abb459a071abd"> 43</a></span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="class_c_l_app_cam.html#aa0f1c434be24055bab3abb459a071abd">getBufferSize</a>() {<span class="keywordflow">return</span> (fb?fb-&gt;len:0);};</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="class_c_l_app_cam.html#a1f01a309f73eb36142ab8b449c81a381"> 44</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_c_l_app_cam.html#a1f01a309f73eb36142ab8b449c81a381">isJPEGinBuffer</a>() {<span class="keywordflow">return</span> (fb?fb-&gt;format == PIXFORMAT_JPEG:<span class="keyword">false</span>);};</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_c_l_app_cam.html#aaf9c6d7306c5122eb6766011b8fc4c4c">releaseBuffer</a>(); </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_c_l_app_cam.html#a4edda1d5a10e22bdb056be4cb82d9c1d">dumpStatusToJson</a>(json_gen_str_t * jstr, <span class="keywordtype">bool</span> full_status = <span class="keyword">true</span>);</div>
Expand Down Expand Up @@ -179,7 +179,7 @@
<div class="ttc" id="aclass_c_l_app_cam_html_ac20c8599dfc6112502b2ca9e446e6af5"><div class="ttname"><a href="class_c_l_app_cam.html#ac20c8599dfc6112502b2ca9e446e6af5">CLAppCam::getSensorPID</a></div><div class="ttdeci">int getSensorPID()</div><div class="ttdef"><b>Definition:</b> app_cam.h:28</div></div>
<div class="ttc" id="aclass_c_l_app_cam_html_af277f42041c7c0a561bd8c8b087f4b3a"><div class="ttname"><a href="class_c_l_app_cam.html#af277f42041c7c0a561bd8c8b087f4b3a">CLAppCam::start</a></div><div class="ttdeci">int start()</div><div class="ttdef"><b>Definition:</b> app_cam.cpp:8</div></div>
<div class="ttc" id="aclass_c_l_app_cam_html_af812f50b9e35bcdb56af399c4fafd8f2"><div class="ttname"><a href="class_c_l_app_cam.html#af812f50b9e35bcdb56af399c4fafd8f2">CLAppCam::getSensor</a></div><div class="ttdeci">sensor_t * getSensor()</div><div class="ttdef"><b>Definition:</b> app_cam.h:29</div></div>
<div class="ttc" id="aclass_c_l_app_component_html"><div class="ttname"><a href="class_c_l_app_component.html">CLAppComponent</a></div><div class="ttdoc">Abstract root class for the appication components.</div><div class="ttdef"><b>Definition:</b> app_component.h:14</div></div>
<div class="ttc" id="aclass_c_l_app_component_html"><div class="ttname"><a href="class_c_l_app_component.html">CLAppComponent</a></div><div class="ttdoc">Abstract root class for the application components.</div><div class="ttdef"><b>Definition:</b> app_component.h:14</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
2 changes: 1 addition & 1 deletion Docs/html/app__component_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_app_component.html">CLAppComponent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abstract root class for the appication components. <a href="class_c_l_app_component.html#details">More...</a><br /></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abstract root class for the application components. <a href="class_c_l_app_component.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
Expand Down
Loading

0 comments on commit 2f19f4b

Please sign in to comment.