Skip to content

Quickstart baremetal notes #965

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.

Sign up for GitHub

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 6 commits into from
Mar 1, 2019
Merged

Quickstart baremetal notes #965

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
47ac927
Add bare-metal build instructions to quick start guide
kegilbert Feb 26, 2019
0a04a21
Remove hardcoded expected serial output.
kegilbert Feb 26, 2019
d6fed97
Disable JSON snippet from running in CI
kegilbert Feb 26, 2019
8111567
Edit cli_code.md
Feb 26, 2019
88c2279
Delete comma in example_walkthrough.md
Feb 26, 2019
31a6d87
Edit quick-start-compiler.md
Feb 26, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion docs/tutorials/quickstart/cli_code.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,20 @@

```console
$ mbed compile --target K64F --toolchain ARM --flash
```
```

The `--flash` argument automatically flashes the compiled program onto your board if it is connected to your computer.

<span class="tips">**Tip:** You can get the name of the board plugged into your computer by running `mbed detect`, and you can get a full list of supported toolchains and targets by running the `mbed compile --supported` command.</span>

<span class="notes">**Note:** To build with the Mbed OS bare metal profile, add `"requires": ["bare-metal"]` to the `mbed_app.json` file:

```NOCI
{
"requires": ["bare-metal"],
"target_overrides": {
"*": {
```
</span>

1. Press the board's reset button. The LED blinks.
42 changes: 3 additions & 39 deletions docs/tutorials/quickstart/example_walkthrough.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,45 +10,9 @@ The default baud rate, or speed, for this application is set to `9600`. You can

<span class="tips">**Tip:** You can find more information on the Mbed OS configuration tools and serial communication in Mbed OS in the [related links section](#related-links).</span>

The output transmits the following block at the blinking LED frequency (actual values may vary depending on your target, build profile and toolchain):

```
=============================== SYSTEM INFO ================================
Mbed OS Version: 999999
CPU ID: 0x410fc241
Compiler ID: 2
Compiler Version: 60300
RAM0: Start 0x20000000 Size: 0x30000
RAM1: Start 0x1fff0000 Size: 0x10000
ROM0: Start 0x0 Size: 0x100000
================= CPU STATS =================
Idle: 98% Usage: 2%
================ HEAP STATS =================
Current heap: 1096
Max heap size: 1096
================ THREAD STATS ===============
ID: 0x20001eac
Name: main_thread
State: 2
Priority: 24
Stack Size: 4096
Stack Space: 3296

ID: 0x20000f5c
Name: idle_thread
State: 1
Priority: 1
Stack Size: 512
Stack Space: 352

ID: 0x20000f18
Name: timer_thread
State: 3
Priority: 40
Stack Size: 768
Stack Space: 664

```
The output transmits the system, CPU, heap and thread information.

<span class="notes">**Note:** If you are building with the Mbed OS bare metal profile, you will not get thread information.</span>

#### Understanding the output

Expand Down
10 changes: 10 additions & 0 deletions docs/tutorials/quickstart/quick-start-compiler.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,16 @@ Alternatively, you may select the import button on the top left hand side of the

<span class="images">![](https://s3-us-west-2.amazonaws.com/mbed-os-docs-images/online_compile_button.png)</span>

<span class="notes">**Note:** To build with the Mbed OS bare metal profile, add `"requires": ["bare-metal"]` to the `mbed_app.json` file:

```NOCI
{
"requires": ["bare-metal"],
"target_overrides": {
"*": {
```
</span>

1. Open the folder where the executable file was downloaded, and then click and drag (or copy and paste) the file to your Mbed board's USB device folder.

1. Press the board's reset button.