Simplify application #192

hugueskamba · 2019-10-11T11:56:45Z

Description

The example project has been re-written to be simplified. It uses a delay within
a loop. As it is single-threaded, it showcases that some of Mbed OS
APIs can be used both with and without rtos (using Mbed OS bare metal profile).
Instructions are also provided to build the simple blinky application with
Mbed OS bare metal profile.

Runtime statistics has been removed and is only mentioned in the README. The
reader is invited to find out more. Runtime statistics is a topic on its own
and should not be implemented here.

The example project also exposes the user to Mbed OS parameter configuration
option.

bulislaw · 2019-10-11T12:20:05Z

main.cpp

-        }
-        ++count;
-    }
+#ifndef MBED_BARE_METAL


Could we try to simplify it and maybe showcase that some of the RTOS APIs can be used both with and without rtos? I'd like the code for blinky not to go over 1 screen it has to be simple and clear. Your example for RTOS is nice, but it my opinion it fits more exactly as RTOS example. Also adding short explanation in README what is the difference between normal and bare metal modes with link to docs would be useful.

Re-worked it including your feedback acdb35f

README.md

AnotherButler

We should make sure we're not making changes for the sake of making changes. Some of the README wording changes, for example, keep the same content but rearrange it.

README.md

The application has been re-written to use inter-thread communication in order to blink the LED. It now shows how threads can be created, started and how they can communicate with each other. Runtime statistics are made optional via an application configuration file. Instructions have been provided to use the configuration to enable runtime statistics to be printed on the serial output. Finally, a configuration file has been provided to build the application with Mbed OS bare metal profile

The example project has been re-written to include variants of an application to blink an LED. The variants include a simple variant that uses a delay within a loop and a more complex that creates threads and shows inter-thread communication. As the simpler variant is single-threaded, it showcases that some of Mbed OS APIs can be used both with and without rtos (using Mbed OS bare metal profile). Instructions are also provided to build the simple blinky application with Mbed OS bare metal profile. Runtime statistics has been removed and is only mentioned in the README. The reader is invited to find out more. Runtime statistics is a topic on its own and should not be implemented here. The example project also exposes the user to Mbed OS parameter configuration option.

The test was checking the serial output from the runtime stats. Runtime stats have been removed.

…ranch

evedon

I like the simplicity of the example.

mbed-os.lib

README.md

bulislaw

Looks good could we clearly reference the other forms of blinky somewhere at the top? That is baremetal and eventqueue. It would be good to briefly explain the difference and their purpose.

evedon · 2019-11-01T12:09:19Z

Looks good could we clearly reference the other forms of blinky somewhere at the top? That is baremetal and eventqueue. It would be good to briefly explain the difference and their purpose.

We are providing links at the bottom of the page for further references. I think it's better than the top so that the reader can get straight to the "getting started`' example. @hugueskamba you can add a link to https://os.mbed.com/docs/mbed-os/v5.14/tutorials/the-eventqueue-api.html for the eventqueue

evedon · 2019-11-01T12:11:16Z

@AnotherButler could you check the latest version please?

AnotherButler

@evedon Please forgive all of the suggested changes. I usually edit these directly, but I don't have permissions for this repo.

We'll need to update the quick start documentation next.

@Wenchou01 @sophewilliams From a UX perspective, do you have any concerns about only having quick start for both the full and bare metal configurations?

README.md

AnotherButler · 2019-11-01T19:11:11Z

README.md


