Add variants_dir support to pio build, allowing local variants in project repos (earlephilhower#1911)

josephduchesne · web-flow · commit 15eb459df907 · 2023-12-26T09:59:45.000-08:00
diff --git a/tools/platformio-build.py b/tools/platformio-build.py
@@ -321,9 +321,15 @@ def configure_network_flags(cpp_defines):
 
 variant = board.get("build.arduino.earlephilhower.variant", board.get("build.variant", ""))
 
+# The following 3 lines are adapted from espressif/arduino-esp32, also licensed under apache2
+variants_dir = os.path.join(FRAMEWORK_DIR, "variants")
+
+if "build.variants_dir" in board:
+    variants_dir = os.path.join("$PROJECT_DIR", board.get("build.variants_dir"))
+
 if variant != "":
     env.Append(CPPPATH=[
-        os.path.join(FRAMEWORK_DIR, "variants", variant)
+        os.path.join(variants_dir, variant)
     ])
 
     env.Append(CPPDEFINES=[
@@ -335,7 +341,7 @@ def configure_network_flags(cpp_defines):
     # otherwise weak function overriding won't work in the linking stage.
     env.BuildSources(
         os.path.join("$BUILD_DIR", "FrameworkArduinoVariant"),
-        os.path.join(FRAMEWORK_DIR, "variants", variant))
+        os.path.join(variants_dir, variant))
 
 libs.append(
     env.BuildLibrary(
