Skip to content

Commit d152aec

Browse files
abratchikabratchik
committed
refactoring storage and adding doxygen documentation
1 parent 563ecc8 commit d152aec

File tree

241 files changed

+18966
-174
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

241 files changed

+18966
-174
lines changed

‎API.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,16 @@ Only for 3Mp+ camera modules:
7676

7777
#### Commands
7878
These are commands; they can be sent by calling the `/control` URI with them as
79-
the `<key>` *(a `<val>` must also be supplied, but can be any value and is ignored)*.
79+
the `<key>` parameter.
8080
```
81-
save_prefs - Saves preferences file
82-
clear_prefs - Deletes the preferences file
83-
reboot - Reboots the board
81+
* save_prefs - Saves preferences
82+
`val=cam` or not specified will save camera preferences
83+
`val=conn` will save network preferences
84+
* clear_prefs - Deletes camera the preferences
85+
`val=cam` or not specified will reset camera preferences
86+
`val=conn` will reset network preferences. Attention! after this the server will boot as access point after restart, and all
87+
connection settings will be lost.
88+
* reboot - Reboots the board
8489
```
8590

8691
## Examples

‎Docs/html/_a_p_i_8md.html

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.9.3"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>ESP32 WebCam Server: API.md File Reference</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr id="projectrow">
23+
<td id="projectlogo"><img alt="Logo" src="logo.svg"/></td>
24+
<td id="projectalign">
25+
<div id="projectname">ESP32 WebCam Server<span id="projectnumber">&#160;5.0</span>
26+
</div>
27+
<div id="projectbrief">Fully customizable WebCam server based on Espressif ESP32-based board with a camera.</div>
28+
</td>
29+
</tr>
30+
</tbody>
31+
</table>
32+
</div>
33+
<!-- end header part -->
34+
<!-- Generated by Doxygen 1.9.3 -->
35+
<script type="text/javascript">
36+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
37+
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
38+
/* @license-end */
39+
</script>
40+
<script type="text/javascript" src="menudata.js"></script>
41+
<script type="text/javascript" src="menu.js"></script>
42+
<script type="text/javascript">
43+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
44+
$(function() {
45+
initMenu('',true,false,'search.php','Search');
46+
$(document).ready(function() { init_search(); });
47+
});
48+
/* @license-end */
49+
</script>
50+
<div id="main-nav"></div>
51+
<!-- window showing the filter options -->
52+
<div id="MSearchSelectWindow"
53+
onmouseover="return searchBox.OnSearchSelectShow()"
54+
onmouseout="return searchBox.OnSearchSelectHide()"
55+
onkeydown="return searchBox.OnSearchSelectKey(event)">
56+
</div>
57+
58+
<!-- iframe showing the search results (closed by default) -->
59+
<div id="MSearchResultsWindow">
60+
<iframe src="javascript:void(0)" frameborder="0"
61+
name="MSearchResults" id="MSearchResults">
62+
</iframe>
63+
</div>
64+
65+
</div><!-- top -->
66+
<div class="header">
67+
<div class="headertitle"><div class="title">API.md File Reference</div></div>
68+
</div><!--header-->
69+
<div class="contents">
70+
</div><!-- contents -->
71+
<!-- start footer part -->
72+
<hr class="footer"/><address class="footer"><small>
73+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3
74+
</small></address>
75+
</body>
76+
</html>

‎Docs/html/_c_o_n_t_r_i_b_u_t_i_n_g_8md.html

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.9.3"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>ESP32 WebCam Server: CONTRIBUTING.md File Reference</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr id="projectrow">
23+
<td id="projectlogo"><img alt="Logo" src="logo.svg"/></td>
24+
<td id="projectalign">
25+
<div id="projectname">ESP32 WebCam Server<span id="projectnumber">&#160;5.0</span>
26+
</div>
27+
<div id="projectbrief">Fully customizable WebCam server based on Espressif ESP32-based board with a camera.</div>
28+
</td>
29+
</tr>
30+
</tbody>
31+
</table>
32+
</div>
33+
<!-- end header part -->
34+
<!-- Generated by Doxygen 1.9.3 -->
35+
<script type="text/javascript">
36+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
37+
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
38+
/* @license-end */
39+
</script>
40+
<script type="text/javascript" src="menudata.js"></script>
41+
<script type="text/javascript" src="menu.js"></script>
42+
<script type="text/javascript">
43+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
44+
$(function() {
45+
initMenu('',true,false,'search.php','Search');
46+
$(document).ready(function() { init_search(); });
47+
});
48+
/* @license-end */
49+
</script>
50+
<div id="main-nav"></div>
51+
<!-- window showing the filter options -->
52+
<div id="MSearchSelectWindow"
53+
onmouseover="return searchBox.OnSearchSelectShow()"
54+
onmouseout="return searchBox.OnSearchSelectHide()"
55+
onkeydown="return searchBox.OnSearchSelectKey(event)">
56+
</div>
57+
58+
<!-- iframe showing the search results (closed by default) -->
59+
<div id="MSearchResultsWindow">
60+
<iframe src="javascript:void(0)" frameborder="0"
61+
name="MSearchResults" id="MSearchResults">
62+
</iframe>
63+
</div>
64+
65+
</div><!-- top -->
66+
<div class="header">
67+
<div class="headertitle"><div class="title">CONTRIBUTING.md File Reference</div></div>
68+
</div><!--header-->
69+
<div class="contents">
70+
</div><!-- contents -->
71+
<!-- start footer part -->
72+
<hr class="footer"/><address class="footer"><small>
73+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3
74+
</small></address>
75+
</body>
76+
</html>