+## Troubleshooting
 If you have problems, you can review the [documentation](https://os.mbed.com/docs/latest/tutorials/debugging.html) for suggestions on what could be wrong and how to fix it.

 ## Related Links

 * [Mbed OS Stats API](https://os.mbed.com/docs/latest/apis/mbed-statistics.html)


Suggested change

* [Mbed OS Stats API](https://os.mbed.com/docs/latest/apis/mbed-statistics.html)

* [Mbed OS Stats API](https://os.mbed.com/docs/latest/apis/mbed-statistics.html).

AnotherButler · 2019-11-01T19:11:17Z

README.md


+## Troubleshooting
 If you have problems, you can review the [documentation](https://os.mbed.com/docs/latest/tutorials/debugging.html) for suggestions on what could be wrong and how to fix it.

 ## Related Links

 * [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)


Suggested change

* [Mbed OS Configuration](https://os.mbed.com/docs/latest/reference/configuration.html)

* [Mbed OS Configuration](https://os.mbed.com/docs/latest/reference/configuration.html).

AnotherButler · 2019-11-01T19:11:25Z

README.md


+## Troubleshooting
 If you have problems, you can review the [documentation](https://os.mbed.com/docs/latest/tutorials/debugging.html) for suggestions on what could be wrong and how to fix it.

 ## Related Links

 * [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)


Suggested change

* [Mbed OS Serial Communication](https://os.mbed.com/docs/latest/tutorials/serial-communication.html)

* [Mbed OS Serial Communication](https://os.mbed.com/docs/latest/tutorials/serial-communication.html).

README.md

Co-Authored-By: Amanda Butler <[email protected]>

evedon · 2019-11-04T09:45:26Z

@AnotherButler You now have write access. Please check latest corrections. Thanks.

Add/change punctuation to follow our style guide for consistency across documents.

AnotherButler

Looks good 👍

hugueskamba requested review from bulislaw, AnotherButler and evedon October 11, 2019 11:56

bulislaw reviewed Oct 11, 2019

View reviewed changes

hugueskamba changed the title ~~Use threads comms to blink and add baremetal version~~ Add application variants and Mbed OS bare metal tutorial Oct 12, 2019

hugueskamba force-pushed the hk-multi-threaded-blinky-and-baremetal branch 6 times, most recently from acdb35f to 512a54a Compare October 14, 2019 06:26

rajkan01 reviewed Oct 14, 2019

View reviewed changes

README.md Outdated Show resolved Hide resolved

rajkan01 reviewed Oct 14, 2019

View reviewed changes

README.md Outdated Show resolved Hide resolved

AnotherButler suggested changes Oct 14, 2019

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

hugueskamba force-pushed the hk-multi-threaded-blinky-and-baremetal branch from 512a54a to e069957 Compare October 14, 2019 13:21

hugueskamba added 4 commits October 15, 2019 14:18

Remove multithreaded application

007b92b

Remove tests as no longer relevant

b3e0e50

The test was checking the serial output from the runtime stats. Runtime stats have been removed.

hugueskamba force-pushed the hk-multi-threaded-blinky-and-baremetal branch from 5dabd86 to b3e0e50 Compare October 15, 2019 13:20

hugueskamba added 2 commits October 15, 2019 14:23

Correct the last force push resulting from rebasing from the master b…

9f4477f

…ranch

Marked the example as official

3e5b7df

hugueskamba changed the title ~~Add application variants and Mbed OS bare metal tutorial~~ Simplify application and add Mbed OS bare metal tutorial Oct 15, 2019

evedon reviewed Oct 15, 2019

View reviewed changes

hugueskamba added 2 commits October 16, 2019 07:57

Addressing PR review comments and adding a smaller badge

2f96047

Remove bare metal information in the project

2022670

evedon requested changes Oct 29, 2019

View reviewed changes

bulislaw approved these changes Oct 30, 2019

View reviewed changes

hugueskamba added 2 commits October 30, 2019 15:36

Merge branch 'master' into hk-multi-threaded-blinky-and-baremetal

8b7730c

Move supported toolchain info to the "Building and Running" section

0010085

hugueskamba added 3 commits October 30, 2019 15:46

Add an "Expected output" section to README.

96c4eba

Add information about importing to the online compiler.

77b6b31

Say that the example is part of the official Mbed OS examples

effcefb

0xc0170 approved these changes Oct 31, 2019

View reviewed changes

hugueskamba changed the title ~~Simplify application and add Mbed OS bare metal tutorial~~ Simplify application Oct 31, 2019

Add commands to download the project with git clone and mbed import.

1b45642

evedon approved these changes Nov 1, 2019

View reviewed changes

AnotherButler reviewed Nov 1, 2019

View reviewed changes

hugueskamba and others added 2 commits November 4, 2019 07:39

Apply suggestions from code review

5213199

Co-Authored-By: Amanda Butler <[email protected]>

Correct indentation

de2bd2c

Add nitpicky punctuation

4eb2565

Add/change punctuation to follow our style guide for consistency across documents.

AnotherButler approved these changes Nov 4, 2019

View reviewed changes

evedon merged commit 885f1eb into ARMmbed:master Nov 4, 2019

hugueskamba deleted the hk-multi-threaded-blinky-and-baremetal branch November 5, 2019 07:40

jamesbeyond mentioned this pull request Nov 7, 2019

TESTS: turn off blinky log compare test due to example changed ARMmbed/mbed-os#11833

Merged

	* [Mbed OS Stats API](https://os.mbed.com/docs/latest/apis/mbed-statistics.html)
	* [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 Configuration](https://os.mbed.com/docs/latest/reference/configuration.html).

	* [Mbed OS Serial Communication](https://os.mbed.com/docs/latest/tutorials/serial-communication.html)
	* [Mbed OS Serial Communication](https://os.mbed.com/docs/latest/tutorials/serial-communication.html).

Simplify application #192

Simplify application #192

Uh oh!

Conversation

hugueskamba commented Oct 11, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

bulislaw Oct 11, 2019

Choose a reason for hiding this comment

Uh oh!

hugueskamba Oct 12, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

AnotherButler left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

evedon left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bulislaw left a comment

Choose a reason for hiding this comment

Uh oh!

evedon commented Nov 1, 2019

Uh oh!

evedon commented Nov 1, 2019

Uh oh!

AnotherButler left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AnotherButler Nov 1, 2019

Choose a reason for hiding this comment

Uh oh!

AnotherButler Nov 1, 2019

Choose a reason for hiding this comment

Uh oh!

AnotherButler Nov 1, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

evedon commented Nov 4, 2019

Uh oh!

AnotherButler left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

hugueskamba commented Oct 11, 2019 •

edited

Loading

hugueskamba Oct 12, 2019 •

edited

Loading