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 02:21:25 UTC
[GitHub] ccollins476ad closed pull request #706: Continued conversion of mynewt-site docs to core with doxygen integration.
ccollins476ad closed pull request #706: Continued conversion of mynewt-site docs to core with doxygen integration.
URL: https://github.com/apache/mynewt-core/pull/706
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/index.rst b/docs/index.rst
index 64ab351f9..06f8914cf 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -13,7 +13,7 @@ Mynewt Documentation
newt/newt_intro
newtmgr/overview
known_issues
- FAQ <faq/answers>
+ Miscellaneous <misc/misc>
Welcome to Apache Mynewt
diff --git a/docs/faq/answers.rst b/docs/misc/faq.rst
similarity index 100%
rename from docs/faq/answers.rst
rename to docs/misc/faq.rst
diff --git a/docs/faq/go_env.rst b/docs/misc/go_env.rst
similarity index 85%
rename from docs/faq/go_env.rst
rename to docs/misc/go_env.rst
index d532b95f4..ef85e2ad2 100644
--- a/docs/faq/go_env.rst
+++ b/docs/misc/go_env.rst
@@ -7,7 +7,6 @@ you want to:
- Build the tools with latest updates from the master branch on Linux
or Windows platforms.
-
**Note:** For Mac OS, you can use the
``brew install mynewt-newt -HEAD`` and the
``brew install mynewt-newtmgr --HEAD`` commands.
@@ -23,7 +22,7 @@ This guide shows you how to perform the following:
4. Update and rebuild the tools.
**Note:** You will also need to read and follow the instructions from
-the `FAQ </faq/answers/>`__ to set up your git repos to submit changes.
+the :doc:`FAQ </misc/faq>` to set up your git repos to submit changes.
Step 1: Installing Go
~~~~~~~~~~~~~~~~~~~~~
@@ -33,8 +32,7 @@ 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
-^^^^^^^^^^^^^^^^^^^
-
+^^^^^^^^^^^^^^^^^^^^^^^^^
If you do not have Homebrew installed, run the following command. You
will be prompted for your sudo password.
@@ -47,6 +45,7 @@ You can also extract (or ``git clone``) Homebrew and install it to
/usr/local.
Use brew to install Go:
+^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: console
@@ -62,15 +61,13 @@ You can also download the Go package directly from
brewing it.
Installing Go on Linux and Windows
-^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^
You can download Go from
-
https://golang.org/dl/.
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
@@ -120,8 +117,7 @@ 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
-^^^^^^^^^^^^^^^^^^^
-
+^^^^^^^^^^^^^^^^^^^^^^^^^
The newt Go package is **mynewt.apache.org/newt/newt** and is stored in
the `Apache Mynewt newt tool repository mirrored on
@@ -131,39 +127,38 @@ Download the newt package source and install the tool:
.. code-block:: console
- $cd $GOPATH
- $go get mynewt.apache.org/newt/newt
- $cd $GOPATH/src/mynewt.apache.org/newt
- $ls
+ $ cd $GOPATH
+ $ go get mynewt.apache.org/newt/newt
+ $ cd $GOPATH/src/mynewt.apache.org/newt
+ $ ls
DISCLAIMER RELEASE_NOTES.md util
INSTALLING.md build.sh viper
LICENSE newt yaml
NOTICE newtmgr
README.md newtvm
- $git status
+ $ git status
On branch master
Your branch is up-to-date with 'origin/master'.
nothing to commit, working directory clean
- **Note:** The source code under the **newtmgr** directory is no longer
+**Note:** The source code under the **newtmgr** directory is no longer
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
-\*\* $GOPATH/bin\*\*:
+**$GOPATH/bin**:
.. code-block:: console
- $ls $GOPATH/bin/newt
+ $ ls $GOPATH/bin/newt
~/dev/go/bin/newt
- $which newt
+ $ which newt
~/dev/go/bin/newt
- $newt version
+ $ newt version
Apache Newt version: 1.1.0-dev
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
@@ -173,12 +168,12 @@ Download the newtmgr package and install the tool:
.. code-block:: console
- $cd $GOPATH
- $go get mynewt.apache.org/newtmgr/newtmgr
- $cd $GOPATH/src/mynewt.apache.org/newtmgr
- $ls
+ $ cd $GOPATH
+ $ go get mynewt.apache.org/newtmgr/newtmgr
+ $ cd $GOPATH/src/mynewt.apache.org/newtmgr
+ $ ls
LICENSE NOTICE README.md newtmgr nmxact
- $git status
+ $ git status
On branch master
Your branch is up-to-date with 'origin/master'.
nothing to commit, working directory clean
@@ -188,15 +183,16 @@ from **$GOPATH/bin**:
.. code-block:: console
- $ls $GOPATH/bin/newtmgr
+ $ ls $GOPATH/bin/newtmgr
~/dev/go/bin/newtmgr
- $which newtmgr
+ $ which newtmgr
~/dev/go/bin/newtmgr
-Step 4: Updating and Rebuilding the Tools
-~~~~~~~~~~~~~~~
+Step 4: Updating and Rebuilding the Tools:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-This section shows you how to rebuild the newt and newtmgr tools with the latest updates from
+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
@@ -208,7 +204,7 @@ tools.
is installed.
2. Pull the latest changes from the master branch. If you made changes
you will need to rebase with **origin master** (See
- `FAQ </faq/answers/>`__).
+ :doc:`FAQ </misc/faq>`).
3. Build and install the tool.
Change to the directory where the source for the tool is installed.
@@ -217,13 +213,13 @@ For the **newt** tool:
.. code-block:: console
- $cd $GOPATH/src/mynewt.apache.org/newt/newt
+ $ cd $GOPATH/src/mynewt.apache.org/newt/newt
For the **newtmgr** tool:
.. code-block:: console
- $cd $GOPATH/src/mynewt.apache.org/newtmgr/newtmgr
+ $ cd $GOPATH/src/mynewt.apache.org/newtmgr/newtmgr
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
@@ -232,14 +228,14 @@ command:
.. code-block:: console
- $git pull
+ $ git pull
Build and install the tool. The updated binary will be installed in the
**$GOPATH/bin** directory:
.. code-block:: console
- $go install
+ $ go install
You can run the ``ls -l`` command to check the modification time for the
binary to ensure the new version is installed.
diff --git a/docs/faq/how_to_edit_docs.rst b/docs/misc/how_to_edit_docs.rst
similarity index 100%
rename from docs/faq/how_to_edit_docs.rst
rename to docs/misc/how_to_edit_docs.rst
diff --git a/docs/faq/ide.rst b/docs/misc/ide.rst
similarity index 91%
rename from docs/faq/ide.rst
rename to docs/misc/ide.rst
index abf334b27..f3e50890b 100644
--- a/docs/faq/ide.rst
+++ b/docs/misc/ide.rst
@@ -18,12 +18,10 @@ Prerequisites:
- Perform `native
installation </os/get_started/native_install_intro.html>`__ for the
Mynewt tools and toolchains.
-
**Note:** For Windows platforms, ensure that the MinGW bash you
install is added to your Windows Path. In addition, if you are using
Windows 10 WSL, you must have the MinGW bash before the Windows 10
WSL bash in your Windows Path.
-
- Read the Mynewt OS Concepts section.
- Create a project space (directory structure) and populate it with the
core code repository (apache-mynewt-core) or know how to as explained
@@ -77,8 +75,10 @@ To install the Native Debugger:
2. Type ``ext install webfreak.debug`` in the search box and press
Enter. You should see the Native Debug extension at the top of the
list.
-3. Click ``Install`` to install the extension. ###Defining Tasks for
- Mynewt Projects
+3. Click ``Install`` to install the extension.
+
+Defining Tasks for Mynewt Projects
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Two main concepts in Visual Studio Code are workspaces and tasks. A
workspace represents a folder that is open. You can open multiple
@@ -91,9 +91,10 @@ 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
+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.
@@ -102,7 +103,7 @@ 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
-^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You define Visual Studio Code tasks to build and debug your Mynewt
targets in Visual Studio Code. We use the Blinky application for the
@@ -120,26 +121,14 @@ Step 1: Press ``Ctrl-Shift-P``, type ``task``, and select
Step 2: Select **Others** (scroll down to the bottom of the list) to
create a task runner for external commands.
-.. raw:: html
-
- <p align="center">
-
-.. raw:: html
-
- </p>
+.. figure:: pics/task_runner_small.png
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.
-.. raw:: html
-
- <p align="center">
-
-.. raw:: html
-
- </p>
+.. figure:: pics/task_json_small.png
The sample ``tasks.json`` file defines a simple task that runs the echo
command with "Hello World" as the argument.
@@ -210,8 +199,7 @@ For more information on tasks and all supported properties, see the
documentation <https://code.visualstudio.com/docs/editor/tasks>`__.
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
@@ -219,29 +207,16 @@ and select **Tasks: Run Task**. The tasks that you define in the
The following is an example of running the ``build_arduino_boot`` task:
-.. raw:: html
-
- <p align="center">
-
-.. raw:: html
-
- </p>
+.. figure:: pics/task_select_small.png
-.. raw:: html
+.. figure:: pics/task_start_small.png
- <p align="center">
-
-.. raw:: html
-
- </p>
-
-**Note**:To run the ``build_arduino_blinky`` task, you can use the
+**Note**: To run the ``build_arduino_blinky`` task, you can use the
keyboard shortcut ``Ctrl-Shift-B`` because the task has the property
``isBuildCommand`` set to true.
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
@@ -270,40 +245,24 @@ 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:
-.. raw:: html
-
- <p align="center">
-
-.. raw:: html
-
- </p>
+.. figure:: pics/integrated_terminal_small.png
Defining Debugger Configurations
-~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-You need to define a debugger configuration to launch the GDB debugger from within Visual Studio Code:
+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.
-.. raw:: html
-
- <p align="center">
+.. figure:: pics/debug_new_config_small.png
-.. raw:: html
-
- </p>
You should see a default ``launch.json`` file created in the ``.vscode``
folder.
-.. raw:: html
-
- <p align="center">
-
-.. raw:: html
-
- </p>
+.. figure:: pics/launch_small.png
Step 2: Delete the content from the ``launch.json`` file, add the
following definitions, and press 'Ctrl-S' to save the file.
@@ -346,13 +305,7 @@ Perform the following:
3. Press ``Ctrl-Shift-U`` to open the Output Panel and see the OpenOCD
GDB Server output.
- .. raw:: html
-
- <p align="center">
-
- .. raw:: html
-
- </p>
+.. figure:: pics/gdb_server_small.png
Step 2: Start the GDB session. Perform the following:
@@ -362,24 +315,12 @@ Step 2: Start the GDB session. Perform the following:
3. Select ``gdb_arduino_blinky`` from the DEBUG drop down menu.
4. Press the green play button to start the gdb session.
-.. raw:: html
-
- <p align="center">
-
-.. raw:: html
-
- </p>
+.. figure:: pics/gdb_small.png
Step 3: Debug your application. You should see a debug session similar
to the one shown below:
-.. raw:: html
-
- <p align="center">
-
-.. raw:: html
-
- </p>
+.. figure:: pics/gdb_debug_small.png
For more information on how to use the Visual Studio Code Debugger, see
the `Visual Studio Code debugging
diff --git a/docs/misc/misc.rst b/docs/misc/misc.rst
new file mode 100644
index 000000000..88f31e46b
--- /dev/null
+++ b/docs/misc/misc.rst
@@ -0,0 +1,8 @@
+Miscellaneous
+-------------
+
+.. toctree::
+
+ Setting Up Go <go_env>
+ Using an IDE to Develop Mynewt Applications <ide>
+ FAQ <faq>
diff --git a/docs/newt/install/newt_linux.rst b/docs/newt/install/newt_linux.rst
index aabd88968..a6cb0dd92 100644
--- a/docs/newt/install/newt_linux.rst
+++ b/docs/newt/install/newt_linux.rst
@@ -31,8 +31,8 @@ versions (for example: Ubuntu 14) may have incompatibility with the
repository. You can manually download and install the Debian binary
package.
-**Note:** See `Setting Up a Go Environment to Contribute to Newt and
-Newtmgr Tools </faq/go_env>`__ if you want to:
+**Note:** See :doc:`Setting Up a Go Environment to Contribute to Newt and
+Newtmgr Tools </misc/go_env>` if you want to:
- Use the newt tool with the latest updates from the master branch. The
master branch may be unstable and we recommend that you use the
diff --git a/docs/newt/install/newt_mac.rst b/docs/newt/install/newt_mac.rst
index b76c32539..308654763 100644
--- a/docs/newt/install/newt_mac.rst
+++ b/docs/newt/install/newt_mac.rst
@@ -11,9 +11,8 @@ This page shows you how to:
See `Installing Previous Releases of Newt <prev_releases>`__ to install an earlier version of newt.
-**Note:** If you would like to contribute to the newt tool, see `Setting
-Up Go Environment to Contribute to Newt and Newtmgr
-Tools </faq/go_env>`__.
+**Note:** If you would like to contribute to the newt tool, see :doc:`Setting Up Go Environment to Contribute
+to Newt and Newtmgr Tools </misc/go_env>`.
Installing Homebrew
~~~~~~~~~~~~~~~~~~~
diff --git a/docs/newt/install/newt_windows.rst b/docs/newt/install/newt_windows.rst
index ec276b399..2fdbc3992 100644
--- a/docs/newt/install/newt_windows.rst
+++ b/docs/newt/install/newt_windows.rst
@@ -25,9 +25,9 @@ See `Installing Previous Releases of
Newt </newt/install/prev_releases>`__ to install an earlier version of
newt. You still need to set up your MinGW development environment.
-**Note:** If you would like to contribute to the newt tool, see `Setting
+**Note:** If you would like to contribute to the newt tool, see :doc:`Setting
Up Go Environment to Contribute to Newt and Newtmgr
-Tools </faq/go_env.html>`__.
+Tools </misc/go_env>`.
Installing MSYS2/MinGW
^^^^^^^^^^^^^^^^^^^^^^
diff --git a/docs/newtmgr/install_linux.rst b/docs/newtmgr/install_linux.rst
index 237b44c97..46fd93b85 100644
--- a/docs/newtmgr/install_linux.rst
+++ b/docs/newtmgr/install_linux.rst
@@ -33,8 +33,8 @@ versions (for example: Ubuntu 14) may have incompatibility with the
repository. You can manually download and install the Debian binary
package.
-**Note:** See `Setting Up a Go Environment to Contribute to Newt and
-Newtmgr Tools </faq/go_env>`__ if you want to:
+**Note:** See :doc:`Setting Up a Go Environment to Contribute to Newt and
+Newtmgr Tools </misc/go_env>` if you want to:
- Use the newtmgr tool with the latest updates from the master branch.
The master branch may be unstable and we recommend that you use the
@@ -129,7 +129,7 @@ newtmgr:
.. code-block:: console
- $ sudo apt-get update
+ $ sudo apt-get update
$ sudo apt-get install newtmgr
Method 2: Downloading and Installing the Debian Package Manually
@@ -246,5 +246,3 @@ version of newtmgr.
-r, --tries int total number of tries in case of timeout (default 1)
Use "newtmgr [command] --help" for more information about a command.
-
-
diff --git a/docs/newtmgr/install_mac.rst b/docs/newtmgr/install_mac.rst
index 7b65b6c0f..09b4a45e9 100644
--- a/docs/newtmgr/install_mac.rst
+++ b/docs/newtmgr/install_mac.rst
@@ -13,8 +13,8 @@ See `Installing Previous Releases of Newtmgr </newtmgr/prev_releases>`__
to install an earlier version of newtmgr.
**Note:** If you would like to contribute to the newtmgr tool, see
-`Setting Up Go Environment to Contribute to Newt and Newtmgr
-Tools </faq/go_env>`__.
+:doc:`Setting Up Go Environment to Contribute to Newt and Newtmgr
+Tools </misc/go_env>`.
Adding the Mynewt Homebrew Tap
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -174,5 +174,3 @@ run:
Cleaning /usr/local/Cellar/mynewt-newtmgr/1.3.0
Cleaning /usr/local/Cellar/mynewt-newtmgr/HEAD-2d5217f
1 links created for /usr/local/Cellar/mynewt-newtmgr/1.3.0
-
-
diff --git a/docs/newtmgr/install_windows.rst b/docs/newtmgr/install_windows.rst
index 8f4e15ba2..e7954e513 100644
--- a/docs/newtmgr/install_windows.rst
+++ b/docs/newtmgr/install_windows.rst
@@ -17,8 +17,8 @@ See `Installing Previous Releases of Newtmgr </newtmgr/prev_releases>`__
to install an earlier version of newtgmr.
**Note:** If you would like to contribute to the newtmgr tool, see
-`Setting Up Go Environment to Contribute to Newt and Newtmgr
-Tools </faq/go_env.html>`__.
+:doc:`Setting Up Go Environment to Contribute to Newt and Newtmgr
+Tools </misc/go_env>`.
Installing the Latest Release of Newtmgr Tool from Binary
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -167,4 +167,3 @@ version of newtmgr.
-r, --tries int total number of tries in case of timeout (default 1)
Use "newtmgr [command] --help" for more information about a command.
-
diff --git a/docs/os/core_os/mbuf/pics/mbuf_fig1.png b/docs/os/core_os/mbuf/pics/mbuf_fig1.png
deleted file mode 100644
index ba7ab0fb7..000000000
Binary files a/docs/os/core_os/mbuf/pics/mbuf_fig1.png and /dev/null differ
diff --git a/docs/os/core_os/mbuf/pics/mbuf_fig2.png b/docs/os/core_os/mbuf/pics/mbuf_fig2.png
deleted file mode 100644
index 68a971628..000000000
Binary files a/docs/os/core_os/mbuf/pics/mbuf_fig2.png and /dev/null differ
diff --git a/docs/os/core_os/mbuf/pics/mbuf_fig3.png b/docs/os/core_os/mbuf/pics/mbuf_fig3.png
deleted file mode 100644
index 6d5ac5b4f..000000000
Binary files a/docs/os/core_os/mbuf/pics/mbuf_fig3.png and /dev/null differ
diff --git a/docs/os/core_os/mynewt_os.rst b/docs/os/core_os/mynewt_os.rst
index a339152a5..08327c644 100644
--- a/docs/os/core_os/mynewt_os.rst
+++ b/docs/os/core_os/mynewt_os.rst
@@ -9,7 +9,7 @@ Mynewt Core OS
time/os_time
task/task
event_queue/event_queue
- semaphote/semaphore
+ semaphore/semaphore
mutex/mutex
memory_pool/memory_pool
heap/heap
diff --git a/docs/os/get_started/get_started.rst b/docs/os/get_started/get_started.rst
index aaf6f88b3..44091811d 100644
--- a/docs/os/get_started/get_started.rst
+++ b/docs/os/get_started/get_started.rst
@@ -5,9 +5,9 @@ Basic Setup
:hidden:
native_install_intro
- docker
- project_create
- serial_access
+ Docker Container <docker>
+ Create Your First Project <project_create>
+ Serial Port Setup <serial_access>
If you are curious about Mynewt and want to get a quick feel for the
project, you've come to the right place. We have two options for you:
diff --git a/docs/os/get_started/serial_access.rst b/docs/os/get_started/serial_access.rst
index e52614a81..391e12440 100644
--- a/docs/os/get_started/serial_access.rst
+++ b/docs/os/get_started/serial_access.rst
@@ -122,7 +122,7 @@ 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:
-::
+.. code-block:: console
$ screen /dev/tty.usbserial-0020124 115200
@@ -131,13 +131,13 @@ To exit out of ``screen`` you'll type ``control-A`` followed by
You can also use minicom:
-::
+.. code-block:: console
$ minicom -D /dev/tty.usbserial-0020124
Welcome to minicom 2.7
- OPTIONS:
+ OPTIONS:
Compiled on Nov 24 2015, 16:14:21.
Port /dev/tty.usbserial-0020124, 09:57:17
@@ -163,20 +163,20 @@ Check what USB devices are already connected:
.. code-block:: console
- $ls -l /dev/ttyS*
+ $ ls -l /dev/ttyS*
crw-rw-rw- 1 <user> None 117, 5 May 9 04:24 /dev/ttyS5
$
- /dev/ttyS5 maps to the Windows COM6 port. You can run Windows Device
+/dev/ttyS5 maps to the Windows COM6 port. You can run Windows Device
Manager to confirm:
- |Device Manager - USB Devices|
+|Device Manager - USB Devices|
Plug in the FT232H board and check the ports again:
.. code-block:: console
- $ls -l /dev/ttyS*
+ $ ls -l /dev/ttyS*
ls -l /dev/ttyS*
crw-rw-rw- 1 <user> None 117, 10 May 9 04:55 /dev/ttyS10
crw-rw-rw- 1 <user> None 117, 5 May 9 04:55 /dev/ttyS5
@@ -184,7 +184,7 @@ Plug in the FT232H board and check the ports again:
The FT232H board is connected to port /dev/ttyS10 (or COM11):
- |Device Manager - FT232H|
+|Device Manager - FT232H|
We use the PuTTY terminal application to connect to the board on the
COM11 port: |PuTTY|
@@ -201,4 +201,3 @@ move on to creating one!
.. |Device Manager - USB Devices| image:: /os/tutorials/pics/device_manager_no_ft232H.png
.. |Device Manager - FT232H| image:: /os/tutorials/pics/device_manager_ft232H.png
.. |PuTTY| image:: /os/tutorials/pics/putty.png
-
diff --git a/docs/os/modules/devmgmt/device-mgmt.png b/docs/os/modules/devmgmt/device-mgmt.png
new file mode 100644
index 000000000..534d97f5c
Binary files /dev/null and b/docs/os/modules/devmgmt/device-mgmt.png differ
diff --git a/docs/os/modules/json/json_encode_object_key.rst b/docs/os/modules/json/json_encode_object_key.rst
index 749e85ab9..5e83f76c5 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/sensor_framework/sensor_framework.png b/docs/os/modules/sensor_framework/sensor_framework.png
new file mode 100644
index 000000000..8114e0676
Binary files /dev/null and b/docs/os/modules/sensor_framework/sensor_framework.png differ
diff --git a/docs/os/tutorials/ble/bleprph/bleprph-sections/bleprph-app.rst b/docs/os/tutorials/ble/bleprph/bleprph-sections/bleprph-app.rst
index 2fd8d095e..ec888e0a5 100644
--- a/docs/os/tutorials/ble/bleprph/bleprph-sections/bleprph-app.rst
+++ b/docs/os/tutorials/ble/bleprph/bleprph-sections/bleprph-app.rst
@@ -46,58 +46,48 @@ Peripheral
Now if you reset the board, and fire up your BLE Central App, you should
see a new peripheral device called 'nimble-bleprph'.
-.. figure:: ../pics/LightBlue-1.jpg
+.. figure:: /os/tutorials/pics/LightBlue-1.jpg
:alt: LightBlue iOS App with nimble-bleprph device
- LightBlue
-
Now that you can see the device, you can begin to interact with the
advertised service.
Click on the device and you'll establish a connection.
-.. figure:: ../pics/LightBlue-2.jpg
+.. figure:: /os/tutorials/pics/LightBlue-2.jpg
:alt: LightBlue iOS App connected to the nimble-bleprph device
- LightBlue
-
Now that you're connected, you can see the Services that are being
advertised.
Scroll to the bottom and you will see a Read Characteristic, and a
Read/Write Characteristic.
-.. figure:: ../pics/LightBlue-3.jpg
+.. figure:: /os/tutorials/pics/LightBlue-3.jpg
:alt: LightBlue iOS App connected to the nimble-bleprph device
- LightBlue
-
Just click on the Read Write Characteristic and you will see the
existing value.
-.. figure:: ../pics/LightBlue-4.jpg
+.. figure:: /os/tutorials/pics/LightBlue-4.jpg
:alt: LightBlue iOS App with nimble-bleprph device Characteristic
- LightBlue
-
Type in a new value.
-.. figure:: ../pics/LightBlue-5.jpg
+.. figure:: /os/tutorials/pics/LightBlue-5.jpg
:alt: LightBlue iOS App Value Change
LightBlue
And you will see the new value reflected.
-.. figure:: ../pics/LightBlue-6.jpg
+.. figure:: /os/tutorials/pics/LightBlue-6.jpg
:alt: LightBlue iOS App with nimble-bleprph new value
- LightBlue
-
If you still have your console connected, you will be able to see the
connection requests, and pairing, happen on the device as well.
-.. code:: hl_lines="1"
+.. code:: console
258894:[ts=2022609336ssb, mod=64 level=1] connection established; status=0 handle=1 our_ota_addr_type=0 our_ota_addr=0a:0a:0a:0a:0a:0a our_id_addr_type=0 our_id_addr=0a:0a:0a:0a:0a:0a peer_ota_addr_type=1 peer_ota_addr=7f:be:d4:44:c0:d4 peer_id_addr_type=1 peer_id_addr=7f:be:d4:44:c0:d4 conn_itvl=24 conn_latency=0 supervision_timeout=72 encrypted=0 authenticated=0 bonded=0
258904:[ts=2022687456ssb, mod=64 level=1]
diff --git a/docs/os/tutorials/sensors/sensor_bleprph_oic.rst b/docs/os/tutorials/sensors/sensor_bleprph_oic.rst
index 9fb443cd0..9a9b1aba3 100644
--- a/docs/os/tutorials/sensors/sensor_bleprph_oic.rst
+++ b/docs/os/tutorials/sensors/sensor_bleprph_oic.rst
@@ -47,7 +47,6 @@ initialization handler.
Step 1: Copying the bleprph\_oic source
~~~~~~~~~~~~~~~
-
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:
@@ -181,7 +180,7 @@ The lines to delete are highlighted below:
oc_resource_set_default_interface(res, OC_IF_RW);
oc_resource_set_discoverable(res);
- oc_resource_set_periodic_observable(res, 1);
+ oc_resource_set_periodic_observable(res, 1);
oc_resource_set_request_handler(res, OC_GET, app_get_light);
oc_resource_set_request_handler(res, OC_PUT, app_set_light);
oc_add_resource(res);
@@ -196,8 +195,8 @@ to create an OIC resource for the sensor device:
static void
omgr_app_init(void)
- {
-
+ {
+
oc_init_platform("MyNewt", NULL, NULL);
oc_add_device("/oic/d", "oic.d.sensy", "sensy", "1.0", "1.0", NULL, NULL);
@@ -212,12 +211,12 @@ sensor framework OIC server support:
static void
omgr_app_init(void)
- {
-
+ {
+
oc_init_platform("MyNewt", NULL, NULL);
oc_add_device("/oic/d", "oic.d.sensy", "sensy", "1.0", "1.0", NULL, NULL);
-
+
sensor_oic_init();
}
@@ -259,10 +258,10 @@ build\_profile variables for the target.
.. code-block:: console
- $ newt target set nrf52_bleprph_oic_bno055 app=@apache-mynewt-core/apps/bleprph_oic_sensor bsp=@apache-mynewt-core/hw/bsp/nrf52dk build_profile=debug
+ $ newt target set nrf52_bleprph_oic_bno055 app=@apache-mynewt-core/apps/bleprph_oic_sensor bsp=@apache-mynewt-core/hw/bsp/nrf52dk build_profile=debug
Target targets/nrf52_bleprph_oic_bno055 successfully set target.app to @apache-mynewt-core/apps/bleprph_oic_sensor
Target targets/nrf52_bleprph_oic_bno055 successfully set target.bsp to @apache-mynewt-core/hw/bsp/nrf52dk
- Target targets/nrf52_bleprph_oic_bno055 successfully set target.build_profile to debug
+ 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``,
diff --git a/docs/themes/mynewt/main-banner.html b/docs/themes/mynewt/main-banner.html
index ba7abede6..2a5da76fa 100644
--- a/docs/themes/mynewt/main-banner.html
+++ b/docs/themes/mynewt/main-banner.html
@@ -8,7 +8,7 @@ <h4 class="tagline">An OS to build, deploy and securely manage billions of devic
</div>
<div class="news-cell">
<div class="well">
- <h4>Latest News:</h4> <a href="/download">Apache Mynewt 1.0.0-b1</a> released (Dec 13, 2016)
+ <h4>Latest News:</h4> <a href="/download">Apache Mynewt 1.3.0</a> released (December 13, 2017)
</div>
</div>
</div>
----------------------------------------------------------------
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