‎Docs/html/_r_e_a_d_m_e_8md.html

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.9.3"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>ESP32 WebCam Server: README.md File Reference</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr id="projectrow">
23+
<td id="projectlogo"><img alt="Logo" src="logo.svg"/></td>
24+
<td id="projectalign">
25+
<div id="projectname">ESP32 WebCam Server<span id="projectnumber">&#160;5.0</span>
26+
</div>
27+
<div id="projectbrief">Fully customizable WebCam server based on Espressif ESP32-based board with a camera.</div>
28+
</td>
29+
</tr>
30+
</tbody>
31+
</table>
32+
</div>
33+
<!-- end header part -->
34+
<!-- Generated by Doxygen 1.9.3 -->
35+
<script type="text/javascript">
36+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
37+
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
38+
/* @license-end */
39+
</script>
40+
<script type="text/javascript" src="menudata.js"></script>
41+
<script type="text/javascript" src="menu.js"></script>
42+
<script type="text/javascript">
43+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
44+
$(function() {
45+
initMenu('',true,false,'search.php','Search');
46+
$(document).ready(function() { init_search(); });
47+
});
48+
/* @license-end */
49+
</script>
50+
<div id="main-nav"></div>
51+
<!-- window showing the filter options -->
52+
<div id="MSearchSelectWindow"
53+
onmouseover="return searchBox.OnSearchSelectShow()"
54+
onmouseout="return searchBox.OnSearchSelectHide()"
55+
onkeydown="return searchBox.OnSearchSelectKey(event)">
56+
</div>
57+
58+
<!-- iframe showing the search results (closed by default) -->
59+
<div id="MSearchResultsWindow">
60+
<iframe src="javascript:void(0)" frameborder="0"
61+
name="MSearchResults" id="MSearchResults">
62+
</iframe>
63+
</div>
64+
65+
</div><!-- top -->
66+
<div class="header">
67+
<div class="headertitle"><div class="title">README.md File Reference</div></div>
68+
</div><!--header-->
69+
<div class="contents">
70+
</div><!-- contents -->
71+
<!-- start footer part -->
72+
<hr class="footer"/><address class="footer"><small>
73+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3
74+
</small></address>
75+
</body>
76+
</html>

‎Docs/html/annotated.html

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.9.3"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>ESP32 WebCam Server: Data Structures</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr id="projectrow">
23+
<td id="projectlogo"><img alt="Logo" src="logo.svg"/></td>
24+
<td id="projectalign">
25+
<div id="projectname">ESP32 WebCam Server<span id="projectnumber">&#160;5.0</span>
26+
</div>
27+
<div id="projectbrief">Fully customizable WebCam server based on Espressif ESP32-based board with a camera.</div>
28+
</td>
29+
</tr>
30+
</tbody>
31+
</table>
32+
</div>
33+
<!-- end header part -->
34+
<!-- Generated by Doxygen 1.9.3 -->
35+
<script type="text/javascript">
36+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
37+
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
38+
/* @license-end */
39+
</script>
40+
<script type="text/javascript" src="menudata.js"></script>
41+
<script type="text/javascript" src="menu.js"></script>
42+
<script type="text/javascript">
43+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
44+
$(function() {
45+
initMenu('',true,false,'search.php','Search');
46+
$(document).ready(function() { init_search(); });
47+
});
48+
/* @license-end */
49+
</script>
50+
<div id="main-nav"></div>
51+
</div><!-- top -->
52+
<!-- window showing the filter options -->
53+
<div id="MSearchSelectWindow"
54+
onmouseover="return searchBox.OnSearchSelectShow()"
55+
onmouseout="return searchBox.OnSearchSelectHide()"
56+
onkeydown="return searchBox.OnSearchSelectKey(event)">
57+
</div>
58+
59+
<!-- iframe showing the search results (closed by default) -->
60+
<div id="MSearchResultsWindow">
61+
<iframe src="javascript:void(0)" frameborder="0"
62+
name="MSearchResults" id="MSearchResults">
63+
</iframe>
64+
</div>
65+
66+
<div class="header">
67+
<div class="headertitle"><div class="title">Data Structures</div></div>
68+
</div><!--header-->
69+
<div class="contents">
70+
<div class="textblock">Here are the data structures with brief descriptions:</div><div class="directory">
71+
<table class="directory">
72+
<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>
73+
<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>
74+
<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>
75+
<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 />
76+
</td></tr>
77+
<tr id="row_4_" 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_storage.html" target="_self">CLStorage</a></td><td class="desc">Storage Manager Encapsulates access to the file system, which can be either external (SD card) or internal (LittleFS) </td></tr>
78+
<tr id="row_5_"><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="struct_static_i_p.html" target="_self">StaticIP</a></td><td class="desc"></td></tr>
79+
<tr id="row_6_" 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="struct_station.html" target="_self">Station</a></td><td class="desc"></td></tr>
80+
<tr id="row_7_"><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="struct_uri_mapping.html" target="_self">UriMapping</a></td><td class="desc">Static URI to path mapping </td></tr>
81+
</table>
82+
</div><!-- directory -->
83+
</div><!-- contents -->
84+
<!-- start footer part -->
85+
<hr class="footer"/><address class="footer"><small>
86+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3
87+
</small></address>
88+
</body>
89+
</html>

0 commit comments

Comments
 (0)