Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

docs: Add a new variant (board) and "Generic System Clock configuration" #2557

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
thernstig opened this issue Nov 8, 2024 · 8 comments
Closed
Labels
documentation 📚 Improvements or additions to documentation enhancement New feature or request

Comments

@thernstig
Copy link
Contributor

I had a hard time understanding https://github.com/stm32duino/Arduino_Core_STM32/wiki/Add-a-new-variant-%28board%29#3---generic-system-clock-configuration.

I am quoting the parts I found hard and what I felt was missing/strange:

Go to Pinout tab, enable the desired peripherals which require specific clock configuration (not needed for peripherals clocked by HCLKx, or APBx clock): SDIO, USB, ... In this example only USB needs to be enabled as other peripherals default clock are correct by default.

What is "desired peripherals" here? How would I know what to enable?

Set PLL Source Mux to HSI.

There is no PLL Source Mux for the MCU I added in #2556. The sentence is written like it is something that should exist, but it does not seem true for all MCUs.

@thernstig thernstig added the enhancement New feature or request label Nov 8, 2024
@fpistm fpistm added the documentation 📚 Improvements or additions to documentation label Nov 8, 2024
@thernstig
Copy link
Contributor Author

In addition, this part:

6 - Restart
Restart Arduino IDE and try one of the new entry with the CheckVariant example.

It mentions nothing on how to do this on that above page. Should there have been a link to somewhere on how to load the new board into Arduino to test it?

@fpistm
Copy link
Member

fpistm commented Nov 9, 2024

The board should appears in the menu you add it that's all. Select it and voilà.

@thernstig
Copy link
Contributor Author

@fpistm I am talking about an unreleased version of Arduino_Core_STM32. Then the new board does not immediately show up in the JSON file does it?

@fpistm
Copy link
Member

fpistm commented Nov 9, 2024

Yes. I need to perform a release.
But if you use the git repository in the Arduino package you will see it.

@thernstig
Copy link
Contributor Author

thernstig commented Nov 9, 2024

@fpistm I think this part:

But if you use the git repository in the Arduino package you will see it.

Is not explained from https://github.com/stm32duino/Arduino_Core_STM32/wiki/Add-a-new-variant-%28board%29#6---restart.

How would one know how to do this? I just started with both Arduino and STM32, so consider it from a point from someone who never used these tools before (even though understanding the basics).

@fpistm
Copy link
Member

fpistm commented Nov 9, 2024

It is explained here: https://github.com/stm32duino/Arduino_Core_STM32/wiki/Using-git-repository

Feel free to propose update, it is a community project.

@thernstig
Copy link
Contributor Author

I would propose a lot more if I knew the answers 😆

@thernstig
Copy link
Contributor Author

Wrote #2559 as a separate issue.

The two core issues of this topic are still valid. I do not know how to update those as I have no idea what those parts in reality mean.

@stm32duino stm32duino locked and limited conversation to collaborators Nov 12, 2024
@fpistm fpistm converted this issue into discussion #2563 Nov 12, 2024

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
documentation 📚 Improvements or additions to documentation enhancement New feature or request
Projects
Development

No branches or pull requests

2 participants