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>
52 lines
1.8 KiB
INI
52 lines
1.8 KiB
INI
; The indicated settings support placeholder substitution as follows:
|
|
;
|
|
; #{platform} - The microcontroller platform, e.g. "esp32" or "esp8266"
|
|
; #{unique_id} - A unique identifier derived from the MAC address, e.g. "0b0a859d6816"
|
|
; #{random} - A random number encoded as a hex string, e.g. "55722f94"
|
|
|
|
[factory_settings]
|
|
build_flags =
|
|
; WiFi settings
|
|
-D FACTORY_WIFI_SSID=\"\"
|
|
-D FACTORY_WIFI_PASSWORD=\"\"
|
|
-D FACTORY_WIFI_HOSTNAME=\"#{platform}-#{unique_id}\" ; supports placeholders
|
|
|
|
; Access point settings
|
|
-D FACTORY_AP_PROVISION_MODE=AP_MODE_DISCONNECTED
|
|
-D FACTORY_AP_SSID=\"ESP8266-React-#{unique_id}\" ; 1-64 characters, supports placeholders
|
|
-D FACTORY_AP_PASSWORD=\"esp-react\" ; 8-64 characters
|
|
-D FACTORY_AP_LOCAL_IP=\"192.168.4.1\"
|
|
-D FACTORY_AP_GATEWAY_IP=\"192.168.4.1\"
|
|
-D FACTORY_AP_SUBNET_MASK=\"255.255.255.0\"
|
|
|
|
; User credentials for admin and guest user
|
|
-D FACTORY_ADMIN_USERNAME=\"admin\"
|
|
-D FACTORY_ADMIN_PASSWORD=\"admin\"
|
|
-D FACTORY_GUEST_USERNAME=\"guest\"
|
|
-D FACTORY_GUEST_PASSWORD=\"guest\"
|
|
|
|
; NTP settings
|
|
-D FACTORY_NTP_ENABLED=true
|
|
-D FACTORY_NTP_TIME_ZONE_LABEL=\"Europe/London\"
|
|
-D FACTORY_NTP_TIME_ZONE_FORMAT=\"GMT0BST,M3.5.0/1,M10.5.0\"
|
|
-D FACTORY_NTP_SERVER=\"time.google.com\"
|
|
|
|
; OTA settings
|
|
-D FACTORY_OTA_PORT=8266
|
|
-D FACTORY_OTA_PASSWORD=\"esp-react\"
|
|
-D FACTORY_OTA_ENABLED=true
|
|
|
|
; MQTT settings
|
|
-D FACTORY_MQTT_ENABLED=false
|
|
-D FACTORY_MQTT_HOST=\"test.mosquitto.org\"
|
|
-D FACTORY_MQTT_PORT=1883
|
|
-D FACTORY_MQTT_USERNAME=\"\" ; supports placeholders
|
|
-D FACTORY_MQTT_PASSWORD=\"\"
|
|
-D FACTORY_MQTT_CLIENT_ID=\"#{platform}-#{unique_id}\" ; supports placeholders
|
|
-D FACTORY_MQTT_KEEP_ALIVE=60
|
|
-D FACTORY_MQTT_CLEAN_SESSION=true
|
|
-D FACTORY_MQTT_MAX_TOPIC_LENGTH=128
|
|
|
|
; JWT Secret
|
|
-D FACTORY_JWT_SECRET=\"#{random}-#{random}\" ; supports placeholders
|