From 4c8c74aaa323c14ff53bf0d2ebb05968ec648f9a Mon Sep 17 00:00:00 2001 From: Rune Daugaard Harlyk Date: Mon, 14 Aug 2023 09:58:29 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=91=A3=20Adds=20example=20configuration?= =?UTF-8?q?=20settings=20and=20updates=20readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- include/secrets.example.h | 24 ++++++++++++++++++++++++ readme.md | 5 +++++ 2 files changed, 29 insertions(+) create mode 100644 include/secrets.example.h diff --git a/include/secrets.example.h b/include/secrets.example.h new file mode 100644 index 0000000..ded0ed5 --- /dev/null +++ b/include/secrets.example.h @@ -0,0 +1,24 @@ +// NOTE: do NOT enter your network details in this file (secrets.example.h)! +// Instead, copy this file to secrets.h, and set the below defines in that file! + +#define HOSTNAME "leika" // Relevant if wifi is enabled +#define SSID "" // Relevant if wifi is enabled +#define PASS "" // Relevant if wifi is enabled + +#define HTTP_PORT 80 // Relevant if webserver is enabled +#define WEBSOCKET_PATH "/" // Relevant if ws is enabled + +#define CAMERA_MODEL_AI_THINKER // Relevant if camera is enabled +// #define CAMERA_MODEL_WROVER_KIT +// #define CAMERA_MODEL_ESP_EYE +// #define CAMERA_MODEL_M5STACK_PSRAM +// #define CAMERA_MODEL_M5STACK_V2_PSRAM +// #define CAMERA_MODEL_M5STACK_WIDE +// #define CAMERA_MODEL_M5STACK_ESP32CAM +// #define CAMERA_MODEL_M5STACK_UNITCAM +// #define CAMERA_MODEL_TTGO_T_JOURNAL +// #define CAMERA_MODEL_XIAO_ESP32S3 +// #define CAMERA_MODEL_ESP32_CAM_BOARD +// #define CAMERA_MODEL_ESP32S3_CAM_LCD +// #define CAMERA_MODEL_ESP32S2_CAM_BOARD +// #define CAMERA_MODEL_ESP32S3_EYE diff --git a/readme.md b/readme.md index f4a2ab4..935e4bc 100644 --- a/readme.md +++ b/readme.md @@ -207,6 +207,11 @@ The kinematic for the robot is from this [kinematics paper](https://www.research npm install ``` +1. Configure device settings + 1. Make a copy of *include/secrets.example.h* in the same folder + 2. Rename the copy to *secrets.h* + 3. Configure relevant settings + ## Usage ### Developing