You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Review and fix not working links and other web-site usability readability issues. (#26)
* Fix broken link and improve consistency with rest of concepts pages.
* Fix 404 errors on tutorials.
* Fix anchor points.
* Use correct product names, micro-ROS and Micro XRCE-DDS.
* Fix broken links.
* Improve html errors checks.
* Fix internal links.
* Ignore alt attribute for images.
Fails only on 4xx HTTP errors.
-[Micro XRCE-DDS through serial](#How-to-execute-Micro-XRCE-DDS)
32
+
-[NSH through UART](#NSH-UART-Discovery)
33
+
-[BMP180 through I2C](#BMP180-Discovery)
34
+
-[HIH6130 through I2C](#HIH6130-Discovery)
35
+
-[Power Manager](#Power-Manager-Discovery)
36
+
-[Micro XRCE-DDS through serial](#Micro-XRCE-DDS-Discovery)
38
37
39
38
40
39
41
40
# Repositories to be used
42
41
43
42
For the examples listed below, please make use of the branch called `master` for this two repositories:
44
43
45
-
-[NuttX](https://github.com/microROS/Nuttx) fork, where NuttX RTOS is stored.
46
-
-[Apps](https://github.com/microROS/apps) fork, whee NuttX applications and examples are placed.
44
+
-[NuttX](https://github.com/micro-ROS/Nuttx) fork, where NuttX RTOS is stored.
45
+
-[Apps](https://github.com/micro-ROS/apps) fork, whee NuttX applications and examples are placed.
47
46
48
47
----------------------
49
48
@@ -63,7 +62,7 @@ The flash script will execute the proper command to upload the firmware to the b
63
62
64
63
This section provides step-by-step tutorials so you can start executing the examples we have created. These tutorials starts using NuttX, using many different peripherals and tools, and ends up showing how to execute Micro XRCE-DDS client and micro-ROS client.
65
64
66
-
## How to execute NSH over USB under Olimex-STM32-E407
65
+
## How to execute NSH over USB under Olimex-STM32-E40 {#NSH-USB-Olimex}
67
66
68
67
NSH is a system console that can be use throught the next interfaces: USB,UART and Telnet. With this console you can execute apps, set system configuration and see the state of the system.
69
68
@@ -119,7 +118,8 @@ If you don't know which interface is the micro USB, type `dmesg` command at a te
119
118
## How to execute NSH with the UART.
120
119
121
120
122
-
### Olimex-STM32-E407
121
+
### Olimex-STM32-E407 {#NSH-UART-Olimex}
122
+
123
123
This board have the possibility to show the console through the UART or through USB.
124
124
125
125
Go to the main folder of NuttX and execute the next command to configure the board:
@@ -173,7 +173,8 @@ nsh>
173
173
```
174
174
175
175
176
-
### STM32L1Discovery
176
+
### STM32L1Discovery {#NSH-UART-Discovery}
177
+
177
178
**This board only can show the NSH console throught the UART**
178
179
179
180
Go to the main folder of NuttX and execute the next command to configure the board:
@@ -225,7 +226,7 @@ nsh>
225
226
```
226
227
If you don't know which interface is the micro USB, type `dmesg` command at a terminal, this command should let you know which is the last USB device that has been connected to your computer and at what interface is attached.
227
228
228
-
## How to use an auxiliary UART:
229
+
## How to use an auxiliary UART {#Auxiliar-UART-Olimex}
229
230
230
231
In this demo we will show how to use an auxiliary UART to send and receive messages.
231
232
When we run this demos, we will send the first argument to the auxiliary terminal and we will wait for an input from the auxiliary terminal.
@@ -265,7 +266,7 @@ BMP180 is a I2C barometric pressure sensor. With this sensor you can obtain the
@@ -534,7 +535,7 @@ Now if you type something in the computer, the board should echo the same and sh
534
535
535
536
536
537
537
-
## How to execute TCP Echo server example
538
+
## How to execute TCP Echo server example {#TCPEcho-Olimex}
538
539
539
540
540
541
Go to the main folder of NuttX and type the next command to configure the board:
@@ -631,7 +632,7 @@ The variables are shown in two hexadecimal numbers per each field. In case of th
631
632
`0x85` = 133
632
633
633
634
634
-
## How to use MRF24j40-6LowPan
635
+
## How to use MRF24j40-6LowPan {#MRF24j40-6LowPan-Olimex}
635
636
636
637
With this demo, we'll be able to create a point to point connection with the MRF24J40 module using the protocol 6LowPan. This network, allows you to have hundreds of nodes with very little power consumption.
637
638
One of the nodes is a TCP or UDP server, and the other nodes are TCP or UDP clients that they connect to the server.
@@ -736,7 +737,7 @@ Now the UDP Client, will send a `HelloWorld` to the UDP Server.
736
737
737
738
738
739
739
-
## How to use the ADC demo
740
+
## How to use the ADC demo {#ADC-Olimex}
740
741
741
742
In this demo we will take the analog value pin A1, that is attached to channel 4 of the ADC number 3. This demo only works in the Olimex board.
742
743
@@ -759,7 +760,7 @@ If you execute the application typing `adc_simple`, you will see a measurement o
759
760
760
761
761
762
762
-
# How to execute CPU performance telemetry app
763
+
# How to execute CPU performance telemetry app {#Telemetry-Olimex}
763
764
764
765
Go to the main folder of NuttX and type the next command to configure the board:
This example is simple. After some seconds, the board enter into a sleep mode that could be re-waken up, writing into the serial season. As the MCU is in low power mode, some data is lost, until the complete wake up is done.
897
898
898
-
### Olimex STM32-E407
899
+
### Olimex STM32-E407 {#Power-Manager-Olimex}
899
900
900
901
Go to the main folder of NuttX and type the command to configure the board:
901
902
`./scripts/configure.sh olimex-stm32-e407 pm`
@@ -906,7 +907,7 @@ Compile:
906
907
Upload:
907
908
`./scripts/flash.sh olimex-stm32-e407`
908
909
909
-
### STM32L Discovery
910
+
### STM32L Discovery {#Power-Manager-Discovery}
910
911
911
912
Go to the main folder of NuttX and type the command to configure the board:
912
913
`./scripts/configure.sh stm32l1 pm`
@@ -939,7 +940,7 @@ Info : Listening on port 4444 for telnet connections
939
940
Now open a serial session for connecting to the board. Once the prompt pops-up, do not type for some seconds and you will see that, in a point, if you type something, it will not appear at the command line. After some seconds, the command line will again work properly.
940
941
941
942
942
-
## How to use a micro SD-Card in the Olimex-STM32-E407 board
943
+
## How to use a micro SD-Card in the Olimex-STM32-E407 board {#SD-Card-Olimex}
943
944
944
945
This demo it's only for the Olimex board. This demo shows how to write and read files from a SD card.
945
946
@@ -974,7 +975,7 @@ In this example, we will execute Micro XRCE-DDS client in NuttX. This example ru
974
975
For this demo we need two boards (It doesn't matter if it's the Olimex Board or the STM32L1), one will be the publisher which will send a topic with a shape, the color of the shape and the coordinate of the shape. The other board will subscribe to the topic.
975
976
At this moment it's only possible to work through serial, but it could be possible to use with UDP and TCP in a future.
976
977
977
-
### Olimex STM32-E407
978
+
### Olimex STM32-E407 {#Micro-XRCE-DDS-Olimex}
978
979
979
980
Go to the main folder of NuttX and type the command to configure the board:
Go to the main folder of NuttX and type the command to configure the board:
991
992
`./scripts/configure.sh stm32l1 microxrcedds`
@@ -1033,7 +1034,7 @@ And it should look like this:
1033
1034
For this board we need two TTL232 cables. The first one is used to show the console.
1034
1035
Connect the serial cable `RX` to pin `PA9` and `TX` to pin `PA10` and the GND wire to a `GND` pin.
1035
1036
1036
-
Then, you need to connect to the second UART to use micro-XRCE-DDS:
1037
+
Then, you need to connect to the second UART to use Micro XRCE-DDS:
1037
1038
Connect the serial cable `RX` to pin `PA2` and `TX` to pin `PA3` and the GND wire to a `GND` pin.
1038
1039
1039
1040
And it should look like this:
@@ -1042,7 +1043,7 @@ And it should look like this:
1042
1043
1043
1044
In this example, we use an Olimex board and a STM32L1 Board, but you can use any combination between STM32L1, Olimex Board and PC. Now we're going to execute the Agent in the PC.
1044
1045
First, we need to check the port number of the serial cable that we want to use as Micro XRCE-DDS interface.
1045
-
Note: You must installed micro-XRCE-DDS agent previously, follow this guide -> https://micro-xrce-dds.readthedocs.io/en/latest/installation.html
1046
+
Note: You must installed Micro XRCE-DDS agent previously, follow this guide -> https://micro-xrce-dds.readthedocs.io/en/latest/installation.html
1046
1047
1047
1048
Open a console and type the next command:
1048
1049
`MicroXRCE-DDSAgent serial <serial_port>`
@@ -1089,16 +1090,16 @@ We have the STM32L1 as publisher, so we need to check the serial port number of
1089
1090
Then, we have the Olimex as subscriber, so we need to follow the same steps as with the STM32L1 board.
1090
1091
1091
1092
1092
-
## How to use micro-ROS demo:
1093
+
## How to use micro-ROS demo {#micro-ROS-demo-Olimex}
1093
1094
1094
-
In this demo, we will use the alpha version of microROS for NuttX running under the Olimex-STM32-E407 board.
1095
+
In this demo, we will use the alpha version of micro-ROS for NuttX running under the Olimex-STM32-E407 board.
1095
1096
With board running this demo we could create a ROS2 publisher or a ROS2 subscriber.
1096
1097
The publisher creates and publishes as a topic a progressive count of integers (From 0 to 1000).
1097
1098
The subscriber subscribes to that topic and shows the value of the number published.
1098
1099
1099
1100
This demo is a little bit different as the other demos because we need to follow another path to configure it.
1100
1101
We need to download the docker files of micro-ROS, executing the next command:
This is a follow-up to [Debugging with gdb and openocd](/docs/tutorials/debugging-gdb-openocd/), because the set up done in that tutorial is a pre-requisite to debugging with Visual Studio Code.
7
+
This is a follow-up to [Debugging with gdb and openocd](/docs/tutorials/advanced/debugging-gdb-openocd/), because the set up done in that tutorial is a pre-requisite to debugging with Visual Studio Code.
8
8
9
9
## Motivation
10
10
11
11
Visual Studio Code is a modern IDE that is very easy to extend and popular with both the Web/Cloud and IoT communities. It is also one of the easiest IDEs to get working with embedded systems. That said, it is *not* the most powerful or featureful IDEs for this purpose, but it is easy and will do.
12
12
13
13
## Prerequisites
14
14
15
-
* All the prerequisites of [Debugging with gdb and openocd](/docs/tutorials/debugging-gdb-openocd/)
15
+
* All the prerequisites of [Debugging with gdb and openocd](/docs/tutorials/advanced/debugging-gdb-openocd/)
16
16
* Cortex-M hardware (all of our standard boards are ARM based)
17
17
*[Visual Studio Code](https://code.visualstudio.com/)
0 commit comments