Skip to content

Add basic stats reporting to blinky. #144

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

Merged
merged 1 commit into from
Nov 28, 2018

Conversation

kegilbert
Copy link
Contributor

Acts as an update to the quick start experience. Moving from:

https://github.com/armmbed/mbed-os-quick-start-blinky to this repo to avoid having old versions floating around.

@janjongboom @bulislaw @SenRamakri


* [Mbed OS Stats API](https://os.mbed.com/docs/latest/apis/mbed-statistics.html)
* [Mbed OS Configuration](https://os.mbed.com/docs/latest/reference/configuration.html)
* [Mbed OS Serial Communication](https://os.mbed.com/docs/latest/tutorials/serial-communication.html)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kegilbert - Maybe we can point to other stats examples as well - https://github.com/ARMmbed/mbed-os-example-cpu-stats

Copy link
Contributor Author

@kegilbert kegilbert Nov 27, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The stats API link has examples on that page inline that are pulled from the teams repo which is copied from the github repo (quite the path...). I can add the github links as well if we'd like a direct link to the Github hosted examples (the docs site does lose the README info).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the stats API link has the links already we ca skip adding them here.

Copy link

@SenRamakri SenRamakri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall this looks good to me.

@cmonr cmonr requested a review from a team November 27, 2018 17:02
@kegilbert
Copy link
Contributor Author

@janjongboom Does that look a bit nicer?

@janjongboom
Copy link
Contributor

janjongboom commented Nov 28, 2018

@kegilbert Ack, I think stdint is not required if we include mbed.h, but OK. Isn't mbed_stats.h required here too or is this now included automatically?

{
"target_overrides": {
"*": {
"platform.stdio-baud-rate": 115200,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should check with docs team if changing this will require docs change too, as we now need to specify the baud rate in any place where we mention serial.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quick start makes mention of it, but pinging @AnotherButler to double check.

Copy link
Contributor

@0xc0170 0xc0170 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

style + license fix needed. Some documentation for SystemReport would be nice, this is first demo that anyone runs

Basically this is still blinky if I don't connect/or ignore serial output.

@kegilbert
Copy link
Contributor Author

kegilbert commented Nov 28, 2018

@0xc0170 Ran through astyle and added headers and some rudimentary comments. I initially had everything in just a header file due to its size but can break it out to a proper file format as the additional comments are making it a bit larger.

@SenRamakri Added the ROM/RAM reporting stats as well. Along with that and the refactoring may want to double check it.

@janjongboom mbed_stats.h was added to mbed.h recently: https://github.com/ARMmbed/mbed-os/blob/master/mbed.h#L100

@cmonr cmonr dismissed 0xc0170’s stale review November 28, 2018 20:17

Styling and license changes addressed.

@kegilbert
Copy link
Contributor Author

@0xc0170 Updated, thanks for the catch!

Acts as an update to the quick start experience
Update license notes
Copy link
Contributor

@cmonr cmonr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@cmonr cmonr merged commit 991939f into ARMmbed:master Nov 28, 2018
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.

5 participants