🔧 Add date, version to Config Export

Author: thinkyhead

Marlin/Configuration_adv.h

@@ -35,9 +35,9 @@
 // @section develop
 
 /**
- * Configuration Dump
+ * Configuration Export
  *
- * Dump the configuration as part of the build. (See signature.py)
+ * Export the configuration as part of the build. (See signature.py)
  * Output files are saved with the build (e.g., .pio/build/mega2560).
  *
  * See `build_all_examples --ini` as an example of config.ini archiving.
@@ -48,7 +48,7 @@
  *  3 = schema.json - The entire configuration schema. (13 = pattern groups)
  *  4 = schema.yml - The entire configuration schema.
  */
-//#define CONFIG_DUMP   // :[1:'JSON', 2:'config.ini', 3:'schema.json', 4:'schema.yml']
+//#define CONFIG_EXPORT   // :[1:'JSON', 2:'config.ini', 3:'schema.json', 4:'schema.yml']
 
 //===========================================================================
 //============================= Thermal Settings ============================

Marlin/base.ini

@@ -4,12 +4,20 @@
 #
 [config:base]
 ini_use_config                           = none
-#ini_use_config                          = base.ini, another.ini
-#ini_use_config                          = example/Creality/Ender-5 Plus
-#ini_use_config                          = https://me.myserver.com/path/to/configs
-#ini_use_config                          = base
-#config_dump                             = 2
 
+# Load all config: sections in this file
+;ini_use_config                          = all
+# Load config file relative to Marlin/
+;ini_use_config                          = another.ini
+# Download configurations from GitHub
+;ini_use_config                          = example/Creality/Ender-5 Plus @ bugfix-2.1.x
+# Download configurations from your server
+;ini_use_config                          = https://me.myserver.com/path/to/configs
+# Evaluate config:base and do a config dump
+;ini_use_config                          = base
+;config_export                           = 2
+
+[config:minimal]
 motherboard                              = BOARD_RAMPS_14_EFB
 serial_port                              = 0
 baudrate                                 = 250000

Marlin/config.ini

@@ -18,7 +18,7 @@ def apply_opt(name, val, conf=None):
 	if name == "lcd": name, val = val, "on"
 
 	# Create a regex to match the option and capture parts of the line
-	regex = re.compile(r'^(\s*)(//\s*)?(#define\s+)(' + name + r'\b)(\s*)(.*?)(\s*)(//.*)?$', re.IGNORECASE)
+	regex = re.compile(rf'^(\s*)(//\s*)?(#define\s+)({name}\b)(\s*)(.*?)(\s*)(//.*)?$', re.IGNORECASE)
 
 	# Find and enable and/or update all matches
 	for file in ("Configuration.h", "Configuration_adv.h"):
@@ -87,6 +87,9 @@ def fetch_example(path):
 	if path.endswith("/"):
 		path = path[:-1]
 
+	if '@' in path:
+		path, brch = map(strip, path.split('@'))
+
 	url = path.replace("%", "%25").replace(" ", "%20")
 	if not path.startswith('http'):
 		url = "https://raw.githubusercontent.com/MarlinFirmware/Configurations/bugfix-2.1.x/config/%s" % url

buildroot/share/PlatformIO/scripts/configuration.py

@@ -95,7 +95,7 @@ class Parse:
 	# Regex for #define NAME [VALUE] [COMMENT] with sanitized line
 	defgrep = re.compile(r'^(//)?\s*(#define)\s+([A-Za-z0-9_]+)\s*(.*?)\s*(//.+)?$')
 	# Defines to ignore
-	ignore = ('CONFIGURATION_H_VERSION', 'CONFIGURATION_ADV_H_VERSION', 'CONFIG_DUMP')
+	ignore = ('CONFIGURATION_H_VERSION', 'CONFIGURATION_ADV_H_VERSION', 'CONFIG_EXPORT')
 	# Start with unknown state
 	state = Parse.NORMAL
 	# Serial ID

buildroot/share/PlatformIO/scripts/schema.py

@@ -1,8 +1,10 @@
 #
 # signature.py
 #
-import subprocess,re,json,hashlib
 import schema
+
+import subprocess,re,json,hashlib
+from datetime import datetime
 from pathlib import Path
 
 #
@@ -112,9 +114,9 @@ def compute_build_signature(env):
 		defines[key] = value if len(value) else ""
 
 	#
-	# Continue to gather data for CONFIGURATION_EMBEDDING or CONFIG_DUMP
+	# Continue to gather data for CONFIGURATION_EMBEDDING or CONFIG_EXPORT
 	#
-	if not ('CONFIGURATION_EMBEDDING' in defines or 'CONFIG_DUMP' in defines):
+	if not ('CONFIGURATION_EMBEDDING' in defines or 'CONFIG_EXPORT' in defines):
 		return
 
 	# Second step is to filter useless macro
@@ -157,18 +159,32 @@ def tryint(key):
 		except:
 			return 0
 
-	config_dump = tryint('CONFIG_DUMP')
+	config_dump = tryint('CONFIG_EXPORT')
 
 	#
-	# Produce an INI file if CONFIG_DUMP == 2
+	# Produce an INI file if CONFIG_EXPORT == 2
 	#
 	if config_dump == 2:
 		print("Generating config.ini ...")
-		ignore = ('CONFIGURATION_H_VERSION', 'CONFIGURATION_ADV_H_VERSION', 'CONFIG_DUMP')
-		filegrp = { 'Configuration.h':'config:basic', 'Configuration_adv.h':'config:advanced' }
 		config_ini = build_path / 'config.ini'
 		with config_ini.open('w') as outfile:
-			outfile.write('#\n# Marlin Firmware\n# config.ini - Options to apply before the build\n#\n')
+			ignore = ('CONFIGURATION_H_VERSION', 'CONFIGURATION_ADV_H_VERSION', 'CONFIG_EXPORT')
+			filegrp = { 'Configuration.h':'config:basic', 'Configuration_adv.h':'config:advanced' }
+			vers = defines["CONFIGURATION_H_VERSION"]
+			dt_string = datetime.now().strftime("%Y-%m-%d at %H:%M:%S")
+			ini_fmt = '{0:40}{1}\n'
+			outfile.write(
+				'#\n'
+				+ '# Marlin Firmware\n'
+				+ '# config.ini - Options to apply before the build\n'
+				+ '#\n'
+				+ f'# Generated by Marlin build on {dt_string}\n'
+				+ '#\n'
+				+ '\n'
+				+ '[config:base]\n'
+				+ ini_fmt.format('ini_use_config', ' = all')
+				+ ini_fmt.format('ini_config_vers', f' = {vers}')
+			)
 			# Loop through the data array of arrays
 			for header in data:
 				if header.startswith('__'):
@@ -177,10 +193,10 @@ def tryint(key):
 				for key in sorted(data[header]):
 					if key not in ignore:
 						val = 'on' if data[header][key] == '' else data[header][key]
-						outfile.write('{0:40}{1}'.format(key.lower(), ' = ' + val) + '\n')
+						outfile.write(ini_fmt.format(key.lower(), ' = ' + val))
 
 	#
-	# Produce a schema.json file if CONFIG_DUMP == 3
+	# Produce a schema.json file if CONFIG_EXPORT == 3
 	#
 	if config_dump >= 3:
 		try:
@@ -191,7 +207,7 @@ def tryint(key):
 
 		if conf_schema:
 			#
-			# Produce a schema.json file if CONFIG_DUMP == 3
+			# Produce a schema.json file if CONFIG_EXPORT == 3
 			#
 			if config_dump in (3, 13):
 				print("Generating schema.json ...")
@@ -201,7 +217,7 @@ def tryint(key):
 					schema.dump_json(conf_schema, build_path / 'schema_grouped.json')
 
 			#
-			# Produce a schema.yml file if CONFIG_DUMP == 4
+			# Produce a schema.yml file if CONFIG_EXPORT == 4
 			#
 			elif config_dump == 4:
 				print("Generating schema.yml ...")
@@ -226,7 +242,7 @@ def tryint(key):
 		pass
 
 	#
-	# Produce a JSON file for CONFIGURATION_EMBEDDING or CONFIG_DUMP == 1
+	# Produce a JSON file for CONFIGURATION_EMBEDDING or CONFIG_EXPORT == 1
 	#
 	if config_dump == 1 or 'CONFIGURATION_EMBEDDING' in defines:
 		with marlin_json.open('w') as outfile: