-
Notifications
You must be signed in to change notification settings - Fork 94
/
Esp32_servers_config.h
105 lines (89 loc) · 8.03 KB
/
Esp32_servers_config.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
// Esp32_web_ftp_telnet_server_template configuration
// you can skip some files #included if you don't need the whole functionality
// uncomment the following line to get additional compile-time information about how the project gets compiled
// #define SHOW_COMPILE_TIME_INFORMATION
// include version_of_servers.h to include version information
#include "./servers/version_of_servers.h"
// include dmesg.hpp which is useful for run-time debugging - for dmesg telnet command
// #include "./servers/dmesg.hpp"
// include esp32_ping.hpp to occasioanly ping the router to check if ESP32 is still connected to WiFi
// #include "./servers/esp32_ping.hpp"
// 1. TIME: #define which time settings, wil be used with time_functions.h - will be included later
// define which 3 NTP servers will be called to get current GMT (time) from
// this information will be written into /etc/ntp.conf file if file_system.h will be included
// #define DEFAULT_NTP_SERVER_1 "1.si.pool.ntp.org" // <- replace with your information
// #define DEFAULT_NTP_SERVER_2 "2.si.pool.ntp.org" // <- replace with your information
// #define DEFAULT_NTP_SERVER_3 "3.si.pool.ntp.org" // <- replace with your information
// define time zone to calculate local time from GMT
// #define TZ "CET-1CEST,M3.5.0,M10.5.0/3" // default: Europe/Ljubljana, or select another (POSIX) time zones: https://github.com/nayarsystems/posix_tz_db/blob/master/zones.csv
// 2. FILE SYSTEM: #define which file system you want to use
// the file system must correspond to Tools | Partition scheme setting: FILE_SYSTEM_FAT (for FAT partition scheme), FILE_SYSTEM_LITTLEFS (for SPIFFS partition scheme) or FILE_SYSTEM_SD_CARD (if SC card is attached)
// FAT file system can be bitwise combined with FILE_SYSTEM_SD_CARD, like #define FILE_SYSTEM (FILE_SYSTEM_FAT | FILE_SYSTEM_SD_CARD)
#define FILE_SYSTEM FILE_SYSTEM_LITTLEFS // LittleFS uses the least of memory, which may be needed for all the functionalities to run
// 3. NETWORK: #define how ESP32 will use the network
// STA(tion)
// #define how ESP32 will connecto to WiFi router
// this information will be written into /etc/wpa_supplicant/wpa_supplicant.conf file if file_system.h will be included
// if these #definitions are missing STAtion will not be set up
#define DEFAULT_STA_SSID "YOUR_STA_SSID" // <- replace with your information
#define DEFAULT_STA_PASSWORD "YOUR_STA_PASSWORD" // <- replace with your information
// the use of DHCP or static IP address wil be set in /network/interfaces if file_system.h will be included, the following is information needed for static IP configuration
// if these #definitions are missing DHCP will be assumed
// #define DEFAULT_STA_IP "10.18.1.200" // <- replace with your information
// #define DEFAULT_STA_SUBNET_MASK "255.255.255.0" // <- replace with your information
// #define DEFAULT_STA_GATEWAY "10.18.1.1" // <- replace with your information
// #define DEFAULT_STA_DNS_1 "193.189.160.13" // <- replace with your information
// #define DEFAULT_STA_DNS_2 "193.189.160.23" // <- replace with your information
// A(ccess) P(oint)
// #define how ESP32 will set up its access point
// this information will be writte into /etc/dhcpcd.conf and /etc/hostapd/hostapd.conf files if file_system.h will be included
// if these #definitions are missing Access Point will not be set up
// #define DEFAULT_AP_SSID HOSTNAME // <- replace with your information,
// #define DEFAULT_AP_PASSWORD "YOUR_AP_PASSWORD" // <- replace with your information, at least 8 characters
// #define DEFAULT_AP_IP "192.168.0.1" // <- replace with your information
// #define DEFAULT_AP_SUBNET_MASK "255.255.255.0" // <- replace with your information
// define the name Esp32 will use as its host name
#define HOSTNAME "ESP32_oscilloscope" // <- replace with your information, max 32 bytes
// replace MACHINETYPE with your information if you want, it is only used in uname telnet command
#if CONFIG_IDF_TARGET_ESP32
#define MACHINETYPE "ESP32"
#elif CONFIG_IDF_TARGET_ESP32S2
#define MACHINETYPE "ESP32-S2"
#elif CONFIG_IDF_TARGET_ESP32S3
#define MACHINETYPE "ESP32-S3"
#elif CONFIG_IDF_TARGET_ESP32C3
#define MACHINETYPE "ESP32-C3"
#elif CONFIG_IDF_TARGET_ESP32C6
#define MACHINETYPE "ESP32-C6"
#elif CONFIG_IDF_TARGET_ESP32H2
#define MACHINETYPE "ESP32-H2"
#else
#define MACHINETYPE "ESP32 (other)"
#endif
// 4. USERS: #define what kind of user management you want before #including user_management.h
#define USER_MANAGEMENT NO_USER_MANAGEMENT // or UNIX_LIKE_USER_MANAGEMENT or HARDCODED_USER_MANAGEMENT
// if UNIX_LIKE_USER_MANAGEMENT is selected you must also include file_system.h to be able to use /etc/passwd and /etc/shadow files
// #define DEFAULT_ROOT_PASSWORD "rootpassword" // <- replace with your information if UNIX_LIKE_USER_MANAGEMENT or HARDCODED_USER_MANAGEMENT are used
// #define DEFAULT_WEBADMIN_PASSWORD "webadminpassword" // <- replace with your information if UNIX_LIKE_USER_MANAGEMENT is used
// #define DEFAULT_USER_PASSWORD "changeimmediatelly" // <- replace with your information if UNIX_LIKE_USER_MANAGEMENT is used
// 5. #include (or comment-out) the functionalities you want (or don't want) to use
#ifdef FILE_SYSTEM
#include "./servers/fileSystem.hpp" // most functionalities can run even without a file system if everything is stored in RAM (smaller web pages, ...)
#endif
#include "./servers/time_functions.h" // fileSystem.hpp is needed prior to #including time_functions.h if you want to store the default parameters
#include "./servers/netwk.h" // fileSystem.hpp is needed prior to #including network.h if you want to store the default parameters
// #include "./servers/httpClient.h" // support to access web pages from other servers and curl telnet command
// #include "./servers/ftpClient.h" // fileSystem.hpp is needed prior to #including ftpClient.h if you want to store the default parameters
// #include "./servers/smtpClient.h" // fileSystem.hpp is needed prior to #including smtpClient.h if you want to store the default parameters
#include "./servers/userManagement.hpp" // fileSystem.hpp is needed prior to #including userManagement.hpp in case of UNIX_LIKE_USER_MANAGEMENT
// #include "./servers/telnetServer.hpp" // needs almost all the above files for whole functionality, but can also work without them
#ifdef FILE_SYSTEM
#include "./servers/ftpServer.hpp" // fileSystem.hpp is also necessary to use ftpServer.h
#endif
#ifdef FILE_SYSTEM
// #define WEB_SESSIONS // comment this line out if you won't use web sessions
#endif
#define USE_I2S_INTERFACE // I2S interface improves web based oscilloscope analog sampling (of a single signal) if ESP32 board has one
// check INVERT_ADC1_GET_RAW and INVERT_I2S_READ #definitions in oscilloscope.h if the signals are inverted
#include "./servers/oscilloscope.h" // web based oscilloscope: you must #include httpServer.hpp as well to use it
#include "./servers/httpServer.hpp" // fileSystem.hpp is needed prior to #including httpServer.h if you want server also to serve .html and other files from built-in flash disk