nRF Connect for VSCode - How to make jlink the default runner for flashing a device

RE: nRF Connect for VSCode - How to make jlink the default runner for flashing a device

Priyanka — Tue, 30 May 2023 07:26:29 GMT

Hi Ravi,

The solution would be to remove the buildConfigs entry in the nrf-connect.taskBindings setting's flash entry. This, for example, will run the task Custom build to all build configurations:

"nrf-connect.taskBindings": {
                "build": [
                        {
                                "taskName": "Custom build",
                        }
                ]
        },

Please refer this documentation.

If you defined the board yourself though, you should specify the default runner for the board in the board's cmake file, and not override it in VS Code. See https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/zephyr/hardware/porting/board_porting.html#flash-and-debug-support

-Priyanka

RE: nRF Connect for VSCode - How to make jlink the default runner for flashing a device

Priyanka — Tue, 30 May 2023 05:44:09 GMT

Hi Ravi,

I am yet to hear from the internal team. We have just resumed working today as it was a public holiday yesterday. I will get back to you as soon as I hear from the team.

-Priyanka

RE: nRF Connect for VSCode - How to make jlink the default runner for flashing a device

zpm1066 — Thu, 25 May 2023 21:46:12 GMT

Hello Priyanka,

Did you get a response regarding the following?

It would be preferable to have the "Flash" action run the jlink as runner for all the projects in the nRF Connect Workspace and remove the need for "<YOUR-APP-FOLDER>" in the path "${workspaceFolder}/<YOUR-APP-FOLDER>/build".

Is there a way to use the currently selected build path to avoid specifying "<YOUR-APP-FOLDER>" explicitly?

Thanks.

RE: nRF Connect for VSCode - How to make jlink the default runner for flashing a device

Priyanka — Mon, 22 May 2023 08:20:57 GMT

Hi Ravi,

Thank you for your feedback and suggestion. I have conveyed them internally and will get back to you with a response.

RE: nRF Connect for VSCode - How to make jlink the default runner for flashing a device

zpm1066 — Fri, 19 May 2023 16:16:13 GMT

Hi Priyanka,

There is a question from my previous message that is still outstanding.

How do I modify the above task so that the "Flash" action runs the jlink as the runner for all the projects in the nRF Connect Workspace?

As it stands, I would need to explicitly specify a <YOUR-APP-FOLDER>" in the path "${workspaceFolder}/<YOUR-APP-FOLDER>/build" for each project in the nRF Connect Workspace. It’s not a desirable approach.

Please check if the above ask is possible. If not, an enhancement to "nRF Connect for VSCode" extension settings to select a "runner" of choice would be the way to go.

Thank you.

RE: nRF Connect for VSCode - How to make jlink the default runner for flashing a device

Priyanka — Fri, 19 May 2023 05:53:03 GMT

Hi,

Glad to hear that you got it running. I will forward your concerns and suggestions to the internal team. 🙂

Have a nice weekend.

-Priyanka

RE: nRF Connect for VSCode - How to make jlink the default runner for flashing a device

zpm1066 — Tue, 16 May 2023 23:59:51 GMT

Hi Priyanka,

With your suggestion above and assistance from Florian , I'm able to flash a device with jlink as the runner.

Here's in full the task and binding sections.

<project>.code-workspace file > "settings:" > ""nrf-connect.taskBindings:", add

	"flash": [
	    { 	"taskName": "jlink flash" ,
			"buildConfigs":[
			"${workspaceFolder}/<YOUR-APP-FOLDER>/build"
			]
		}
	]

<project>.code-workspace file, add the following. I'm using NCS 2.3 as "/path/to/zephyr".

    "tasks": {
        "version": "2.0.0",
        "tasks": [
            {
                "label": "jlink flash",
                "options":{"env": {"ZEPHYR_BASE": "/opt/nordic/ncs/v2.3.0/zephyr"}},
                "command": "west flash --runner=jlink --dev-id YOUR_DEVICE_ID -d ${workspaceFolder}/<YOUR-APP-FOLDER>/build",
                "type": "shell",
                "args": [],
                "presentation": {
                    "clear": true,
                    "reveal": "always"
                },
                "group": "build"
            }
        ]
    },

The above task and action works fine. However, as it stands, I would have to create a separate task/bind for each of my projects in the nRF Connect Workspace.

It would be preferable to have the "Flash" action run the jlink as runner for all the projects in the nRF Connect Workspace and remove the need for "<YOUR-APP-FOLDER>" in the path "${workspaceFolder}/<YOUR-APP-FOLDER>/build".

Is there a way to use the currently selected build path to avoid specifying "<YOUR-APP-FOLDER>" explicitly?

I don't want to have explicit task/bind actions for all my projects in the workspace. I would think nRF Connect would know the build path of the currently selected project.

The best option would be an enhancement to "nRF Connect for VSCode" extension, i.e. select a "runner" of choice in the nRF Connect extension (pyocd, jlink).

I'm quite surprised that such an option doesn't already exist. I'm sure quite a lot of nRF Connect developers utilize jlink.

How can I submit an enhancement request for nRF Connect for VSCode? Or is this something that you can raise?

Please consider the proposed enhancement request. Thank you. Your assistance is much appreciated.

