Skip to content

need more documentation on -fqbn param #241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
gherlein opened this issue Aug 1, 2017 · 4 comments
Closed

need more documentation on -fqbn param #241

gherlein opened this issue Aug 1, 2017 · 4 comments
Assignees
Labels
conclusion: declined Will not be worked on topic: documentation Related to documentation for the project

Comments

@gherlein
Copy link

gherlein commented Aug 1, 2017

How does one construct the fqbn param?

How does one get a list of boards possible?

NOTE: this is similar to the --list-boards enhancement request earlier, but short of getting that can we at least get some examples and/or docs?

@Amertz08
Copy link

Ran into this issue too. Found the following.

https://forum.arduino.cc/index.php?topic=376923.0

I'm on Mac so for me it looks like from the root of my hardware folder /Applications/Arduino.app/Contents/Java/hardware/ I build my fqbn by looking at the folder and then the target in boards.txt so for me PATH_TO_HARDWARE/arduino/avr/boards.txt with a desired target of Arduino/Genuino Uno became arduino:avr:uno

Hope that helps and makes sense. But yeah documentation on that is lacking.

Adam

@adumont
Copy link

adumont commented Dec 21, 2018

Indeed.
My trick? Use Visual Studio Code, with the Arduino Extension. When you configure the board for sketch, it will create a new file called arduino.json under .vscode in your sketch directory, containing at least these three fields: sketch, board and configuration.

Here is an example:

{
    "sketch": "ESP-sc-gway.ino",
    "board": "esp8266:esp8266:d1_mini",
    "configuration": "CpuFrequency=80,VTable=flash,FlashSize=4M1M,LwIPVariant=v2mss536,Debug=Disabled,DebugLevel=None____,FlashErase=sdk,UploadSpeed=921600"
}

When building with VSCode, I noticed that it uses arduino-builder, and the -fqbn is esp8266:esp8266:d1_mini:CpuFrequency=80,VTable=flash,FlashSize=4M1M,LwIPVariant=v2mss536,Debug=Disabled,DebugLevel=None____,FlashErase=sdk,UploadSpeed=921600, which is the contatenation of board and configuration values.

At least that works for me :)

@per1234 per1234 added the topic: documentation Related to documentation for the project label Oct 14, 2021
@jjtmp
Copy link

jjtmp commented Aug 20, 2022

Ran into this issue too. Found the following.

https://forum.arduino.cc/index.php?topic=376923.0

Close. When you go to the link from @Amertz08 you get the hint to the redirect to https://arduino.github.io/arduino-cli/0.26/platform-specification/

The latter link is better than the former, I suppose. When you search for "fqbn" on the page you find even variants of providing additional details.

@per1234
Copy link
Contributor

per1234 commented Sep 27, 2022

Thanks @jjtmp for sharing the link to the platform specification. There is also some information about FQBN in the FAQ:

https://arduino.github.io/arduino-cli/latest/FAQ/#whats-the-fqbn-string

arduino-builder is deprecated in favor of Arduino CLI so no further documentation will be developed specific to arduino-builder, but it would be beneficial to improve the documentation about FQBNs in general. We are using arduino/arduino-cli#355 to track that task. I will close this issue in favor of that one. If anyone has additional information to share on the subject, feel free to comment in the other thread.

@per1234 per1234 closed this as not planned Won't fix, can't repro, duplicate, stale Sep 27, 2022
@per1234 per1234 added the conclusion: declined Will not be worked on label Sep 27, 2022
@per1234 per1234 self-assigned this Sep 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
conclusion: declined Will not be worked on topic: documentation Related to documentation for the project
Projects
None yet
Development

No branches or pull requests

5 participants