Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 5 additions & 5 deletions _data/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@

- title: Basic Tutorials
docs:
- tutorials/getting_started
- tutorials/getting_started_embedded
- tutorials/getting_started_simulator
- tutorials/basic/getting_started
- tutorials/basic/getting_started_embedded
- tutorials/basic/getting_started_simulator

- title: Advanced Tutorials
docs:
- tutorials/advanced/nuttx_getting_started
- tutorials/advanced/debugging-gdb-openocd
- tutorials/advanced/debugging-vscode
- tutorials/advanced/debugging_gdb_openocd
- tutorials/advanced/debugging_vscode
- tutorials/advanced/6lowpan_nuttx_rpi

- title: Concepts
Expand Down
1 change: 1 addition & 0 deletions _docs/concepts/rtos/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Real-Time Operating Systems (RTOS)
permalink: /docs/concepts/rtos/
redirect_from: /docs/concepts/
---

# RTOS
Expand Down
1 change: 1 addition & 0 deletions _docs/overview/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Overview
permalink: /docs/overview/
redirect_from: /docs/
---

[micro-ROS](https://cordis.europa.eu/project/rcn/213167_en.html) puts ROS2 onto microcontrollers, making them first class participants of the ROS 2 environment.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Debugging a NuttX target with GDB and OpenOCD
permalink: /docs/tutorials/advanced/debugging_gdb_openocd/
author: Ingo Lütkebohle
permalink: /docs/tutorials/advanced/debugging-gdb-openocd/
---

Rare is the program that works on the first try -- so you will usually need a debugger. This is even more true on an embedded device, where "printf"-style debugging is very cumbersome.
Expand Down Expand Up @@ -133,7 +133,7 @@ In my case, this is the NSH thread which is waiting for some input.
This concludes this basic tutorial on getting gdb to run with OpenOCD and NuttX support.

Using gdb on the command line is considered a bit cumbersome by many. So if you know your way
around an IDE with gdb support, integrating it should be easy. We leave that as an exercise
around an IDE with gdb support, integrating it should be easy. We leave that as an exercise
for the reader ;-)

There are also IDEs with microcontroller support -- stay tuned for another tutorial with more
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Debugging with Visual Studio Code
permalink: /docs/tutorials/advanced/debugging-vscode/
permalink: /docs/tutorials/advanced/debugging_vscode/
author: Ingo Lütkebohle
---

Expand Down Expand Up @@ -63,9 +63,9 @@ As in the gdb tutorial, initially you won't see much because the program is stop

### Adding an SVD File

You may have noticed that on the left-hand side, there is a sub-window called "Cortex Peripherals" which simply states "No SVD File loaded". SVD means "System View Description" and is a standard format which microcontroller vendors use to describe the available features of their MCUs.
You may have noticed that on the left-hand side, there is a sub-window called "Cortex Peripherals" which simply states "No SVD File loaded". SVD means "System View Description" and is a standard format which microcontroller vendors use to describe the available features of their MCUs.

For example, in the case of our STM32-E407 board, which features an STM32F407ZGT6 MCU, we can download the SVD description from [STM's web-page for the STM32F407ZG series](https://www.st.com/en/microcontrollers-microprocessors/stm32f407zg.html). In the "HW Model, CAD Libraries & SVD", you will find a link to the [STM32F4 series SVD](https://www.st.com/resource/en/svd/stm32f4_svd.zip).
For example, in the case of our STM32-E407 board, which features an STM32F407ZGT6 MCU, we can download the SVD description from [STM's web-page for the STM32F407ZG series](https://www.st.com/en/microcontrollers-microprocessors/stm32f407zg.html). In the "HW Model, CAD Libraries & SVD", you will find a link to the [STM32F4 series SVD](https://www.st.com/resource/en/svd/stm32f4_svd.zip).

Extract the SVD and then add an `svdFile` attribute to the launch configuration. The full configuration will look like this:

Expand Down
11 changes: 0 additions & 11 deletions _docs/tutorials/advanced/index.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Getting Started with your computer (WIP)
permalink: /docs/tutorials/getting_started/
permalink: /docs/tutorials/basic/getting_started/
redirect_from: /docs/tutorials/basic/
redirect_from: /docs/tutorials/
---

Table of contents
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Getting Started with an embedded board (WIP)
permalink: /docs/tutorials/getting_started_embedded/
permalink: /docs/tutorials/basic/getting_started_embedded/
---

Table of contents
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Getting Started with simulator (WIP)
permalink: /docs/tutorials/getting_started_simulator/
permalink: /docs/tutorials/basic/getting_started_simulator/
author: Iñigo Muguruza Goenaga, Juan Muñoz Flores
---

Expand Down
4 changes: 2 additions & 2 deletions _includes/topnav.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
<div id="navbar" class="collapse navbar-collapse">
<ul class="nav navbar-nav">
<li {% if page.path contains '_docs/overview' %} class="active" {% endif %}><a href="{{ "/docs/overview/" | prepend: site.baseurl }}">Overview</a></li>
<li {% if page.path contains '_docs/concepts' %} class="active" {% endif %}><a href="{{ "/docs/concepts/rtos" | prepend: site.baseurl }}">Concepts</a></li>
<li {% if page.path contains '_docs/tutorials' %} class="active" {% endif %}><a href="{{ "/docs/tutorials/getting_started" | prepend: site.baseurl }}">Tutorials</a></li>
<li {% if page.path contains '_docs/concepts' %} class="active" {% endif %}><a href="{{ "/docs/concepts/" | prepend: site.baseurl }}">Concepts</a></li>
<li {% if page.path contains '_docs/tutorials' %} class="active" {% endif %}><a href="{{ "/docs/tutorials/" | prepend: site.baseurl }}">Tutorials</a></li>
<li {% if page.sectionid=='posts' %} class="active" {% endif %}><a href="{{ site.posts.first.url | prepend: site.baseurl }}">Blog</a></li>
</ul>
<ul class="nav navbar-nav navbar-right">
Expand Down