e771ab134a
* Use text formatting for default factory values to produce dynamic names.
Header files contains duplicates of factory values defined in factory_settings.ini Removed them to simplify the code.
* Use text formatting for default factory values to produce dynamic names.
Header files contains duplicates of factory values defined in factory_settings.ini Removed them to simplify the code.
* Configured the WiFi host name to contain the device id by default
* Removed possibility to use placeholders for FACTORY_WIFI_SSID factory setting.
* Update README.md
Updated documentation
* Use text formatting for default factory values to produce dynamic names.
Header files contains duplicates of factory values defined in factory_settings.ini Removed them to simplify the code.
* Configured the WiFi host name to contain the device id by default
* Removed possibility to use placeholders for FACTORY_WIFI_SSID factory setting.
* Added a space to the end of the file to comply project code style
* fix typos
clang formatting
use 2 spaces in ini files
use ${platform}-${chip_id} for hostname
put chip id in brackets in AP SSID
* restore (and update) factory setting ifndefs
- this is so src can be built without an exaustive set build-time defines
- standardize ordering of defines: factory settings, paths, config
* format and modify comment
* escape spaces in pio defines
experiment with removing $'s from our format strings (they are being substituted with empty values by pio)
* fix formatting in readme
rename FactoryValue to SettingValue, put in own header
give example of direct usage of FactorySetting::format in README.md
* auto format
* use hash to delimit placeholders
* fix factory_settings.ini
* remove flash string helpers
* format ini file
* use MAC address instead of chip id for properly unique identifier
* use lower case hex encoding for unique id
use chip id and unique id for more secure secret
* fix comment
* Use random values for JWT secret
Arduino uses the ESP random number generator for "true random" numbers on both esp32 and esp8266
This makes a better JWT secret and may be useful for other factory defaults too
In addition a modification has been made to force the FSPersistance to save the file if applying defaults
* Don't use spaces in default AP SSID
* restore helpful comment in factory_settings.ini
fix default defines
Co-authored-by: kasedy <kasedy@gmail.com>
125 lines
3.3 KiB
C++
125 lines
3.3 KiB
C++
#ifndef APSettingsConfig_h
|
|
#define APSettingsConfig_h
|
|
|
|
#include <SettingValue.h>
|
|
#include <HttpEndpoint.h>
|
|
#include <FSPersistence.h>
|
|
#include <JsonUtils.h>
|
|
|
|
#include <DNSServer.h>
|
|
#include <IPAddress.h>
|
|
|
|
#ifndef FACTORY_AP_PROVISION_MODE
|
|
#define FACTORY_AP_PROVISION_MODE AP_MODE_DISCONNECTED
|
|
#endif
|
|
|
|
#ifndef FACTORY_AP_SSID
|
|
#define FACTORY_AP_SSID "ESP8266-React-#{unique_id}"
|
|
#endif
|
|
|
|
#ifndef FACTORY_AP_PASSWORD
|
|
#define FACTORY_AP_PASSWORD "esp-react"
|
|
#endif
|
|
|
|
#ifndef FACTORY_AP_LOCAL_IP
|
|
#define FACTORY_AP_LOCAL_IP "192.168.4.1"
|
|
#endif
|
|
|
|
#ifndef FACTORY_AP_GATEWAY_IP
|
|
#define FACTORY_AP_GATEWAY_IP "192.168.4.1"
|
|
#endif
|
|
|
|
#ifndef FACTORY_AP_SUBNET_MASK
|
|
#define FACTORY_AP_SUBNET_MASK "255.255.255.0"
|
|
#endif
|
|
|
|
#define AP_SETTINGS_FILE "/config/apSettings.json"
|
|
#define AP_SETTINGS_SERVICE_PATH "/rest/apSettings"
|
|
|
|
#define MANAGE_NETWORK_DELAY 10000
|
|
|
|
#define AP_MODE_ALWAYS 0
|
|
#define AP_MODE_DISCONNECTED 1
|
|
#define AP_MODE_NEVER 2
|
|
|
|
#define DNS_PORT 53
|
|
|
|
enum APNetworkStatus { ACTIVE = 0, INACTIVE, LINGERING };
|
|
|
|
class APSettings {
|
|
public:
|
|
uint8_t provisionMode;
|
|
String ssid;
|
|
String password;
|
|
IPAddress localIP;
|
|
IPAddress gatewayIP;
|
|
IPAddress subnetMask;
|
|
|
|
bool operator==(const APSettings& settings) const {
|
|
return provisionMode == settings.provisionMode && ssid == settings.ssid && password == settings.password &&
|
|
localIP == settings.localIP && gatewayIP == settings.gatewayIP && subnetMask == settings.subnetMask;
|
|
}
|
|
|
|
static void read(APSettings& settings, JsonObject& root) {
|
|
root["provision_mode"] = settings.provisionMode;
|
|
root["ssid"] = settings.ssid;
|
|
root["password"] = settings.password;
|
|
root["local_ip"] = settings.localIP.toString();
|
|
root["gateway_ip"] = settings.gatewayIP.toString();
|
|
root["subnet_mask"] = settings.subnetMask.toString();
|
|
}
|
|
|
|
static StateUpdateResult update(JsonObject& root, APSettings& settings) {
|
|
APSettings newSettings = {};
|
|
newSettings.provisionMode = root["provision_mode"] | FACTORY_AP_PROVISION_MODE;
|
|
switch (settings.provisionMode) {
|
|
case AP_MODE_ALWAYS:
|
|
case AP_MODE_DISCONNECTED:
|
|
case AP_MODE_NEVER:
|
|
break;
|
|
default:
|
|
newSettings.provisionMode = AP_MODE_ALWAYS;
|
|
}
|
|
newSettings.ssid = root["ssid"] | SettingValue::format(FACTORY_AP_SSID);
|
|
newSettings.password = root["password"] | FACTORY_AP_PASSWORD;
|
|
|
|
JsonUtils::readIP(root, "local_ip", newSettings.localIP, FACTORY_AP_LOCAL_IP);
|
|
JsonUtils::readIP(root, "gateway_ip", newSettings.gatewayIP, FACTORY_AP_GATEWAY_IP);
|
|
JsonUtils::readIP(root, "subnet_mask", newSettings.subnetMask, FACTORY_AP_SUBNET_MASK);
|
|
|
|
if (newSettings == settings) {
|
|
return StateUpdateResult::UNCHANGED;
|
|
}
|
|
settings = newSettings;
|
|
return StateUpdateResult::CHANGED;
|
|
}
|
|
};
|
|
|
|
class APSettingsService : public StatefulService<APSettings> {
|
|
public:
|
|
APSettingsService(AsyncWebServer* server, FS* fs, SecurityManager* securityManager);
|
|
|
|
void begin();
|
|
void loop();
|
|
APNetworkStatus getAPNetworkStatus();
|
|
|
|
private:
|
|
HttpEndpoint<APSettings> _httpEndpoint;
|
|
FSPersistence<APSettings> _fsPersistence;
|
|
|
|
// for the captive portal
|
|
DNSServer* _dnsServer;
|
|
|
|
// for the mangement delay loop
|
|
volatile unsigned long _lastManaged;
|
|
volatile boolean _reconfigureAp;
|
|
|
|
void reconfigureAP();
|
|
void manageAP();
|
|
void startAP();
|
|
void stopAP();
|
|
void handleDNS();
|
|
};
|
|
|
|
#endif // end APSettingsConfig_h
|