You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by GitBox <gi...@apache.org> on 2018/01/09 01:51:51 UTC
[GitHub] ccollins476ad closed pull request #708: Fix doc conversion
ccollins476ad closed pull request #708: Fix doc conversion
URL: https://github.com/apache/mynewt-core/pull/708
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/docs/faq/go_env.rst b/docs/faq/go_env.rst
index 3341d5fb9..d532b95f4 100644
--- a/docs/faq/go_env.rst
+++ b/docs/faq/go_env.rst
@@ -32,7 +32,9 @@ The latest master branch of newt and newtmgr requires GO version 1.7.6
or higher. You can skip this step and proceed to Step 2 if you already
have Go version 1.7.6 or higher installed.
- #### Installing Go on Mac OS X
+Installing Go on Mac OS X
+^^^^^^^^^^^^^^^^^^^
+
If you do not have Homebrew installed, run the following command. You
will be prompted for your sudo password.
@@ -44,14 +46,14 @@ will be prompted for your sudo password.
You can also extract (or ``git clone``) Homebrew and install it to
/usr/local.
- Use brew to install Go:
+Use brew to install Go:
.. code-block:: console
$ brew install go
- ==>
+ ==>
+ ...
...
- ...
==> Summary
? /usr/local/Cellar/go/1.8.3: 7,035 files, 282.0MB
@@ -59,10 +61,16 @@ You can also download the Go package directly from
(https://golang.org/dl/) and install it in /usr/local/bin instead of
brewing it.
- #### Installing Go on Linux and Windows You can download Go from
+Installing Go on Linux and Windows
+^^^^^^^^^^^^^^^^^^^
+
+You can download Go from
+
https://golang.org/dl/.
- ###Step 2: Setting Up Your Go Environment
+Step 2: Setting Up Your Go Environment
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
This section describes the Go environment and how to setup a Go
workspace. If you already have a Go workspace for your other Go
@@ -90,11 +98,11 @@ newtmgr repositories.
.. code-block:: console
$ cd $HOME
- $ mkdir -p dev/go
+ $ mkdir -p dev/go
$ cd dev/go
$ export GOPATH=`pwd`
- Add the following export statements to your ~/.bash\_profile file and
+Add the following export statements to your ~/.bash\_profile file and
source the file:
.. code-block:: console
@@ -111,7 +119,9 @@ repositories. You can download the source and install one or both tools.
We use the ``go get`` command to download the source, build, and install
the binary in the **$GOPATH/bin** directory.
- #### Downloading and Installing the Newt Tool
+Downloading and Installing the Newt Tool
+^^^^^^^^^^^^^^^^^^^
+
The newt Go package is **mynewt.apache.org/newt/newt** and is stored in
the `Apache Mynewt newt tool repository mirrored on
@@ -124,7 +134,7 @@ Download the newt package source and install the tool:
$cd $GOPATH
$go get mynewt.apache.org/newt/newt
$cd $GOPATH/src/mynewt.apache.org/newt
- $ls
+ $ls
DISCLAIMER RELEASE_NOTES.md util
INSTALLING.md build.sh viper
LICENSE newt yaml
@@ -139,7 +149,7 @@ Download the newt package source and install the tool:
used or updated. The current **newtmgr** source has its own Git
repository.
- Check that the newt binary is installed and you are using the one from
+Check that the newt binary is installed and you are using the one from
\*\* $GOPATH/bin\*\*:
.. code-block:: console
@@ -151,7 +161,9 @@ repository.
$newt version
Apache Newt version: 1.1.0-dev
- #### Downloading and Installing the Newtmgr Tool
+Downloading and Installing the Newtmgr Tool
+^^^^^^^^^^^^^^^^^^^
+
The newtmgr Go package is **mynewt.apache.org/newtmgr/newtmgr**. It is
stored in the `Apache Mynewt newtmgr tool repository mirrored on
@@ -171,7 +183,7 @@ Download the newtmgr package and install the tool:
Your branch is up-to-date with 'origin/master'.
nothing to commit, working directory clean
- Check that the newtmgr binary is installed and you are using the one
+Check that the newtmgr binary is installed and you are using the one
from **$GOPATH/bin**:
.. code-block:: console
@@ -181,8 +193,10 @@ from **$GOPATH/bin**:
$which newtmgr
~/dev/go/bin/newtmgr
- ### Step 4: Updating and Rebuilding the Tools: This section shows you
-how to rebuild the newt and newtmgr tools with the latest updates from
+Step 4: Updating and Rebuilding the Tools
+~~~~~~~~~~~~~~~
+
+This section shows you how to rebuild the newt and newtmgr tools with the latest updates from
the master branch or after you have made changes in your branch.
Here is the general procedure to rebuild either the newt or newtmgr
@@ -197,7 +211,7 @@ tools.
`FAQ </faq/answers/>`__).
3. Build and install the tool.
- Change to the directory where the source for the tool is installed.
+Change to the directory where the source for the tool is installed.
For the **newt** tool:
@@ -211,16 +225,16 @@ For the **newtmgr** tool:
$cd $GOPATH/src/mynewt.apache.org/newtmgr/newtmgr
- After you change to the specific tool directory, get the latest updates
+After you change to the specific tool directory, get the latest updates
from the master branch. If you made changes and need to rebase with the
origin, add the ``--rebase origin master`` arguments to the ``git pull``
command:
.. code-block:: console
- $git pull
+ $git pull
- Build and install the tool. The updated binary will be installed in the
+Build and install the tool. The updated binary will be installed in the
**$GOPATH/bin** directory:
.. code-block:: console
diff --git a/docs/faq/ide.rst b/docs/faq/ide.rst
index 0031a070a..abf334b27 100644
--- a/docs/faq/ide.rst
+++ b/docs/faq/ide.rst
@@ -64,7 +64,7 @@ You need to install two extensions:
2. The Native Debug extension from webfreak. This extension provides GDB
support.
- To install the C/C++ extension:
+To install the C/C++ extension:
1. Press ``Ctrl-P`` to open the search box.
2. Type ``ext install cpptools`` in the search box and press Enter. You
@@ -90,8 +90,10 @@ run from and the task results can be analyzed in Visual Studio Code.
Tasks are defined within the scope of a workspace. This means that the
tasks you define for a workspace only apply to the given workspace.
- ####Associating a Mynewt Project to a Workspace For your Mynewt
-project, your Visual Studio Code workspace is the Mynewt project base
+Associating a Mynewt Project to a Workspace
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+For your Mynewt project, your Visual Studio Code workspace is the Mynewt project base
directory. For example, if you create a project named ``myproj`` under
the ``~/dev`` directory, then you open the ``~/dev/myproj`` folder for
your workspace.
@@ -99,8 +101,8 @@ your workspace.
Select **File** > **Open Folder**, and select the ``myproj`` folder from
the ``Select Folder`` dialog box to open the folder.
- ####Defining Visual Studio Code Tasks to Build and Debug Mynewt
-Applications
+Defining Visual Studio Code Tasks to Build and Debug Mynewt Applications
+^^^^^^^^^^^^^^^^^^^^^^^^^
You define Visual Studio Code tasks to build and debug your Mynewt
targets in Visual Studio Code. We use the Blinky application for the
@@ -126,7 +128,7 @@ create a task runner for external commands.
</p>
- Tasks are defined in the ``tasks.json`` file. You should see the
+Tasks are defined in the ``tasks.json`` file. You should see the
``.vscode`` folder created in the ``MYPROJ`` folder and a ``tasks.json``
file created in the ``.vscode`` folder. The ``tasks.json`` file has the
following default values.
@@ -152,7 +154,7 @@ following definitions, and press ``Ctrl-S`` to save the file.
"command": "newt",
"echoCommand": true,
"isShellCommand": true,
-
+
"tasks":[
{
"taskName": "build_arduino_boot",
@@ -162,14 +164,14 @@ following definitions, and press ``Ctrl-S`` to save the file.
{
"taskName": "build_arduino_blinky",
"args": ["build", "arduino_blinky"],
- "isBuildCommand": true,
+ "isBuildCommand": true,
"suppressTaskName": true
},
{
"taskName": "create_arduino_blinky",
"args": ["create-image", "arduino_blinky", "1.0.0"],
"suppressTaskName":true
- },
+ },
{
"taskName": "debug_arduino_blinky",
"args": ["debug", "arduino_blinky", "-n"],
@@ -178,7 +180,7 @@ following definitions, and press ``Ctrl-S`` to save the file.
]
}
- The ``tasks.json`` file specifies the tasks that are run to build and
+The ``tasks.json`` file specifies the tasks that are run to build and
debug the Arduino blinky targets. Each task runs a ``newt`` command. The
``newt`` command to run and the arguments for the ``newt`` command are
passed in the ``args`` property for each task.
@@ -207,7 +209,9 @@ For more information on tasks and all supported properties, see the
`Visual Studio Code Task
documentation <https://code.visualstudio.com/docs/editor/tasks>`__.
- ####Running a Task
+Running a Task
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
To run a task, press ``Ctrl-Shift-P``, type ``task`` on the search box,
and select **Tasks: Run Task**. The tasks that you define in the
@@ -235,7 +239,9 @@ The following is an example of running the ``build_arduino_boot`` task:
keyboard shortcut ``Ctrl-Shift-B`` because the task has the property
``isBuildCommand`` set to true.
- ####Defining Tasks for Other Newt Commands
+Defining Tasks for Other Newt Commands
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
Other newt commands, such as the ``newt load`` command, do not need to
run from within Visual Studio Code. You can define a task for each
@@ -253,14 +259,14 @@ the ``tasks.json`` file:
"taskName": "load_arduino_boot",
"args": ["load", "arduino_boot"],
"suppressTaskName":true
- },
+ },
{
"taskName": "load_arduino_blinky",
"args": ["load", "arduino_blinky"],
"suppressTaskName":true
- },
+ },
- To run a command from the Visual Studio integrated terminal, instead of
+To run a command from the Visual Studio integrated terminal, instead of
starting a task, press ``Ctrl-``` to launch the integrated terminal and
enter the command on the prompt:
@@ -272,8 +278,10 @@ enter the command on the prompt:
</p>
- ###Defining Debugger Configurations You need to define a debugger
-configuration to launch the GDB debugger from within Visual Studio Code:
+Defining Debugger Configurations
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You need to define a debugger configuration to launch the GDB debugger from within Visual Studio Code:
Step 1: Select **Debug** > **Open Configuration**, and select the
**GDB** environment.
@@ -297,7 +305,7 @@ folder.
</p>
- Step 2: Delete the content from the ``launch.json`` file, add the
+Step 2: Delete the content from the ``launch.json`` file, add the
following definitions, and press 'Ctrl-S' to save the file.
.. code-block:: console
@@ -319,7 +327,7 @@ following definitions, and press 'Ctrl-S' to save the file.
]
}
- This defines a ``gdb_arduino_blinky`` debugger configuration. It
+This defines a ``gdb_arduino_blinky`` debugger configuration. It
specifies:
- The debugger is type **gdb**.
@@ -362,7 +370,7 @@ Step 2: Start the GDB session. Perform the following:
</p>
- Step 3: Debug your application. You should see a debug session similar
+Step 3: Debug your application. You should see a debug session similar
to the one shown below:
.. raw:: html
@@ -373,7 +381,7 @@ to the one shown below:
</p>
- For more information on how to use the Visual Studio Code Debugger, see
+For more information on how to use the Visual Studio Code Debugger, see
the `Visual Studio Code debugging
documentation <https://code.visualstudio.com/docs/editor/debugging>`__.
diff --git a/docs/mynewt_doc/tutorials/arduino_zero_converted.rst b/docs/mynewt_doc/tutorials/arduino_zero_converted.rst
index e054ac119..f0f10c7cb 100644
--- a/docs/mynewt_doc/tutorials/arduino_zero_converted.rst
+++ b/docs/mynewt_doc/tutorials/arduino_zero_converted.rst
@@ -209,7 +209,7 @@ You can now build the target, with ``newt build``:
<snip>
App successfully built: myproject/bin/arduino_blinky/apps/blinky/blinky.elf
- Congratulations! You have successfully built your application. Now it's
+Congratulations! You have successfully built your application. Now it's
time to load both the bootloader and application onto the target.
Connect the Target
@@ -238,7 +238,7 @@ Execute the command to download the bootloader.
If the newt tool finishes without error, that means the bootloader has
been successfully loaded onto the target.
- Reminder if you are using Docker: When working with actual hardware,
+Reminder if you are using Docker: When working with actual hardware,
remember that each board has an ID. If you swap boards and do not
refresh the USB Device Filter on the VirtualBox UI, the ID might be
stale and the Docker instance may not be able to see the board
diff --git a/docs/network/ble/bletiny/bletiny_GATT.rst b/docs/network/ble/bletiny/bletiny_GATT.rst
index 038578270..c2d31ddcb 100644
--- a/docs/network/ble/bletiny/bletiny_GATT.rst
+++ b/docs/network/ble/bletiny/bletiny_GATT.rst
@@ -154,7 +154,9 @@ sub-procedures:
| | | | ng=1`` |
+-------+------------+------------------+---------+
- ### Using nimBLE commands Assuming you have discovered and established
+Using nimBLE commands Assuming you have discovered and established
+~~~~~~~~~~~~~~~
+
a BLE connection with at least one peer device (as explained earlier in
`API for bletiny app <bletiny_api.html>`__, you can find out what
characteristics and services are available over these connections. Here
diff --git a/docs/newt/install/newt_linux.rst b/docs/newt/install/newt_linux.rst
index 60672e2d7..aabd88968 100644
--- a/docs/newt/install/newt_linux.rst
+++ b/docs/newt/install/newt_linux.rst
@@ -183,7 +183,9 @@ a bin directory in your PATH:
$ mv newt/newt /usr/bin
- ### Checking the Installed Version of Newt
+Checking the Installed Version of Newt
+~~~~~~~~~~~~~~~
+
1. Check which newt you are using and that the version is the latest
release version.
diff --git a/docs/newt/install/newt_mac.rst b/docs/newt/install/newt_mac.rst
index 8b732cf4c..b76c32539 100644
--- a/docs/newt/install/newt_mac.rst
+++ b/docs/newt/install/newt_mac.rst
@@ -58,7 +58,9 @@ to upgrade to newt 1.3.0:
$ brew update
$ brew upgrade mynewt-newt
- #### Installing the Latest Release Version of Newt
+Installing the Latest Release Version of Newt
+^^^^^^^^^^^^^^^^^^^
+
Run the following command to install the latest release version (1.3.0)
of newt:
@@ -80,7 +82,9 @@ Sierra, El Capitan, and Yosemite. If you are running an earlier version
of Mac OS, the installation will install the latest version of Go and
compile newt locally.
- ### Checking the Installed Version
+Checking the Installed Version
+~~~~~~~~~~~~~~~
+
Check that you are using the installed version of newt:
@@ -100,7 +104,7 @@ Check that you are using the installed version of newt:
"/usr/local/bin" for your PATH in ~/.bash\_profile, and source
~/.bash\_profile.
- Get information about newt:
+Get information about newt:
.. code-block:: console
@@ -157,7 +161,9 @@ Check that you are using the installed version of newt:
Use "newt [command] --help" for more information about a command.
- ### Installing Earlier Release Versions of Newt
+Installing Earlier Release Versions of Newt
+~~~~~~~~~~~~~~~
+
If you want to install newt 1.0, run the following commands:
@@ -180,7 +186,7 @@ commands:
$ echo 'export PATH=/usr/local/Cellar/mynewt-newt@1.0/1.0.0/bin:$PATH' >> ~/.bash_profile
$ source ~/.bash_profile
- You can also manually symlink into /usr/local/bin as follows:
+You can also manually symlink into /usr/local/bin as follows:
1. Unlink newt if you have the latest version of newt installed:
@@ -207,14 +213,14 @@ install newt from the HEAD of the master branch.
- This installation will install the latest version of Go on your
computer, if it is not installed, and compile newt locally.
- If you previously installed newt using brew, unlink the current
+If you previously installed newt using brew, unlink the current
version:
.. code-block:: console
$brew unlink mynewt-newt
- Install the latest unstable version of newt from the master branch:
+Install the latest unstable version of newt from the master branch:
.. code-block:: console
@@ -233,7 +239,7 @@ version:
$newt version
Apache Newt version: 1.3.0-dev
- To switch back to the latest stable release version (1.3.0) of newt,
+To switch back to the latest stable release version (1.3.0) of newt,
you can run:
.. code-block:: console
diff --git a/docs/newt/install/prev_releases.rst b/docs/newt/install/prev_releases.rst
index 9e03e9882..06353267a 100644
--- a/docs/newt/install/prev_releases.rst
+++ b/docs/newt/install/prev_releases.rst
@@ -32,21 +32,23 @@ commands:
$ echo 'export PATH=/usr/local/Cellar/mynewt-newt@1.0/1.0.0/bin:$PATH' >> ~/.bash_profile
$ source ~/.bash_profile
- You can also manually symlink into /usr/local/bin as follows:
+You can also manually symlink into /usr/local/bin as follows:
- 1. Unlink newt if you have the latest version of newt installed:
+1. Unlink newt if you have the latest version of newt installed:
.. code-block:: console
$ brew unlink mynewt-newt
- 2. Link mynewt-newt@1.0 into /usr/local/bin:
+2. Link mynewt-newt@1.0 into /usr/local/bin:
.. code-block:: console
$ brew link -f mynewt-newt@1.0
- ### Linux 1. Download the binary:
+Linux 1. Download the binary:
+~~~~~~~~~~~~~~~
+
+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Version | Download |
@@ -56,13 +58,15 @@ commands:
| 1.1.0 | `newt\_1.1.0-1\_amd64.deb <https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.1.0/newt_1.1.0-1_amd64.deb>`__ |
+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------+
- 2. Run the ``sudo apt-get remove newt`` command to remove the the
+2. Run the ``sudo apt-get remove newt`` command to remove the the
current installation.
- 3. Install the package. For example, run
+3. Install the package. For example, run
``sudo dpkg -i newt_1.0.0-1_amd64.deb`` to install newt 1.0.0
- ### Windows 1. Download the binary:
+Windows 1. Download the binary:
+~~~~~~~~~~~~~~~
+
+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Version | Download |
@@ -70,7 +74,7 @@ current installation.
| 1.1.0 | `newt\_1\_1\_0\_windows\_amd64.tar.gz <https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.1.0/newt_1.1.0-1_amd64.deb>`__ |
+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
- 2. Extract the file:
+2. Extract the file:
- If you previously built newt from the master branch, you can extract
the file into your $GOPATH/bin directory. Note: This overwrites the
diff --git a/docs/newtmgr/command_list/newtmgr_image.rst b/docs/newtmgr/command_list/newtmgr_image.rst
index 4163450d9..5ff8e8e40 100644
--- a/docs/newtmgr/command_list/newtmgr_image.rst
+++ b/docs/newtmgr/command_list/newtmgr_image.rst
@@ -1,4 +1,4 @@
-newtmgr image
+newtmgr image
--------------
Manage images on a device.
@@ -8,7 +8,7 @@ Usage:
.. code-block:: console
- newtmgr image [command] -c <connection_profile> [flags]
+ newtmgr image [command] -c <connection_profile> [flags]
Flags:
^^^^^^
@@ -17,11 +17,13 @@ The coredownload subcommand uses the following local flags:
.. code-block:: console
- -n, --bytes uint32 Number of bytes of the core to download
- -e, --elfify Create an ELF file
- --offset unint32 Offset of the core file to start the download
+ -n, --bytes uint32 Number of bytes of the core to download
+ -e, --elfify Create an ELF file
+ --offset unint32 Offset of the core file to start the download
+
+Global Flags:
+^^^^^^^^^^^^^^^^^^^
- #### Global Flags:
.. code-block:: console
@@ -32,8 +34,10 @@ The coredownload subcommand uses the following local flags:
-t, --timeout float timeout in seconds (partial seconds allowed) (default 10)
-r, --tries int total number of tries in case of timeout (default 1)
- ####Description The image command provides subcommands to manage core
-and image files on a device. Newtmgr uses the ``conn_profile``
+Description
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The image command provides subcommands to manage core and image files on a device. Newtmgr uses the ``conn_profile``
connection profile to connect to the device.
+----------------+---------------------------+
diff --git a/docs/newtmgr/command_list/newtmgr_stat.rst b/docs/newtmgr/command_list/newtmgr_stat.rst
index 9be5594c3..bb98ad0ce 100644
--- a/docs/newtmgr/command_list/newtmgr_stat.rst
+++ b/docs/newtmgr/command_list/newtmgr_stat.rst
@@ -116,7 +116,7 @@ The statistics for the ble\_att Stats:
0 write_rsp_rx
0 write_rsp_tx
- The list of Stats names using the list subcommand:
+The list of Stats names using the list subcommand:
.. code-block:: console
diff --git a/docs/newtmgr/install_linux.rst b/docs/newtmgr/install_linux.rst
index 5b5e6bbd5..237b44c97 100644
--- a/docs/newtmgr/install_linux.rst
+++ b/docs/newtmgr/install_linux.rst
@@ -61,21 +61,21 @@ the key has changed.
3. Add the repository for the binary and source packages to the apt
source list.
- 1. Install the apt-transport-https package:
+1. Install the apt-transport-https package:
.. code-block:: console
$sudo apt-get update
$sudo apt-get install apt-transport-https
- 2. Download the public key for the runtimeco apt repo (**Note:** There
+2. Download the public key for the runtimeco apt repo (**Note:** There
is a ``-`` after ``apt-key add``):
.. code-block:: console
wget -qO - https://raw.githubusercontent.com/runtimeco/debian-mynewt/master/mynewt.gpg.key | sudo apt-key add -
- 3. Add the repository for the binary packages to the ``mynewt.list``
+3. Add the repository for the binary packages to the ``mynewt.list``
apt source list file.
.. code-block:: console
@@ -89,14 +89,14 @@ apt source list file.
**Note:** Do not forget to exit the root shell.
- 4. Verify the content of the source list file:
+4. Verify the content of the source list file:
.. code-block:: console
$more /etc/apt/sources.list.d/mynewt.list
deb https://raw.githubusercontent.com/runtimeco/debian-mynewt/master latest main
- 5. Update the available packages:
+5. Update the available packages:
.. code-block:: console
@@ -112,12 +112,16 @@ download and install the binary package.
W: Failed to fetch https://raw.githubusercontent.com/runtimeco/debian-mynewt/master/dists/latest/main/source/Sources Ht
tpError404
- ### Installing the Latest Release of Newtmgr from a Binary Package
+Installing the Latest Release of Newtmgr from a Binary Package
+~~~~~~~~~~~~~~~
+
You can use either apt-get to install the package, or manually download
and install the Debian binary package.
- #### Method 1: Using apt-get to Upgrade or to Install
+Method 1: Using apt-get to Upgrade or to Install
+^^^^^^^^^^^^^^^^^^^
+
Run the following commands to upgrade or install the latest version of
newtmgr:
@@ -141,16 +145,18 @@ Download and install the package manually.
See `Checking the Installed Version of Newtmgr <#check>`__ to verify
that you are using the installed version of newtmgr.
- ### Installing the Latest Release Version of Newtmgr from Source
+Installing the Latest Release Version of Newtmgr from Source
+~~~~~~~~~~~~~~~
+
If you are running Linux on a different architecture, you can build and
install the latest release version of newtmgr from source.
- 1. Download and install the latest version of
+1. Download and install the latest version of
`Go <https://golang.org/dl/>`__. Newtmgr requires Go version 1.7.6 or
higher.
- 2. Create a Go workspace in the /tmp directory:
+2. Create a Go workspace in the /tmp directory:
.. code-block:: console
@@ -160,7 +166,7 @@ higher.
$ cd go
$ export GOPATH=/tmp/go
- 3. Run ``go get`` to download the newtmgr source. Note that ``go get``
+3. Run ``go get`` to download the newtmgr source. Note that ``go get``
pulls down the HEAD from the master branch in git, builds, and installs
newtmgr.
@@ -171,7 +177,7 @@ newtmgr.
$ ls -l /tmp/go/bin/newtmgr
-rwxr-xr-x 1 user staff 17884488 Jul 29 16:25 /tmp/go/bin/newtmgr
- 4. Check out the source from the latest release version:
+4. Check out the source from the latest release version:
.. code-block:: console
@@ -180,7 +186,7 @@ newtmgr.
$ git checkout mynewt_1_3_0_tag
Note: checking out 'mynewt_1_3_0_tag'.
- 5. Build newtmgr from the latest release version:
+5. Build newtmgr from the latest release version:
.. code-block:: console
@@ -190,18 +196,20 @@ newtmgr.
$ ls /tmp/go/bin/newtmgr
-rwxr-xr-x 1 user staff 17888680 Jul 29 16:28 /tmp/go/bin/newtmgr
- 6. If you have a Go workspace, remember to reset your GOPATH to your Go
+6. If you have a Go workspace, remember to reset your GOPATH to your Go
workspace.
- 7. Copy the newtmgr executable to a bin directory in your path. You can
+7. Copy the newtmgr executable to a bin directory in your path. You can
put it in the /usr/bin or the $GOPATH/bin directory.
- ### Checking the Latest Version of Newtmgr is Installed
+Checking the Latest Version of Newtmgr is Installed
+~~~~~~~~~~~~~~~
+
- 1. Run ``which newtmgr`` to verify that you are using the installed
+1. Run ``which newtmgr`` to verify that you are using the installed
version of newtmgr.
- 2. Get information about the newtmgr tool:
+2. Get information about the newtmgr tool:
.. code-block:: console
diff --git a/docs/newtmgr/install_mac.rst b/docs/newtmgr/install_mac.rst
index d6505ecf1..7b65b6c0f 100644
--- a/docs/newtmgr/install_mac.rst
+++ b/docs/newtmgr/install_mac.rst
@@ -47,7 +47,9 @@ following commands to upgrade to the latest version of newtmgr:
$ brew update
$ brew upgrade mynewt-newtmgr
- #### Installing the Latest Release Version of Newtmgr
+Installing the Latest Release Version of Newtmgr
+^^^^^^^^^^^^^^^^^^^
+
Run the following command to install the latest release version of
newtmgr:
@@ -69,7 +71,9 @@ Sierra, El Captian. If you are running an earlier version of Mac OS, the
installation will install the latest version of Go and compile newtmgr
locally.
- ### Checking the Installed Version
+Checking the Installed Version
+~~~~~~~~~~~~~~~
+
Check that you are using the installed version of newtmgr:
@@ -86,7 +90,7 @@ Check that you are using the installed version of newtmgr:
"/usr/local/bin" for your PATH in ~/.bash\_profile, and source
~/.bash\_profile.
- Get information about newtmgr:
+Get information about newtmgr:
.. code-block:: console
@@ -135,13 +139,13 @@ install newtmgr from the HEAD of the master branch.
- This installation will install the latest version of Go on your
computer, if it is not installed, and compile newtmgr locally.
- If you already installed newtgmr, unlink the current version:
+If you already installed newtgmr, unlink the current version:
.. code-block:: console
$brew unlink mynewt-newtmgr
- Install the latest unstable version of newtmgr from the master branch:
+Install the latest unstable version of newtmgr from the master branch:
.. code-block:: console
@@ -161,7 +165,7 @@ install newtmgr from the HEAD of the master branch.
==> go install
? /usr/local/Cellar/mynewt-newtmgr/HEAD-2d5217f: 3 files, 17.3MB, built in 1 minute 10 seconds
- To switch back to the latest stable release version of newtmgr, you can
+To switch back to the latest stable release version of newtmgr, you can
run:
.. code-block:: console
diff --git a/docs/newtmgr/install_windows.rst b/docs/newtmgr/install_windows.rst
index 3f280ab29..8f4e15ba2 100644
--- a/docs/newtmgr/install_windows.rst
+++ b/docs/newtmgr/install_windows.rst
@@ -26,16 +26,16 @@ Installing the Latest Release of Newtmgr Tool from Binary
You can install the latest release of newtmgr from binary. It has been
tested on Windows 10 64 bit platform.
- 1. Start a MinGW terminal.
+1. Start a MinGW terminal.
- 2. Download the newtmgr binary tar file:
+2. Download the newtmgr binary tar file:
.. code-block:: console
$ wget -P /tmp https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.3.0/newtmgr_1_3_0_windows_amd64.tar.gz
- 3. Extract the file:
+3. Extract the file:
- If you previously built newtmgr from the master branch, you can
extract the file into your $GOPATH/bin directory. Note: This
@@ -53,21 +53,23 @@ tested on Windows 10 64 bit platform.
tar -xzf /tmp/newtmgr_1_3_0_windows_amd64.tar.gz -C /usr/bin
- 4. Verify the installed version of newtmgr. See `Checking the Installed
+4. Verify the installed version of newtmgr. See `Checking the Installed
Version <#check_newtmgr>`__.
- ### Installing the Latest Release of Newtmgr from Source
+Installing the Latest Release of Newtmgr from Source
+~~~~~~~~~~~~~~~
+
If you have an older version of Windows or a 32 bit platform, you can
build and install the latest release version of newtmgr from source.
- 1. Download and install the latest version of
+1. Download and install the latest version of
`Go <https://golang.org/dl/>`__. Newtmgr requires Go version 1.7.6 or
higher.
- 2. Start MinGW terminal.
+2. Start MinGW terminal.
- 3. Create a Go workspace in the /tmp directory:
+3. Create a Go workspace in the /tmp directory:
.. code-block:: console
@@ -77,7 +79,7 @@ higher.
$ cd go
$ export GOPATH=/tmp/go
- 4. Run ``go get`` to download the newtmgr source. Note that ``go get``
+4. Run ``go get`` to download the newtmgr source. Note that ``go get``
pulls down the HEAD from the master branch in git, builds, and installs
newtmgr.
@@ -96,7 +98,7 @@ step:
# github.com/currantlabs/ble/examples/lib/dev
..\..\..\github.com\currantlabs\ble\examples\lib\dev\dev.go:7: undefined: DefaultDevice
- 5. Check out the source from the latest release version:
+5. Check out the source from the latest release version:
.. code-block:: console
@@ -105,7 +107,7 @@ step:
$ git checkout mynewt_1_3_0_tag
Note: checking out 'mynewt_1_3_0_tag'.
- 6. Build newtmgr from the latest release version:
+6. Build newtmgr from the latest release version:
.. code-block:: console
@@ -115,18 +117,20 @@ step:
$ ls /tmp/go/bin/newtmgr.exe
-rwxr-xr-x 1 user None 15457280 Sep 12 00:30 /tmp/go/bin/newtmgr.exe
- 7. If you have a Go workspace, remember to reset your GOPATH to your Go
+7. If you have a Go workspace, remember to reset your GOPATH to your Go
workspace.
- 7. Copy the newtmgr executable to a bin directory in your path. You can
+7. Copy the newtmgr executable to a bin directory in your path. You can
put it in the /usr/bin or the $GOPATH/bin directory.
- ### Checking the Installed Version
+Checking the Installed Version
+~~~~~~~~~~~~~~~
+
- 1. Run ``which newtmgr`` to verify that you are using the installed
+1. Run ``which newtmgr`` to verify that you are using the installed
version of newtmgr.
- 2. Get information about the newtmgr tool:
+2. Get information about the newtmgr tool:
.. code-block:: console
diff --git a/docs/newtmgr/prev_releases.rst b/docs/newtmgr/prev_releases.rst
index 20ffc7cfc..6b9b19c42 100644
--- a/docs/newtmgr/prev_releases.rst
+++ b/docs/newtmgr/prev_releases.rst
@@ -32,21 +32,23 @@ following commands:
$ echo 'export PATH=/usr/local/Cellar/mynewt-newtmgr@1.0/1.0.0/bin:$PATH' >> ~/.bash_profile
$ source ~/.bash_profile
- You can also manually symlink into /usr/local/bin as follows:
+You can also manually symlink into /usr/local/bin as follows:
- 1. Unlink newtmgr if you have the latest version of newtmgr installed:
+1. Unlink newtmgr if you have the latest version of newtmgr installed:
.. code-block:: console
$ brew unlink mynewt-newtmgr
- 2. Link mynewt-newt@1.0 into /usr/local/bin:
+2. Link mynewt-newt@1.0 into /usr/local/bin:
.. code-block:: console
$ brew link -f mynewt-newtmgr@1.0
- ### Linux 1. Download the binary:
+Linux 1. Download the binary:
+~~~~~~~~~~~~~~~
+
+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| Version | Download |
@@ -56,13 +58,15 @@ following commands:
| 1.1.0 | `newtmgr\_1.1.0-1\_amd64.deb <https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.1.0/newtmgr_1.1.0-1_amd64.deb>`__ |
+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
- 2. Run the ``sudo apt-get remove newtmgr`` command to remove the the
+2. Run the ``sudo apt-get remove newtmgr`` command to remove the the
current installation.
- 3. Install the package. For example, run
+3. Install the package. For example, run
``sudo dpkg -i newtmgr_1.0.0-1_amd64.deb`` to install newtmgr 1.0.0
- ### Windows 1. Download the binary:
+Windows 1. Download the binary:
+~~~~~~~~~~~~~~~
+
+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Version | Download |
@@ -70,7 +74,7 @@ current installation.
| 1.1.0 | `newtmgr\_1\_1\_0\_windows\_amd64.tar.gz <https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.1.0/newtmgr_1.1.0-1_amd64.deb>`__ |
+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- 2. Extract the file:
+2. Extract the file:
- If you previously built newtmgr from the master branch, you can
extract the file into your $GOPATH/bin directory. Note: This
diff --git a/docs/os/core_os/memory_pool/memory_pool.rst b/docs/os/core_os/memory_pool/memory_pool.rst
index 2c3316d04..43f20b183 100644
--- a/docs/os/core_os/memory_pool/memory_pool.rst
+++ b/docs/os/core_os/memory_pool/memory_pool.rst
@@ -20,7 +20,7 @@ of blocks, size of the blocks, etc).
struct os_mempool my_pool;
- The next order of business is to allocate the memory used by the memory
+The next order of business is to allocate the memory used by the memory
pool. This memory can either be statically allocated (i.e. a global
variable) or dynamically allocated (i.e. from the heap). When
determining the amount of memory required for the memory pool, simply
@@ -54,7 +54,7 @@ allocated on the correct boundary (i.e. OS\_ALIGNMENT).
os_membuf_t my_memory_buffer[OS_MEMPOOL_SIZE(NUM_BLOCKS, BLOCK_SIZE)];
- Now that the memory pool has been defined as well as the memory
+Now that the memory pool has been defined as well as the memory
required for the memory blocks which make up the pool the user needs to
initialize the memory pool by calling ``os_mempool_init``.
@@ -63,7 +63,7 @@ initialize the memory pool by calling ``os_mempool_init``.
os_mempool_init(&my_pool, NUM_BLOCKS, BLOCK_SIZE, my_memory_buffer,
"MyPool");
- Once the memory pool has been initialized the developer can allocate
+Once the memory pool has been initialized the developer can allocate
memory blocks from the pool by calling ``os_memblock_get``. When the
memory block is no longer needed the memory can be freed by calling
``os_memblock_put``.
diff --git a/docs/os/get_started/cross_tools.rst b/docs/os/get_started/cross_tools.rst
index f3fcfa2df..62ae26f76 100644
--- a/docs/os/get_started/cross_tools.rst
+++ b/docs/os/get_started/cross_tools.rst
@@ -31,7 +31,7 @@ created points to the correct version of the debugger.
$ brew tap PX4/homebrew-px4
$ brew update
$ brew install gcc-arm-none-eabi-49
- $ arm-none-eabi-gcc --version
+ $ arm-none-eabi-gcc --version
arm-none-eabi-gcc (GNU Tools for ARM Embedded Processors) 4.9.3 20150529 (release) [ARM/embedded-4_9-branch revision 224288]
Copyright (C) 2014 Free Software Foundation, Inc.
This is free software; see the source for copying conditions. There is NO
@@ -42,7 +42,9 @@ created points to the correct version of the debugger.
**Note:** If no version is specified, brew will install the latest
version available.
- ### Installing the ARM Toolchain For Linux
+Installing the ARM Toolchain For Linux
+~~~~~~~~~~~~~~~
+
On a Debian-based Linux distribution, gcc 4.9.3 for ARM can be installed
with apt-get as documented below. The steps are explained in depth at
@@ -50,14 +52,16 @@ https://launchpad.net/~team-gcc-arm-embedded/+archive/ubuntu/ppa.
.. code-block:: console
- $ sudo apt-get remove binutils-arm-none-eabi gcc-arm-none-eabi
+ $ sudo apt-get remove binutils-arm-none-eabi gcc-arm-none-eabi
$ sudo add-apt-repository ppa:team-gcc-arm-embedded/ppa
- $ sudo apt-get update
+ $ sudo apt-get update
$ sudo apt-get install gcc-arm-none-eabi
$ sudo apt-get install gdb-arm-none-eabi
- ### Installing the ARM Toolchain for Windows Step 1: Download and run
-the
+Installing the ARM Toolchain for Windows
+~~~~~~~~~~~~~~~
+
+Step 1: Download and run the
`installer <https://launchpad.net/gcc-arm-embedded/4.9/4.9-2015-q2-update/+download/gcc-arm-none-eabi-4_9-2015q2-20150609-win32.exe>`__
to install arm-none-eabi-gcc and arm-none-eabi-gdb. Select the default
destination folder: **C::raw-latex:`\Program `Files
@@ -98,25 +102,27 @@ to http://openocd.org.
OpenOCD version 0.10.0 with nrf52 support is required. A binary for this
version is available to download for Mac OS, Linux, and Windows.
- #### Installing OpenOCD on Mac OS Step 1: Download the `binary tarball
-for Mac
+Installing OpenOCD on Mac OS
+^^^^^^^^^^^^^^^^^^^
+
+Step 1: Download the `binary tarball for Mac
OS <https://github.com/runtimeco/openocd-binaries/raw/master/openocd-bin-0.10.0-MacOS.tgz>`__.
Step 2: Change to the root directory:
.. code-block:: console
- $cd /
+ $cd /
- Step 3: Untar the tarball and install into \*\* /usr/local/bin**. You
+Step 3: Untar the tarball and install into \*\* /usr/local/bin**. You
will need to replace ** ~/Downloads \*\* with the directory that the
tarball is downloaded to.
.. code-block:: console
- sudo tar -xf ~/Downloads/openocd-bin-0.10.0-MacOS.tgz `
+ sudo tar -xf ~/Downloads/openocd-bin-0.10.0-MacOS.tgz `
- Step 4: Check the OpenOCD version you are using.
+Step 4: Check the OpenOCD version you are using.
.. code-block:: console
@@ -139,17 +145,19 @@ If you see one of these errors:
- Library not loaded: /usr/local/lib/libhidapi.0.dylib - Run
``brew install hidapi``.
- #### Installing OpenOCD on Linux Step 1: Download the `binary tarball
-for
+Installing OpenOCD on Linux
+^^^^^^^^^^^^^^^^^^^
+
+Step 1: Download the `binary tarball for
Linux <https://github.com/runtimeco/openocd-binaries/raw/master/openocd-bin-0.10.0-Linux.tgz>`__
Step 2: Change to the root directory:
::
- $cd /
+ $cd /
- Step 3: Untar the tarball and install into \*\* /usr/local/bin**. You
+Step 3: Untar the tarball and install into \*\* /usr/local/bin**. You
will need to replace ** ~/Downloads \*\* with the directory that the
tarball is downloaded to.
@@ -159,7 +167,7 @@ tarball is downloaded to.
$sudo tar -xpf ~/Downloads/openocd-bin-0.10.0-Linux.tgz
- Step 4: Check the OpenOCD version you are using:
+Step 4: Check the OpenOCD version you are using:
.. code-block:: console
@@ -187,8 +195,10 @@ run the following command to install the libraries:
$sudo apt-get install libhidapi-dev:i386
- #### Installing OpenOCD on Windows Step 1: Download the `binary zip
-file for
+Installing OpenOCD on Windows
+^^^^^^^^^^^^^^^^^^^
+
+Step 1: Download the `binary zip file for
Windows <https://github.com/runtimeco/openocd-binaries/raw/master/openocd-0.10.0.zip>`__.
Step 2: Extract into the **C::raw-latex:`\openocd`-0.10.0** folder.
@@ -215,7 +225,9 @@ terminal and run the following commands:
You should see version: **0.10.0**.
- ###Installing SEGGER J-Link You can download and install Segger J-LINK
+Installing SEGGER J-Link You can download and install Segger J-LINK
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
Software and documentation pack from
`SEGGER <https://www.segger.com/jlink-software.html>`__.
diff --git a/docs/os/get_started/project_create.rst b/docs/os/get_started/project_create.rst
index 474e42e17..d664e3352 100644
--- a/docs/os/get_started/project_create.rst
+++ b/docs/os/get_started/project_create.rst
@@ -44,11 +44,12 @@ Creating a New Project and Fetching the Source Repository
This section describes how to use the newt tool to create a new project
and fetch the core mynewt source repository.
- ####Creating a New Project
+Creating a New Project
+^^^^^^^^^^^^^^^^^^^^^^^^^
Choose a name for your project. We name the project ``myproj``.
- Run the ``newt new myproj`` command, from your **dev** directory, to
+Run the ``newt new myproj`` command, from your **dev** directory, to
create a new project:
**Note:** This tutorial assumes you created a **dev** directory under
@@ -74,7 +75,7 @@ and ``pacman -Su tree`` from a MinGW terminal to install on Windows.
.. code-block:: console
$ cd myproj
- $ tree
+ $ tree
.
??? DISCLAIMER
??? LICENSE
@@ -116,7 +117,8 @@ base directory:
**Note:** The actual code and package files are not installed (except
the template for ``main.c``). See the next step to install the packages.
- #### Fetching the Mynewt Source Repository and Dependencies
+Fetching the Mynewt Source Repository and Dependencies
+^^^^^^^^^^^^^^^^^^^
By default, Mynewt projects rely on a single repository:
**apache-mynewt-core** and uses the source in the master branch. If you
@@ -138,7 +140,7 @@ branch may not be stable and you may encounter bugs or other problems.**
and use the latest master branch. Release 1.0.0 is not supported on
Windows.
- Run the ``newt install`` command, from your project base directory
+Run the ``newt install`` command, from your project base directory
(myproj), to fetch the source repository and dependencies.
**Note:** It may take a while to download the apache-mynewt-core
@@ -374,12 +376,14 @@ on Mynewt's simulated hardware.
Tutorials </os/tutorials/blinky.html>`__ to create a blinky application
for a target board.
- ####Building the Application To build the simulated blinky application,
-run ``newt build my_blinky_sim``:
+Building the Application
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To build the simulated blinky application, run ``newt build my_blinky_sim``:
.. code-block:: console
- $ newt build my_blinky_sim
+ $ newt build my_blinky_sim
Building target targets/my_blinky_sim
Compiling repos/apache-mynewt-core/hw/hal/src/hal_common.c
Compiling repos/apache-mynewt-core/hw/drivers/uart/src/uart.c
@@ -410,7 +414,7 @@ If you natively install the toolchain execute the binary directly:
$ ./bin/targets/my_blinky_sim/app/apps/blinky/blinky.elf
hal_gpio set pin 1 to 0
- If you are using newt docker, use ``newt run`` to run the simulated
+If you are using newt docker, use ``newt run`` to run the simulated
binary.
.. code-block:: console
diff --git a/docs/os/get_started/serial_access.rst b/docs/os/get_started/serial_access.rst
index f1c1e383b..e52614a81 100644
--- a/docs/os/get_started/serial_access.rst
+++ b/docs/os/get_started/serial_access.rst
@@ -96,7 +96,7 @@ directory and the format of the port name is platform dependent:
- Linux uses the format ``TTYUSB<N>``, where ``N`` is a number. For
example, TTYUSB2.
- This example is run on a Mac OS system.
+This example is run on a Mac OS system.
Check what USB devices are already connected:
@@ -107,7 +107,7 @@ Check what USB devices are already connected:
0 crw-rw-rw- 1 root wheel 20, 62 Nov 23 11:13 /dev/tty.usbmodem401322
$
- Plug in the FT232H board and check the ports again:
+Plug in the FT232H board and check the ports again:
.. code-block:: console
@@ -118,7 +118,7 @@ Check what USB devices are already connected:
0 crw-rw-rw- 1 root wheel 20, 64 Nov 23 11:26 /dev/tty.usbserial-0020124
$
- The FT232H is connected to ``/dev/tty.usbserial-0020124`` (The number
+The FT232H is connected to ``/dev/tty.usbserial-0020124`` (The number
after tty.usbserial will be different on your machine.) Use the screen
command to connect to the board:
@@ -126,7 +126,7 @@ command to connect to the board:
$ screen /dev/tty.usbserial-0020124 115200
- To exit out of ``screen`` you'll type ``control-A`` followed by
+To exit out of ``screen`` you'll type ``control-A`` followed by
``control-\`` and you'll be back to a terminal prompt.
You can also use minicom:
@@ -143,7 +143,7 @@ You can also use minicom:
Press Meta-Z for help on special keys
- If there's no Mynewt app running, or the Mynewt app doesn't have the
+If there's no Mynewt app running, or the Mynewt app doesn't have the
Shell and Console enabled, you won't see anything there, but you can
always refer back to this page from later tutorials if you need to.
@@ -182,7 +182,7 @@ Plug in the FT232H board and check the ports again:
crw-rw-rw- 1 <user> None 117, 5 May 9 04:55 /dev/ttyS5
$
- The FT232H board is connected to port /dev/ttyS10 (or COM11):
+The FT232H board is connected to port /dev/ttyS10 (or COM11):
|Device Manager - FT232H|
diff --git a/docs/os/modules/console/console.rst b/docs/os/modules/console/console.rst
index f71151c36..60a9f032d 100644
--- a/docs/os/modules/console/console.rst
+++ b/docs/os/modules/console/console.rst
@@ -64,11 +64,13 @@ file:
pkg.req_apis:
- console
- The project ``pkg.yml`` file also specifies the version of the console
+The project ``pkg.yml`` file also specifies the version of the console
package to use.
- #### Using the Full Console Package A project that requires the full
-console capability must list the ``sys/console/full`` package as a
+Using the Full Console Package
+^^^^^^^^^^^^^^^^^^^
+
+A project that requires the full console capability must list the ``sys/console/full`` package as a
dependency in its ``pkg.yml`` file.
An example is the ``slinky`` application. It requires the full console
@@ -89,7 +91,9 @@ capability and has the following ``pkg.yml`` file:
...
- sys/id
- #### Using the Stub Console Package
+Using the Stub Console Package
+^^^^^^^^^^^^^^^^^^^
+
A project that uses console stub API must list the ``sys/console/stub``
package as a dependency in its ``pkg.yml`` file.
@@ -153,13 +157,17 @@ has the following ``pkg.yml`` file:
- sys/console/minimal
- boot/boot_serial
- #### Output to the Console
+Output to the Console
+^^^^^^^^^^^^^^^^^^^
+
You use the ``console_write()`` function to write raw output and the
``console_printf()`` function to write a C-style formatted string to the
console.
- #### Input from the Console
+Input from the Console
+^^^^^^^^^^^^^^^^^^^
+
The following syscfg settings control input from the console:
@@ -172,12 +180,14 @@ The following syscfg settings control input from the console:
set echo on or off programatically.
- ``CONSOLE_MAX_INPUT_LEN``: Specifies the maximum input line length.
- The Mynewt 1.1 console package adds a new API for reading input data
+The Mynewt 1.1 console package adds a new API for reading input data
from the console. The package supports backward compatibility for the
Mynewt 1.0 console API. The steps you use to receive data from the
console for each API version are provided below.
- ##### Mynewt 1.0 Console API
+# Mynewt 1.0 Console API
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
To use the Mynewt 1.0 console API for reading input from the console,
you perform the follow steps:
@@ -193,7 +203,9 @@ you perform the follow steps:
enable backward compatibility support. The setting is enabled by
default.
- ##### Mynewt 1.1 Console API
+# Mynewt 1.1 Console API
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
Mynewt 1.1 console API adds the
``console_set_queues(struct os_eventq *avail_queue, struct os_eventq *lines_queue)``
@@ -246,7 +258,7 @@ is received. The two event queues are used as follows:
pointers to the callback and the ``console_input`` buffer, must be
added to the avail\_queue.
- Here is a code excerpt that shows how to use the
+Here is a code excerpt that shows how to use the
``console_set_queues()`` function. The example adds one event to the
avail\_queue and uses the OS default event queue for the lines\_queue.
@@ -282,16 +294,18 @@ avail\_queue and uses the OS default event queue for the lines\_queue.
return;
}
- static void
+ static void
myapp_init(void)
{
os_eventq_init(&avail_queue);
os_eventq_put(&avail_queue, &myapp_console_event);
-
+
console_set_queues(&avail_queue, os_eventq_dflt_get());
}
- ###Data structures
+Data structures
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
The ``struct console_input`` data structure represents a console input
buffer. Each event added to the console avail\_queue must have the
diff --git a/docs/os/modules/console/console_echo.rst b/docs/os/modules/console/console_echo.rst
index 03a6ad543..ae2a3ed2c 100644
--- a/docs/os/modules/console/console_echo.rst
+++ b/docs/os/modules/console/console_echo.rst
@@ -1,4 +1,4 @@
- console\_echo
+console\_echo
---------------
.. code-block:: console
diff --git a/docs/os/modules/console/console_init.rst b/docs/os/modules/console/console_init.rst
index ce6d2aa8f..bfe6f558b 100644
--- a/docs/os/modules/console/console_init.rst
+++ b/docs/os/modules/console/console_init.rst
@@ -1,4 +1,4 @@
- console\_init
+console\_init
---------------
.. code-block:: console
diff --git a/docs/os/modules/console/console_is_init.rst b/docs/os/modules/console/console_is_init.rst
index d0fc18afb..7a5a31530 100644
--- a/docs/os/modules/console/console_is_init.rst
+++ b/docs/os/modules/console/console_is_init.rst
@@ -1,4 +1,4 @@
- console\_is\_init
+console\_is\_init
-------------------
.. code-block:: console
diff --git a/docs/os/modules/console/console_printf.rst b/docs/os/modules/console/console_printf.rst
index eacd11b9c..684600da8 100644
--- a/docs/os/modules/console/console_printf.rst
+++ b/docs/os/modules/console/console_printf.rst
@@ -1,4 +1,4 @@
- console\_printf
+console\_printf
----------------
.. code-block:: console
diff --git a/docs/os/modules/console/console_read.rst b/docs/os/modules/console/console_read.rst
index 06cc68636..679af4bfe 100644
--- a/docs/os/modules/console/console_read.rst
+++ b/docs/os/modules/console/console_read.rst
@@ -1,4 +1,4 @@
- console\_read
+console\_read
---------------
.. code:: c
diff --git a/docs/os/modules/console/console_set_queues.rst b/docs/os/modules/console/console_set_queues.rst
index 0e6dc42e8..d150bf299 100644
--- a/docs/os/modules/console/console_set_queues.rst
+++ b/docs/os/modules/console/console_set_queues.rst
@@ -1,4 +1,4 @@
- console\_set\_queues
+console\_set\_queues
----------------------
.. code:: c
diff --git a/docs/os/modules/console/console_write.rst b/docs/os/modules/console/console_write.rst
index cbe401e7b..6b8cfdc43 100644
--- a/docs/os/modules/console/console_write.rst
+++ b/docs/os/modules/console/console_write.rst
@@ -1,4 +1,4 @@
- console\_write
+console\_write
----------------
.. code-block:: console
diff --git a/docs/os/modules/elua/lua_init.rst b/docs/os/modules/elua/lua_init.rst
index dd3d8c7c2..2895332a9 100644
--- a/docs/os/modules/elua/lua_init.rst
+++ b/docs/os/modules/elua/lua_init.rst
@@ -1,4 +1,4 @@
- lua\_init
+lua\_init
-----------
.. code-block:: console
diff --git a/docs/os/modules/elua/lua_main.rst b/docs/os/modules/elua/lua_main.rst
index 57bf85047..191f7b28b 100644
--- a/docs/os/modules/elua/lua_main.rst
+++ b/docs/os/modules/elua/lua_main.rst
@@ -1,4 +1,4 @@
- lua\_main
+lua\_main
-----------
.. code-block:: console
diff --git a/docs/os/modules/imgmgr/imgmgr_module_init.rst b/docs/os/modules/imgmgr/imgmgr_module_init.rst
index c9b3df196..a626ab585 100644
--- a/docs/os/modules/imgmgr/imgmgr_module_init.rst
+++ b/docs/os/modules/imgmgr/imgmgr_module_init.rst
@@ -1,4 +1,4 @@
- imgmgr\_module\_init
+imgmgr\_module\_init
----------------------
.. code-block:: console
diff --git a/docs/os/modules/imgmgr/imgr_ver_parse.rst b/docs/os/modules/imgmgr/imgr_ver_parse.rst
index 068d18cc5..93c1f3864 100644
--- a/docs/os/modules/imgmgr/imgr_ver_parse.rst
+++ b/docs/os/modules/imgmgr/imgr_ver_parse.rst
@@ -1,4 +1,4 @@
- imgr\_ver\_parse
+imgr\_ver\_parse
------------------
.. code-block:: console
diff --git a/docs/os/modules/imgmgr/imgr_ver_str.rst b/docs/os/modules/imgmgr/imgr_ver_str.rst
index 248ddc462..3aca24719 100644
--- a/docs/os/modules/imgmgr/imgr_ver_str.rst
+++ b/docs/os/modules/imgmgr/imgr_ver_str.rst
@@ -1,4 +1,4 @@
- imgr\_ver\_str
+imgr\_ver\_str
----------------
.. code-block:: console
diff --git a/docs/os/modules/json/json_encode_object_entry.rst b/docs/os/modules/json/json_encode_object_entry.rst
index c667ac863..a8e7f606d 100644
--- a/docs/os/modules/json/json_encode_object_entry.rst
+++ b/docs/os/modules/json/json_encode_object_entry.rst
@@ -1,4 +1,4 @@
- json\_encode\_object\_entry
+json\_encode\_object\_entry
-----------------------------
.. code-block:: console
diff --git a/docs/os/modules/json/json_encode_object_finish.rst b/docs/os/modules/json/json_encode_object_finish.rst
index 3d78afb94..0d98c82c1 100644
--- a/docs/os/modules/json/json_encode_object_finish.rst
+++ b/docs/os/modules/json/json_encode_object_finish.rst
@@ -1,4 +1,4 @@
- json\_encode\_object\_finish
+json\_encode\_object\_finish
------------------------------
.. code-block:: console
diff --git a/docs/os/modules/json/json_encode_object_key.rst b/docs/os/modules/json/json_encode_object_key.rst
index d76617afe..749e85ab9 100644
--- a/docs/os/modules/json/json_encode_object_key.rst
+++ b/docs/os/modules/json/json_encode_object_key.rst
@@ -1,4 +1,4 @@
- json\_encode\_object\_key
+json\_encode\_object\_key
---------------------------
.. code-block:: console
diff --git a/docs/os/modules/json/json_encode_object_start.rst b/docs/os/modules/json/json_encode_object_start.rst
index ddde4f1ee..800354cac 100644
--- a/docs/os/modules/json/json_encode_object_start.rst
+++ b/docs/os/modules/json/json_encode_object_start.rst
@@ -1,4 +1,4 @@
- json\_encode\_object\_start
+json\_encode\_object\_start
-----------------------------
.. code-block:: console
diff --git a/docs/os/modules/json/json_read_object.rst b/docs/os/modules/json/json_read_object.rst
index 12045d949..379dc9fff 100644
--- a/docs/os/modules/json/json_read_object.rst
+++ b/docs/os/modules/json/json_read_object.rst
@@ -1,4 +1,4 @@
- json\_read\_object
+json\_read\_object
--------------------
.. code-block:: console
diff --git a/docs/os/modules/logs/logs.rst b/docs/os/modules/logs/logs.rst
index 44d9b909c..7d98e2fd8 100644
--- a/docs/os/modules/logs/logs.rst
+++ b/docs/os/modules/logs/logs.rst
@@ -22,7 +22,7 @@ follows:
pkg.req_apis:
- log
- The application's ``pkg.yml`` file specifies the version of the log
+The application's ``pkg.yml`` file specifies the version of the log
package to use. A project that requires the full logging capability must
list the ``sys/log/full`` package as a dependency in its ``pkg.yml``
file:
@@ -32,7 +32,7 @@ file:
pkg.deps:
- sys/log/full
- You can use the ``sys/log/stub`` package if you want to build your
+You can use the ``sys/log/stub`` package if you want to build your
application without logging to reduce code size.
Syscfg Settings
@@ -55,7 +55,9 @@ following setting corresponds to LOG\_LEVEL\_ERROR:
The ``LOG_LEVEL`` setting applies to all modules registered with the log
package.
- ### Log
+Log
+~~~~~~~~~~~~~~~
+
Each log stream requires a ``log`` structure to define its logging
properties.
diff --git a/docs/os/modules/sensor_framework/sensor_api.rst b/docs/os/modules/sensor_framework/sensor_api.rst
index 1902ad0cf..956f5ebc5 100644
--- a/docs/os/modules/sensor_framework/sensor_api.rst
+++ b/docs/os/modules/sensor_framework/sensor_api.rst
@@ -53,7 +53,9 @@ object:
API </os/modules/sensor_framework/sensor_manager_api.html>`__ for
details.
- #### Setting the Configured Sensor Types
+Setting the Configured Sensor Types
+^^^^^^^^^^^^^^^^^^^
+
The BSP, or the sensor creator package, also calls the
``<sensorname>_config()`` function to configure the sensor device with
@@ -169,7 +171,9 @@ is a bit mask that specifies the sensor types that the sensor device is
configured for. Only sensor data for a configured sensor type can be
read.
- #### Sensor Types
+Sensor Types
+^^^^^^^^^^^^^^^^^^^
+
The ``sensor_type_t`` type is an enumeration of a bit mask of sensor
types, with each bit representing one sensor type. Here is an excerpt of
@@ -235,7 +239,9 @@ The ``si_cs_pin`` specifies the chip select pin and is optional. The
#define SENSOR_ITF_I2C (1)
#define SENSOR_ITF_UART (2)
- #### Sensor Value Type
+Sensor Value Type
+^^^^^^^^^^^^^^^^^^^
+
The ``struct sensor_cfg`` data structure represents the configuration
sensor type:
@@ -256,7 +262,7 @@ sensor type:
uint8_t _reserved[3];
};
- Only the ``sc_valtype`` field is currently used and specifies the data
+Only the ``sc_valtype`` field is currently used and specifies the data
value type of the sensor data. The valid value types are:
.. code:: c
@@ -284,7 +290,9 @@ value type of the sensor data. The valid value types are:
*/
#define SENSOR_VALUE_TYPE_FLOAT_TRIPLET (4)
- #### Sensor Driver Functions
+Sensor Driver Functions
+^^^^^^^^^^^^^^^^^^^
+
The ``struct sensor_device`` data structure represents the device driver
functions. The sensor device driver must implement the functions and set
@@ -297,7 +305,9 @@ up the function pointers.
sensor_get_config_func_t sd_get_config;
};
- ### List of Functions:
+List of Functions:
+~~~~~~~~~~~~~~~
+
These are the functions defined by the sensor API. Please see the
`sensor.h <https://github.com/apache/mynewt-core/blob/master/hw/sensor/include/sensor/sensor.h>`__
diff --git a/docs/os/modules/sensor_framework/sensor_create.rst b/docs/os/modules/sensor_framework/sensor_create.rst
index bdc95ffcb..13d3dc302 100644
--- a/docs/os/modules/sensor_framework/sensor_create.rst
+++ b/docs/os/modules/sensor_framework/sensor_create.rst
@@ -11,14 +11,16 @@ discuss what the ``hw/sensor/creator`` package does differently to
create an off-board sensor. We also discuss how an application can
change the default configuration for a sensor device.
- ### Creating an Onboard Sensor To create and initialize a sensor device
-named ``SENSORNAME``, the BSP implements the following in the
+Creating an Onboard Sensor
+~~~~~~~~~~~~~~~
+
+To create and initialize a sensor device named ``SENSORNAME``, the BSP implements the following in the
``hal_bsp.c`` file.
**Note**: All example excerpts are from the code that creates the
LIS2DH12 onboard sensor in the nrf52\_thingy BSP.
- 1. Define a ``<SENSORNAME>_ONB`` syscfg setting to specify whether the
+1. Define a ``<SENSORNAME>_ONB`` syscfg setting to specify whether the
onboard sensor named ``SENSORNAME`` is enabled. The setting is disabled
by default. The setting is used to conditionally include the code to
create a sensor device for ``SENSORNAME`` when it is enabled by the
@@ -32,13 +34,13 @@ application. For example:
description: 'NRF52 Thingy onboard lis2dh12 sensor'
value: 0
- 2. Include the "<sensorname>/<sensorname>.h" header file. The BSP uses
+2. Include the "<sensorname>/<sensorname>.h" header file. The BSP uses
the functions and data structures that a device driver package exports.
See the `Sensor Device
Driver </os/modules/sensor_framework/sensor_driver.html>`__ page for
details.
- 3. Declare a variable named ``sensorname`` of type
+3. Declare a variable named ``sensorname`` of type
``struct sensorname``. For example:
.. code:: c
@@ -49,7 +51,7 @@ details.
static struct lis2dh12 lis2dh12;
#endif
- 4. Declare and specify the values for a variable of type
+4. Declare and specify the values for a variable of type
``struct sensor_itf`` that the sensor device driver uses to communicate
with the sensor device. For example:
@@ -63,7 +65,7 @@ with the sensor device. For example:
.si_addr = 0x19
<br>
- 5. In the ``hal_bsp_init()`` function, create an OS device for the
+5. In the ``hal_bsp_init()`` function, create an OS device for the
sensor device. Call the ``os_dev_create()`` function and pass the
following to the function:
@@ -137,7 +139,7 @@ is called when the BSP is initialized during sysinit(). For example:
return 0;
}
- 7. Add the following in the BSP ``pkg.yml`` file:
+7. Add the following in the BSP ``pkg.yml`` file:
- A conditional package dependency for the
``hw/drivers/sensors/<sensorname>`` package when the
@@ -157,7 +159,9 @@ For example:
pkg.init:
config_lis2dh12_sensor: 400
- ### Creating an Off-Board Sensor
+Creating an Off-Board Sensor
+~~~~~~~~~~~~~~~
+
The steps to create an off-board sensor is very similar to the steps for
a BSP. The ``hw/sensor/creator/`` package also declares the variables
@@ -167,7 +171,7 @@ for a BSP. The package does the following differently.
**Note**: All example excerpts are from the code that creates the BNO055
off-board sensor in ``hw/sensor/creator`` package.
- 1. Define a ``<SENSORNAME>_OFB`` syscfg setting to specify whether the
+1. Define a ``<SENSORNAME>_OFB`` syscfg setting to specify whether the
off-board sensor named ``SENSORNAME`` is enabled. This setting is
disabled by default. The ``hw/sensor/creator`` package uses the setting
to conditionally include the code to create the sensor device when it is
@@ -184,10 +188,10 @@ enabled by the application.
BNO055_OFB:
description: 'BNO055 is present'
value : 0
-
+
...
- 2. Add the calls to the ``os_dev_create()`` and the
+2. Add the calls to the ``os_dev_create()`` and the
``config_<sensorname>_sensor()`` functions in the
``sensor_dev_create()`` function defined in the ``sensor_creator.c``
file . The ``sensor_dev_create()`` function is the ``hw/sensor/creator``
@@ -218,7 +222,7 @@ For example:
}
- 3. Add a conditional package dependency for the
+3. Add a conditional package dependency for the
``hw/drivers/sensors/<sensorname>`` package when the
``<SENSORNAME>_OFB`` setting is enabled. For example:
diff --git a/docs/os/modules/sensor_framework/sensor_driver.rst b/docs/os/modules/sensor_framework/sensor_driver.rst
index 3ef3d61db..4e71e33fd 100644
--- a/docs/os/modules/sensor_framework/sensor_driver.rst
+++ b/docs/os/modules/sensor_framework/sensor_driver.rst
@@ -18,7 +18,9 @@ driver for the sensor named ``SENSORNAME``.
**Note:** All example excerpts are from the BNO055 sensor device driver
package.
- ### Initializing and Configuring a Sensor Device
+Initializing and Configuring a Sensor Device
+~~~~~~~~~~~~~~~
+
A driver package for a sensor named ``SENSORNAME`` must define and
export the following data structures and functions to initialize and
@@ -146,7 +148,9 @@ For example:
bno055_sensor_get_config
};
- ### Registering the Sensor in the Sensor Framework
+Registering the Sensor in the Sensor Framework
+~~~~~~~~~~~~~~~
+
The device driver must initialize and register a ``struct sensor``
object with the sensor manager. See the `Sensor
@@ -312,7 +316,9 @@ err: return rc; }
\`\`\`
- ### Implementing a Sensor Device Shell Command
+Implementing a Sensor Device Shell Command
+~~~~~~~~~~~~~~~
+
A sensor device driver package may optionally implement a sensor device
shell command that retrieves and sets sensor device information to aid
@@ -408,7 +414,9 @@ endif
\`\`\`
- ### Defining Stats
+Defining Stats
+~~~~~~~~~~~~~~~
+
A sensor device driver may also define stats for the sensor. See the
`Stats OS Guide <os/modules/stats/stats.html>`__ for more details on how
diff --git a/docs/os/modules/shell/shell.rst b/docs/os/modules/shell/shell.rst
index 2eb66d7ef..3f2fea2b0 100644
--- a/docs/os/modules/shell/shell.rst
+++ b/docs/os/modules/shell/shell.rst
@@ -105,7 +105,9 @@ There are two methods to register command handlers in Mynewt 1.1:
this method. You can increase this value if your application and
the packages it includes register more than the default value.
- ####Enabling Help Information for Shell Commands
+Enabling Help Information for Shell Commands
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
The shell supports command help. A package that supports command help
initializes the ``struct shell_cmd`` data structure with help text for
@@ -133,13 +135,17 @@ whether to print the current os ticks in the prompt. The
``SHELL_PROMPT_MODULE`` syscfg setting enables or disables this module.
The module is disabled by default.
- #### Enabling Command Name Completion
+Enabling Command Name Completion
+^^^^^^^^^^^^^^^^^^^
+
The shell supports command name completion. The ``SHELL_COMPLETION``
syscfg setting enables or disables the feature. The feature is enabled
by default.
- ### Processing Newtmgr Line Protocol Over Serial Transport
+Processing Newtmgr Line Protocol Over Serial Transport
+~~~~~~~~~~~~~~~
+
The shell's second job is to handle packet framing, encoding, and
decoding of newtmgr protocol messages that are sent over the console.
@@ -154,7 +160,7 @@ enabled over shell. The setting is enabled by default.
Data Structures
---------------
- The ``struct shell_cmd`` data structure represents a shell command and
+The ``struct shell_cmd`` data structure represents a shell command and
is used to register a command.
.. code-block:: console
@@ -242,7 +248,7 @@ module.
**Note**: A command handler registered via the ``shell_cmd_register()``
function is automatically added to the ``compat`` module.
- The ``struct shell_param`` and ``struct shell_cmd_help`` data
+The ``struct shell_param`` and ``struct shell_cmd_help`` data
structures hold help texts for a shell command.
.. code:: c
diff --git a/docs/os/modules/shell/shell_cmd_register.rst b/docs/os/modules/shell/shell_cmd_register.rst
index b0bde1065..03e132aab 100644
--- a/docs/os/modules/shell/shell_cmd_register.rst
+++ b/docs/os/modules/shell/shell_cmd_register.rst
@@ -1,4 +1,4 @@
- shell\_cmd\_register
+shell\_cmd\_register
----------------------
.. code-block:: console
@@ -34,7 +34,9 @@ number of shell commands that the ``compat`` module supports. This
function aborts if the number of handlers registered exceeds this limit.
You can increase the value for this setting.
- #### Example
+Example
+^^^^^^^^^^^^^^^^^^^
+
.. code-block:: console
diff --git a/docs/os/modules/shell/shell_evq_set.rst b/docs/os/modules/shell/shell_evq_set.rst
index 7103c6cc4..920fbc6ce 100644
--- a/docs/os/modules/shell/shell_evq_set.rst
+++ b/docs/os/modules/shell/shell_evq_set.rst
@@ -1,4 +1,4 @@
- shell\_evq\_set
+shell\_evq\_set
----------------
.. code:: c
diff --git a/docs/os/modules/shell/shell_nlip_input_register.rst b/docs/os/modules/shell/shell_nlip_input_register.rst
index 7a0acf3a3..266424dd7 100644
--- a/docs/os/modules/shell/shell_nlip_input_register.rst
+++ b/docs/os/modules/shell/shell_nlip_input_register.rst
@@ -1,4 +1,4 @@
- shell\_nlip\_input\_register
+shell\_nlip\_input\_register
------------------------------
.. code-block:: console
diff --git a/docs/os/modules/shell/shell_nlip_output.rst b/docs/os/modules/shell/shell_nlip_output.rst
index 365ca99d7..0317e5572 100644
--- a/docs/os/modules/shell/shell_nlip_output.rst
+++ b/docs/os/modules/shell/shell_nlip_output.rst
@@ -1,4 +1,4 @@
- shell\_nlip\_output
+shell\_nlip\_output
---------------------
.. code-block:: console
diff --git a/docs/os/modules/shell/shell_register.rst b/docs/os/modules/shell/shell_register.rst
index c5493f446..3626473bf 100644
--- a/docs/os/modules/shell/shell_register.rst
+++ b/docs/os/modules/shell/shell_register.rst
@@ -1,4 +1,4 @@
- shell\_register
+shell\_register
-----------------
.. code:: c
diff --git a/docs/os/modules/shell/shell_register_app_cmd_handler.rst b/docs/os/modules/shell/shell_register_app_cmd_handler.rst
index fb0d9348a..ca396f808 100644
--- a/docs/os/modules/shell/shell_register_app_cmd_handler.rst
+++ b/docs/os/modules/shell/shell_register_app_cmd_handler.rst
@@ -1,4 +1,4 @@
- shell\_register\_app\_cmd\_handler
+shell\_register\_app\_cmd\_handler
------------------------------------
.. code:: c
diff --git a/docs/os/modules/shell/shell_register_default_module.rst b/docs/os/modules/shell/shell_register_default_module.rst
index 92475b988..51055b993 100644
--- a/docs/os/modules/shell/shell_register_default_module.rst
+++ b/docs/os/modules/shell/shell_register_default_module.rst
@@ -1,4 +1,4 @@
- shell\_register\_default\_module
+shell\_register\_default\_module
---------------------------------
.. code:: c
diff --git a/docs/os/modules/sysinitconfig/sysconfig_error.rst b/docs/os/modules/sysinitconfig/sysconfig_error.rst
index 87cfd49bb..929cb2202 100644
--- a/docs/os/modules/sysinitconfig/sysconfig_error.rst
+++ b/docs/os/modules/sysinitconfig/sysconfig_error.rst
@@ -37,7 +37,9 @@ override violations:
value but needs to conditionally override the value based on another
setting value.
- ####Example: Ambiguity Violation Error Message
+Example: Ambiguity Violation Error Message
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
The following example shows the error message that newt outputs for an
ambiguity violation:
@@ -206,7 +208,9 @@ cause the error:
syscfg.vals:
REBOOT_LOG_FLASH_AREA: FLASH_AREA_NFFS
- ###Restriction Violations For setting definitions with ``restrictions``
+Restriction Violations For setting definitions with ``restrictions``
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
specified, newt checks for the following violations:
- A setting with a ``$notnull`` restriction does not have a value.
@@ -283,7 +287,9 @@ files that cause the error:
syscfg.vals:
CONFIG_FCB: 1
- ###Task Priority Violations
+Task Priority Violations
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
For ``task_priority`` type setting definitions, newt checks for the
following violations:
@@ -330,7 +336,9 @@ value.
**Note:** Newt does not output the ``Setting history`` with task
priority violation error messages.
- ###Duplicate System Configuration Setting Definition
+Duplicate System Configuration Setting Definition
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
A setting definition must be unique. Newt checks that only one package
in the target defines a setting. The following example shows the error
@@ -379,7 +387,7 @@ is an excerpt from its ``syscfg.yml`` file:
STATS_NEWTMGR: 1
LOG_NEWMGR: 1
- The ``newt target config show slinky_sim`` command outputs the
+The ``newt target config show slinky_sim`` command outputs the
following WARNING message:
.. code-block:: console
@@ -405,7 +413,9 @@ DEBUG message:
2017/02/18 17:06:21.451 [DEBUG] LOG_NEWMGR: [apps/slinky:1]
2017/02/18 17:06:21.451 [DEBUG] NFFS_FLASH_AREA: [hw/bsp/native:FLASH_AREA_NFFS]
- #### BSP Package Overrides Undefined Configuration Settings
+BSP Package Overrides Undefined Configuration Settings
+^^^^^^^^^^^^^^^^^^^
+
You might see a warning that indicates your application's BSP package is
overriding some undefined settings. As you can see from the previous
diff --git a/docs/os/modules/testutil/test_assert.rst b/docs/os/modules/testutil/test_assert.rst
index 77c07d2c2..add28e10d 100644
--- a/docs/os/modules/testutil/test_assert.rst
+++ b/docs/os/modules/testutil/test_assert.rst
@@ -1,4 +1,4 @@
- TEST\_ASSERT
+TEST\_ASSERT
-------------
.. code-block:: console
diff --git a/docs/os/modules/testutil/test_case.rst b/docs/os/modules/testutil/test_case.rst
index 08813e581..3b8d886f0 100644
--- a/docs/os/modules/testutil/test_case.rst
+++ b/docs/os/modules/testutil/test_case.rst
@@ -1,4 +1,4 @@
- TEST\_CASE
+TEST\_CASE
------------
.. code-block:: console
diff --git a/docs/os/modules/testutil/test_decl.rst b/docs/os/modules/testutil/test_decl.rst
index b5b9c0caa..fe0daf924 100644
--- a/docs/os/modules/testutil/test_decl.rst
+++ b/docs/os/modules/testutil/test_decl.rst
@@ -1,4 +1,4 @@
- TEST\_CASE\_DECL
+TEST\_CASE\_DECL
------------------
.. code-block:: console
diff --git a/docs/os/modules/testutil/test_pass.rst b/docs/os/modules/testutil/test_pass.rst
index c15b96a5f..7913a4b7e 100644
--- a/docs/os/modules/testutil/test_pass.rst
+++ b/docs/os/modules/testutil/test_pass.rst
@@ -1,4 +1,4 @@
- TEST\_PASS
+TEST\_PASS
------------
.. code-block:: console
diff --git a/docs/os/modules/testutil/test_suite.rst b/docs/os/modules/testutil/test_suite.rst
index 98391a73e..e929745c9 100644
--- a/docs/os/modules/testutil/test_suite.rst
+++ b/docs/os/modules/testutil/test_suite.rst
@@ -1,4 +1,4 @@
- TEST\_SUITE
+TEST\_SUITE
-------------
.. code-block:: console
diff --git a/docs/os/modules/testutil/tu_init.rst b/docs/os/modules/testutil/tu_init.rst
index 0f97690d5..93a7d2ff1 100644
--- a/docs/os/modules/testutil/tu_init.rst
+++ b/docs/os/modules/testutil/tu_init.rst
@@ -1,4 +1,4 @@
- tu\_init
+tu\_init
---------
.. code-block:: console
diff --git a/docs/os/modules/testutil/tu_restart.rst b/docs/os/modules/testutil/tu_restart.rst
index 0065c021c..a08a62e61 100644
--- a/docs/os/modules/testutil/tu_restart.rst
+++ b/docs/os/modules/testutil/tu_restart.rst
@@ -1,4 +1,4 @@
- tu\_restart
+tu\_restart
-------------
.. code-block:: console
diff --git a/docs/os/tutorials/add_newtmgr.rst b/docs/os/tutorials/add_newtmgr.rst
index da6068582..5089a2915 100644
--- a/docs/os/tutorials/add_newtmgr.rst
+++ b/docs/os/tutorials/add_newtmgr.rst
@@ -1,7 +1,7 @@
Enabling Newt Manager in Your Application
-----------------------------------------
- In order for your application to communicate with the newtmgr tool and
+In order for your application to communicate with the newtmgr tool and
process Newt Manager commands, you must enable Newt Manager device
management and the support to process Newt Manager commands in your
application. This tutorial explains how to add the support to your
@@ -89,7 +89,7 @@ parameter in the target or application ``syscfg.yml`` file:
SHELL_TASK: 1
SHELL_NEWTMGR: 1
- The first five configuration settings enable support for the Newt
+The first five configuration settings enable support for the Newt
Manager ``log``, ``stat``, ``config``, ``crash``, and ``run`` commands.
The ``SHELL_TASK`` setting enables the shell for serial transport. The
``SHELL_NEWTMGR`` setting enables newtmgr support in the shell.
@@ -128,7 +128,7 @@ Add the ``mgmt/mgmt.h`` header file:
#include <mgmt/mgmt.h>
- Add the call to specify the event queue. In the ``main()`` function,
+Add the call to specify the event queue. In the ``main()`` function,
scroll down to the ``while (1)`` loop and add the following statement
above the loop:
@@ -204,7 +204,7 @@ communicating with the newtmgr tool:
# newtmgr -c myconn echo hello
hello
- Test your application to ensure that it can process a Newt Manager
+Test your application to ensure that it can process a Newt Manager
command that is supported by a different package. Issue the ``stat``
command to see the BLE stats.
@@ -238,7 +238,9 @@ command to see the BLE stats.
Your application is now able to communicate with the newtmgr tool.
- ### Other Configuration Options
+Other Configuration Options
+~~~~~~~~~~~~~~~
+
This section explains how to customize your application to use other
Newt Manager protocol options.
diff --git a/docs/os/tutorials/ble/blehci_project.rst b/docs/os/tutorials/ble/blehci_project.rst
index 58443351a..c03483a53 100644
--- a/docs/os/tutorials/ble/blehci_project.rst
+++ b/docs/os/tutorials/ble/blehci_project.rst
@@ -136,7 +136,7 @@ Load the bootloader:
Loading bootloader
$
- Load the application image:
+Load the application image:
.. code-block:: console
diff --git a/docs/os/tutorials/ble/eddystone.rst b/docs/os/tutorials/ble/eddystone.rst
index ec0bcc559..1c31a8875 100644
--- a/docs/os/tutorials/ble/eddystone.rst
+++ b/docs/os/tutorials/ble/eddystone.rst
@@ -52,7 +52,9 @@ behave:
Let's take these one at a time.
- #### 1. Wait for host-controller sync
+1. Wait for host-controller sync
+^^^^^^^^^^^^^^^^^^^
+
The first step, waiting for host-controller-sync, is mandatory in all
BLE applications. The NimBLE stack is inoperable while the two
@@ -96,7 +98,9 @@ sync occurs. Our callback function, ``ble_app_on_sync()``, kicks off the
control flow that we specified above. Now we need to fill in the two
stub functions.
- #### 2. Configure the NimBLE stack with an address
+2. Configure the NimBLE stack with an address
+^^^^^^^^^^^^^^^^^^^
+
A BLE device needs an address to do just about anything. Some devices
have a public Bluetooth address burned into them, but this is not always
@@ -145,7 +149,9 @@ stack:
You can click either of the function names for more detailed
documentation.
- #### 3. Advertise indefinitely
+3. Advertise indefinitely
+^^^^^^^^^^^^^^^^^^^
+
The first step in advertising is to configure the host with advertising
data. This operation tells the host what data to use for the contents of
diff --git a/docs/os/tutorials/ble/ibeacon.rst b/docs/os/tutorials/ble/ibeacon.rst
index 032636930..fb53597f5 100644
--- a/docs/os/tutorials/ble/ibeacon.rst
+++ b/docs/os/tutorials/ble/ibeacon.rst
@@ -39,7 +39,9 @@ behave:
Let's take these one at a time.
- #### 1. Wait for host-controller sync
+1. Wait for host-controller sync
+^^^^^^^^^^^^^^^^^^^
+
The first step, waiting for host-controller-sync, is mandatory in all
BLE applications. The NimBLE stack is inoperable while the two
@@ -83,7 +85,9 @@ sync occurs. Our callback function, ``ble_app_on_sync()``, kicks off the
control flow that we specified above. Now we need to fill in the two
stub functions.
- #### 2. Configure the NimBLE stack with an address
+2. Configure the NimBLE stack with an address
+^^^^^^^^^^^^^^^^^^^
+
A BLE device needs an address to do just about anything. Some devices
have a public Bluetooth address burned into them, but this is not always
@@ -132,7 +136,9 @@ stack:
You can click either of the function names for more detailed
documentation.
- #### 3. Advertise indefinitely
+3. Advertise indefinitely
+^^^^^^^^^^^^^^^^^^^
+
The first step in advertising is to configure the host with advertising
data. This operation tells the host what data to use for the contents of
diff --git a/docs/os/tutorials/blinky/arduino_zero.rst b/docs/os/tutorials/blinky/arduino_zero.rst
index 6b1f9465e..e5f9c894f 100644
--- a/docs/os/tutorials/blinky/arduino_zero.rst
+++ b/docs/os/tutorials/blinky/arduino_zero.rst
@@ -44,7 +44,7 @@ Run the following commands to create a new project:
apache-mynewt-core
$
- Fetch External Packages
+Fetch External Packages
~~~~~~~~~~~~~~~~~~~~~~~~
Mynewt uses source code provided directly from the chip manufacturer for
@@ -76,7 +76,7 @@ repo: mynewt-core
repository.mynewt\_arduino\_zero: type: github vers: 1-latest user:
runtimeco repo: mynewt\_arduino\_zero $ \`\`\`
- Install the project dependencies using the ``newt install`` command
+Install the project dependencies using the ``newt install`` command
(you can specify ``-v`` for verbose output):
.. code-block:: console
@@ -208,7 +208,9 @@ application image:
Linking ~/dev/myproj/bin/targets/arduino_blinky/app/apps/blinky/blinky.elf
Target successfully built: targets/arduino_blinky
- ### Connect to the Board
+Connect to the Board
+~~~~~~~~~~~~~~~
+
Connect your computer to the Arduino Zero (from now on we'll call this
the target) with a Micro-USB cable through the Programming Port as shown
@@ -266,7 +268,7 @@ will need to erase the board.
Info : at91samd21g18.cpu: hardware has 4 breakpoints, 2 watchpoints
Error: Target not halted
- To erase your board, start a debug session and enter the highlighted
+To erase your board, start a debug session and enter the highlighted
commands at the ``(gdb)`` prompts:
**Note:** On Windows, openocd and gdb are started in separate Windows
@@ -279,7 +281,7 @@ terminal.
Run the ``newt load arduino_boot`` command again after erasing the
board.
- Reminder if you are using Docker: When working with actual hardware,
+Reminder if you are using Docker: When working with actual hardware,
remember that each board has an ID. If you swap boards and do not
refresh the USB Device Filter on the VirtualBox UI, the ID might be
stale and the Docker instance may not be able to see the board
@@ -372,4 +374,4 @@ If you want the image to run without the debugger connected, simply quit
the debugger and restart the board. The image you programmed will come
and run on the Arduino on next boot!
- You should see the LED blink!
+You should see the LED blink!
diff --git a/docs/os/tutorials/blinky/blinky_console.rst b/docs/os/tutorials/blinky/blinky_console.rst
index 1a86f7baf..aa7681c9c 100644
--- a/docs/os/tutorials/blinky/blinky_console.rst
+++ b/docs/os/tutorials/blinky/blinky_console.rst
@@ -214,7 +214,7 @@ a Windows COM port: ``/dev/ttyS<N>`` maps to ``COM<N+1>``. For example,
You can also use the Windows Device Manager to locate the COM port.
- To test and make sure that the Shell is running, first just hit :
+To test and make sure that the Shell is running, first just hit :
.. code-block:: console
diff --git a/docs/os/tutorials/blinky/blinky_primo.rst b/docs/os/tutorials/blinky/blinky_primo.rst
index f49368a07..c8723884a 100644
--- a/docs/os/tutorials/blinky/blinky_primo.rst
+++ b/docs/os/tutorials/blinky/blinky_primo.rst
@@ -15,8 +15,10 @@ Prerequisites
- Install a debugger. Choose one of the two options below: Option 1
requires additional hardware but very easy to set up.
- ##### Option 1 \* `Segger J-Link Debug
-Probe <https://www.segger.com/jlink-debug-probes.html>`__ - any model
+# Option 1
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ \* `Segger J-Link Debug Probe <https://www.segger.com/jlink-debug-probes.html>`__ - any model
(this tutorial has been tested with J-Link EDU and J-Link Pro) \*
`J-Link 9 pin Cortex-M
Adapter <https://www.segger.com/jlink-adapters.html#CM_9pin>`__ that
@@ -56,7 +58,9 @@ Run the following commands to create a new project:
apache-mynewt-core
$
- ### Create the Targets
+Create the Targets
+~~~~~~~~~~~~~~~
+
Create two targets for the Arduino Primo board - one for the bootloader
and one for the Blinky application.
@@ -69,7 +73,7 @@ to create a bootloader target. We name the target ``primo_boot``.
$ newt target create primo_boot
$ newt target set primo_boot app=@apache-mynewt-core/apps/boot bsp=@apache-mynewt-core/hw/bsp/arduino_primo_nrf52 build_profile=optimized
- Run the following ``newt target`` commands to create a target for the
+Run the following ``newt target`` commands to create a target for the
Blinky application. We name the target ``primoblinky``.
.. code-block:: console
@@ -77,7 +81,7 @@ Blinky application. We name the target ``primoblinky``.
$ newt target create primoblinky
$ newt target set primoblinky app=apps/blinky bsp=@apache-mynewt-core/hw/bsp/arduino_primo_nrf52 build_profile=debug
- If you are using openocd, run the following ``newt target set``
+If you are using openocd, run the following ``newt target set``
commands:
.. code-block:: console
@@ -85,7 +89,7 @@ commands:
$ newt target set primoblinky syscfg=OPENOCD_DEBUG=1
$ newt target set primo_boot syscfg=OPENOCD_DEBUG=1
- You can run the ``newt target show`` command to verify the target
+You can run the ``newt target show`` command to verify the target
settings:
.. code-block:: console
@@ -129,7 +133,7 @@ Run the ``newt build primo_boot`` command to build the bootloader:
Linking ~/dev/myproj/bin/targets/primo_boot/app/apps/boot/boot.elf
Target successfully built: targets/primo_boot
- Run the ``newt build primoblinky`` command to build the Blinky
+Run the ``newt build primoblinky`` command to build the Blinky
application:
.. code-block:: console
@@ -222,12 +226,14 @@ additional notes about the installation:
Run the ``newt load primo_boot`` command again.
- ###Load the Blinky Application Image Run the ``newt load primoblinky``
-command to load the Blinky application image onto the board.
+Load the Blinky Application Image
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Run the ``newt load primoblinky`` command to load the Blinky application image onto the board.
.. code-block:: console
- $ newt load primoblinky
+ $ newt load primoblinky
Loading app image into slot 1
$
@@ -236,8 +242,10 @@ blink!
Note: If the LED does not blink, try resetting the board.
- ###Erase Flash If you want to erase the flash and load the image again,
-use JLinkExe and issue the ``erase`` command when you are using the
+Erase Flash
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you want to erase the flash and load the image again, use JLinkExe and issue the ``erase`` command when you are using the
Jlink debug probe:
**Note:** On Windows: Run the ``jlink`` command with the same arguments
@@ -292,5 +300,3 @@ terminal.
warning: Source file is more recent than executable.
200 if (ticks > 0) {
(gdb) mon nrf52 mass_erase
-
-
diff --git a/docs/os/tutorials/blinky/blinky_stm32f4disc.rst b/docs/os/tutorials/blinky/blinky_stm32f4disc.rst
index a0d965c8e..39c565c16 100644
--- a/docs/os/tutorials/blinky/blinky_stm32f4disc.rst
+++ b/docs/os/tutorials/blinky/blinky_stm32f4disc.rst
@@ -52,7 +52,7 @@ to create a bootloader target. We name the target ``stm32f4disc_boot``:
$ newt target set stm32f4disc_boot bsp=@apache-mynewt-core/hw/bsp/stm32f4discovery
$ newt target set stm32f4disc_boot build_profile=optimized
- Run the following ``newt target`` commands to create a target for the
+Run the following ``newt target`` commands to create a target for the
Blinky application. We name the target ``stm32f4disc_blinky``:
.. code-block:: console
@@ -62,7 +62,7 @@ Blinky application. We name the target ``stm32f4disc_blinky``:
$ newt target set stm32f4disc_blinky bsp=@apache-mynewt-core/hw/bsp/stm32f4discovery
$ newt target set stm32f4disc_blinky build_profile=debug
- You can run the ``newt target show`` command to verify the target
+You can run the ``newt target show`` command to verify the target
settings:
.. code-block:: console
@@ -106,7 +106,7 @@ Run the ``newt build stm32f4disc_boot`` command to build the bootloader:
Linking ~/dev/myproj/bin/targets/stm32f4disc_boot/app/apps/boot/boot.elf
Target successfully built: targets/stm32f4disc_boot
- Run the ``newt build stm32f4disc_blinky`` command to build the Blinky
+Run the ``newt build stm32f4disc_blinky`` command to build the Blinky
application:
.. code-block:: console
@@ -197,7 +197,7 @@ If you receive an error like
some example ``udev`` rules for ST-LINK programmers
`here <https://github.com/texane/stlink/tree/master/etc/udev/rules.d>`__.
- Run the ``newt load stm32f4disc_blinky`` command to load the Blinky
+Run the ``newt load stm32f4disc_blinky`` command to load the Blinky
application image onto the board.
.. code-block:: console
diff --git a/docs/os/tutorials/blinky/nRF52.rst b/docs/os/tutorials/blinky/nRF52.rst
index 9f49eae07..7d3a87933 100644
--- a/docs/os/tutorials/blinky/nRF52.rst
+++ b/docs/os/tutorials/blinky/nRF52.rst
@@ -54,7 +54,7 @@ one for the Blinky application.
Run the following ``newt target`` commands, from your project directory,
to create a bootloader target. We name the target ``nrf52_boot``:
- Note: This tutorial uses the Nordic nRF52-DK board. You must specify
+Note: This tutorial uses the Nordic nRF52-DK board. You must specify
the correct bsp for the board you are using.
- For the Nordic Preview Dev Kit choose
@@ -71,7 +71,7 @@ the correct bsp for the board you are using.
$ newt target set nrf52_boot bsp=@apache-mynewt-core/hw/bsp/nrf52pdk
$ newt target set nrf52_boot build_profile=optimized
- Run the following ``newt target`` commands to create a target for the
+Run the following ``newt target`` commands to create a target for the
Blinky application. We name the target ``nrf52_blinky``.
.. code:: hl_lines="3"
@@ -81,7 +81,7 @@ Blinky application. We name the target ``nrf52_blinky``.
$ newt target set nrf52_blinky bsp=@apache-mynewt-core/hw/bsp/nrf52dk
$ newt target set nrf52_blinky build_profile=debug
- You can run the ``newt target show`` command to verify the target
+You can run the ``newt target show`` command to verify the target
settings:
.. code-block:: console
@@ -121,7 +121,7 @@ Run the ``newt build nrf52_boot`` command to build the bootloader:
Linking ~/dev/myproj/bin/targets/nrf52_boot/app/apps/boot/boot.elf
Target successfully built: targets/nrf52_boot
- Run the ``newt build nrf52_blinky`` command to build the Blinky
+Run the ``newt build nrf52_blinky`` command to build the Blinky
application:
.. code-block:: console
@@ -175,7 +175,7 @@ board:
Loading bootloader
$
- Run the ``newt load nrf52_blinky`` command to load the Blinky
+Run the ``newt load nrf52_blinky`` command to load the Blinky
application image onto the board.
.. code-block:: console
diff --git a/docs/os/tutorials/blinky/olimex.rst b/docs/os/tutorials/blinky/olimex.rst
index 5ce7a08c2..0b981860c 100644
--- a/docs/os/tutorials/blinky/olimex.rst
+++ b/docs/os/tutorials/blinky/olimex.rst
@@ -13,8 +13,10 @@ application on an Olimex STM32-E407 board. ### Prerequisites
- Have a USB A-B type cable to connect the debugger to your computer.
- Install the `OpenOCD debugger </os/get_started/cross_tools/>`__.
- ### Create a Project Create a new project if you do not have an
-existing one. You can skip this step and proceed to `create the
+Create a Project
+~~~~~~~~~~~~~~~
+
+Create a new project if you do not have an existing one. You can skip this step and proceed to `create the
targets <#create_targets>`__ if you already created a project.
Run the following commands to create a new project:
@@ -50,7 +52,7 @@ to create a bootloader target. We name the target ``boot_olimex``.
$ newt target set boot_olimex app=@apache-mynewt-core/apps/boot
$ newt target set boot_olimex bsp=@apache-mynewt-core/hw/bsp/olimex_stm32-e407_devboard
- Run the following ``newt target`` commands to create a target for the
+Run the following ``newt target`` commands to create a target for the
Blinky application. We name the target ``olimex_blinky``.
.. code-block:: console
@@ -84,8 +86,10 @@ Run the ``newt build boot_olimex`` command to build the bootloader:
Linking ~/dev/myproj/bin/targets/boot_olimex/app/apps/boot/boot.elf
Target successfully built: targets/boot_olimex
- ### Build the Blinky Application Run the ``newt build olimex_blinky``
-command to build the blinky application:
+Build the Blinky Application
+~~~~~~~~~~~~~~~
+
+Run the ``newt build olimex_blinky`` command to build the blinky application:
.. code-block:: console
@@ -190,7 +194,7 @@ will need to install the usb driver. Download
- Click Install Driver.
- Run the ``newt load boot_olimex`` command again.
- Run the ``newt load olimex_blinky`` command to load the blinky
+Run the ``newt load olimex_blinky`` command to load the blinky
application image onto the board:
.. code-block:: console
@@ -200,9 +204,9 @@ application image onto the board:
Load command: ~/dev/myproj/repos/apache-mynewt-core/hw/bsp/olimex_stm32-e407_devboard/olimex_stm32-e407_devboard_download.sh ~/dev/myproj/repos/apache-mynewt-core/hw/bsp/olimex_stm32-e407_devboard ~/dev/myproj/bin/targets/olimex_blinky/app/apps/blinky/blinky
Successfully loaded image.
- The LED should be blinking!
+The LED should be blinking!
- Let's double check that it is indeed booting from flash and making the
+Let's double check that it is indeed booting from flash and making the
LED blink from the image in flash. Pull the USB cable off the Olimex
JTAG adaptor, severing the debug connection to the JTAG port. Next power
off the Olimex board by pulling out the USB cable from the board. Wait
@@ -220,7 +224,7 @@ when you quit gdb. In addition, the output of openocd is logged to the
openocd.log file in your project's base directory instead of the
terminal.
- Type ``c`` to continue inside the gdb session.
+Type ``c`` to continue inside the gdb session.
.. code-block:: console
@@ -234,7 +238,7 @@ terminal.
(info)
...
target state: halted
- target halted due to debug-request, current mode: Thread
+ target halted due to debug-request, current mode: Thread
xPSR: 0x01000000 pc: 0x08000250 msp: 0x10010000
Info : accepting 'gdb' connection from 3333
Info : device id = 0x10036413
@@ -257,8 +261,8 @@ locations is specific to the processor.
(gdb) monitor flash erase_sector 0 0 4
erased sectors 0 through 4 on flash bank 0 in 2.296712s
(gdb) monitor mdw 0x08000000 16
- 0x08000000: ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff
- (0x08000020: ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff
- (0x08000000: ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff
- (0x08000020: ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff
+ 0x08000000: ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff
+ (0x08000020: ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff
+ (0x08000000: ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff
+ (0x08000020: ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff
(gdb) monitor flash info 0
diff --git a/docs/os/tutorials/blinky/rbnano2.rst b/docs/os/tutorials/blinky/rbnano2.rst
index 2c356eadf..c777bdef7 100644
--- a/docs/os/tutorials/blinky/rbnano2.rst
+++ b/docs/os/tutorials/blinky/rbnano2.rst
@@ -51,7 +51,7 @@ to create a bootloader target. We name the target ``rbnano2_boot``:
$ newt target set rbnano2_boot bsp=@apache-mynewt-core/hw/bsp/rb-nano2
$ newt target set rbnano2_boot build_profile=optimized
- Run the following ``newt target`` commands to create a target for the
+Run the following ``newt target`` commands to create a target for the
Blinky application. We name the target ``nrf52_blinky``.
.. code-block:: console
@@ -61,7 +61,7 @@ Blinky application. We name the target ``nrf52_blinky``.
$ newt target set rbnano2_blinky bsp=@apache-mynewt-core/hw/bsp/rb-nano2
$ newt target set rbnano2_blinky build_profile=debug
- You can run the ``newt target show`` command to verify the target
+You can run the ``newt target show`` command to verify the target
settings:
.. code-block:: console
@@ -101,7 +101,7 @@ Run the ``newt build rbnano2_boot`` command to build the bootloader:
Linking ~/dev/myproj/bin/targets/rbnano2_boot/app/apps/boot/boot.elf
Target successfully built: targets/rbnano2_boot
- Run the ``newt build rbnano2_blinky`` command to build the Blinky
+Run the ``newt build rbnano2_blinky`` command to build the Blinky
application:
.. code-block:: console
@@ -167,7 +167,9 @@ additional notes about the installation:
Run the ``newt load rbnano2_boot`` command again.
- ####Clear the Write Protection on the Flash Memory The flash memory on
+Clear the Write Protection on the Flash Memory The flash memory on
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
the RedBear Nano 2 comes write protected from the factory. If you get an
error loading the bootloader and you are using a brand new chip, you
need to clear the write protection from the debugger and then load the
diff --git a/docs/os/tutorials/event_queue.rst b/docs/os/tutorials/event_queue.rst
index 37d12c56b..fa8c1f7be 100644
--- a/docs/os/tutorials/event_queue.rst
+++ b/docs/os/tutorials/event_queue.rst
@@ -81,7 +81,9 @@ The application handles events from three sources on two event queues:
- hw/hal
- sys/console/stub
- #### Application Task Generated Events
+Application Task Generated Events
+^^^^^^^^^^^^^^^^^^^
+
The application creates a task that generates events, at periodic
intervals, to toggle the LED at pin ``TASK_LED``. The event is queued on
@@ -102,7 +104,7 @@ callback function to process the event:
.ev_cb = my_ev_cb,
};
- Implement the ``my_ev_cb()`` callback function to process a task
+Implement the ``my_ev_cb()`` callback function to process a task
generated event and toggle the LED at pin ``TASK_LED``:
.. code:: c
@@ -122,7 +124,7 @@ generated event and toggle the LED at pin ``TASK_LED``:
return;
}
- Create a task that generates an event at periodic intervals and adds,
+Create a task that generates an event at periodic intervals and adds,
using the ``os_eventq_put()`` function, the event to the Mynewt default
event queue:
@@ -161,7 +163,7 @@ event queue:
}
- Implement the application ``main()`` function to call the
+Implement the application ``main()`` function to call the
``os_eventq_run()`` function to dequeue an event from the Mynewt default
event queue and call the callback function to process the event.
@@ -181,7 +183,9 @@ event queue and call the callback function to process the event.
assert(0);
}
- #### OS Callout Timer Events
+OS Callout Timer Events
+^^^^^^^^^^^^^^^^^^^
+
Set up OS callout timer events. For this example, we use a dedicated
event queue for timer events to show you how to create a dedicated event
@@ -211,7 +215,7 @@ event and toggle the LED at pin ``CALLOUT_LED``:
os_callout_reset(&my_callout, OS_TICKS_PER_SEC / 2);
}
- In the ``init_tasks()`` function, initialize the
+In the ``init_tasks()`` function, initialize the
``my_timer_interrupt_eventq`` event queue, create a task to process
events from the queue, and initialize the OS callout for the timer:
@@ -250,7 +254,7 @@ events from the queue, and initialize the OS callout for the timer:
}
- Implement the ``my_timer_interrupt_task()`` task handler to dispatch
+Implement the ``my_timer_interrupt_task()`` task handler to dispatch
events from the ``my_timer_interrupt_eventq`` event queue:
.. code:: c
@@ -264,7 +268,9 @@ events from the ``my_timer_interrupt_eventq`` event queue:
}
}
- #### Interrupt Events
+Interrupt Events
+^^^^^^^^^^^^^^^^^^^
+
The application toggles the LED each time button 1 on the board is
pressed. The interrupt handler generates an event when the GPIO for
@@ -281,7 +287,7 @@ Declare and initialize the ``gpio_ev`` event with the
.ev_cb = my_interrupt_ev_cb,
};
- Implement the ``my_interrupt_ev_cb()`` callback function to process an
+Implement the ``my_interrupt_ev_cb()`` callback function to process an
interrupt event and toggle the LED at pin ``GPIO_LED``:
.. code:: c
@@ -351,7 +357,9 @@ the LEDs:
hal_gpio_init_out(GPIO_LED, 1);
}
- ### Putting It All Together
+Putting It All Together
+~~~~~~~~~~~~~~~
+
Here is the complete ``main.c`` source for your application. Build the
application and load it on your board. The task LED (LED1) blinks at an
diff --git a/docs/os/tutorials/nrf52_adc.rst b/docs/os/tutorials/nrf52_adc.rst
index a668d2ae1..a01bab285 100644
--- a/docs/os/tutorials/nrf52_adc.rst
+++ b/docs/os/tutorials/nrf52_adc.rst
@@ -102,7 +102,7 @@ Create the targets
Create two targets - one for the bootloader and one for the nrf52 board.
- Note: The correct bsp must be chosen for the board you are using.
+Note: The correct bsp must be chosen for the board you are using.
- For the Nordic Dev Kit choose @apache-mynewt-core/hw/bsp/nrf52dk
instead (in the highlighted lines)
diff --git a/docs/os/tutorials/ota_upgrade_nrf52.rst b/docs/os/tutorials/ota_upgrade_nrf52.rst
index f57790483..4e00de5a8 100644
--- a/docs/os/tutorials/ota_upgrade_nrf52.rst
+++ b/docs/os/tutorials/ota_upgrade_nrf52.rst
@@ -39,7 +39,9 @@ Ensure that you meet the following prerequisites:
via a serial connection. See `BLE Peripheral
App </os/tutorials/bleprph/bleprph-app/>`__.
- ### Reducing the Log Level
+Reducing the Log Level
+~~~~~~~~~~~~~~~
+
You need to build your application with log level set to INFO or lower.
The default log level for the **bleprph** app is set to DEBUG. The extra
@@ -54,8 +56,10 @@ reduce the log level to INFO, build, and load the application.
$ newt create-image myperiph 1.0.0
$ newt load myperiph
- ### Upgrading an Image on a Device Once you have an application with
-newtmgr image management with BLE transport support running on a device,
+Upgrading an Image on a Device
+~~~~~~~~~~~~~~~
+
+Once you have an application with newtmgr image management with BLE transport support running on a device,
you can use the newtmgr tool to upgrade an image over-the-air.
You must perform the following steps to upgrade an image:
@@ -68,8 +72,10 @@ image permanent.
See the `Bootloader </os/modules/bootloader/bootloader>`__ section for
more information on the bootloader, image slots, and boot states.
- ### Step 1: Creating a Newtmgr Connection Profile The **bleprph**
-application sets and advertises ``nimble-bleprph`` as its bluetooth
+Step 1: Creating a Newtmgr Connection Profile
+~~~~~~~~~~~~~~~
+
+The **bleprph** application sets and advertises ``nimble-bleprph`` as its bluetooth
device address. Run the ``newtmgr conn add`` command to create a newtmgr
connection profile that uses this peer address to communicate with the
device over BLE:
@@ -80,13 +86,13 @@ device over BLE:
$ newtmgr conn add mybleprph type=ble connstring="peer_name=nimble-bleprph"
Connection profile mybleprph successfully added
- Verify that the newtmgr tool can communicate with the device and check
+Verify that the newtmgr tool can communicate with the device and check
the image status on the device:
.. code-block:: console
- $ newtmgr image list -c mybleprph
+ $ newtmgr image list -c mybleprph
Images:
slot=0
version: 1.0.0
@@ -107,7 +113,7 @@ upload the new image. You can upload a different image.
$ newt create-image myperiph 2.0.0
App image succesfully generated: ~/dev/myproj/bin/targets/myperiph/app/apps/bleprph/bleprph.img
- Run the ``newtmgr image upload`` command to upload the image:
+Run the ``newtmgr image upload`` command to upload the image:
.. code-block:: console
@@ -132,7 +138,7 @@ upload the new image. You can upload a different image.
The numbers indicate the number of bytes that the newtmgr tool has
uploaded.
- Verify that the image uploaded to the secondary slot on the device
+Verify that the image uploaded to the secondary slot on the device
successfully:
.. code-block:: console
@@ -148,7 +154,7 @@ successfully:
slot=1
version: 2.0.0
bootable: true
- flags:
+ flags:
hash: 291ebc02a8c345911c96fdf4e7b9015a843697658fd6b5faa0eb257a23e93682
Split status: N/A (0)
@@ -178,7 +184,7 @@ slot and runs the image.
The status of the image in the secondary slot is now set to **pending**.
- Power the device OFF and ON and run the ``newtmgr image list`` command
+Power the device OFF and ON and run the ``newtmgr image list`` command
to check the image status on the device after the reboot:
.. code-block:: console
@@ -212,7 +218,7 @@ image hash value in the command:
.. code-block:: console
- $ newtmgr image confirm -c mybleprph
+ $ newtmgr image confirm -c mybleprph
Images:
slot=0
version: 2.0.0
@@ -222,7 +228,7 @@ image hash value in the command:
slot=1
version: 1.0.0
bootable: true
- flags:
+ flags:
hash: b8d17c77a03b37603cd9f89fdcfe0ba726f8ddff6eac63011dee2e959cc316c2
Split status: N/A (0)
diff --git a/docs/os/tutorials/pin-wheel-mods.rst b/docs/os/tutorials/pin-wheel-mods.rst
index f368d729c..3bc104186 100644
--- a/docs/os/tutorials/pin-wheel-mods.rst
+++ b/docs/os/tutorials/pin-wheel-mods.rst
@@ -1,7 +1,9 @@
Pin Wheel Modifications to "Blinky" on STM32F3 Discovery
--------------------------------------------------------
- ### Objective
+Objective
+~~~~~~~~~~~~~~~
+
Learn how to modify an existing app -- the `blinky <STM32F303.html>`__ app
-- to light all the LEDs on the STM32F3 Discovery board.
diff --git a/docs/os/tutorials/segger_sysview.rst b/docs/os/tutorials/segger_sysview.rst
index b8fd0df5a..d95802f40 100644
--- a/docs/os/tutorials/segger_sysview.rst
+++ b/docs/os/tutorials/segger_sysview.rst
@@ -1,7 +1,9 @@
SEGGER SystemView
-----------------
- ### Objective
+Objective
+~~~~~~~~~~~~~~~
+
With `SEGGER's SystemView <https://www.segger.com/systemview.html>`__
you can "record data from the target system while it is running. The
@@ -71,7 +73,7 @@ attach to:
Launch the app
~~~~~~~~~~~~~~
- Launch the app and press **OK** in the System Information dialog box.
+Launch the app and press **OK** in the System Information dialog box.
.. figure:: pics/segger_sysview1.png
:alt: SEGGER SystemView
diff --git a/docs/os/tutorials/sensors/sensor_bleprph_oic.rst b/docs/os/tutorials/sensors/sensor_bleprph_oic.rst
index 11fddec48..9fb443cd0 100644
--- a/docs/os/tutorials/sensors/sensor_bleprph_oic.rst
+++ b/docs/os/tutorials/sensors/sensor_bleprph_oic.rst
@@ -44,9 +44,11 @@ To add OIC sensor support, we modify the bleprph\_oic application to
call the ``sensor_oic_init()`` function in the OIC application
initialization handler.
- ### Step 1: Copying the bleprph\_oic source
+Step 1: Copying the bleprph\_oic source
+~~~~~~~~~~~~~~~
- 1. Copy the @apache-mynewt-core/apps/bleprph\_oic to a new package. We
+
+1. Copy the @apache-mynewt-core/apps/bleprph\_oic to a new package. We
name the new package **apps/bleprph\_oic\_sensor**. From your project
base directory, run the ``newt pkg copy`` command:
@@ -56,7 +58,7 @@ base directory, run the ``newt pkg copy`` command:
$ newt pkg copy @apache-mynewt-core/apps/bleprph_oic @apache-mynewt-core/apps/bleprph_oic_sensor
Copying package @apache-mynewt-core/apps/bleprph_oic to @apache-mynewt-core/apps/bleprph_oic_sensor
- 2. The newt tools creates the ``bleprph_oic_sensor`` package in the
+2. The newt tools creates the ``bleprph_oic_sensor`` package in the
``~/dev/myproj/repos/apache-mynewt-core/apps/bleprph_oic_sensor``
directory. Go to the directory to update the package ``pkg.yml`` and
source files.
@@ -92,7 +94,9 @@ net/nimble/host/store/ram - net/nimble/transport/ram
\`\`\`
- ### Step 3: Setting Syscfg Values to Enable OIC Support
+Step 3: Setting Syscfg Values to Enable OIC Support
+~~~~~~~~~~~~~~~
+
Add the following setting values to ``syscfg.vals`` in the
``syscfg.yml`` file:
@@ -138,7 +142,9 @@ We make the following modifications to main.c:
- Delete the OIC application request handler functions that process the
CoAP requests for the light resource.
- #### Adding the Sensor Package Header File:
+Adding the Sensor Package Header File:
+^^^^^^^^^^^^^^^^^^^
+
Add the sensor package header file ``sensor/sensor.h`` below
``#include "bleprph.h"`` file:
@@ -155,7 +161,7 @@ Modifying the omgr\_app\_init() Function
Make the following modifications to the ``omgr_app_init()`` function:
- 1. Delete the code segment that creates the OIC device and resource.
+1. Delete the code segment that creates the OIC device and resource.
The lines to delete are highlighted below:
\`\`\`hl\_lines="4 7 8 9 10 11 12 13 14 15 16 17 18 19"
@@ -198,7 +204,7 @@ to create an OIC resource for the sensor device:
}
- 3. Add the call to the ``sensor_oic_init()`` function to initialize the
+3. Add the call to the ``sensor_oic_init()`` function to initialize the
sensor framework OIC server support:
.. code:: hl_lines="9"
@@ -216,7 +222,9 @@ sensor framework OIC server support:
}
- #### Deleting the app\_get\_light() and app\_set\_light() Functions
+Deleting the app\_get\_light() and app\_set\_light() Functions
+^^^^^^^^^^^^^^^^^^^
+
Since we modify the application to no longer create an OIC light
resource, the ``app_get_light()`` and the ``app_set_light()`` handler
@@ -224,7 +232,9 @@ functions that process read and write requests are not used. We need to
delete the functions to avoid compilation errors. Search for the two
functions and delete them.
- ### Step 5: Creating and Building the Application Image
+Step 5: Creating and Building the Application Image
+~~~~~~~~~~~~~~~
+
In this step of the tutorial we create and build an application image
for the bleprph\_oic\_sensor application to verify that the application
@@ -234,7 +244,7 @@ We use the same syscfg settings from the `Enabling OIC Sensor Data
Monitoring in the sensors\_test Application
Tutorial </os/tutorials/sensors/sensor_nrf52_bno055_oic.html>`__.
- 1. From your project base directory, run the ``newt create target``
+1. From your project base directory, run the ``newt create target``
command to create a new target named ``nrf52_bleprph_oic_bno055``:
.. code-block:: console
@@ -243,7 +253,7 @@ command to create a new target named ``nrf52_bleprph_oic_bno055``:
$ newt target create nrf52_bleprph_oic_bno055
Target targets/nrf52_bleprph_oic_bno055 successfully created
- 2. Run the ``newt target set`` command to set the app, bsp, and
+2. Run the ``newt target set`` command to set the app, bsp, and
build\_profile variables for the target.
.. code-block:: console
@@ -255,7 +265,7 @@ build\_profile variables for the target.
Target targets/nrf52_bleprph_oic_bno055 successfully set target.build_profile to debug
$
- 3. Run the ``newt target set`` command to set ``I2C_0=1``,
+3. Run the ``newt target set`` command to set ``I2C_0=1``,
``BNO055_OFB=1``, ``BLE_MAX_CONNECTIONS=4``, ``MSYS_1_BLOCK_COUNT=52``,
``MSYS_1_BLOCK_SIZE=100``, and ``OC_APP_RESOURCES=11``.
@@ -266,11 +276,13 @@ build\_profile variables for the target.
Target targets/nrf52_bleprph_oic_bno055 successfully set target.syscfg to BNO055_OFB=1:I2C_0=1:BLE_MAX_CONNECTIONS=4:MSYS_1_BLOCK_COUNT=52:MSYS_1_BLOCK_SIZE=100:OC_APP_RESOURCES=11
$
- 4. Run the ``newt build nrf52_bleprph_oic_bno055`` and
+4. Run the ``newt build nrf52_bleprph_oic_bno055`` and
``newt create-image nrf52_bleprph_oic_bno055 1.0.0`` commands to build
and create the application image.
- ### Step 6: Connecting the Sensor and Loading the Images to the Board
+Step 6: Connecting the Sensor and Loading the Images to the Board
+~~~~~~~~~~~~~~~
+
Perform the following steps to reboot the board with the new images:
@@ -291,7 +303,9 @@ Perform the following steps to reboot the board with the new images:
application image.
4. Power the device OFF and ON to reboot.
- ### Step 7: Viewing Sensor Data from the Mynewt Smart Device Controller
+Step 7: Viewing Sensor Data from the Mynewt Smart Device Controller
+~~~~~~~~~~~~~~~
+
Start the Mynewt Smart Device Controller app on your iOS or Android
device to view the sensor data. You should already have the app
@@ -333,5 +347,5 @@ from the Android App:
<p>
- 2. Move your BNO055 sensor device around to see the values for the
+2. Move your BNO055 sensor device around to see the values for the
coordinates change.
diff --git a/docs/os/tutorials/sensors/sensor_nrf52_bno055.rst b/docs/os/tutorials/sensors/sensor_nrf52_bno055.rst
index 2a2040b6a..6ceb28eeb 100644
--- a/docs/os/tutorials/sensors/sensor_nrf52_bno055.rst
+++ b/docs/os/tutorials/sensors/sensor_nrf52_bno055.rst
@@ -92,8 +92,10 @@ enable the application functionality that this tutorial demonstrates:
setting needs to be set to enable the shell support in the package.
The sensors\_test application enables this setting by default.
- ### Step 1: Creating the Application Target In this step, you create a
-target for the sensors\_test application that enables the BNO055
+Step 1: Creating the Application Target
+~~~~~~~~~~~~~~~
+
+In this step, you create a target for the sensors\_test application that enables the BNO055
off-board sensor.
To add the BNO055 sensor support, you create the application target with
@@ -120,7 +122,7 @@ the following syscfg settings enabled:
commands. The ``SENSOR_CLI`` setting, that specifies whether the
``sensor`` shell command is enabled, is enabled by default.
- 1. Run the ``newt target create`` command, from your project base
+1. Run the ``newt target create`` command, from your project base
directory, to create the target. We name the target
``nrf52_bno055_test``:
@@ -131,20 +133,20 @@ directory, to create the target. We name the target
Target targets/nrf52_bno055_test successfully created
$
- 2. Run the ``newt target set`` command to set the app, bsp, and
+2. Run the ``newt target set`` command to set the app, bsp, and
build\_profile variables for the target:
.. code-block:: console
- $ newt target set nrf52_bno055_test app=@apache-mynewt-core/apps/sensors_test bsp=@apache-mynewt-core/hw/bsp/nrf52dk build_profile=debug
+ $ newt target set nrf52_bno055_test app=@apache-mynewt-core/apps/sensors_test bsp=@apache-mynewt-core/hw/bsp/nrf52dk build_profile=debug
Target targets/nrf52_bno055_test successfully set target.app to @apache-mynewt-core/apps/sensors_test
Target targets/nrf52_bno055_test successfully set target.bsp to @apache-mynewt-core/hw/bsp/nrf52dk
Target targets/nrf52_bno055_test successfully set target.build_profile to debug
$
- 3. Run the ``newt target set`` command to enable the ``I2C_0``,
+3. Run the ``newt target set`` command to enable the ``I2C_0``,
``BNO055_OFB``, and ``BBNO055_CLI`` syscfg settings:
.. code-block:: console
@@ -154,23 +156,27 @@ build\_profile variables for the target:
Target targets/nrf52_bno055_test successfully set target.syscfg to BNO055_OFB=1:I2C_0=1:BNO055_CLI=1
$
- ### Step 2: Creating the Bootloader Target Run the following
-``newt target`` commands, from your project directory, to create a
+Step 2: Creating the Bootloader Target
+~~~~~~~~~~~~~~~
+
+Run the following ``newt target`` commands, from your project directory, to create a
bootloader target. We name the target ``nrf52_boot``:
.. code-block:: console
$ newt target create nrf52_boot
- Target targets/nrf52_boot successfully created
+ Target targets/nrf52_boot successfully created
$ newt target set nrf52_boot app=@apache-mynewt-core/apps/boot bsp=@apache-mynewt-core/hw/bsp/nrf52dk build_profile=optimized
Target targets/nrf52_boot successfully set target.app to @apache-mynewt-core/apps/boot
Target targets/nrf52_boot successfully set target.bsp to @apache-mynewt-core/hw/bsp/nrf52dk
Target targets/nrf52_boot successfully set target.build_profile to optimized
$
- ### Step 3: Building the Bootloader and Application Image 1. Run the
-``newt build nrf52_boot`` command to build the bootloader:
+Step 3: Building the Bootloader and Application Image
+~~~~~~~~~~~~~~~
+
+1. Run the ``newt build nrf52_boot`` command to build the bootloader:
.. code-block:: console
@@ -191,7 +197,7 @@ bootloader target. We name the target ``nrf52_boot``:
Linking ~/dev/myproj/bin/targets/nrf52_boot/app/apps/boot/boot.elf
Target successfully built: targets/nrf52_boot
- 2. Run the ``newt build nrf52_bno055_test`` command to build the
+2. Run the ``newt build nrf52_bno055_test`` command to build the
sensors\_test application:
.. code-block:: console
@@ -258,8 +264,10 @@ specified in the following table:
|Alt Layout - BNO055| |Alt Layout - NRF52\_IC2|
- ### Step 6: Connecting the nRF52-DK Board to your Computer 1. Set up
-two connections between your computer and the nRF52-DK board:
+Step 6: Connecting the nRF52-DK Board to your Computer
+~~~~~~~~~~~~~~~
+
+1. Set up two connections between your computer and the nRF52-DK board:
- A serial connection to communicate with the sensors\_test application
and view the sensor data and hardware information via the Mynewt
@@ -273,11 +281,13 @@ two connections between your computer and the nRF52-DK board:
board to power the board and to load the bootloader and application
image.
- 2. Turn the power on the board to ON. You should see the green LED
+2. Turn the power on the board to ON. You should see the green LED
light up on the board.
- ### Step 7: Loading the Bootloader and the Application Image 1. Run the
-``newt load nrf52_boot`` command to load the bootloader onto the board:
+Step 7: Loading the Bootloader and the Application Image
+~~~~~~~~~~~~~~~
+
+1. Run the ``newt load nrf52_boot`` command to load the bootloader onto the board:
.. code-block:: console
@@ -286,7 +296,7 @@ light up on the board.
Loading bootloader
$
- 2. Run the ``newt load nrf52_bno055_test`` command to load the
+2. Run the ``newt load nrf52_bno055_test`` command to load the
application image on to the board:
.. code-block:: console
@@ -294,10 +304,12 @@ application image on to the board:
$ newt load nrf52_bno055_test
Loading app image into slot 1
- $
+ $
- 3. Power the nRF52-DK board OFF and ON. ### Step 8: Using a Terminal
-Emulator to Connect to the Application Console
+3. Power the nRF52-DK board OFF and ON.
+
+Step 8: Using a Terminal Emulator to Connect to the Application Console
+~~~~~~~~~~~~~~~
Start up a terminal emulator to connect the sensors\_test application
console. You can use one of the terminal emulators listed below or one
@@ -318,7 +330,7 @@ of your choice:
You can also use the Windows Device Manager to locate the COM port.
- We use minicom for this tutorial. After minicom connects, enter
+We use minicom for this tutorial. After minicom connects, enter
<return> to ensure the shell is running. You should see the ``compat>``
prompt:
@@ -327,17 +339,19 @@ prompt:
Welcome to minicom 2.7.1
- OPTIONS:
+ OPTIONS:
Compiled on May 17 2017, 15:29:14.
Port /dev/tty.usbserial, 13:55:21
Press Meta-Z for help on special keys
- 010674 compat>
+ 010674 compat>
+
+Step 9: Viewing the Registered Sensors and Sensor Data
+~~~~~~~~~~~~~~~
- ### Step 9: Viewing the Registered Sensors and Sensor Data The sensor
-framework package implements the ``sensor`` shell command. This command
+The sensor framework package implements the ``sensor`` shell command. This command
allows you to:
- List all the registered sensor devices.
@@ -353,21 +367,23 @@ To view the command syntax, enter ``sensor``
002341 list
002341 list of sensors registered
002342 read <sensor_name> <type> [-n nsamples] [-i poll_itvl(ms)] [-d poll_du]
- 002344 read <no_of_samples> from sensor<sensor_name> of type:<type> at pr
+ 002344 read <no_of_samples> from sensor<sensor_name> of type:<type> at pr
002347 at <poll_interval> rate for <poll_duration>
002348 type <sensor_name>
002349 types supported by registered sensor
- 002350 compat>
+ 002350 compat>
+
+Listing the Registered Sensors
+^^^^^^^^^^^^^^^^^^^
- #### Listing the Registered Sensors You use the ``sensor list`` command
-to list all the registered sensor devices:
+You use the ``sensor list`` command to list all the registered sensor devices:
.. code-block:: console
031798 compat> sensor list
- 129441 sensor dev = bno055_0, configured type = 0x1 0x2 0x4 0x200 0x1000 0x2000
- 129444 compat>
+ 129441 sensor dev = bno055_0, configured type = 0x1 0x2 0x4 0x200 0x1000 0x2000
+ 129444 compat>
The output shows one sensor, **bno055\_0**, registered, and the
configured types for the sensor. A configure type is a subset of the
@@ -382,19 +398,22 @@ supports:
.. code-block:: console
- 031822 compat> sensor type bno055_0
+ 031822 compat> sensor type bno055_0
033156 sensor dev = bno055_0,
type =
- 033157 accelerometer: 0x1
- 033157 magnetic field: 0x2
- 033158 gyroscope: 0x4
- 033159 temperature: 0x10
- 033160 vector: 0x200
- 033160 accel: 0x1000
- 033161 gravity: 0x2000
- 033162 euler: 0x4000
-
- #### Viewing Sensor Data Samples You use the ``sensor read`` command to
+ 033157 accelerometer: 0x1
+ 033157 magnetic field: 0x2
+ 033158 gyroscope: 0x4
+ 033159 temperature: 0x10
+ 033160 vector: 0x200
+ 033160 accel: 0x1000
+ 033161 gravity: 0x2000
+ 033162 euler: 0x4000
+
+Viewing Sensor Data Samples
+^^^^^^^^^^^^^^^^^^^
+
+You use the ``sensor read`` command to
read data samples for a configured type. You can specify the number of
samples to read, a poll interval, and a poll duration. You can only view
sensor data for the sensor types that a sensor device is configured for.
@@ -405,17 +424,17 @@ sensor data for the sensor types that a sensor device is configured for.
.. code-block:: console
- 033163 compat> sensor read bno055_0 0x1 -n 5
- 042974 ts: [ secs: 335 usecs: 745441 cputime: 336218225 ]
- 042976 x = -0.519999968 y = -7.289999968 z = 6.489999776
- 042978 ts: [ secs: 335 usecs: 771216 cputime: 336244000 ]
- 042979 x = -0.529999968 y = -7.360000128 z = 6.559999936
- 042981 ts: [ secs: 335 usecs: 794640 cputime: 336267424 ]
- 042982 x = -0.529999968 y = -7.340000160 z = 6.480000032
- 042983 ts: [ secs: 335 usecs: 810795 cputime: 336283579 ]
- 042984 x = -0.519999968 y = -7.300000192 z = 6.530000224
- 042986 ts: [ secs: 335 usecs: 833703 cputime: 336306487 ]
- 042987 x = -0.510000000 y = -7.309999936 z = 6.380000128
+ 033163 compat> sensor read bno055_0 0x1 -n 5
+ 042974 ts: [ secs: 335 usecs: 745441 cputime: 336218225 ]
+ 042976 x = -0.519999968 y = -7.289999968 z = 6.489999776
+ 042978 ts: [ secs: 335 usecs: 771216 cputime: 336244000 ]
+ 042979 x = -0.529999968 y = -7.360000128 z = 6.559999936
+ 042981 ts: [ secs: 335 usecs: 794640 cputime: 336267424 ]
+ 042982 x = -0.529999968 y = -7.340000160 z = 6.480000032
+ 042983 ts: [ secs: 335 usecs: 810795 cputime: 336283579 ]
+ 042984 x = -0.519999968 y = -7.300000192 z = 6.530000224
+ 042986 ts: [ secs: 335 usecs: 833703 cputime: 336306487 ]
+ 042987 x = -0.510000000 y = -7.309999936 z = 6.380000128
Each sample contains two lines of output. The first line is the time
when the sample is read. The second line is the sample data. For the
@@ -426,48 +445,50 @@ These two lines are for the first sample:
.. code-block:: console
- 042974 ts: [ secs: 335 usecs: 745441 cputime: 336218225 ]
- 042976 x = -0.519999968 y = -7.289999968 z = 6.489999776
+ 042974 ts: [ secs: 335 usecs: 745441 cputime: 336218225 ]
+ 042976 x = -0.519999968 y = -7.289999968 z = 6.489999776
- These two lines are for the last sample:
+These two lines are for the last sample:
.. code-block:: console
- 042986 ts: [ secs: 335 usecs: 833703 cputime: 336306487 ]
- 042987 x = -0.510000000 y = -7.309999936 z = 6.380000128
+ 042986 ts: [ secs: 335 usecs: 833703 cputime: 336306487 ]
+ 042987 x = -0.510000000 y = -7.309999936 z = 6.380000128
**Example 2:** Read the vector data at 20 ms poll interval. You can
enter ``ctrl-c``, ``q <return>``, or ``Q <return>`` to stop the polling.
.. code-block:: console
- 002350 compat> sensor read bno055_0 0x200 -i 20
+ 002350 compat> sensor read bno055_0 0x200 -i 20
019271 ts: [ secs: 150 usecs: 560056 cputime: 151019584 ]
- 019272 x = 3.442626944 y = 0.026977540 z = 3.993286144 w = 0.829833984
+ 019272 x = 3.442626944 y = 0.026977540 z = 3.993286144 w = 0.829833984
019274 ts: [ secs: 150 usecs: 580598 cputime: 151040126 ]
- 019275 x = 3.442626944 y = 0.026977540 z = 3.993286144 w = 0.829833984
- 019277 ts: [ secs: 150 usecs: 604036 cputime: 151063564 ]
- 019278 x = 3.442626944 y = 0.026977540 z = 3.993286144 w = 0.829833984
- 019280 ts: [ secs: 150 usecs: 627474 cputime: 151087002 ]
- 019281 x = 3.442626944 y = 0.026977540 z = 3.993286144 w = 0.829833984
- 019283 ts: [ secs: 150 usecs: 650912 cputime: 151110440 ]
- 019284 x = 3.442626944 y = 0.026977540 z = 3.993286144 w = 0.829833984
- 019286 ts: [ secs: 150 usecs: 674350 cputime: 151133878 ]
- 019287 x = 3.442626944 y = 0.026977540 z = 3.993286144 w = 0.829833984
- 019289 ts: [ secs: 150 usecs: 697788 cputime: 151157316 ]
- 019290 x = 3.442626944 y = 0.026977540 z = 3.993286144 w = 0.829833984
- 019292 ts: [ secs: 150 usecs: 721225 cputime: 151180753 ]
- 019293 x = 3.442626944 y = 0.026977540 z = 3.993286144 w = 0.829833984
- 019295 ts: [ secs: 150 usecs: 744663 cputime: 151204191 ]
- 019296 x = 3.442626944 y = 0.026977540 z = 3.993286144 w = 0.829833984
- 019298 ts: [ secs: 150 usecs: 768101 cputime: 151227629 ]
- 019299 x = 3.442626944 y = 0.026977540 z = 3.993286144 w = 0.829833984
- 019301 ts: [ secs: 150 usecs: 791539 cputime: 151251067 ]
- 019302 x = 3.442626944 y = 0.026977540 z = 3.993286144 w = 0.829833984
-
- ### Step 10: Controlling and Viewing Sensor Device Hardware and Sensor
-Data The BNO055 device driver implements the ``bno055`` shell command
+ 019275 x = 3.442626944 y = 0.026977540 z = 3.993286144 w = 0.829833984
+ 019277 ts: [ secs: 150 usecs: 604036 cputime: 151063564 ]
+ 019278 x = 3.442626944 y = 0.026977540 z = 3.993286144 w = 0.829833984
+ 019280 ts: [ secs: 150 usecs: 627474 cputime: 151087002 ]
+ 019281 x = 3.442626944 y = 0.026977540 z = 3.993286144 w = 0.829833984
+ 019283 ts: [ secs: 150 usecs: 650912 cputime: 151110440 ]
+ 019284 x = 3.442626944 y = 0.026977540 z = 3.993286144 w = 0.829833984
+ 019286 ts: [ secs: 150 usecs: 674350 cputime: 151133878 ]
+ 019287 x = 3.442626944 y = 0.026977540 z = 3.993286144 w = 0.829833984
+ 019289 ts: [ secs: 150 usecs: 697788 cputime: 151157316 ]
+ 019290 x = 3.442626944 y = 0.026977540 z = 3.993286144 w = 0.829833984
+ 019292 ts: [ secs: 150 usecs: 721225 cputime: 151180753 ]
+ 019293 x = 3.442626944 y = 0.026977540 z = 3.993286144 w = 0.829833984
+ 019295 ts: [ secs: 150 usecs: 744663 cputime: 151204191 ]
+ 019296 x = 3.442626944 y = 0.026977540 z = 3.993286144 w = 0.829833984
+ 019298 ts: [ secs: 150 usecs: 768101 cputime: 151227629 ]
+ 019299 x = 3.442626944 y = 0.026977540 z = 3.993286144 w = 0.829833984
+ 019301 ts: [ secs: 150 usecs: 791539 cputime: 151251067 ]
+ 019302 x = 3.442626944 y = 0.026977540 z = 3.993286144 w = 0.829833984
+
+Step 10: Controlling and Viewing Sensor Device Hardware and Sensor Data
+~~~~~~~~~~~~~~~
+
+The BNO055 device driver implements the ``bno055`` shell command
that allows you to:
- Read sensor data samples for all the sensor types that the device
@@ -487,42 +508,44 @@ Enter ``bno055`` to see the command syntax:
.. code-block:: console
- 711258 bno055 cmd [flags...]
- 711259 cmd:
+ 711258 bno055 cmd [flags...]
+ 711259 cmd:
711259 r [n_samples] [ 0-acc | 1 -mag | 2 -gyro | 4 -tem|
9-quat | 26-linearacc | 27-gravity | 28-eul]
-
+
711264 mode [0-config | 1-acc | 2 -mag | 3 -gyro | 4 -acc|
5-accgyro | 6-maggyro | 7 -amg | 8 -imuplus | 9 -com|
- 9-m4g |11-NDOF_FMC_OFF | 12-NDOF ]
- 711269 chip_id
- 711270 rev
- 711270 reset
- 711270 pmode [0-normal | 1-lowpower | 2-suspend]
- 711272 sensor_offsets
- 711272 dumpreg [addr]
+ 9-m4g |11-NDOF_FMC_OFF | 12-NDOF ]
+ 711269 chip_id
+ 711270 rev
+ 711270 reset
+ 711270 pmode [0-normal | 1-lowpower | 2-suspend]
+ 711272 sensor_offsets
+ 711272 dumpreg [addr]
\*\* Example 3: \*\* Query the device chip id:
.. code-block:: console
- 711273 compat> bno055 chip_id
- 769056 0xA0
+ 711273 compat> bno055 chip_id
+ 769056 0xA0
**Example 4:** View the sensor revisions:
.. code-block:: console
- 827472 compat> bno055 rev
- 862354 accel_rev:0xFB
- mag_rev:0x32
- gyro_rev:0x0F
- sw_rev:0x311
- bl_rev:0x15
+ 827472 compat> bno055 rev
+ 862354 accel_rev:0xFB
+ mag_rev:0x32
+ gyro_rev:0x0F
+ sw_rev:0x311
+ bl_rev:0x15
+
+Next Steps
+~~~~~~~~~~~~~~~
- ### Next Steps
Now that you have successfully enabled an application to communicate
with a sensor, We recommend that you:
@@ -552,4 +575,3 @@ with a sensor, We recommend that you:
.. |Alt Layout - BNO055| image:: /os/tutorials/pics/BNO055_small.jpg
.. |Alt Layout - NRF52\_IC2| image:: /os/tutorials/pics/NRF52_I2C_small.jpg
-
diff --git a/docs/os/tutorials/sensors/sensor_nrf52_bno055_oic.rst b/docs/os/tutorials/sensors/sensor_nrf52_bno055_oic.rst
index 8a2717d7a..f7e208425 100644
--- a/docs/os/tutorials/sensors/sensor_nrf52_bno055_oic.rst
+++ b/docs/os/tutorials/sensors/sensor_nrf52_bno055_oic.rst
@@ -47,7 +47,7 @@ not need to set these settings in the target because the
enables the ``BLE_ROLE_PERIPHERAL`` and ``BLE_ROLE_BROADCASTER``
settings by default.
- 1. Run the ``newt target create`` command to create the target. We name
+1. Run the ``newt target create`` command to create the target. We name
the target ``nrf52_bno055_oic_test``.
.. code-block:: console
@@ -57,7 +57,7 @@ the target ``nrf52_bno055_oic_test``.
Target targets/nrf52_bno055_oic_test successfully created
$
- 2. Run the ``newt target set`` command to set the app, bsp, and
+2. Run the ``newt target set`` command to set the app, bsp, and
build\_profile variables for the target:
.. code-block:: console
@@ -69,7 +69,7 @@ build\_profile variables for the target:
Target targets/nrf52_bno055_oic_test successfully set target.build_profile to debug
$
- 3. Run the ``newt target set`` command to set ``I2C_0=1``,
+3. Run the ``newt target set`` command to set ``I2C_0=1``,
``BNO055_OFB=1``, ``BLE_MAX_CONNECTIONS=4``, ``MSYS_1_BLOCK_COUNT=52``,
``MSYS_1_BLOCK_SIZE=100``, and ``OC_APP_RESOURCES=11``.
@@ -83,11 +83,13 @@ commands, also set ``SENSOR_CLI=0`` and ``BNO055_CLI=0``.
Target targets/nrf52_bno055_oic_test successfully set target.syscfg to BNO055_OFB=1:I2C_0=1:BLE_MAX_CONNECTIONS=4:MSYS_1_BLOCK_COUNT=52:MSYS_1_BLOCK_SIZE=100:OC_APP_RESOURCES=11
$
- 4. Run the ``newt build nrf52_bno055_oic_test`` and
+4. Run the ``newt build nrf52_bno055_oic_test`` and
``newt create-image nrf52_bno055_oic_test 1.0.0`` commands to build and
create the application image.
- ### Step 2: Connecting the Sensor and Loading the Images to the Board
+Step 2: Connecting the Sensor and Loading the Images to the Board
+~~~~~~~~~~~~~~~
+
Perform the following steps to reboot the board with the new images:
@@ -105,7 +107,9 @@ Perform the following steps to reboot the board with the new images:
application image.
4. Power the device OFF and ON to reboot.
- ### Step 3: Viewing Sensor Data from the Mynewt Smart Device Controller
+Step 3: Viewing Sensor Data from the Mynewt Smart Device Controller
+~~~~~~~~~~~~~~~
+
Start the Mynewt Smart Device Controller app on your iOS or Android
device to view the sensor data. If you have not installed the Mynewt
@@ -113,7 +117,7 @@ Smart Device Controller follow the instructions in the `Sensor Tutorials
Overview </os/tutorials/sensors/sensors.html>`__ to install the app, then
continue with this step of the tutorial.
- The Mynewt Smart Device Controller scans for the devices when it starts
+The Mynewt Smart Device Controller scans for the devices when it starts
up and displays the sensors it can view. The following is an example
from the Android App:
diff --git a/docs/os/tutorials/sensors/sensor_offboard_config.rst b/docs/os/tutorials/sensors/sensor_offboard_config.rst
index 9533d821f..b131132b6 100644
--- a/docs/os/tutorials/sensors/sensor_offboard_config.rst
+++ b/docs/os/tutorials/sensors/sensor_offboard_config.rst
@@ -73,7 +73,9 @@ excerpt for this function is shown below:
return rc;
}
- ### Changing the Default Configuration
+Changing the Default Configuration
+~~~~~~~~~~~~~~~
+
To change the default configuration, you can directly edit the fields in
the ``config_bno055_sensor()`` function in the
@@ -87,15 +89,19 @@ application, you must initialize all the fields in the sensor
configuration data structure even if you are not changing the default
values.
- #### Step 1: Adding the Sensor Device Driver Header File
+Step 1: Adding the Sensor Device Driver Header File
+^^^^^^^^^^^^^^^^^^^
+
Add the bno055 device driver header file:
::
- #include <bno055/bno055.h>
+ #include <bno055/bno055.h>
+
+Step 2: Adding a New Configuration Function
+^^^^^^^^^^^^^^^^^^^
- #### Step 2: Adding a New Configuration Function
Add the ``sensors_test_config_bno055()`` function and copy the code from
the ``config_bno055_sensor()`` function in the
@@ -139,7 +145,9 @@ below:
return rc;
}
- #### Step 3: Changing the Default Configuration Settings
+Step 3: Changing the Default Configuration Settings
+^^^^^^^^^^^^^^^^^^^
+
Delete the ``SENSOR_TYPE_ACCELEROMETER`` type from the ``bcfg.bc_mask``
initialization setting values:
@@ -199,18 +207,24 @@ Add the ``int rc`` declaration and the call to the
return (0);
}
- #### Step 5: Building a New Application Image
+Step 5: Building a New Application Image
+^^^^^^^^^^^^^^^^^^^
+
Run the ``newt build nrf52_bno055_test`` and the
``newt create-image nrf52_bno055_test 2.0.0`` commands to rebuild and
create a new application image.
- #### Step 6: Loading the New Image and Rebooting the Device
+Step 6: Loading the New Image and Rebooting the Device
+^^^^^^^^^^^^^^^^^^^
+
Run the ``newt load nrf52_bno055_test`` command and power the device OFF
and On.
- #### Step 7: Verifing the Sensor is Configured with the New Values
+Step 7: Verifing the Sensor is Configured with the New Values
+^^^^^^^^^^^^^^^^^^^
+
Start a terminal emulator, and run the ``sensor list`` command to verify
the accelerometer (0x1) is not configured. The ``configured type``
@@ -220,11 +234,11 @@ listed for the sensor should not have the value ``0x1``.
045930 compat> sensor list
- 046482 sensor dev = bno055_0, configured type = 0x2 0x4 0x200 0x1000 0x2000 0x4000
+ 046482 sensor dev = bno055_0, configured type = 0x2 0x4 0x200 0x1000 0x2000 0x4000
046484 compat>
- #### Step 8: Verifying that the Accelerometer Data Samples Cannot be
-Read
+Step 8: Verifying that the Accelerometer Data Samples Cannot be Read
+^^^^^^^^^^^^^^^^^^^
Run the ``sensor read`` command to read data samples from the
accelerometer to verify that the sensor cannot be read:
@@ -234,4 +248,3 @@ accelerometer to verify that the sensor cannot be read:
046484 compat> sensor read bno055_0 0x1 -n 5
092387 Cannot read sensor bno055_0
-
diff --git a/docs/os/tutorials/sensors/sensor_thingy_lis2dh12_onb.rst b/docs/os/tutorials/sensors/sensor_thingy_lis2dh12_onb.rst
index 9f2280f1d..295c014e0 100644
--- a/docs/os/tutorials/sensors/sensor_thingy_lis2dh12_onb.rst
+++ b/docs/os/tutorials/sensors/sensor_thingy_lis2dh12_onb.rst
@@ -8,7 +8,7 @@ completed the `Enabling an Off-Board Sensor in an Existing Application
Tutorial </os/tutorials/sensors/sensor_nrf52_bno055.html>`__ and are
familiar with the sensor framework and sensor shell command.
- This tutorial shows you how to:
+This tutorial shows you how to:
- Develop an application for the Nordic Thingy LIS2DH12 accelerometer
onboard sensor with the sensor framework ``sensor`` shell command
@@ -39,7 +39,9 @@ Developing a Sensor Enabled Application with Shell Support
We first develop a simple application with the LIS2DH12 onboard sensor
on the Nordic Thingy and the ``sensor`` shell command enabled.
- #### Step 1: Creating a New App Package
+Step 1: Creating a New App Package
+^^^^^^^^^^^^^^^^^^^
+
We name the new app package ``my_sensor_app``. From your project base
directory, run the ``newt pkg new`` command to create a new app package.
@@ -52,7 +54,7 @@ This tutorial uses ~/dev/myproj for the project.
Download package template for package type app.
Package successfuly installed into ~/dev/myproj/apps/my_sensor_app
- The newt tool creates a skeleton ``my_sensor_app`` package directory in
+The newt tool creates a skeleton ``my_sensor_app`` package directory in
the ``~/dev/myproj/apps/`` directory. Go to the ``my_sensor_app``
directory to update the package ``pkg.yml`` and source files.
@@ -61,7 +63,9 @@ directory to update the package ``pkg.yml`` and source files.
$ cd apps/my_sensor_app
- #### Step 2: Adding the Package Dependencies
+Step 2: Adding the Package Dependencies
+^^^^^^^^^^^^^^^^^^^
+
The my\_sensor\_app package requires the sensor framework,
``hw/sensor``, package as a package dependency. Note that the BSP
@@ -82,7 +86,9 @@ Add the highlighted line to the ``pkg.yml`` file to add the
- "@apache-mynewt-core/sys/stats/full"
- "@apache-mynewt-core/hw/sensor"
- #### Step 3: Using the Skeleton main.c File
+Step 3: Using the Skeleton main.c File
+^^^^^^^^^^^^^^^^^^^
+
The newt tool creates a skeleton main.c file in the
``my_sensor_app/src`` directory. The skeleton ``main()`` code shown is
@@ -114,7 +120,9 @@ event queue.
return 0;
}
- #### Step 4: Creating the Target for the my\_sensor\_app Application
+Step 4: Creating the Target for the my\_sensor\_app Application
+^^^^^^^^^^^^^^^^^^^
+
You create a target for the my\_sensor\_app to run on the Nordic Thingy.
The following syscfg settings must be set:
@@ -147,7 +155,7 @@ The following syscfg settings must be set:
``/hw/driver/sensors/lis2dh12``, currently does not support a shell
command to view information on the device.
- 1. Run the following newt commands to create the target and set the
+1. Run the following newt commands to create the target and set the
application and BSP.
.. code-block:: console
@@ -162,7 +170,7 @@ application and BSP.
$ newt target set thingy_my_sensor build_profile=debug
Target targets/thingy_my_sensor successfully set target.build_profile to debug
- 2. Run the following ``newt target set`` command to set the syscfg
+2. Run the following ``newt target set`` command to set the syscfg
settings:
.. code-block:: console
@@ -171,12 +179,14 @@ settings:
$ newt target set thingy_my_sensor syscfg=I2C_0=1:LIS2DH12_ONB=1:SHELL_TASK=1:CONSOLE_RTT=1:CONSOLE_UART=0:SENSOR_OIC=0
Target targets/thingy_my_sensor successfully set target.syscfg to I2C_0=1:LIS2DH12_ONB=1:SHELL_TASK=1:CONSOLE_RTT=1:CONSOLE_UART=0:SENSOR_OIC=0
- #### Step 5: Creating and Building the Bootloader Target
+Step 5: Creating and Building the Bootloader Target
+^^^^^^^^^^^^^^^^^^^
+
Create a target for the bootloader for the nRF52 Thingy. We name the
target ``thingy_boot``.
- 1. Run the following ``newt target`` commands to create the target:
+1. Run the following ``newt target`` commands to create the target:
.. code-block:: console
@@ -190,12 +200,12 @@ target ``thingy_boot``.
$ newt target set thingy_boot build_profile=optimized
Target targets/thingy_boot successfully set target.build_profile to optimized
- 2. Run the ``newt build`` command to build the bootloader target:
+2. Run the ``newt build`` command to build the bootloader target:
.. code-block:: console
- $ newt build thingy_boot
+ $ newt build thingy_boot
Building target targets/thingy_boot
...
@@ -205,14 +215,16 @@ target ``thingy_boot``.
Linking ~/dev/myproj/bin/targets/thingy_boot/app/apps/boot/boot.elf
Target successfully built: targets/thingy_boot
- #### Step 6: Connecting the Thingy to your Computer Perform the
-following steps to connect the Thingy to your computer:
+Step 6: Connecting the Thingy to your Computer
+^^^^^^^^^^^^^^^^^^^
+
+Perform the following steps to connect the Thingy to your computer:
- 1. Move the power switch to the left to power ON the Thingy:
+1. Move the power switch to the left to power ON the Thingy:
|Thingy|
- 2. Connect the debug probe to the JTAG port on the board using the
+2. Connect the debug probe to the JTAG port on the board using the
Jlink 9-pin adapter and cable, and connect the probe to your computer.
|J-Link debug probe to Thingy|
@@ -221,13 +233,15 @@ Jlink 9-pin adapter and cable, and connect the probe to your computer.
<p>
- #### Step 7: Loading the Image and Connecting to the Console via RTT
+Step 7: Loading the Image and Connecting to the Console via RTT
+^^^^^^^^^^^^^^^^^^^
+
To run the application, you need to load the bootloader on to the
device, load the application image, and start a GDB debug process for
RTT to attach to.
- 1. Run the ``newt load`` command to load the bootloader:
+1. Run the ``newt load`` command to load the bootloader:
.. code-block:: console
@@ -235,7 +249,7 @@ RTT to attach to.
$ newt load thingy_boot
Loading bootloader
- 2. Run the ``newt run`` command to build and create an image for the
+2. Run the ``newt run`` command to build and create an image for the
my\_sensor\_app, load the image, and start a GDB process to debug the
application:
@@ -282,11 +296,11 @@ application:
204 if (ticks > 0) {
Resetting target
0x000000dc in ?? ()
- (gdb)
+ (gdb)
- 3. Enter ``c <return>`` in the (gdb) prompt to continue.
+3. Enter ``c <return>`` in the (gdb) prompt to continue.
- 4. Run the following telnet command to connect to the Mynewt console
+4. Run the following telnet command to connect to the Mynewt console
via RTT and enter <return> to get the shell prompt after you are
connected.
@@ -305,9 +319,11 @@ connected.
011468 compat>
- #### Step 8: Viewing the list of Sensors and Sensor Data
+Step 8: Viewing the list of Sensors and Sensor Data
+^^^^^^^^^^^^^^^^^^^
+
- 1. Enter ``sensor list`` to see the sensors that are registered with
+1. Enter ``sensor list`` to see the sensors that are registered with
the sensor manager. You should see the ``lis2dh12_0`` sensor. This
sensor is only configured for the accelerometer (0x1).
@@ -316,10 +332,10 @@ sensor is only configured for the accelerometer (0x1).
011468 compat> sensor list
sensor list
- 029706 sensor dev = lis2dh12_0, configured type = 0x1
- 029707 compat>
+ 029706 sensor dev = lis2dh12_0, configured type = 0x1
+ 029707 compat>
- 2. Enter the ``sensor read`` command to read some data samples from the
+2. Enter the ``sensor read`` command to read some data samples from the
accelerometer:
.. code-block:: console
@@ -337,9 +353,11 @@ accelerometer:
042538 x = 9.806650176 y = 29.419950496 z = -9904.716796
042538 ts: [ secs: 331 usecs: 111288 cputime: 331445551 ]
042538 x = 58.839900992 y = 0.000000000 z = -9816.457031
- 042538 compat>
+ 042538 compat>
+
+Extending the Application to Use the Sensor API to Read Sensor Data
+~~~~~~~~~~~~~~~
- ### Extending the Application to Use the Sensor API to Read Sensor Data
As this tutorial demonstrates so far, the Mynewt sensor framework
enables you to easily and quickly develop an application with a sensor
@@ -375,11 +393,13 @@ a listener. An application may not need to poll sensors. For example, an
application that processes remote requests for sensor data might only
read the sensor data when it receives a request.
- #### Step 1: Modifying main.c to Add a Sensor Listener
+Step 1: Modifying main.c to Add a Sensor Listener
+^^^^^^^^^^^^^^^^^^^
+
Add the following code to the ``my_sensor_app/src/main.c`` file:
- 1. Add the highlighted include files:
+1. Add the highlighted include files:
\`\`\`hl\_lines="4 5 6 7"
@@ -389,21 +409,21 @@ include "sysinit/sysinit.h"
include "os/os.h"
=================
-include
+include
========
-include
+include
========
-include
+include
========
-include
+include
========
\`\`\`
- 2. Add the ``struct sensor * my_sensor``. This is the handle for the
+2. Add the ``struct sensor * my_sensor``. This is the handle for the
sensor that the sensor API uses to perform operations on the sensor. We
set this variable when we lookup the sensor.
@@ -412,7 +432,7 @@ set this variable when we lookup the sensor.
static struct sensor *my_sensor;
- 3. Declare and initialize a sensor listener. You specify a bit mask for
+3. Declare and initialize a sensor listener. You specify a bit mask for
the sensor types to listen for, the callback function, and an opaque
argument to pass to the callback. You initialize the type to
SENSOR\_TYPE\_ACCELEROMETER, the listener callback to the
@@ -440,7 +460,7 @@ callback.
.sl_arg = (void *)LISTENER_CB,
};
- 4. Add the code for the ``read_accelerometer()`` function. The sensor
+4. Add the code for the ``read_accelerometer()`` function. The sensor
data is stored in the ``databuf`` and ``type`` specifies the type of
sensor data.
@@ -466,7 +486,7 @@ sensor data.
return SYS_EINVAL;
}
-
+
console_printf("%s: [ secs: %ld usecs: %d cputime: %u ]\n",
((int)arg == LISTENER_CB) ? "LISTENER_CB" : "READ_CB",
(long int)sensor->s_sts.st_ostv.tv_sec,
@@ -479,7 +499,7 @@ sensor data.
return 0;
}
- 5. Set the poll rate for the sensor to two seconds. The
+5. Set the poll rate for the sensor to two seconds. The
``sensor_set_poll_rate_ms()`` function sets the poll rate for a named
sensor.
@@ -522,7 +542,7 @@ int main(int argc, char \*\*argv) { int rc ...
\`\`\`
- 6. Look up the sensor by name to get the handle for the sensor and
+6. Look up the sensor by name to get the handle for the sensor and
register a listener for the sensor.
\`\`\`hl\_lines="9 10 11 12"
@@ -550,9 +570,11 @@ int main(int argc, char \*\*argv) { ...
\`\`\`
- #### Step 2: Rebuilding the Application and Connecting to Console
+Step 2: Rebuilding the Application and Connecting to Console
+^^^^^^^^^^^^^^^^^^^
+
- 1. Run the ``newt run`` command to rebuild the application, create a
+1. Run the ``newt run`` command to rebuild the application, create a
new image, load the image, and start a GDB process:
.. code-block:: console
@@ -576,10 +598,10 @@ new image, load the image, and start a GDB process:
204 if (ticks > 0) {
Resetting target
0x000000dc in ?? ()
- (gdb) c
+ (gdb) c
Continuing.
- 2. Connect to the console via RTT:
+2. Connect to the console via RTT:
.. code-block:: console
@@ -612,8 +634,8 @@ new image, load the image, and start a GDB process:
You should see the accelerometer sensor data output from the listener
callback.
- #### Step 3: Modifying main.c to Use sensor\_read() Instead of a
-Listener
+Step 3: Modifying main.c to Use sensor\_read() Instead of a Listener
+^^^^^^^^^^^^^^^^^^^
Lets extend the application to use the ``sensor_read()`` function
instead of a listener. We setup an OS callout to call the
@@ -621,7 +643,7 @@ instead of a listener. We setup an OS callout to call the
will most likely read the sensor data when it gets a request or some
other event.
- 1. Add an OS callout and initialize an OS timer to fire every 5
+1. Add an OS callout and initialize an OS timer to fire every 5
seconds. The timer callback calls the ``sensor_read()`` function to read
the sensor data. The ``read_accelerometer()`` callback is called when
the sensor data is read. The READ\_CB value is passed to the
@@ -670,7 +692,7 @@ from the ``sensor_read()`` function and not from the listener.
}
- 2. Remove the listener registration and call the ``init_timer()``
+2. Remove the listener registration and call the ``init_timer()``
function in ``main()``. You can delete the
``sensor_register_listener()`` function call, but we call the
``sensor_unregister_listener()`` function to illustrate how to use this
@@ -703,8 +725,10 @@ function.
\`\`\`
- #### Step 4: Rebuilding the Application and Connecting to Console 1.
-Run the ``newt run`` command to rebuild the application, create an new
+Step 4: Rebuilding the Application and Connecting to Console
+^^^^^^^^^^^^^^^^^^^
+
+1. Run the ``newt run`` command to rebuild the application, create an new
image, and start a GDB process:
.. code-block:: console
@@ -731,7 +755,7 @@ image, and start a GDB process:
(gdb) c
Continuing.
- 3. Connect to the console via RTT:
+3. Connect to the console via RTT:
.. code-block:: console
@@ -764,4 +788,3 @@ data callback.
.. |Thingy| image:: /os/tutorials/pics/thingy.jpg
.. |J-Link debug probe to Thingy| image:: /os/tutorials/pics/thingy_jlink.jpg
-
diff --git a/docs/os/tutorials/sensors/sensors.rst b/docs/os/tutorials/sensors/sensors.rst
index 1fb637562..83f770f4e 100644
--- a/docs/os/tutorials/sensors/sensors.rst
+++ b/docs/os/tutorials/sensors/sensors.rst
@@ -56,7 +56,10 @@ Controller App, see the `Android Sensor
source <https://github.com/runtimeco/android_sensor>`__ and `iOS Sensor
source <https://github.com/runtimeco/iOS_oic>`__ on github.
- ### Prerequisites Ensure that you meet the following prerequisites
+Prerequisites
+~~~~~~~~~~~~~~~
+
+Ensure that you meet the following prerequisites
before continuing with one of the tutorials.
- Have Internet connectivity to fetch remote Mynewt components.
diff --git a/docs/os/tutorials/slinky/project-nrf52-slinky.rst b/docs/os/tutorials/slinky/project-nrf52-slinky.rst
index 5bebbae13..f9c855972 100644
--- a/docs/os/tutorials/slinky/project-nrf52-slinky.rst
+++ b/docs/os/tutorials/slinky/project-nrf52-slinky.rst
@@ -32,10 +32,10 @@ Run the following commands to create a new project. We name the project
Installing skeleton in slink...
Project slinky successfully created
$ cd slinky
- $newt install
+ $newt install
apache-mynewt-core
- Create the Targets
+Create the Targets
~~~~~~~~~~~~~~~~~~~
Create two targets for the nRF52-DK board - one for the bootloader and
@@ -51,7 +51,7 @@ to create a bootloader target. We name the target ``nrf52_boot``.
$ newt target set nrf52_boot build_profile=optimized
$ newt target set nrf52_boot app=@apache-mynewt-core/apps/boot
- Run the following ``newt target`` commands to create a target for the
+Run the following ``newt target`` commands to create a target for the
Slinky application. We name the target ``nrf52_slinky``.
.. code-block:: console
@@ -132,7 +132,9 @@ Connect to the Board
- Turn the power on the board to ON. You should see the green LED light
up on the board.
- ### Load the Bootloader and the Slinky Application Image
+Load the Bootloader and the Slinky Application Image
+~~~~~~~~~~~~~~~
+
Run the ``newt load nrf52_boot`` command to load the bootloader onto the
board:
@@ -143,7 +145,7 @@ board:
Loading bootloader
$
- Run the ``newt load nrf52_slinky`` command to load the Slinky
+Run the ``newt load nrf52_slinky`` command to load the Slinky
application image onto the board:
.. code-block:: console
@@ -198,7 +200,7 @@ profile for the serial port. We name the connection profile
Connection profile nrf52serial successfully added
$
- You can run the ``newt conn show`` command to see all the newtmgr
+You can run the ``newt conn show`` command to see all the newtmgr
connection profiles:
.. code-block:: console
@@ -209,8 +211,10 @@ connection profiles:
sim1: type=serial, connstring='/dev/ttys012'
$
- ### Use Newtmgr to Query the Board Run some newtmgr commands to query
-and receive responses back from the board (See the `Newt Manager
+Use Newtmgr to Query the Board
+~~~~~~~~~~~~~~~
+
+Run some newtmgr commands to query and receive responses back from the board (See the `Newt Manager
Guide <../../newtmgr/overview>`__ for more information on the newtmgr
commands).
@@ -219,16 +223,16 @@ simplest command that requests the board to echo back the text.
.. code-block:: console
- $ newtmgr echo hello -c nrf52serial
+ $ newtmgr echo hello -c nrf52serial
hello
$
- Run the ``newtmgr image list -c nrf52serial`` command to list the
+Run the ``newtmgr image list -c nrf52serial`` command to list the
images on the board:
.. code-block:: console
- $ newtmgr image list -c nrf52serial
+ $ newtmgr image list -c nrf52serial
Images:
slot=0
version: 1.0.0
@@ -238,7 +242,7 @@ images on the board:
Split status: N/A
$
- Run the ``newtmgr taskstat -c nrf52serial`` command to display the task
+Run the ``newtmgr taskstat -c nrf52serial`` command to display the task
statistics on the board:
.. code-block:: console
diff --git a/docs/os/tutorials/slinky/project-sim-slinky.rst b/docs/os/tutorials/slinky/project-sim-slinky.rst
index 1f7506cab..f62e7996e 100644
--- a/docs/os/tutorials/slinky/project-sim-slinky.rst
+++ b/docs/os/tutorials/slinky/project-sim-slinky.rst
@@ -5,7 +5,9 @@ This tutorial shows you how to create, build and run the Slinky
application and communicate with newtmgr for a simulated device. This is
supported on Mac OS and Linux platforms.
- ### Prerequisites
+Prerequisites
+~~~~~~~~~~~~~~~
+
Meet the prerequisites listed in `Project
Slinky </os/tutorials/project-slinky.html>`__.
diff --git a/docs/os/tutorials/slinky/project-stm32-slinky.rst b/docs/os/tutorials/slinky/project-stm32-slinky.rst
index c895d029a..4b52de9f7 100644
--- a/docs/os/tutorials/slinky/project-stm32-slinky.rst
+++ b/docs/os/tutorials/slinky/project-stm32-slinky.rst
@@ -31,7 +31,7 @@ Slinky <project-slinky.html>`__ tutorial.
$newt install
apache-mynewt-core
- Create the Targets
+Create the Targets
~~~~~~~~~~~~~~~~~~~
Create two targets for the STM32-E407 board - one for the bootloader and
@@ -47,7 +47,7 @@ to create a bootloader target. We name the target ``stm32_boot``.
$ newt target set stm32_boot build_profile=optimized
$ newt target set stm32_boot target.app=@apache-mynewt-core/apps/boot
- Run the following ``newt target`` commands to create a target for the
+Run the following ``newt target`` commands to create a target for the
Slinky application. We name the target ``stm32_slinky``.
.. code-block:: console
@@ -84,7 +84,7 @@ Run the ``newt build stm32_boot`` command to build the bootloader:
Target successfully built: targets/stm32_boot
$
- Run the ``newt build stm32_slinky`` command to build the Slinky
+Run the ``newt build stm32_slinky`` command to build the Slinky
application:
.. code-block:: console
@@ -108,7 +108,9 @@ application:
Target successfully built: targets/stm32_slinky
$
- ### Sign and Create the Slinky Application Image
+Sign and Create the Slinky Application Image
+~~~~~~~~~~~~~~~
+
Run the ``newt create-image stm32_slinky 1.0.0`` command to create and
sign the application image. You may assign an arbitrary version (e.g.
@@ -136,7 +138,9 @@ Connect to the Board
You should see a red LED light up on the board.
- ### Load the Bootloader and the Slinky Application Image
+Load the Bootloader and the Slinky Application Image
+~~~~~~~~~~~~~~~
+
Run the ``newt load stm32_boot`` command to load the bootloader onto the
board:
@@ -147,7 +151,7 @@ board:
Loading bootloader
$
- Note: If you are using Windows and get a ``no device found`` error, you
+Note: If you are using Windows and get a ``no device found`` error, you
will need to install the usb driver. Download
`Zadig <http://zadig.akeo.ie>`__ and run it:
@@ -158,7 +162,7 @@ will need to install the usb driver. Download
- Click Install Driver.
- Run the ``newt load stm32_boot`` command again.
- Run the ``newt load stm32_slinky`` command to load the Slinky
+Run the ``newt load stm32_slinky`` command to load the Slinky
application image onto the board:
.. code-block:: console
@@ -190,7 +194,7 @@ for reference.
- Connect the GND pin of the USB-TTL serial cable to the GND (Pin 2) of
the UEXT connector on the board.
- Locate the port, in the /dev directory on your computer, that the
+Locate the port, in the /dev directory on your computer, that the
serial connection uses. The format of the port name is platform
dependent:
@@ -211,7 +215,7 @@ dependent:
/dev/tty.usbserial-1d13
$
- Setup a newtmgr connection profile for the serial port. For our
+Setup a newtmgr connection profile for the serial port. For our
example, the port is ``/dev/tty.usbserial-1d13``.
Run the ``newtmgr conn add`` command to define a newtmgr connection
@@ -231,7 +235,7 @@ profile for the serial port. We name the connection profile
Connection profile stm32serial successfully added
$
- You can run the ``newt conn show`` command to see all the newtmgr
+You can run the ``newt conn show`` command to see all the newtmgr
connection profiles:
.. code-block:: console
@@ -242,8 +246,10 @@ connection profiles:
sim1: type=serial, connstring='/dev/ttys012'
$
- ### Use Newtmgr to Query the Board Run some newtmgr commands to query
-and receive responses back from the board (See the `Newt Manager
+Use Newtmgr to Query the Board
+~~~~~~~~~~~~~~~
+
+Run some newtmgr commands to query and receive responses back from the board (See the `Newt Manager
Guide <newtmgr/overview>`__ for more information on the newtmgr
commands).
@@ -256,7 +262,7 @@ simplest command that requests the board to echo back the text.
hello
$
- Run the ``newtmgr image list -c stm32serial`` command to list the
+Run the ``newtmgr image list -c stm32serial`` command to list the
images on the board:
.. code-block:: console
@@ -271,7 +277,7 @@ images on the board:
Split status: N/A
$
- Run the ``newtmgr taskstat -c stm32serial`` command to display the task
+Run the ``newtmgr taskstat -c stm32serial`` command to display the task
statistics on the board:
.. code-block:: console
diff --git a/docs/os/tutorials/tasks_lesson.rst b/docs/os/tutorials/tasks_lesson.rst
index faa8a8819..e21b8f4ec 100644
--- a/docs/os/tutorials/tasks_lesson.rst
+++ b/docs/os/tutorials/tasks_lesson.rst
@@ -107,7 +107,7 @@ majority of work is done by a task. Let?s write a task function for
g_led_pin = LED_BLINK_PIN;
hal_gpio_init_out(g_led_pin, 1);
-
+
while (1) {
t = os_sched_get_current_task();
assert(t->t_func == work_task_handler);
@@ -155,7 +155,7 @@ our main function clean.
/* ? */
os_stack_t *work_stack;
work_stack = malloc(sizeof(os_stack_t)*WORK_STACK_SIZE);
-
+
assert(work_stack);
os_task_init(&work_task, "work", work_task_handler, NULL,
WORK_TASK_PRIO, OS_WAIT_FOREVER, work_stack,
@@ -184,16 +184,19 @@ loop:
}
}
- And that?s it! Now run your application using the newt run command.
+And that?s it! Now run your application using the newt run command.
::
$ newt run arduino_blinky 0.0.0
- When GDB appears press C then Enter to continue and ? *wait, why
+When GDB appears press C then Enter to continue and ? *wait, why
doesn't our LED blink anymore?*
- #### Review Before we run our new app, let?s review what we need in
+Review
+^^^^^^^^^^^^^^^^^^^
+
+Before we run our new app, let?s review what we need in
order to create a task. This is a general case for a new task called
mytask:
@@ -213,7 +216,7 @@ mytask:
.. code:: c
- void
+ void
mytask_handler(void *arg)
{
while (1) {
@@ -225,7 +228,7 @@ mytask:
.. code:: c
- os_task_init(&mytask, "mytask", mytask_handler, NULL,
+ os_task_init(&mytask, "mytask", mytask_handler, NULL,
MYTASK_PRIO, OS_WAIT_FOREVER, mytask_stack,
MYTASK_STACK_SIZE);
@@ -270,14 +273,14 @@ which is defined in the MCU, by the number of seconds we wish to delay.
}
}
- In order to notice the LED changing, modify the time delay in
+In order to notice the LED changing, modify the time delay in
``main()`` to blink at a higher frequency.
.. code:: c
os_time_delay(OS_TICKS_PER_SEC/10);
- Before we run the app, let?s predict the behavior. With the newest
+Before we run the app, let?s predict the behavior. With the newest
additions to ``work_task_handler()``, our first action will be to sleep
for three seconds. This allows the ``main`` task, running ``main()``, to
take over the CPU and blink to its heart?s content. After three seconds,
diff --git a/docs/os/tutorials/wi-fi_on_arduino.rst b/docs/os/tutorials/wi-fi_on_arduino.rst
index 9760b9026..3a381d7e7 100644
--- a/docs/os/tutorials/wi-fi_on_arduino.rst
+++ b/docs/os/tutorials/wi-fi_on_arduino.rst
@@ -57,7 +57,7 @@ Run the following commands to create a new project:
apache-mynewt-core
$
- Fetch External Packages
+Fetch External Packages
~~~~~~~~~~~~~~~~~~~~~~~~
Mynewt uses source code provided directly from the chip manufacturer for
@@ -100,7 +100,7 @@ repo: mynewt-core
repository.mynewt\_arduino\_zero: type: github vers: 1-latest user:
runtimeco repo: mynewt\_arduino\_zero $ \`\`\`
- Install the project dependencies using the ``newt install`` command
+Install the project dependencies using the ``newt install`` command
(you can specify ``-v`` for verbose output):
.. code-block:: console
@@ -148,7 +148,9 @@ application target ``mkr1000_wifi``.
$ newt target set mkr1000_wifi build_profile=debug
$ newt target set mkr1000_boot syscfg=BSP_ARDUINO_ZERO_PRO=1
- ### Build the Bootloader
+Build the Bootloader
+~~~~~~~~~~~~~~~
+
Run the ``newt build mkr1000_boot`` command to build the bootloader:
@@ -192,7 +194,9 @@ application image:
Target successfully built: targets/mkr1000_wifi
$
- ### Sign and Create the Wi-Fi Application Image
+Sign and Create the Wi-Fi Application Image
+~~~~~~~~~~~~~~~
+
Run the ``newt create-image mkr1000_wifi 1.0.0`` command to sign and
create an image file for the Wi-Fi application. You may assign an
@@ -220,7 +224,7 @@ Connect to the Board
<p>
- Mynewt will download and debug the target through this port. You should
+Mynewt will download and debug the target through this port. You should
see a green LED come on and indicates the board has power.
Load the Bootloader onto the Board
@@ -247,7 +251,9 @@ onto the board:
Loading app image into slot 1
$
- ### Setup a Serial Connection Between Your Computer and the Board
+Setup a Serial Connection Between Your Computer and the Board
+~~~~~~~~~~~~~~~
+
Set up a serial connection from your computer to the MKR1000 board (See
`Serial Port Setup </os/get_started/serial_access.html>`__). On the
@@ -258,7 +264,7 @@ Connection to MKR1000|
<p>
- Locate the port, in the /dev directory on your computer, that the
+Locate the port, in the /dev directory on your computer, that the
serial connection uses. The format of the port name is platform
dependent:
@@ -292,7 +298,7 @@ command with the serial port you located on your computer:
$ minicom -D /dev/tty.usbserial-1d13 -b 115200
- Type ``wifi start`` to start Wi-Fi.
+Type ``wifi start`` to start Wi-Fi.
.. code:: hl_lines="11"
@@ -313,7 +319,7 @@ command with the serial port you located on your computer:
(APP)(INFO)Curr driver ver: 19.3.0
wifi_init : 0
- Connect to the local Wi-Fi network. Note that the MKR1000 board only
+Connect to the local Wi-Fi network. Note that the MKR1000 board only
supports 2.4 GHz Wi-Fi networks.
Run the ``wifi connect`` command and specify your network and . After
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services