-
Notifications
You must be signed in to change notification settings - Fork 3k
Add new quick-start blinky example #8762
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
Add new quick-start blinky example #8762
Conversation
So I've gotta ask. A new blinky? What's the motivation? Should the old one be deprecated? |
@cmonr Very good question! There's been an ongoing request to improve our Getting Started Guide. As a part of that we've had requests to move to a more in-depth example. Our goal was to keep a very simplistic starting application to allow users to focus on and learn the general Mbed OS workflow and ecosystem before being hit in the face with the full might of the OS, while adding some additional functionality to highlight a bit more how the OS works and what it has to offer. To that end the new default quick start example will link to https://github.com/armmbed/mbed-os-quick-start-blinky which is blinky with the addition of printed runtime device stats. This introduces users to serial, the config system, and show cases a bit more of what is going on behind the scenes of the OS when making an LED blink. Let me know your thoughts on the new example! I've been reaching out to a small set of preliminary reviewers but thought I'd get this up and allow feedback from everyone before the week closes out. #8761 will allow me to cleanup the rather gross compiler config guard in the beginning of main, so that will be heavily reduced soon. The existing blink is fine as is in my opinion and will not require a deprecation. |
@kegilbert nice to see more invloved blicky quickstart. Changes in example.json looks good, However was thinking if example is the right place for the quick start. |
Was putting it in here to:
I'm open to suggestions for other areas if you think this is the wrong place for it (not particularly knowledgeable of tools at the moment). |
@kegilbert You will also need to get Mihail to run this through his magic script to get a version on os.mbed.com so it can be easily imported into the online compiler. |
Pinged @screamerbg earlier today (end of his work day unfortunately), waiting to here back. In the meantime the quick start development page is using this format to import into the online compiler: https://os.mbed.com/docs/v5.10/apis/analogin.html#analogin-hello-world |
/morph build |
Build : SUCCESSBuild number : 3667 Triggering tests/morph test |
Exporter Build : FAILUREBuild number : 3271 |
Test : FAILUREBuild number : 3441 |
Waiting for more approvals for this. I reviewed the example (created one issue that should be addressed soon). |
Test run: SUCCESSSummary: 4 of 4 test jobs passed |
Exporters should be restarted, prior doing that, we still need approvals for this inclusion |
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 don't want yet another blinky example. Why not change the existing one? @SenRamakri
@kegilbert - I was under the impression that the new blinky will supersede the old blinky example. Are we going to keep both? |
@SenRamakri If that's the case, then 1) the commit should update the examples list to remove the blinky example, and 2) a deprecation notice on the old blinky should be added, pointing to the new repo. I'm curious. Has anyone from our groups that regularly interact with customers chimed on on this? @MarceloSalazar or @janjongboom perhaps? There's something to be said about having a simple and basic blinky example, because it serves as a checkmark when a user is getting started, in that if it doesn't "just work", there's almost always something else wrong. |
All the PRs need to be engineering ready (marked as "needs: CI") by the end of the day (Austin time). Otherwise it won't make 5.11 and will need to come in the next release (5.12 for features, 5.11.1 for fixes and new platforms). |
Exporter CI restarted. |
Think this needs to be resolved by a combination of @bulislaw @SenRamakri and @kegilbert |
Why do we need a new repo? Why is this not merged into mbed-os-example-blinky? We all know that deprecation does not work, and then we'll have three blinky's ( I'd say we remove all old blinky's instead of deprecation. |
@janjongboom Where is |
@cmonr The Mbed 2 Blinky which is still listed at every platform page (and the most imported library in online compiler). |
I'm not particularly opposed to replacing the old blinky, just wasn't sure at the time if that was what we had wanted. I can move the new repo to the existing blinky repo. |
ARMmbed/mbed-os-example-blinky#144 If the above is approved this PR can just be scrapped as the repo name won't change. I'll coordinate with @iriark01 and @AnotherButler on updating the quick start doc links/image updates. |
Will keep this open for a bit, but ARMmbed/mbed-os-example-blinky#144 sounds like the right thing to do here. |
I'll close it, we don't need more noise in 5.11 PR list. Feel free to reopen it if there's a reason for that. |
Description
Add the new Quick Start blinky application to the examples test page. Run on all available targets and toolchains by default.
Pull request type