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>
56 lines
1.3 KiB
C++
56 lines
1.3 KiB
C++
#include <SettingValue.h>
|
|
|
|
namespace SettingValue {
|
|
|
|
#ifdef ESP32
|
|
const String PLATFORM = "esp32";
|
|
#elif defined(ESP8266)
|
|
const String PLATFORM = "esp8266";
|
|
#endif
|
|
|
|
/**
|
|
* Returns a new string after replacing each instance of the pattern with a value generated by calling the provided
|
|
* callback.
|
|
*/
|
|
String replaceEach(String value, String pattern, String (*generateReplacement)()) {
|
|
while (true) {
|
|
int index = value.indexOf(pattern);
|
|
if (index == -1) {
|
|
break;
|
|
}
|
|
value = value.substring(0, index) + generateReplacement() + value.substring(index + pattern.length());
|
|
}
|
|
return value;
|
|
}
|
|
|
|
/**
|
|
* Generates a random number, encoded as a hex string.
|
|
*/
|
|
String getRandom() {
|
|
return String(random(2147483647), HEX);
|
|
}
|
|
|
|
/**
|
|
* Uses the station's MAC address to create a unique id for each device.
|
|
*/
|
|
String getUniqueId() {
|
|
uint8_t mac[6];
|
|
#ifdef ESP32
|
|
esp_read_mac(mac, ESP_MAC_WIFI_STA);
|
|
#elif defined(ESP8266)
|
|
wifi_get_macaddr(STATION_IF, mac);
|
|
#endif
|
|
char macStr[13] = {0};
|
|
sprintf(macStr, "%02x%02x%02x%02x%02x%02x", mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
|
|
return String(macStr);
|
|
}
|
|
|
|
String format(String value) {
|
|
value = replaceEach(value, "#{random}", getRandom);
|
|
value.replace("#{unique_id}", getUniqueId());
|
|
value.replace("#{platform}", PLATFORM);
|
|
return value;
|
|
}
|
|
|
|
}; // end namespace SettingValue
|