sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
440787c0c1
nuttx/Documentation/quickstart/running.rst

87 lines
2.6 KiB
ReStructuredText
Raw Normal View History

add quickstart docs from NuttX Companion - with suggested edits from PR feedback
2020-09-04 23:00:59 +02:00
.. include:: /substitutions.rst
.. _running:
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
=======
add quickstart docs from NuttX Companion - with suggested edits from PR feedback
2020-09-04 23:00:59 +02:00
Running
=======
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
In order to finally run NuttX on your board, you first have to flash the NuttX
binary. As an easy start, it is recommended that you choose a well supported board
which also integrates the debugger/programmer in the board itself exposed via USB
connector.
A good choice is a Nucleo or Discovery board from ST Microelectronics,
Documentation: Fix a few typos. * Documentation/contributing/documentation.rst * Documentation/guides/tasktraceuser.rst * Documentation/guides/drivers.rst * Documentation/quickstart/running.rst * Documentation/quickstart/compiling.rst * Documentation/components/drivers/character/watchdog.rst * Documentation/components/drivers/character/foc.rst * Documentation/components/nxgraphics/nxtk.rst * Documentation/applications/nsh/login.rst * Documentation/introduction/detailed_support.rst * Documentation/introduction/resources.rst * Documentation/reference/user/01_task_control.rst * Documentation/reference/os/wqueue.rst Fix some misspelled words. Many of these were caught by codespell.
2021-04-28 21:14:44 +02:00
as there is a wide choice of supported boards for the STM32 architecture in NuttX.
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
Also, these boards expose an UART port over the USB connection which allows you
to interact with NuttX via the interactive console without any extra hardware.
For the purposes of this guide, we will use the Nucleo F103RB board.
Flashing
========
There are various tools you can use to flash the NuttX binary to your Nucleo
Documentation: merge quickstart with the rest of "getting started"
2020-12-06 03:24:34 +01:00
board. One common option is to use ``openocd`` which supports a large number
Documentation: Remove all tail spaces from *.rst and *.html by the below command: find . -type f -name '*.rst' -exec sed --in-place 's/[[:space:]]\+$//' {} \+ Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 18:48:44 +02:00
of programmers and target microcontrollers.
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
Documentation: merge quickstart with the rest of "getting started"
2020-12-06 03:24:34 +01:00
You should note that ``openocd`` project has not made stable releases for long
time and support for newer hardware will probably be only available in the
Documentation: Fix a few typos. * Documentation/contributing/documentation.rst * Documentation/guides/tasktraceuser.rst * Documentation/guides/drivers.rst * Documentation/quickstart/running.rst * Documentation/quickstart/compiling.rst * Documentation/components/drivers/character/watchdog.rst * Documentation/components/drivers/character/foc.rst * Documentation/components/nxgraphics/nxtk.rst * Documentation/applications/nsh/login.rst * Documentation/introduction/detailed_support.rst * Documentation/introduction/resources.rst * Documentation/reference/user/01_task_control.rst * Documentation/reference/os/wqueue.rst Fix some misspelled words. Many of these were caught by codespell.
2021-04-28 21:14:44 +02:00
latest Git version, so it is actually recommended to install latest development
Documentation: merge quickstart with the rest of "getting started"
2020-12-06 03:24:34 +01:00
version.
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
Documentation: merge quickstart with the rest of "getting started"
2020-12-06 03:24:34 +01:00
.. tabs::
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
Documentation: merge quickstart with the rest of "getting started"
2020-12-06 03:24:34 +01:00
.. code-tab:: console Install stable version (Ubuntu)
Documentation: Remove all tail spaces from *.rst and *.html by the below command: find . -type f -name '*.rst' -exec sed --in-place 's/[[:space:]]\+$//' {} \+ Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 18:48:44 +02:00
Documentation: merge quickstart with the rest of "getting started"
2020-12-06 03:24:34 +01:00
$ apt install openocd
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
Documentation: merge quickstart with the rest of "getting started"
2020-12-06 03:24:34 +01:00
.. tab:: Install latest version from source
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
Documentation: merge quickstart with the rest of "getting started"
2020-12-06 03:24:34 +01:00
.. code-block:: console
Documentation: Fix a few typos. * Documentation/contributing/documentation.rst * Documentation/guides/tasktraceuser.rst * Documentation/guides/drivers.rst * Documentation/quickstart/running.rst * Documentation/quickstart/compiling.rst * Documentation/components/drivers/character/watchdog.rst * Documentation/components/drivers/character/foc.rst * Documentation/components/nxgraphics/nxtk.rst * Documentation/applications/nsh/login.rst * Documentation/introduction/detailed_support.rst * Documentation/introduction/resources.rst * Documentation/reference/user/01_task_control.rst * Documentation/reference/os/wqueue.rst Fix some misspelled words. Many of these were caught by codespell.
2021-04-28 21:14:44 +02:00
Documentation: merge quickstart with the rest of "getting started"
2020-12-06 03:24:34 +01:00
$ git clone git://git.code.sf.net/p/openocd/code openocd
$ cd openocd
$ ./bootstrap
$ ./configure --prefix=install/
$ make install
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
Documentation: merge quickstart with the rest of "getting started"
2020-12-06 03:24:34 +01:00
The resulting installation will be under ``openocd/install``. You can add
``openocd/install/bin`` to your ``PATH``.
Documentation: Fix a few typos. * Documentation/contributing/documentation.rst * Documentation/guides/tasktraceuser.rst * Documentation/guides/drivers.rst * Documentation/quickstart/running.rst * Documentation/quickstart/compiling.rst * Documentation/components/drivers/character/watchdog.rst * Documentation/components/drivers/character/foc.rst * Documentation/components/nxgraphics/nxtk.rst * Documentation/applications/nsh/login.rst * Documentation/introduction/detailed_support.rst * Documentation/introduction/resources.rst * Documentation/reference/user/01_task_control.rst * Documentation/reference/os/wqueue.rst Fix some misspelled words. Many of these were caught by codespell.
2021-04-28 21:14:44 +02:00
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
Now, to flash the binary to your board, connect the USB cable and do:
.. code-block:: console
$ cd nuttx/
$ openocd -f interface/st-link-v2.cfg -f target/stm32f1x.cfg -c 'init' \
-c 'program nuttx/nuttx.bin verify reset' -c 'shutdown'
Documentation: Remove all tail spaces from *.rst and *.html by the below command: find . -type f -name '*.rst' -exec sed --in-place 's/[[:space:]]\+$//' {} \+ Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 18:48:44 +02:00
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
Access NuttShell
================
Once you flash your board, it will reset and offer a prompt over the serial
console. With the Nucleo board, you can simply open the terminal program
Documentation: merge quickstart with the rest of "getting started"
2020-12-06 03:24:34 +01:00
of your choice where you will see the ``nsh>`` prompt (press :kbd:`enter`
if you don't see anything):
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
.. tabs::
.. code-tab:: console picocom (CLI)
Documentation: Remove all tail spaces from *.rst and *.html by the below command: find . -type f -name '*.rst' -exec sed --in-place 's/[[:space:]]\+$//' {} \+ Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 18:48:44 +02:00
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
$ picocom -b 115200 /dev/ttyUSB0
Documentation: Remove all tail spaces from *.rst and *.html by the below command: find . -type f -name '*.rst' -exec sed --in-place 's/[[:space:]]\+$//' {} \+ Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 18:48:44 +02:00
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
.. code-tab:: console gtkterm (GUI)
Documentation: Remove all tail spaces from *.rst and *.html by the below command: find . -type f -name '*.rst' -exec sed --in-place 's/[[:space:]]\+$//' {} \+ Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 18:48:44 +02:00
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
$ gtkterm -s 115200 -p /dev/ttyUSB0
Documentation: Fix a few typos. * Documentation/contributing/documentation.rst * Documentation/guides/tasktraceuser.rst * Documentation/guides/drivers.rst * Documentation/quickstart/running.rst * Documentation/quickstart/compiling.rst * Documentation/components/drivers/character/watchdog.rst * Documentation/components/drivers/character/foc.rst * Documentation/components/nxgraphics/nxtk.rst * Documentation/applications/nsh/login.rst * Documentation/introduction/detailed_support.rst * Documentation/introduction/resources.rst * Documentation/reference/user/01_task_control.rst * Documentation/reference/os/wqueue.rst Fix some misspelled words. Many of these were caught by codespell.
2021-04-28 21:14:44 +02:00
Documentation: merge quickstart with the rest of "getting started"
2020-12-06 03:24:34 +01:00
.. tip::
You may have to add yourself to the ``dialout`` group on Linux to have permission
to access serial ports:
Documentation: Fix a few typos. * Documentation/contributing/documentation.rst * Documentation/guides/tasktraceuser.rst * Documentation/guides/drivers.rst * Documentation/quickstart/running.rst * Documentation/quickstart/compiling.rst * Documentation/components/drivers/character/watchdog.rst * Documentation/components/drivers/character/foc.rst * Documentation/components/nxgraphics/nxtk.rst * Documentation/applications/nsh/login.rst * Documentation/introduction/detailed_support.rst * Documentation/introduction/resources.rst * Documentation/reference/user/01_task_control.rst * Documentation/reference/os/wqueue.rst Fix some misspelled words. Many of these were caught by codespell.
2021-04-28 21:14:44 +02:00
Documentation: merge quickstart with the rest of "getting started"
2020-12-06 03:24:34 +01:00
.. code-block:: console
Documentation: Fix a few typos. * Documentation/contributing/documentation.rst * Documentation/guides/tasktraceuser.rst * Documentation/guides/drivers.rst * Documentation/quickstart/running.rst * Documentation/quickstart/compiling.rst * Documentation/components/drivers/character/watchdog.rst * Documentation/components/drivers/character/foc.rst * Documentation/components/nxgraphics/nxtk.rst * Documentation/applications/nsh/login.rst * Documentation/introduction/detailed_support.rst * Documentation/introduction/resources.rst * Documentation/reference/user/01_task_control.rst * Documentation/reference/os/wqueue.rst Fix some misspelled words. Many of these were caught by codespell.
2021-04-28 21:14:44 +02:00
Documentation: merge quickstart with the rest of "getting started"
2020-12-06 03:24:34 +01:00
$ gpasswd -a <user> dialout
Documentation: Fix a few typos. * Documentation/contributing/documentation.rst * Documentation/guides/tasktraceuser.rst * Documentation/guides/drivers.rst * Documentation/quickstart/running.rst * Documentation/quickstart/compiling.rst * Documentation/components/drivers/character/watchdog.rst * Documentation/components/drivers/character/foc.rst * Documentation/components/nxgraphics/nxtk.rst * Documentation/applications/nsh/login.rst * Documentation/introduction/detailed_support.rst * Documentation/introduction/resources.rst * Documentation/reference/user/01_task_control.rst * Documentation/reference/os/wqueue.rst Fix some misspelled words. Many of these were caught by codespell.
2021-04-28 21:14:44 +02:00
Documentation: merge quickstart with the rest of "getting started"
2020-12-06 03:24:34 +01:00
Where ``<user>`` is your username. You will need to log out from your desktop
for the change to have effect.
Reference in New Issue Copy Permalink