search

rogerclarkmelbourne / Arduino_STM32

Arduino STM32. Hardware files to support STM32 boards, on Arduino IDE 1.8.x including LeafLabs Maple and other generic STM32F103 boards
Other
2.52k stars 1.26k forks source link

better platform.txt subject headings #761

Closed ag88 closed 3 years ago

ag88 commented 4 years ago

in stm32duino.com forum, there are often users who installed both official cores and libmaple core. and they are often confused about which core is it while reporting issues.

i'd like to suggest we add the word libmaple, in the platform.txt name define so that they appear in the Arduino IDE boards subject headings https://github.com/rogerclarkmelbourne/Arduino_STM32/blob/master/STM32F1/platform.txt#L6 https://github.com/rogerclarkmelbourne/Arduino_STM32/blob/master/STM32F4/platform.txt#L6

stevstrong commented 3 years ago

Roger, what is your opinion on this?

rogerclarkmelbourne commented 3 years ago

Umm.

Since I gave the stm32duino.com domain to STM (free of charge), and STM have been using that name as a trademark even prior to me giving them the domain, I agree it should be changed.

However, I'm not 100% sure what the the name could be

Possibly just "Arduino_STM32" to match this repo ?

I'm not sure everyone will know what "libmaple" means, because its a long time since LeafLabs abandoned this core.

stevstrong commented 3 years ago

Maybe (Arduino_STM32 aka Libmaple) ?

rogerclarkmelbourne commented 3 years ago

Perhaps

Libmaple/ArduinoSTM32

stevstrong commented 3 years ago

That is promising :)

rogerclarkmelbourne commented 3 years ago

@ag88

Comments?

zoomx commented 3 years ago

LibmapleRCM/ArduinoSTM32 just to be sure not be confused with the original Libmaple?

ag88 commented 3 years ago

Hi Roger, all,Thanks for your response.You can decide on a name you feel comfortable with. My main motivation is simply due to that new users who installed both the official core and this sees stm32duino.com on the board menus in the Arduino IDE. Hence, they confuse this with the official STM core when they post their questions in the forum. As in that when we asked the new user what core are they using, they often reply to that they don't know and yet they are asking questions about the STM32duino cores.Hence, it suffices if we can distinguish this core in the board menus, by asking the user what do they see on the menu. E.g. if they see Arduino_STM32 it is, this core, otherwise it is not. I've originally suggested libmaple as this core is based around libmaple from leaflabs. 

stevstrong commented 3 years ago

I would stick to Roger's suggestion, I think (Libmaple/ArduinoSTM32) would describe correctly the core.

fpistm commented 3 years ago

From my point of view, stm32duino means stm32 support in Arduino. stm32duino Libmaple or something like that. Why not also mention Roger as it relies on your GH username?

Note that with the last Arduino IDE the menu has been reworked to group by arch.

rogerclarkmelbourne commented 3 years ago

It doesn't need to have any mention of me in the name.

I think RCM etc, would just be confusing.

I just did a google search for "libmaple" and was very surprised to find that the original Leaflabs repo , is still top of the list, as are the next 3 hits.

So, this seems to indicate that not many people realise this repo is the active derivative of LibMaple

And perhaps even including LibMaple in the name would be confusing.

As the big difference between this repo and the STM32 official core, is that it doesn't use the HAL, perhaps this could be included in the name. But then again, perhaps hardly anyone would understand "non-HAL"or some similar text

BTW. I never expected people to still be using this core several years after the HAL core was available.

stevstrong commented 3 years ago

Yes, it seems Libmaple repository to be the first result, but it is marked as retired. So I think mentioning Libmaple here would not be wrong. Maybe then (Libmaple-based)? Or simply (Arduino_STM32)?

fpistm commented 3 years ago

Don't know if you used the latest Arduino IDE, this is how the menu is displayed now: image

Note that like tools directories have a boards.txt they are displayed.

ag88 commented 3 years ago

In a sense we have maintained and enhanced libmaple core introducing various fixes and improvements. To the credit of the origins, I'd think it is appropriate to mention this as a libmaple core. I kind of remember one of the fixes I added is for uart hardware serial. It now drop bytes with corrupted stop bits or parity errors. This makes various sketches that expects a clean connection work more reliably. E.g when a connected board is reset, the spurious invalid bytes is discarded. Many others have contributed other fixes.

stevstrong commented 3 years ago

If anyone has problems with that, just post here.