diff --git a/API.md b/API.md index b631a87..9503fb6 100644 --- a/API.md +++ b/API.md @@ -9,6 +9,7 @@ this makes controlling all functions of the camera via GET requests possible. * - stream: starting video capture with full screen mode * - still: taking a still image with full screen mode * `/dump` - Status page (automatically refreshed every 5 sec) +* `/setup` - Configure network settings (WiFi, OTA, etc) ### Special *key / val* settings and commands diff --git a/Docs/data-folder.png b/Docs/data-folder.png new file mode 100644 index 0000000..31a2cf0 Binary files /dev/null and b/Docs/data-folder.png differ diff --git a/Docs/html/app__cam_8h_source.html b/Docs/html/app__cam_8h_source.html index e06ec0f..4e3491a 100644 --- a/Docs/html/app__cam_8h_source.html +++ b/Docs/html/app__cam_8h_source.html @@ -174,12 +174,12 @@
105extern CLAppCam AppCam;
106
107#endif
-
AppCam
CLAppCam AppCam
Definition: app_cam.cpp:248
+
AppCam
CLAppCam AppCam
Definition: app_cam.cpp:247
LAMP_DEFAULT
#define LAMP_DEFAULT
Definition: app_cam.h:11
app_component.h
camera_pins.h
CLAppCam
Camera Manager Manages all interactions with camera.
Definition: app_cam.h:22
-
CLAppCam::savePrefs
int savePrefs()
Definition: app_cam.cpp:170
+
CLAppCam::savePrefs
int savePrefs()
Definition: app_cam.cpp:169
CLAppCam::isJPEGinBuffer
bool isJPEGinBuffer()
Definition: app_cam.h:54
CLAppCam::loadPrefs
int loadPrefs()
Definition: app_cam.cpp:109
CLAppCam::setRotation
void setRotation(int val)
Definition: app_cam.h:48
@@ -188,7 +188,7 @@
CLAppCam::getRotation
int getRotation()
Definition: app_cam.h:49
CLAppCam::getFrameRate
int getFrameRate()
Definition: app_cam.h:42
CLAppCam::getLamp
int getLamp()
Definition: app_cam.h:33
-
CLAppCam::snapToBufer
int snapToBufer()
Definition: app_cam.cpp:233
+
CLAppCam::snapToBufer
int snapToBufer()
Definition: app_cam.cpp:232
CLAppCam::setLamp
void setLamp(int newVal=LAMP_DEFAULT)
Definition: app_cam.cpp:96
CLAppCam::getXclk
int getXclk()
Definition: app_cam.h:46
CLAppCam::stop
int stop()
Definition: app_cam.cpp:89
@@ -198,7 +198,7 @@
CLAppCam::setAutoLamp
void setAutoLamp(bool val)
Definition: app_cam.h:35
CLAppCam::isAutoLamp
bool isAutoLamp()
Definition: app_cam.h:36
CLAppCam::getBuffer
uint8_t * getBuffer()
Definition: app_cam.h:52
-
CLAppCam::releaseBuffer
void releaseBuffer()
Definition: app_cam.cpp:239
+
CLAppCam::releaseBuffer
void releaseBuffer()
Definition: app_cam.cpp:238
CLAppCam::getSensorPID
int getSensorPID()
Definition: app_cam.h:38
CLAppCam::start
int start()
Definition: app_cam.cpp:8
CLAppCam::getSensor
sensor_t * getSensor()
Definition: app_cam.h:39
diff --git a/Docs/html/app__component_8h_source.html b/Docs/html/app__component_8h_source.html index 86cae78..4c35604 100644 --- a/Docs/html/app__component_8h_source.html +++ b/Docs/html/app__component_8h_source.html @@ -98,44 +98,48 @@
29
30 int getLastErr() {return last_err;};
31
-
32 protected:
-
33 void setTag(const char *t) {tag = t;};
-
34
-
35 void setErr(int err_code) {last_err = err_code;};
+
32 bool isConfigured() {return configured;};
+
33
+
34 protected:
+
35 void setTag(const char *t) {tag = t;};
36
-
41 int readJsonIntVal(jparse_ctx_t *jctx, char* token);
-
42
-
43 int parsePrefs(jparse_ctx_t *jctx);
+
37 void setErr(int err_code) {last_err = err_code;};
+
38
+
43 int readJsonIntVal(jparse_ctx_t *jctx, char* token);
44
-
45
-
46 private:
-
47 // prefix for forming preference file name of this class
-
48 const char * tag;
-
49
-
50 bool debug_mode = false;
-
51
-
52 // error code of the last error
-
53 int last_err = 0;
+
45 int parsePrefs(jparse_ctx_t *jctx);
+
46
+
47
+
48 private:
+
49 // prefix for forming preference file name of this class
+
50 const char * tag;
+
51 bool configured = false;
+
52
+
53 bool debug_mode = false;
54
-
55 char prefs[20] = "prefs.json";
-
56};
+
55 // error code of the last error
+
56 int last_err = 0;
57
-
58#endif
+
58 char prefs[20] = "prefs.json";
+
59};
+
60
+
61#endif
app_config.h
CLAppComponent
Abstract root class for the appication components.
Definition: app_component.h:14
CLAppComponent::getLastErr
int getLastErr()
Definition: app_component.h:30
CLAppComponent::loadPrefs
int loadPrefs()
Definition: app_component.h:19
CLAppComponent::savePrefs
int savePrefs()
Definition: app_component.h:20
CLAppComponent::isDebugMode
bool isDebugMode()
Definition: app_component.h:28
-
CLAppComponent::setTag
void setTag(const char *t)
Definition: app_component.h:33
-
CLAppComponent::parsePrefs
int parsePrefs(jparse_ctx_t *jctx)
Definition: app_component.cpp:50
+
CLAppComponent::setTag
void setTag(const char *t)
Definition: app_component.h:35
+
CLAppComponent::parsePrefs
int parsePrefs(jparse_ctx_t *jctx)
Definition: app_component.cpp:51
CLAppComponent::start
int start()
Definition: app_component.h:18
-
CLAppComponent::setErr
void setErr(int err_code)
Definition: app_component.h:35
+
CLAppComponent::setErr
void setErr(int err_code)
Definition: app_component.h:37
CLAppComponent::setDebugMode
void setDebugMode(bool val)
Definition: app_component.h:27
-
CLAppComponent::readJsonIntVal
int readJsonIntVal(jparse_ctx_t *jctx, char *token)
reads the Int value from JSON context by token.
Definition: app_component.cpp:28
-
CLAppComponent::dumpPrefs
void dumpPrefs()
Definition: app_component.cpp:18
+
CLAppComponent::readJsonIntVal
int readJsonIntVal(jparse_ctx_t *jctx, char *token)
reads the Int value from JSON context by token.
Definition: app_component.cpp:29
+
CLAppComponent::isConfigured
bool isConfigured()
Definition: app_component.h:32
+
CLAppComponent::dumpPrefs
void dumpPrefs()
Definition: app_component.cpp:19
CLAppComponent::getPrefsFileName
char * getPrefsFileName(bool forsave=false)
Definition: app_component.cpp:3
-
CLAppComponent::removePrefs
int removePrefs()
Definition: app_component.cpp:36
+
CLAppComponent::removePrefs
int removePrefs()
Definition: app_component.cpp:37
storage.h
diff --git a/Docs/html/app__config_8h_source.html b/Docs/html/app__config_8h_source.html index 80a73c6..7e5b63a 100644 --- a/Docs/html/app__config_8h_source.html +++ b/Docs/html/app__config_8h_source.html @@ -92,55 +92,47 @@
19#define WIFI_WATCHDOG 15000
20
21/*
-
22 * Over The Air firmware updates can be disabled by uncommenting the folowing line
-
23 * When enabled the device will advertise itself using the MDNS_NAME defined above
+
22 * Additional Features
+
23 *
24 */
-
25// #define NO_OTA
-
26
-
27/*
-
28 * Additional Features
-
29 *
-
30 */
+
25
+
26// Uncomment to disable the notification LED on the module
+
27// #define LED_DISABLE
+
28
+
29// Uncomment to disable the illumination lamp features
+
30// #define LAMP_DISABLE
31
-
32
-
33
-
34// Uncomment to disable the notification LED on the module
-
35// #define LED_DISABLE
-
36
-
37// Uncomment to disable the illumination lamp features
-
38// #define LAMP_DISABLE
+
32// Uncomment this line to use LittleFS instead of SD.
+
33// NOTE!
+
34// LittleFS is still experimental, not recommended. The 'official' library installed from the Library Manager
+
35// seems to be broken, but fixed in this PR: https://github.com/lorol/LITTLEFS/pull/56
+
36// To install it, please navigate to you /libraries sub-folder of your sketch location and then execute
+
37// git clone https://github.com/Michael2MacDonald/LITTLEFS.
+
38// #define USE_LittleFS
39
-
40// Uncomment this line to use LittleFS instead of SD.
-
41// NOTE!
-
42// LittleFS is still experimental, not recommended. The 'official' library installed from the Library Manager
-
43// seems to be broken, but fixed in this PR: https://github.com/lorol/LITTLEFS/pull/56
-
44// To install it, please navigate to you /libraries sub-folder of your sketch location and then execute
-
45// git clone https://github.com/Michael2MacDonald/LITTLEFS.
-
46// #define USE_LittleFS
-
47
-
48// Define the startup lamp power setting (as a percentage, defaults to 0%)
-
49// Saved user settings will override this
-
50// #define LAMP_DEFAULT 0
-
51
-
52/*
-
53 * Camera Hardware Selectiom
-
54 *
-
55 * You must uncomment one, and only one, of the lines below to select your board model.
-
56 * Remember to also select the board in the Boards Manager
-
57 * This is not optional
-
58 */
-
59#define CAMERA_MODEL_AI_THINKER // default
-
60// #define CAMERA_MODEL_WROVER_KIT
-
61// #define CAMERA_MODEL_ESP_EYE
-
62// #define CAMERA_MODEL_M5STACK_PSRAM
-
63// #define CAMERA_MODEL_M5STACK_V2_PSRAM
-
64// #define CAMERA_MODEL_M5STACK_WIDE
-
65// #define CAMERA_MODEL_M5STACK_ESP32CAM // Originally: CAMERA_MODEL_M5STACK_NO_PSRAM
-
66// #define CAMERA_MODEL_TTGO_T_JOURNAL
-
67// #define CAMERA_MODEL_ARDUCAM_ESP32S_UNO
-
68
-
69
-
70#endif
+
40// Define the startup lamp power setting (as a percentage, defaults to 0%)
+
41// Saved user settings will override this
+
42// #define LAMP_DEFAULT 0
+
43
+
44/*
+
45 * Camera Hardware Selectiom
+
46 *
+
47 * You must uncomment one, and only one, of the lines below to select your board model.
+
48 * Remember to also select the board in the Boards Manager
+
49 * This is not optional
+
50 */
+
51#define CAMERA_MODEL_AI_THINKER // default
+
52// #define CAMERA_MODEL_WROVER_KIT
+
53// #define CAMERA_MODEL_ESP_EYE
+
54// #define CAMERA_MODEL_M5STACK_PSRAM
+
55// #define CAMERA_MODEL_M5STACK_V2_PSRAM
+
56// #define CAMERA_MODEL_M5STACK_WIDE
+
57// #define CAMERA_MODEL_M5STACK_ESP32CAM // Originally: CAMERA_MODEL_M5STACK_NO_PSRAM
+
58// #define CAMERA_MODEL_TTGO_T_JOURNAL
+
59// #define CAMERA_MODEL_ARDUCAM_ESP32S_UNO
+
60
+
61
+
62#endif