-
Notifications
You must be signed in to change notification settings - Fork 2k
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
doc: add board selection guide #19606
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the idea. Spotted a couple of typos and the tone of some entries in the table is not my taste.
boards/doc.txt
Outdated
| nucleo-64 | Development | o/+/++ | ✔ | ✗ | + (Uno) | Custom | o (1 buttons, 1 LED) | + | ++ | Good bang for the buck | | ||
| nucleo-144 | Development | +/++/+++ | ✔ | (✔) (some have Ethernet) | ++ (Uno, Mega) | Custom | + (1 buttons, 3 LEDs) | + | ++ | Good bang for the buck | | ||
| samr21-xpro | Development | + | ✔ | ✔ (802.15.4) | ✗ | Custom | o (1 buttons, 1 LED) | + | -- | Too expensive | | ||
| samr34-xpro | Development | ++ | ✔ | ✔ (LoRa) | ✗ | Custom | o (1 buttons, 2 LEDs) | + | --- | Got a spare kidney to sell? | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| samr34-xpro | Development | ++ | ✔ | ✔ (LoRa) | ✗ | Custom | o (1 buttons, 2 LEDs) | + | --- | Got a spare kidney to sell? | | |
| samr34-xpro | Development | ++ | ✔ | ✔ (LoRa) | ✗ | Custom | o (1 buttons, 2 LEDs) | + | --- | Quite expensive | |
For LoRa, there are also the b-l072z-lrwan1 and the nucleo-wl55. Both have Arduino compatible headers and on-board St-Link
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thx for the pointer, added them both
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I commented out the b-l072z-lrwan1 again, as the doc of the board is non-existent. I would like to only have boards with robust support and decent doc in the list, so that people buying one of the boards do have a good start.
boards/doc.txt
Outdated
| esp32-wroom-32 | Prototyping | +++ | ✗ | ✔ (WiFi, BLE, custom) | ✗ | Custom | - (1 button) | +++ | +++ | Requires proprietary software | | ||
| microbit-v2 | Education | ++ | ✔ | ✔ (802.15.4, BLE, custom) | ✗ | Custom | +++ (6 buttons, LED matrix, mic, speaker, IMO) | -- | ++ | Good education board | | ||
| nrf52840dk | Development | ++ | ✔ | ✔ (802.15.4, BLE, custom) | +++ (Uno, Mega) | Custom | + (4 buttons, 4 LEDs) | + | + | Excellent boarder router | | ||
| nrf52840dongle | Prototyping | ++ | ✗ | ✔ (802.15.4, BLE, custom) | ✗ | Custom | o (1 buttons, 4 LEDs) | ++ | ++ | Good wireless dev board | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are boards like nRF52840 MDK USB Dongle which are not per se a clone, but identical in all relevant properties. Should we list them here, or is that better addressed on the individual pages?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
Not merging immediately to give @aabadie a chance to object to the kidney comment not having been changed (I like it).
342fe29
to
e13b3c4
Compare
All green |
bors merge |
Build succeeded! The publicly hosted instance of bors-ng is deprecated and will go away soon. If you want to self-host your own instance, instructions are here. If you want to switch to GitHub's built-in merge queue, visit their help page. |
Contribution description
This adds a board selection guide to the documentation to aid new users picking good hardware for their use case.
Testing procedure
Check the generated documentation.
Issues/PRs references
fixes #18021