Skip to content

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

Closed

Conversation

kegilbert
Copy link
Contributor

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

[ ] Fix
[ ] Refactor
[ ] Target update
[ ] Functionality change
[ ] Docs update
[X] Test update
[ ] Breaking change

@kegilbert kegilbert changed the title Add new quick-start blink example Add new quick-start blinky example Nov 15, 2018
@cmonr
Copy link
Contributor

cmonr commented Nov 15, 2018

So I've gotta ask.

A new blinky? What's the motivation? Should the old one be deprecated?

@kegilbert
Copy link
Contributor Author

kegilbert commented Nov 15, 2018

@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.

@SenRamakri

@studavekar
Copy link
Contributor

@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.

@kegilbert
Copy link
Contributor Author

Was putting it in here to:

  1. Get test coverage on it
  2. Be included in Anna's script to automagically create Mbed OS release tags/update the mbed-os.lib file on each Mbed OS release.

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).

@adbridge
Copy link
Contributor

@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.

@kegilbert
Copy link
Contributor Author

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

@NirSonnenschein
Copy link
Contributor

/morph build

@mbed-ci
Copy link

mbed-ci commented Nov 18, 2018

Build : SUCCESS

Build number : 3667
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/8762/

Triggering tests

/morph test
/morph export-build
/morph mbed2-build

@mbed-ci
Copy link

mbed-ci commented Nov 18, 2018

@mbed-ci
Copy link

mbed-ci commented Nov 18, 2018

@0xc0170
Copy link
Contributor

0xc0170 commented Nov 19, 2018

Waiting for more approvals for this. I reviewed the example (created one issue that should be addressed soon).

@mbed-ci
Copy link

mbed-ci commented Nov 22, 2018

Test run: SUCCESS

Summary: 4 of 4 test jobs passed
Build number : 2
Build artifacts
Build logs

@0xc0170 0xc0170 removed the rollup PR label Nov 22, 2018
@0xc0170
Copy link
Contributor

0xc0170 commented Nov 22, 2018

Exporters should be restarted, prior doing that, we still need approvals for this inclusion

Copy link
Member

@bulislaw bulislaw left a 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

@SenRamakri
Copy link
Contributor

@kegilbert - I was under the impression that the new blinky will supersede the old blinky example. Are we going to keep both?

@cmonr
Copy link
Contributor

cmonr commented Nov 26, 2018

@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.

@bulislaw
Copy link
Member

bulislaw commented Nov 26, 2018

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).

@cmonr
Copy link
Contributor

cmonr commented Nov 26, 2018

Exporter CI restarted.

@cmonr
Copy link
Contributor

cmonr commented Nov 26, 2018

Think this needs to be resolved by a combination of @bulislaw @SenRamakri and @kegilbert

@janjongboom
Copy link
Contributor

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.

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 (mbed-blinky, mbed-os-example-blinky, and whatever this new one is).

I'd say we remove all old blinky's instead of deprecation.

@cmonr
Copy link
Contributor

cmonr commented Nov 26, 2018

@janjongboom Where is mbed-blinky? This one I was not aware of.

@janjongboom
Copy link
Contributor

@cmonr The Mbed 2 Blinky which is still listed at every platform page (and the most imported library in online compiler).

@kegilbert
Copy link
Contributor Author

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.

@kegilbert
Copy link
Contributor Author

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.

@cmonr
Copy link
Contributor

cmonr commented Nov 27, 2018

Will keep this open for a bit, but ARMmbed/mbed-os-example-blinky#144 sounds like the right thing to do here.

@bulislaw
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants