Extending PlatformIO

nicklasb · April 24, 2023, 10:47am

Exactly! There scripts are run at the time of installation, which is when I need to install menu items and so forth. If it is run at build time, one has to run build several times and refresh the project.
This is too late, especially if the build depends on defaults from the KConfigs.

ivankravets · April 24, 2023, 12:05pm

Could you simplify the use case so that I can reproduce it on my machine? Or, a simple PlatformIO project as a ZIP archive?

nicklasb · April 24, 2023, 12:22pm

Just add this to your libdeps to a non-esp-idf project:

Run the build.

As you’ll see, that will not add the “Run menuconfig” target until you reload the project (sometimes it also needs that one edits platformio.ini. Also, it obviously cannot remove the target on uninstall.

Basically, I need to be able run this part:

github.com

nicklasb/robusto-platformio/blob/af974fe96834e609665c070db3197991267c689b/scripts/kconfig-build.py#L64


      
          
          
          #def add_menu(source, target, env):
          print("IN ADD MENU ---------------------------------------")
          curr_env = env.subst('$PIOENV')
          curr_dir = os.path.join(env.subst('$PROJECT_LIBDEPS_DIR'), curr_env, "Robusto-PlatformIO", "scripts")
          
          # Co we need to add a menuconfig target?
          targets = global_env.get("__PIO_TARGETS") or {}
          
          if "menuconfig" not in targets.values() and framework.lower() != "espidf":
              menuconfig_cmd = "python {0} {1} ".format(
                  os.path.join(curr_dir, "run_menuconfig.py"),curr_env
                  )
              print("Adding target, command: {0}".format(menuconfig_cmd))
              global_env.AddTarget(
                  name="menuconfig",
                  dependencies=None,
                  group="General",
                  actions=[
                      menuconfig_cmd

…in scripts postinstall, and a corresponding removal of the target it in the preuninstall.
The script I want to run the code is this one, specified in the library.json scripts section:

github.com

nicklasb/robusto-platformio/blob/main/scripts/post-install.py

import os

result = ""
for i, l in sorted(os.environ.items()):     
    result += i + ' : ' + l + '\n'

file_text = open("output.txt", "w")
file_text.write(result)
file_text.close()

In there, I want to access all environments and add the targets on all of them.

But I haven’t succeeded in getting hold of the build environment.
The post-install-runner.py is a symptom of me desperately trying to run post-install.py in various contexts.

ivankravets · April 24, 2023, 2:31pm

You don’t need pre/post install scripts for this case
Add include/robusto.h empty file to your library
Add #include "robusto.h" to any C/C++ file in the project src directory.

In this case, your library(plugin) will be loaded always.

nicklasb · April 24, 2023, 3:00pm

I don’t understand, or maybe I am very unclear, but the library itself is not a C library at all.

This is an implementation of KConfig/menuconfig that sort of does what the ESP-IDF platform does, but for any other framework, thus extending PlatformIO.

It creates menuconfig files and adds generation of headers that creates #define:s for all the settings one might have in one’s project.

At install time, I need to add the targets so that the user can click the “Run Menuconfig”-action.
And if one would uninstall it, it needs to clean those up.

ivankravets · April 24, 2023, 4:04pm

Targets are dynamic. The IDEs use pio run --list-targets to fetch the list of them. When you open project in the VSCode, we load targets one time and use them later.

nicklasb · April 24, 2023, 4:19pm

Ok, however it seems like I can list them in the build stage?
Maybe I’ll have to call that to enumerate them, are there ways to add targets that way too?