RE: nRF Connect for VSCode - How to make jlink the default runner for flashing a device

Priyanka — Tue, 16 May 2023 08:06:34 GMT

This is an environment issue.

You can set

"options": {"env": {"ZEPHYR_BASE": "/path/to/zephyr"}} for the task, pointing to your own zephyr installation.

Unfortunately, the ${nrf-connect.sdk} shorthand only works in the settings.

RE: nRF Connect for VSCode - How to make jlink the default runner for flashing a device

Priyanka — Tue, 16 May 2023 05:25:31 GMT

Thanks for the update. I will get back to you soon.

-Priyanka

RE: nRF Connect for VSCode - How to make jlink the default runner for flashing a device

zpm1066 — Mon, 15 May 2023 17:41:20 GMT

Hi Priyanka,

Thanks.

I can now execute a shell command from a binded task. However, "west flash --runner jlink" doesn't flash the hex file for the current project, see error below.

How can I resolve the issue so that "jlink flash" task uses the current project and Zephyr environment?

From within the VSCode terminal window for the current project, I can use "west flash --runner jlink" to flash device fine.

Executing task in folder nRF_Connect_Projects: west flash --runner jlink

usage: west [-h] [-z ZEPHYR_BASE] [-v] [-V] <command> ...
west: error: argument <command>: invalid choice: 'flash' (choose from 'init', 'update', 'list', 'manifest', 'diff', 'status', 'forall', 'help', 'config', 'topdir', 'selfupdate')

* The terminal process "/usr/local/bin/bash '-c', 'west flash --runner jlink'" terminated with exit code: 2.
* Terminal will be reused by tasks, press any key to close it.

RE: nRF Connect for VSCode - How to make jlink the default runner for flashing a device

Priyanka — Mon, 15 May 2023 08:43:27 GMT

Hi Ravi,

It seems that it should work. Are you setting it properly?

{
        "label": "west flash",
        "type": "shell",
        "command": "west flash --runner jlink",
}

RE: nRF Connect for VSCode - How to make jlink the default runner for flashing a device

Priyanka — Mon, 15 May 2023 05:32:27 GMT

Hi Ravi,

Apologies for the delay as it was the weekend, but I am yet to hear back from the team. I will let you know as soon as I get a response.

RE: nRF Connect for VSCode - How to make jlink the default runner for flashing a device

zpm1066 — Fri, 12 May 2023 16:27:23 GMT

Hi Priyanka,

Any updates? Thanks.

RE: nRF Connect for VSCode - How to make jlink the default runner for flashing a device

Priyanka — Wed, 10 May 2023 13:36:09 GMT

Thank you for sharing the snippet. I will discuss this with experts and get back to you soon.

-Priyanka

RE: nRF Connect for VSCode - How to make jlink the default runner for flashing a device

zpm1066 — Wed, 10 May 2023 12:22:03 GMT

Hi Priyanka,

Yes, I can call "west flash" from a command line or use "-DBOARD_FLASH_RUNNER" compile flag to get the runner to be jlink. What I'm looking for is a less cumbersome option.

It would be much easier, if the nRF extension had a setting to select the a "runner" of choice. It's something that Nordic should consider.

It looks like that binding a task to the "Flash" action is the next best option and offers high customization.

I've reviewed https://nrfconnect.github.io/vscode-nrf-connect/guides/build_bind_tasks.html, where you have an example of how to bind a task to an action.

Here's what I tried. However, when I click "Flash", the default runner "pyocd" gets invoked.

		"nrf-connect.taskBindings": {
			"pristineBuild": [
				{
					"taskName": "Build [pristine]: ble/build",
					"buildConfigs": [
						"${workspaceFolder}/ble/build",
						"${workspaceFolder}/ethernet_hub_ble/build"
					]
				}
			],
			"flash": [{ "taskName": "jlink flash" }]
		}
	},

...
...
...

 {
    "tasks": [``
    {
		"version": "2.0.0",
		"label": "jlink flash",
		"command": "${workspaceFolder}/jlink_flash.sh",
		"args": ["--build", "--erase", "--nrf52"],
		"presentation": {
			"echo": true,
			"reveal": "never",
			"clear": true,
        }
    }
		]
 },

The "${workspaceFolder}/jlink_flash.sh" script below simply runs the jlink runner and works fine from a command line.

west flash --runner jlink

I'm trying to bind a task to "Flash" action but it's not working. Obviously, I'm doing something incorrect and the fix is mostly likely quite simple.

Please review and let me know what I'm doing wrong. Thank you.

RE: nRF Connect for VSCode - How to make jlink the default runner for flashing a device

Priyanka — Wed, 10 May 2023 05:24:58 GMT

Hi Ravi,
The "tasks" entry should be an array. Also there does not seem to be any proof that his script is actually called or what the content of that script is.

Instead of calling a custom script in the task, it is simpler to call west flash, like:
"command": "west", "args": ["flash", "--runner", ...] .

In order to confirm that the task is called correctly. please share the output of the terminal window that executed the flash task.

-Priyanka

RE: nRF Connect for VSCode - How to make jlink the default runner for flashing a device

Priyanka — Tue, 09 May 2023 06:44:29 GMT

Hi Ravi,

I have asked internally regarding this and will get back to you with a response, soon.

Best Regards,

Priyanka