http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/40899401/latest/newt/install/newt_linux/index.html ---------------------------------------------------------------------- diff --git a/latest/newt/install/newt_linux/index.html b/latest/newt/install/newt_linux/index.html index 2e481ee..efbfbca 100644 --- a/latest/newt/install/newt_linux/index.html +++ b/latest/newt/install/newt_linux/index.html @@ -439,10 +439,18 @@ <ul> <li> <p>Next, install Go. When installed, Go offers you as a developer a language environment (to compile Go code), construct Go packages (to assemble Go packages) and import Go code (from github). In the next step, you will use the Go commands to import <em>newt</em> repo into your local Go environment.</p> -<p><strong>Note</strong>: The Newt tool requires Go version 1.6 or later. Depending on the Ubuntu version you have, the following may install an earlier version. In that case, download the latest package of Go 1.6 from <a href="https://golang.org/dl/";>https://golang.org/dl/</a>. You can search for more detailed instructions such as installing Go 1.6 on Ubuntu 14.04 which can be found at <a href="https://www.digitalocean.com/community/tutorials/how-to-install-go-1-6-on-ubuntu-14-04";>https://www.digitalocean.com/community/tutorials/how-to-install-go-1-6-on-ubuntu-14-04</a>.</p> +<p><strong>Note</strong>: The Newt tool requires Go version 1.7 or later. Currently, the latest Go version that Ubuntu installs is 1.6. You can run <code>apt-get install golang-1.7-go</code> to install version 1.7. You can also download version 1.7 from <a href="https://golang.org/dl/";>https://golang.org/dl/</a>. </p> </li> </ul> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> $ sudo apt-get install golang +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$sudo apt-get install golang-1.7-go +Reading package lists... Done + ... +Unpacking golang-1.7-go (1.7.1-2ubuntu1) ... +Setting up golang-1.7-go (1.7.1-2ubuntu1) ... +$ +$sudo ln -s /usr/lib/go-1.7/bin/go /usr/bin/go +$go version +go version go1.7.1 linux/amd64 </pre></div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/40899401/latest/newt/newt_intro/index.html ---------------------------------------------------------------------- diff --git a/latest/newt/newt_intro/index.html b/latest/newt/newt_intro/index.html index d21ee01..5431df7 100644 --- a/latest/newt/newt_intro/index.html +++ b/latest/newt/newt_intro/index.html @@ -452,7 +452,7 @@ project.repositories: # repository.apache-mynewt-core: type: github - vers: 0-latest + vers: 1-latest user: apache repo: incubator-mynewt-core </pre></div> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/40899401/latest/os/core_os/cputime/os_cputime/index.html ---------------------------------------------------------------------- diff --git a/latest/os/core_os/cputime/os_cputime/index.html b/latest/os/core_os/cputime/os_cputime/index.html index 0e28665..555beca 100644 --- a/latest/os/core_os/cputime/os_cputime/index.html +++ b/latest/os/core_os/cputime/os_cputime/index.html @@ -700,7 +700,7 @@ </div> <h1 id="cpu-time">CPU Time</h1> -<p>The MyNewt <code>cputime</code> module provides high resolution time and timer support. This module is intended for use by BSPs, drivers, and network controllers. </p> +<p>The MyNewt <code>cputime</code> module provides high resolution time and timer support. </p> <h2 id="description">Description</h2> <p>The <code>cputime</code> API provides high resolution time and timer support. The module must be initialized, using the <code>os_cputime_init()</code> function, with the clock frequency to use. The module uses the <code>hal_timer</code> API, defined in hal/hal_timer.h, to access the hardware timers. It uses the hardware timer number specified by the <code>OS_CPUTIME_TIMER_NUM</code> system configuration setting.</p> <h2 id="data-structures">Data Structures</h2> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/40899401/latest/os/get_started/project_create/index.html ---------------------------------------------------------------------- diff --git a/latest/os/get_started/project_create/index.html b/latest/os/get_started/project_create/index.html index 5cad4fc..f91e279 100644 --- a/latest/os/get_started/project_create/index.html +++ b/latest/os/get_started/project_create/index.html @@ -573,7 +573,7 @@ repos/apache-mynewt-core/ into your local directory. </p> <p><br></p> <h3 id="test-the-projects-packages">Test the project's packages</h3> -<p>You have already built your first basic project. You can ask Newt to execute the unit tests in a package. For example, to test the <code>libs/os</code> package in the <code>apache-mynewt-core</code> repo, call newt as shown below.</p> +<p>You have already built your first basic project. You can ask Newt to execute the unit tests in a package. For example, to test the <code>sys/config</code> package in the <code>apache-mynewt-core</code> repo, call newt as shown below.</p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt test @apache-mynewt-core/sys/config Testing package @apache-mynewt-core/sys/config/test-fcb Compiling bootutil_misc.c @@ -662,9 +662,10 @@ Target successfully built: targets/my_blinky_sim <p>You can run the simulated version of your project and see the simulated LED blink. If you are using newt docker, use <code>newt run</code> to run the simulated binary.</p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt run my_blinky_sim -No download script for BSP hw/bsp/native -Debugging /workspace/bin/my_blinky_sim/apps/blinky/blinky.elf -<snip> +Loading app image into slot 1 + ... +Debugging ~/dev/myproj/bin/targets/my_blinky_sim/app/apps/blinky/blinky.elf + ... Reading symbols from /bin/targets/my_blinky_sim/app/apps/blinky/blinky.elf...done. (gdb) </pre></div> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/40899401/latest/os/get_started/vocabulary/index.html ---------------------------------------------------------------------- diff --git a/latest/os/get_started/vocabulary/index.html b/latest/os/get_started/vocabulary/index.html index 0782e2d..8b907b7 100644 --- a/latest/os/get_started/vocabulary/index.html +++ b/latest/os/get_started/vocabulary/index.html @@ -413,9 +413,6 @@ pkg.deps: they will inherit their functionality (header files, library definitions, etc.)</li> <li>APIs: Packages can export named APIs, and they can require that certain APIs be present, in order to compile.</li> -<li>Features: Packages can operate differently depending on what named features are - present in the system. Packages can also export features to the rest of the - Mynewt system.</li> </ul> <p>Everything that newt knows about within a project's directory is a package. This makes it very clean and easy to write re-usable components, which can describe their @@ -434,8 +431,9 @@ of your project. Most targets consist of: </p> </ul> <p>Targets can also have additional items specified, including: </p> <ul> +<li><code>aflags</code>: Any additional assembler flags you might want to specify to the build.</li> <li><code>cflags</code>: Any additional compiler flags you might want to specify to the build.</li> -<li><code>features</code>: Any system level features you want to enable.</li> +<li><code>lflags</code>: Any additional linker flags you might want to specify to the build.</li> </ul> <p>In order to create and manipulate targets, the <em>newt</em> tool offers a set of helper commands, you can find more information about these by issuing:</p> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/40899401/latest/os/modules/bootloader/bootloader/index.html ---------------------------------------------------------------------- diff --git a/latest/os/modules/bootloader/bootloader/index.html b/latest/os/modules/bootloader/bootloader/index.html index c472ff4..20975b2 100644 --- a/latest/os/modules/bootloader/bootloader/index.html +++ b/latest/os/modules/bootloader/bootloader/index.html @@ -544,7 +544,7 @@ </div> <h1 id="bootloader">Bootloader</h1> -<p>The "bootloader" is the code that loads the Mynewt OS image into memory and conducts some checks before allowing the OS to be run. It manages images for the embedded system and upgrades of those images using protocols over various interfaces (e.g. serial, BLE etc.). Typically, systems with bootloaders have at least two program images coexisting on the same microcontroller, and hence must include branch code that performs a check to see if an attempt to update software is already underway and manage the progress of the process.</p> +<p>The "bootloader" is the code that loads the Mynewt OS image into memory and conducts some checks before allowing the OS to be run. It manages images for the embedded system and upgrades of those images using protocols over various interfaces (e.g. serial, BLE, etc.). Typically, systems with bootloaders have at least two program images coexisting on the same microcontroller, and hence must include branch code that performs a check to see if an attempt to update software is already underway and manage the progress of the process.</p> <p>The bootloader in the Apache Mynewt project verifies the cryptographic signature of the firmware image before running it. It maintains a detailed status log for each stage of the boot process. For verification of the authenticity of the OS image, it:</p> <ul> <li>Calculates hash of the image.</li> @@ -590,7 +590,7 @@ characteristics:</p> <span style="color: #A90D91">uint16_t</span> <span style="color: #000000">ih_tlv_size</span>; <span style="color: #177500">/* Trailing TLVs */</span> <span style="color: #A90D91">uint8_t</span> <span style="color: #000000">ih_key_id</span>; <span style="color: #A90D91">uint8_t</span> <span style="color: #000000">_pad1</span>; - <span style="color: #A90D91">uint16_t</span> <span style="color: #000000">ih_hdr_s<</span> <span style="color: #000000">bok@bok</span>.<span style="color: #000000">net</span> + <span style="color: #A90D91">uint16_t</span> <span style="color: #000000">ih_hdr_size</span>; <span style="color: #A90D91">uint16_t</span> <span style="color: #000000">_pad2</span>; <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">ih_img_size</span>; <span style="color: #177500">/* Does not include header. */</span> <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">ih_flags</span>; @@ -604,12 +604,12 @@ characteristics:</p> offset of the image itself. This field provides for backwards compatibility in case of changes to the format of the image header.</p> <p>The following are the image header flags available.</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #633820">#define IMAGE_F_PIC 0x00000001</span> -<span style="color: #633820">#define IMAGE_F_SHA256 0x00000002 </span><span style="color: #177500">/* Image contains hash TLV */</span><span style="color: #633820"></span> -<span style="color: #633820">#define IMAGE_F_PKCS15_RSA2048_SHA256 0x00000004 </span><span style="color: #177500">/* PKCS15 w/RSA and SHA */</span><span style="color: #633820"></span> -<span style="color: #633820">#define IMAGE_F_ECDSA224_SHA256 0x00000008 </span><span style="color: #177500">/* ECDSA256 over SHA256 */</span><span style="color: #633820"></span> -<span style="color: #633820">#define IMAGE_F_NON_BOOTABLE 0x00000010</span> -<span style="color: #633820">#define IMAGE_HEADER_SIZE 32</span> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #633820">#define IMAGE_F_PIC 0x00000001</span> +<span style="color: #633820">#define IMAGE_F_SHA256 0x00000002 </span><span style="color: #177500">/* Image contains hash TLV */</span><span style="color: #633820"></span> +<span style="color: #633820">#define IMAGE_F_PKCS15_RSA2048_SHA256 0x00000004 </span><span style="color: #177500">/* PKCS15 w/RSA and SHA */</span><span style="color: #633820"></span> +<span style="color: #633820">#define IMAGE_F_ECDSA224_SHA256 0x00000008 </span><span style="color: #177500">/* ECDSA256 over SHA256 */</span><span style="color: #633820"></span> +<span style="color: #633820">#define IMAGE_F_NON_BOOTABLE 0x00000010</span> +<span style="color: #633820">#define IMAGE_HEADER_SIZE 32</span> </pre></div> @@ -635,11 +635,10 @@ after the end of the image. For example, security data gets added as a footer at <p>A Mynewt device's flash is partitioned according to its <em>flash map</em>. At a high level, the flash map maps numeric IDs to <em>flash areas</em>. A flash area is a region of disk with the following properties:</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">1. An area can be fully erased without affecting any other areas. -2. A write to one area does not restrict writes to other areas. -</pre></div> - - +<ol> +<li>An area can be fully erased without affecting any other areas.</li> +<li>A write to one area does not restrict writes to other areas.</li> +</ol> <p>The boot loader uses the following flash areas:</p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #633820">#define FLASH_AREA_BOOTLOADER 0</span> <span style="color: #633820">#define FLASH_AREA_IMAGE_0 1</span> @@ -731,20 +730,23 @@ An image trailer has the following structure:</p> <p>These records are at the end of each image slot. The offset immediately following such a record represents the start of the next flash area.</p> -<p>Note: "min-write-size" is a property of the flash hardware. If the hardware +<p>Note: <code>min-write-size</code> is a property of the flash hardware. If the hardware allows individual bytes to be written at arbitrary addresses, then -min-write-size is 1. If the hardware only allows writes at even addresses, -then min-write-size is 2, and so on.</p> +<code>min-write-size</code> is 1. If the hardware only allows writes at even addresses, +then <code>min-write-size</code> is 2, and so on.</p> <p>The fields are defined as follows:</p> <ol> <li> <p>MAGIC: The following 16 bytes, written in host-byte-order:</p> -<p>const uint32_t boot_img_magic[4] = { +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">const uint32_t boot_img_magic[4] = { 0xf395c277, 0x7fefd260, 0x0f505235, 0x8079b62c, -};</p> +}; +</pre></div> + + </li> <li> <p>Swap status: A series of single-byte records. Each record corresponds to a @@ -755,18 +757,18 @@ if the device rebooted before a swap operation completed.</p> </li> <li> <p>Copy done: A single byte indicating whether the image in this slot is -complete (0x01=done, 0xff=not done).</p> +complete (<code>0x01=done, 0xff=not done</code>).</p> </li> <li> <p>Image OK: A single byte indicating whether the image in this slot has been -confirmed as good by the user (0x01=confirmed; 0xff=not confirmed).</p> +confirmed as good by the user (<code>0x01=confirmed; 0xff=not confirmed</code>).</p> </li> </ol> <p>The boot vector records are structured around the limitations imposed by flash hardware. As a consequence, they do not have a very intuitive design, and it is difficult to get a sense of the state of the device just by looking at the -boot vector. It is better to map all the possible vector states to the swap types (None, Test, Revert) -via a set of tables. These tables are reproduced below. +boot vector. It is better to map all the possible vector states to the swap types +(None, Test, Revert) via a set of tables. These tables are reproduced below. In these tables, the "pending" and "confirmed" flags are shown for illustrative purposes; they are not actually present in the boot vector.</p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">State I @@ -827,10 +829,11 @@ State IV a high-level overview of the boot process is presented. Then, the following sections describe each step of the process in more detail.</p> <p>Procedure:</p> -<p>A. Inspect swap status region; is an interrupted swap is being resumed? +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">A. Inspect swap status region; is an interrupted swap is being resumed? Yes: Complete the partial swap operation; skip to step C. - No: Proceed to step B.</p> -<p>B. Insect boot vector; is a swap requested? + No: Proceed to step B. + +B. Inspect boot vector; is a swap requested? Yes. 1. Is the requested image valid (integrity and security check)? Yes. @@ -841,14 +844,20 @@ sections describe each step of the process in more detail.</p> a. Erase invalid image. b. Persist failure of swap procedure to boot vector. c. Proceed to step C. - No: Proceed to step C.</p> -<p>C. Boot into image in slot 0.</p> + No: Proceed to step C. + +C. Boot into image in slot 0. +</pre></div> + + <h3 id="image-swapping">Image Swapping</h3> -<p>The boot loader swaps the contents of the two image slots for two reasons: - * User has issued an "image test" operation; the image in slot-1 should be - run once (state II). - * Test image rebooted without being confirmed; the boot loader should - revert to the original image currently in slot-1 (state III).</p> +<p>The boot loader swaps the contents of the two image slots for two reasons:</p> +<ul> +<li>User has issued an "image test" operation; the image in slot-1 should be + run once (state II).</li> +<li>Test image rebooted without being confirmed; the boot loader should + revert to the original image currently in slot-1 (state III).</li> +</ul> <p>If the boot vector indicates that the image in the secondary slot should be run, the boot loader needs to copy it to the primary slot. The image currently in the primary slot also needs to be retained in flash so that it can be used @@ -882,11 +891,12 @@ according to the following procedure:</p> can be written by the user at a later time. With the image trailer unwritten, the user can test the image in slot 1 (i.e., transition to state II).</p> <p>The particulars of step 3 vary depending on whether an image is being tested or -reverted: - * test: - o Write slot0.copy_done = 1 - (should now be in state III)</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">* revert: +reverted:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">* test: + o Write slot0.copy_done = 1 + (should now be in state III) + +* revert: o Write slot0.magic = BOOT_MAGIC o Write slot0.copy_done = 1 o Write slot0.image_ok = 1 @@ -899,9 +909,9 @@ reverted: the middle of an image swap operation. The swap status region consists of a series of single-byte records. These records are written independently, and therefore must be padded according to the minimum write size imposed by the -flash hardware. In the below figure, a min-write-size of 1 is assumed for +flash hardware. In the below figure, a <code>min-write-size</code> of 1 is assumed for simplicity. The structure of the swap status region is illustrated below. In -this figure, a min-write-size of 1 is assumed for simplicity.</p> +this figure, a <code>min-write-size</code> of 1 is assumed for simplicity.</p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ @@ -931,11 +941,14 @@ sectors, the flash layout is not compatible with this boot loader. Finally, reverse the list of indices such that the list starts with index 127 and ends with 0. The swap status region is a representation of this reversed list.</p> <p>During a swap operation, each sector index transitions through four separate -states: - 0. slot 0: image 0, slot 1: image 1, scratch: N/A - 1. slot 0: image 0, slot 1: N/A, scratch: image 1 (1->s, erase 1) - 2. slot 0: N/A, slot 1: image 0, scratch: image 1 (0->1, erase 0) - 3. slot 0: image 1, slot 1: image 0, scratch: N/A (s->0)</p> +states:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">0. slot 0: image 0, slot 1: image 1, scratch: N/A +1. slot 0: image 0, slot 1: N/A, scratch: image 1 (1->s, erase 1) +2. slot 0: N/A, slot 1: image 0, scratch: image 1 (0->1, erase 0) +3. slot 0: image 1, slot 1: image 0, scratch: N/A (s->0) +</pre></div> + + <p>Each time a sector index transitions to a new state, the boot loader writes a record to the swap status region. Logically, the boot loader only needs one record per sector index to keep track of the current swap state. However, due @@ -954,7 +967,7 @@ state 3 | 0x01 | 0x02 | 0x03 <p>The swap status region can accommodate 128 sector indices. Hence, the size of -the region, in bytes, is 128 * min-write-size * 3. The number 128 is chosen +the region, in bytes, is <code>128 * min-write-size * 3</code>. The number 128 is chosen somewhat arbitrarily and will likely be made configurable. The only requirement for the index count is that is is great enough to account for a maximum-sized image (i.e., at least as great as the total sector count in an @@ -1024,12 +1037,14 @@ it had just been started.</p> primary slot. If the boot loader doesn't perform an image swap, then it doesn't perform an integrity check.</p> <p>During the integrity check, the boot loader verifies the following aspects of -an image: - * 32-bit magic number must be correct (0x96f3b83c). - * Image must contain a SHA256 TLV. - * Calculated SHA256 must matche SHA256 TLV contents. - * Image <em>may</em> contain a signature TLV. If it does, its contents must be - verifiable using a key embedded in the boot loader.</p> +an image:</p> +<ul> +<li>32-bit magic number must be correct (0x96f3b83c).</li> +<li>Image must contain a SHA256 TLV.</li> +<li>Calculated SHA256 must matche SHA256 TLV contents.</li> +<li>Image <em>may</em> contain a signature TLV. If it does, its contents must be + verifiable using a key embedded in the boot loader.</li> +</ul> <h3 id="image-signing-and-verification">Image Signing and Verification</h3> <p>As indicated above, the final step of the integrity check is signature verification. The boot loader can have one or more public keys embedded in it @@ -1039,7 +1054,7 @@ The image signature TLV indicates the index of the key that is has been signed with. The boot loader uses this index to identify the corresponding public key.</p> <p>For information on embedding public keys in the boot loader, as well as -producing signed images, see: boot/bootutil/signed_images.md </p> +producing signed images, see: boot/bootutil/signed_images.md</p> <div class="row"> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/40899401/latest/os/modules/console/console/index.html ---------------------------------------------------------------------- diff --git a/latest/os/modules/console/console/index.html b/latest/os/modules/console/console/index.html index 99a552c..ccae748 100644 --- a/latest/os/modules/console/console/index.html +++ b/latest/os/modules/console/console/index.html @@ -549,18 +549,13 @@ application. A user typically inputs text from a keyboard and reads the OS outp monitor. The text are sent as a sequence of characters between the user and the OS. </p> <p>Support is currently available for console access via the serial port on the hardware board.</p> <h3 id="description">Description</h3> -<p>In the Mynewt OS, the console library comes in two versions:</p> +<p>In the Mynewt OS, the console library comes in three versions:</p> <ul> -<li> -<p>The <code>sys/console/full</code> package implements the complete console functionality and API.</p> -</li> -<li> -<p>The <code>sys/console/stub</code> package implements stubs for the API.</p> -</li> +<li>The <code>sys/console/full</code> package implements the complete console functionality and API.</li> +<li>The <code>sys/console/stub</code> package implements stubs for the API.</li> +<li>The <code>sys/console/minimal</code> package implements minimal console functionality of reading from and writing to console. It implements the <code>console_read()</code> and <code>console_write()</code> functions and stubs for all the other console functions.</li> </ul> -<p>Both packages export the <code>console</code> API, and any package that uses -the console API must list <code>console</code> as a requirement. For example, the shell package defines the following <code>pkg.yml</code> -file:</p> +<p>All the packages export the <code>console</code> API, and any package that uses the console API must list <code>console</code> as a requirement its <code>pkg.yml</code> file: </p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">pkg.name: sys/shell pkg.deps: - kernel/os @@ -572,9 +567,11 @@ pkg.req_apis: </pre></div> -<p>The project <code>pkg.yml</code> file specifies the version of the console package to use. -A project that requires the full console capability must list the <code>sys/console/full</code> package as a dependency -in its <code>pkg.yml</code> file.</p> +<p><br> +The project <code>pkg.yml</code> file also specifies the version of the console package to use.</p> +<p><br></p> +<h4 id="using-the-full-console-package">Using the Full Console Package</h4> +<p>A project that requires the full console capability must list the <code>sys/console/full</code> package as a dependency in its <code>pkg.yml</code> file.</p> <p>An example is the <code>slinky</code> application. It requires the full console capability and has the following <code>pkg.yml</code> file: </p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">pkg.name: apps/slinky @@ -592,22 +589,51 @@ pkg.deps: </pre></div> -<p>On the other hand, a project may not have a physical console (e.g. a UART port to connect a terminal to) -but may have a dependency on a package that has console capability. In this case, you use -the console stub API and list the <code>sys/console/stub</code> package as a dependency in its <code>pkg.yml</code> file. </p> -<p>An example is the bootloader project where we want to keep the size of the image small. It includes +<p><br></p> +<h4 id="using-the-stub-console-package">Using the Stub Console Package</h4> +<p>A project that uses console stub API must list the <code>sys/console/stub</code> package as a dependency in its <code>pkg.yml</code> file.</p> +<p>Examples of when a project would use the console stubs might be:</p> +<ul> +<li>A project may not have a physical console (e.g. a UART port to connect a terminal to) +but may have a dependency on a package that has console capability. </li> +<li>A bootloader project where we want to keep the size of the image small. It includes the <code>kernel/os</code> package that can print out messages on a console (e.g. if there is a hard fault). However, we do not want to use any console I/O capability in this particular bootloader project to -keep the size small. The project uses the console stub API and has the following <code>pkg.yml</code> file: </p> +keep the size small. </li> +</ul> +<p>The project would use the console stub API and has the following <code>pkg.yml</code> file: </p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">pkg.name: apps/boot +pkg.deps: + - boot/bootutil + - kernel/os + - sys/console/stub +</pre></div> + + +<p><br></p> +<h4 id="using-the-minimal-console-package">Using the Minimal Console Package</h4> +<p>There might be projects that need to read and write data on a serial connection but do not need the full console capability. An example might be a project that supports serial image upgrade but does not need full newtmgr capability. The project would use the console minimal API and has the following <code>pkg.yml</code> file: </p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">pkg.name: apps/boot +pkg.type: app +pkg.description: Boot loader application. +pkg.author: "Apache Mynewt <[email protected]>" +pkg.homepage: "http://mynewt.apache.org/" +pkg.keywords: + - loader + pkg.deps: - boot/bootutil - kernel/os - sys/console/stub + +pkg.deps.BOOT_SERIAL.OVERWRITE: + - sys/console/minimal + - boot/boot_serial </pre></div> -<p>Console has 2 modes for transmit; <em>blocking mode</em> and <em>non-blocking mode</em>. Usually the <em>non-blocking mode</em> is the +<p><br> +Console has 2 modes for transmit; <em>blocking mode</em> and <em>non-blocking mode</em>. Usually the <em>non-blocking mode</em> is the active one; the output buffer is drained by getting TX completion interrupts from hardware, and more data is added based on these interrupts.</p> <p><em>Blocking mode</em> is used when we don't want TX completion interrupts. It is used when system crashes, and we still http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/40899401/latest/os/modules/console/console_read/index.html ---------------------------------------------------------------------- diff --git a/latest/os/modules/console/console_read/index.html b/latest/os/modules/console/console_read/index.html index f11568c..4515512 100644 --- a/latest/os/modules/console/console_read/index.html +++ b/latest/os/modules/console/console_read/index.html @@ -606,7 +606,7 @@ </div> <h2 id="console_read"><font color="#F2853F" style="font-size:24pt"> console_read </font></h2> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> <span style="color: #000000">console_read</span>(<span style="color: #A90D91">char</span> <span style="color: #000000">*str</span>, <span style="color: #A90D91">int</span> <span style="color: #000000">cnt</span>) +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> <span style="color: #000000">console_read</span>(<span style="color: #A90D91">char</span> <span style="color: #000000">*str</span>, <span style="color: #A90D91">int</span> <span style="color: #000000">cnt</span>, <span style="color: #A90D91">int</span> <span style="color: #000000">*newline</span>) </pre></div> @@ -629,6 +629,10 @@ separate lines; once it encounters a newline character, it replaces that with en <td><code>cnt</code></td> <td>Maximum number of characters to copy.</td> </tr> +<tr> +<td><code>newline</code></td> +<td>Pointer to an integer variable that is set to 1 when an newline character is received and set to 0 otherwise.</td> +</tr> </tbody> </table> <h4 id="returned-values">Returned values</h4> @@ -641,12 +645,13 @@ available, or if the first received character was '\n'.</p> <span style="color: #A90D91">struct</span> <span style="color: #000000">os_event</span> <span style="color: #000000">*ev</span>; <span style="color: #A90D91">char</span> <span style="color: #000000">rx_msg</span>[<span style="color: #1C01CE">128</span>]; <span style="color: #A90D91">int</span> <span style="color: #000000">rx_len</span>; + <span style="color: #A90D91">int</span> <span style="color: #000000">newline</span>; <span style="color: #A90D91">while</span> (<span style="color: #1C01CE">1</span>) { <span style="color: #000000">ev</span> <span style="color: #000000">=</span> <span style="color: #000000">os_eventq_get</span>(<span style="color: #000000">&task1_evq</span>); <span style="color: #000000">assert</span>(<span style="color: #000000">ev</span>); <span style="color: #A90D91">if</span> (<span style="color: #000000">ev->ev_type</span> <span style="color: #000000">==</span> <span style="color: #000000">CONS_EV_TYPE</span>) { - <span style="color: #000000">rx_len</span> <span style="color: #000000">=</span> <span style="color: #000000">console_read</span>(<span style="color: #000000">rx_msg</span>, <span style="color: #A90D91">sizeof</span>(<span style="color: #000000">rx_msg</span>)); + <span style="color: #000000">rx_len</span> <span style="color: #000000">=</span> <span style="color: #000000">console_read</span>(<span style="color: #000000">rx_msg</span>, <span style="color: #A90D91">sizeof</span>(<span style="color: #000000">rx_msg</span>), <span style="color: #000000">&newline</span>); <span style="color: #A90D91">if</span> (<span style="color: #000000">rx_len</span>) { <span style="color: #A90D91">if</span> (<span style="color: #000000">!strncmp</span>(<span style="color: #000000">rx_msg</span>, <span style="color: #C41A16">"reset"</span>, <span style="color: #000000">rx_len</span>)) { <span style="color: #000000">assert</span>(<span style="color: #1C01CE">0</span>); http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/40899401/latest/os/tutorials/STM32F303/index.html ---------------------------------------------------------------------- diff --git a/latest/os/tutorials/STM32F303/index.html b/latest/os/tutorials/STM32F303/index.html index 1f9304b..f1ab01b 100644 --- a/latest/os/tutorials/STM32F303/index.html +++ b/latest/os/tutorials/STM32F303/index.html @@ -232,14 +232,14 @@ - <li><a href=" - ../arduino_zero/ -">Project Blinky</a> + <li ><a href="../blinky/">Project Blinky</a> <ul> + + <li > <a href="../arduino_zero/">Blinky on Arduino Zero</a> @@ -331,8 +331,11 @@ - <li > - <a href="../tasks_lesson/">Tasks and Priority Management</a> + + + <li ><a href="../project-slinky/">Project Slinky for Remote Comms</a> + + </li> @@ -340,7 +343,7 @@ <li > - <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> + <a href="../ibeacon/">BLE iBeacon</a> </li> @@ -348,7 +351,7 @@ <li > - <a href="../unit_test/">Write a Test Suite for a Package</a> + <a href="../eddystone/">BLE Eddystone</a> </li> @@ -356,20 +359,15 @@ <li > - <a href="../event_queue/">Events and Event Queues</a> + <a href="../add_newtmgr/">Enable Newt Manager in any app</a> </li> - - - <li><a href=" - ../project-slinky/ -">Project Slinky for remote comms</a> - - + <li > + <a href="../add_shell/">Enable the OS Shell and Console</a> </li> @@ -377,7 +375,7 @@ <li > - <a href="../add_newtmgr/">Enable Newt Manager in any app</a> + <a href="../tasks_lesson/">Tasks and Priority Management</a> </li> @@ -385,7 +383,7 @@ <li > - <a href="../add_shell/">Enable the OS Shell and Console</a> + <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> @@ -393,18 +391,15 @@ <li > - <a href="../bletiny_project/">BLE app to check stats via console</a> + <a href="../unit_test/">Write a Test Suite for a Package</a> </li> - - - <li ><a href="../bleprph/bleprph-intro/">BLE peripheral project</a> - - + <li > + <a href="../event_queue/">Events and Event Queues</a> </li> @@ -412,15 +407,18 @@ <li > - <a href="../ibeacon/">BLE iBeacon</a> + <a href="../bletiny_project/">BLE app to check stats via console</a> </li> - <li > - <a href="../eddystone/">BLE Eddystone</a> + + + <li ><a href="../bleprph/bleprph-intro/">BLE peripheral project</a> + + </li> @@ -536,7 +534,7 @@ - <li>» <a href="../arduino_zero/">Project Blinky</a></li> + <li>» <a href="../blinky/">Project Blinky</a></li> @@ -716,7 +714,7 @@ $ newt -v load stmf3_blinky <p><br></p> <h3 id="want-more">Want more?</h3> <p>Want to make your board do something a little more exciting with the LEDs? Then try making the modifications to the Blinky app to make it a <a href="../pin-wheel-mods/">pin-wheel app</a> and you can light all the LEDs in a pin-wheel fashion.</p> -<p>We have more fun tutorials for you to get your hands dirty. Be bold and try other Blinky-like <a href="../nRF52/">tutorials</a> or try enabling additional functionality such as <a href="../project-target-slinky/">remote comms</a> on the current board.</p> +<p>We have more fun tutorials for you to get your hands dirty. Be bold and try other Blinky-like <a href="../nRF52/">tutorials</a> or try enabling additional functionality such as <a href="../project-slinky/">remote comms</a> on the current board.</p> <p>If you see anything missing or want to send us feedback, please do so by signing up for appropriate mailing lists on our <a href="../../../community/">Community Page</a>.</p> <p>Keep on hacking and blinking!</p> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/40899401/latest/os/tutorials/add_newtmgr/index.html ---------------------------------------------------------------------- diff --git a/latest/os/tutorials/add_newtmgr/index.html b/latest/os/tutorials/add_newtmgr/index.html index 9cb1a53..e3f9ce1 100644 --- a/latest/os/tutorials/add_newtmgr/index.html +++ b/latest/os/tutorials/add_newtmgr/index.html @@ -232,9 +232,7 @@ - <li><a href=" - ../arduino_zero/ -">Project Blinky</a> + <li ><a href="../blinky/">Project Blinky</a> </li> @@ -254,8 +252,11 @@ - <li > - <a href="../tasks_lesson/">Tasks and Priority Management</a> + + + <li ><a href="../project-slinky/">Project Slinky for Remote Comms</a> + + </li> @@ -263,7 +264,7 @@ <li > - <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> + <a href="../ibeacon/">BLE iBeacon</a> </li> @@ -271,36 +272,31 @@ <li > - <a href="../unit_test/">Write a Test Suite for a Package</a> + <a href="../eddystone/">BLE Eddystone</a> </li> - <li > - <a href="../event_queue/">Events and Event Queues</a> + <li class="active"> + <a href="./">Enable Newt Manager in any app</a> </li> - - - <li><a href=" - ../project-slinky/ -">Project Slinky for remote comms</a> - - + <li > + <a href="../add_shell/">Enable the OS Shell and Console</a> </li> - <li class="active"> - <a href="./">Enable Newt Manager in any app</a> + <li > + <a href="../tasks_lesson/">Tasks and Priority Management</a> </li> @@ -308,7 +304,7 @@ <li > - <a href="../add_shell/">Enable the OS Shell and Console</a> + <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> @@ -316,18 +312,15 @@ <li > - <a href="../bletiny_project/">BLE app to check stats via console</a> + <a href="../unit_test/">Write a Test Suite for a Package</a> </li> - - - <li ><a href="../bleprph/bleprph-intro/">BLE peripheral project</a> - - + <li > + <a href="../event_queue/">Events and Event Queues</a> </li> @@ -335,15 +328,18 @@ <li > - <a href="../ibeacon/">BLE iBeacon</a> + <a href="../bletiny_project/">BLE app to check stats via console</a> </li> - <li > - <a href="../eddystone/">BLE Eddystone</a> + + + <li ><a href="../bleprph/bleprph-intro/">BLE peripheral project</a> + + </li> @@ -696,9 +692,9 @@ your device has limited flash memory and cannot support Over-The-Air (OTA) firmw <ul class="nav nav-pills" style="margin-bottom: 10px"> <li> - <a href=../project-stm32-slinky/> + <a href=../eddystone/> <span class="fa fa-arrow-left"></span> - Previous: Slinky on STM32 board + Previous: BLE Eddystone </a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/40899401/latest/os/tutorials/add_shell/index.html ---------------------------------------------------------------------- diff --git a/latest/os/tutorials/add_shell/index.html b/latest/os/tutorials/add_shell/index.html index abf9f80..c35de7a 100644 --- a/latest/os/tutorials/add_shell/index.html +++ b/latest/os/tutorials/add_shell/index.html @@ -232,9 +232,7 @@ - <li><a href=" - ../arduino_zero/ -">Project Blinky</a> + <li ><a href="../blinky/">Project Blinky</a> </li> @@ -254,8 +252,11 @@ - <li > - <a href="../tasks_lesson/">Tasks and Priority Management</a> + + + <li ><a href="../project-slinky/">Project Slinky for Remote Comms</a> + + </li> @@ -263,7 +264,7 @@ <li > - <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> + <a href="../ibeacon/">BLE iBeacon</a> </li> @@ -271,7 +272,7 @@ <li > - <a href="../unit_test/">Write a Test Suite for a Package</a> + <a href="../eddystone/">BLE Eddystone</a> </li> @@ -279,20 +280,15 @@ <li > - <a href="../event_queue/">Events and Event Queues</a> + <a href="../add_newtmgr/">Enable Newt Manager in any app</a> </li> - - - <li><a href=" - ../project-slinky/ -">Project Slinky for remote comms</a> - - + <li class="active"> + <a href="./">Enable the OS Shell and Console</a> </li> @@ -300,15 +296,15 @@ <li > - <a href="../add_newtmgr/">Enable Newt Manager in any app</a> + <a href="../tasks_lesson/">Tasks and Priority Management</a> </li> - <li class="active"> - <a href="./">Enable the OS Shell and Console</a> + <li > + <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> @@ -316,18 +312,15 @@ <li > - <a href="../bletiny_project/">BLE app to check stats via console</a> + <a href="../unit_test/">Write a Test Suite for a Package</a> </li> - - - <li ><a href="../bleprph/bleprph-intro/">BLE peripheral project</a> - - + <li > + <a href="../event_queue/">Events and Event Queues</a> </li> @@ -335,15 +328,18 @@ <li > - <a href="../ibeacon/">BLE iBeacon</a> + <a href="../bletiny_project/">BLE app to check stats via console</a> </li> - <li > - <a href="../eddystone/">BLE Eddystone</a> + + + <li ><a href="../bleprph/bleprph-intro/">BLE peripheral project</a> + + </li> @@ -602,8 +598,8 @@ prompt on </li> <li class="pull-right"> - <a href=../bletiny_project/> - Next: BLE app to check stats via console + <a href=../tasks_lesson/> + Next: Tasks and Priority Management <span class="fa fa-arrow-right"></span> </a> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/40899401/latest/os/tutorials/air_quality_ble/index.html ---------------------------------------------------------------------- diff --git a/latest/os/tutorials/air_quality_ble/index.html b/latest/os/tutorials/air_quality_ble/index.html index 07bb912..0beea21 100644 --- a/latest/os/tutorials/air_quality_ble/index.html +++ b/latest/os/tutorials/air_quality_ble/index.html @@ -232,9 +232,7 @@ - <li><a href=" - ../arduino_zero/ -">Project Blinky</a> + <li ><a href="../blinky/">Project Blinky</a> </li> @@ -254,8 +252,11 @@ - <li > - <a href="../tasks_lesson/">Tasks and Priority Management</a> + + + <li ><a href="../project-slinky/">Project Slinky for Remote Comms</a> + + </li> @@ -263,7 +264,7 @@ <li > - <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> + <a href="../ibeacon/">BLE iBeacon</a> </li> @@ -271,7 +272,7 @@ <li > - <a href="../unit_test/">Write a Test Suite for a Package</a> + <a href="../eddystone/">BLE Eddystone</a> </li> @@ -279,20 +280,15 @@ <li > - <a href="../event_queue/">Events and Event Queues</a> + <a href="../add_newtmgr/">Enable Newt Manager in any app</a> </li> - - - <li><a href=" - ../project-slinky/ -">Project Slinky for remote comms</a> - - + <li > + <a href="../add_shell/">Enable the OS Shell and Console</a> </li> @@ -300,7 +296,7 @@ <li > - <a href="../add_newtmgr/">Enable Newt Manager in any app</a> + <a href="../tasks_lesson/">Tasks and Priority Management</a> </li> @@ -308,7 +304,7 @@ <li > - <a href="../add_shell/">Enable the OS Shell and Console</a> + <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> @@ -316,18 +312,15 @@ <li > - <a href="../bletiny_project/">BLE app to check stats via console</a> + <a href="../unit_test/">Write a Test Suite for a Package</a> </li> - - - <li ><a href="../bleprph/bleprph-intro/">BLE peripheral project</a> - - + <li > + <a href="../event_queue/">Events and Event Queues</a> </li> @@ -335,15 +328,18 @@ <li > - <a href="../ibeacon/">BLE iBeacon</a> + <a href="../bletiny_project/">BLE app to check stats via console</a> </li> - <li > - <a href="../eddystone/">BLE Eddystone</a> + + + <li ><a href="../bleprph/bleprph-intro/">BLE peripheral project</a> + + </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/40899401/latest/os/tutorials/air_quality_sensor/index.html ---------------------------------------------------------------------- diff --git a/latest/os/tutorials/air_quality_sensor/index.html b/latest/os/tutorials/air_quality_sensor/index.html index d632a96..d0cd4f2 100644 --- a/latest/os/tutorials/air_quality_sensor/index.html +++ b/latest/os/tutorials/air_quality_sensor/index.html @@ -232,9 +232,7 @@ - <li><a href=" - ../arduino_zero/ -">Project Blinky</a> + <li ><a href="../blinky/">Project Blinky</a> </li> @@ -254,8 +252,11 @@ - <li > - <a href="../tasks_lesson/">Tasks and Priority Management</a> + + + <li ><a href="../project-slinky/">Project Slinky for Remote Comms</a> + + </li> @@ -263,7 +264,7 @@ <li > - <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> + <a href="../ibeacon/">BLE iBeacon</a> </li> @@ -271,7 +272,7 @@ <li > - <a href="../unit_test/">Write a Test Suite for a Package</a> + <a href="../eddystone/">BLE Eddystone</a> </li> @@ -279,20 +280,15 @@ <li > - <a href="../event_queue/">Events and Event Queues</a> + <a href="../add_newtmgr/">Enable Newt Manager in any app</a> </li> - - - <li><a href=" - ../project-slinky/ -">Project Slinky for remote comms</a> - - + <li > + <a href="../add_shell/">Enable the OS Shell and Console</a> </li> @@ -300,7 +296,7 @@ <li > - <a href="../add_newtmgr/">Enable Newt Manager in any app</a> + <a href="../tasks_lesson/">Tasks and Priority Management</a> </li> @@ -308,7 +304,7 @@ <li > - <a href="../add_shell/">Enable the OS Shell and Console</a> + <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> @@ -316,18 +312,15 @@ <li > - <a href="../bletiny_project/">BLE app to check stats via console</a> + <a href="../unit_test/">Write a Test Suite for a Package</a> </li> - - - <li ><a href="../bleprph/bleprph-intro/">BLE peripheral project</a> - - + <li > + <a href="../event_queue/">Events and Event Queues</a> </li> @@ -335,15 +328,18 @@ <li > - <a href="../ibeacon/">BLE iBeacon</a> + <a href="../bletiny_project/">BLE app to check stats via console</a> </li> - <li > - <a href="../eddystone/">BLE Eddystone</a> + + + <li ><a href="../bleprph/bleprph-intro/">BLE peripheral project</a> + + </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/40899401/latest/os/tutorials/arduino_zero/index.html ---------------------------------------------------------------------- diff --git a/latest/os/tutorials/arduino_zero/index.html b/latest/os/tutorials/arduino_zero/index.html index c9c8e2d..5943b12 100644 --- a/latest/os/tutorials/arduino_zero/index.html +++ b/latest/os/tutorials/arduino_zero/index.html @@ -232,14 +232,14 @@ - <li><a href=" - ./ -">Project Blinky</a> + <li ><a href="../blinky/">Project Blinky</a> <ul> + + <li class="active"> <a href="./">Blinky on Arduino Zero</a> @@ -317,8 +317,11 @@ - <li > - <a href="../tasks_lesson/">Tasks and Priority Management</a> + + + <li ><a href="../project-slinky/">Project Slinky for Remote Comms</a> + + </li> @@ -326,7 +329,7 @@ <li > - <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> + <a href="../ibeacon/">BLE iBeacon</a> </li> @@ -334,7 +337,7 @@ <li > - <a href="../unit_test/">Write a Test Suite for a Package</a> + <a href="../eddystone/">BLE Eddystone</a> </li> @@ -342,20 +345,15 @@ <li > - <a href="../event_queue/">Events and Event Queues</a> + <a href="../add_newtmgr/">Enable Newt Manager in any app</a> </li> - - - <li><a href=" - ../project-slinky/ -">Project Slinky for remote comms</a> - - + <li > + <a href="../add_shell/">Enable the OS Shell and Console</a> </li> @@ -363,7 +361,7 @@ <li > - <a href="../add_newtmgr/">Enable Newt Manager in any app</a> + <a href="../tasks_lesson/">Tasks and Priority Management</a> </li> @@ -371,7 +369,7 @@ <li > - <a href="../add_shell/">Enable the OS Shell and Console</a> + <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> @@ -379,18 +377,15 @@ <li > - <a href="../bletiny_project/">BLE app to check stats via console</a> + <a href="../unit_test/">Write a Test Suite for a Package</a> </li> - - - <li ><a href="../bleprph/bleprph-intro/">BLE peripheral project</a> - - + <li > + <a href="../event_queue/">Events and Event Queues</a> </li> @@ -398,15 +393,18 @@ <li > - <a href="../ibeacon/">BLE iBeacon</a> + <a href="../bletiny_project/">BLE app to check stats via console</a> </li> - <li > - <a href="../eddystone/">BLE Eddystone</a> + + + <li ><a href="../bleprph/bleprph-intro/">BLE peripheral project</a> + + </li> @@ -526,7 +524,7 @@ - <li>» Project Blinky</li> + <li>» <a href="../blinky/">Project Blinky</a></li> @@ -539,19 +537,12 @@ </div> <h2 id="blinky-your-hello-world-on-arduino-zero">Blinky, your "Hello World!", on Arduino Zero</h2> -<p>Learn how to use packages from a default application repository of Mynewt to build your first <em>Hello World</em> application (Blinky) on a target board. Once built using the <em>newt</em> tool, this application will blink the LED lights on the target board.</p> -<p>This tutorial describes how to run Mynewt OS on Arduino Zero. Follow these simple steps and your board will be blinking in no time!</p> +<p>This tutorial shows you how to create, build and run the Blinky application on an Arduino Zero board.</p> <h3 id="prerequisites">Prerequisites</h3> -<p>Ensure that you have met the following prerequisites before continuing with this tutorial:</p> <ul> +<li>Meet the prerequisites listed in <a href="../blinky/">Project Blinky</a>.</li> <li>Have an Arduino Zero board.<br /> Note: There are many flavors of Arduino. Make sure you are using an Arduino Zero. See below for the versions of Arduino Zero that are compatible with this tutorial.</li> -<li>Have Internet connectivity to fetch remote Mynewt components.</li> -<li>Have a computer to build a Mynewt application and connect to the board over USB.</li> -<li>Have a Micro-USB cable to connect the board and the computer.</li> -<li>Install the Newt tool and toolchains (See <a href="../../get_started/get_started/">Basic Setup</a>).</li> -<li>Create a project space (directory structure) and populated it with the core code repository (apache-mynewt-core) or know how to as explained in <a href="../../../os/get_started/project_create">Creating Your First Project</a>.</li> -<li>Read the Mynewt OS <a href="../../get_started/vocabulary/">Concepts</a> section. </li> </ul> <p>This tutorial uses the Arduino Zero Pro board. The tutorial has been tested on the following three Arduino Zero boards - Zero, M0 Pro, and Zero-Pro.</p> <p><img src="https://www.arduino.cc/en/uploads/Main/Zero_Usb_Ports.jpg"; alt="Drawing" style="width: 390px;"/> @@ -848,17 +839,8 @@ Continuing. <p>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 up and run on the Arduino on the next boot! </p> -<p><br></p> -<h3 id="watch-the-led-blink">Watch the LED Blink</h3> -<p>Congratulations! You have created an Mynewt application running on the -Arduino Zero. The LED right next to the power LED should be blinking. It is toggled -by one task running on the Mynewt OS. </p> -<p>We have more fun tutorials for you to get your hands dirty. Be bold and try other -Blinky-like <a href="../nRF52/">tutorials</a> or try enabling additional functionality -such as <a href="../project-target-slinky/">remote comms</a> on the current board.</p> -<p>If you see anything missing or want to send us feedback, please do so by signing up for -appropriate mailing lists on our <a href="../../../community/">Community Page</a>.</p> -<p>Keep on hacking and blinking!</p> +<p><br> +You should see the LED blink!</p> <div class="row"> @@ -868,9 +850,9 @@ appropriate mailing lists on our <a href="../../../community/">Community Page</a <ul class="nav nav-pills" style="margin-bottom: 10px"> <li> - <a href=../tutorials/> + <a href=../blinky/> <span class="fa fa-arrow-left"></span> - Previous: Tutorials + Previous: Project Blinky </a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/40899401/latest/os/tutorials/blehci_project/index.html ---------------------------------------------------------------------- diff --git a/latest/os/tutorials/blehci_project/index.html b/latest/os/tutorials/blehci_project/index.html index 9cac008..5b5347c 100644 --- a/latest/os/tutorials/blehci_project/index.html +++ b/latest/os/tutorials/blehci_project/index.html @@ -232,9 +232,7 @@ - <li><a href=" - ../arduino_zero/ -">Project Blinky</a> + <li ><a href="../blinky/">Project Blinky</a> </li> @@ -254,8 +252,11 @@ - <li > - <a href="../tasks_lesson/">Tasks and Priority Management</a> + + + <li ><a href="../project-slinky/">Project Slinky for Remote Comms</a> + + </li> @@ -263,7 +264,7 @@ <li > - <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> + <a href="../ibeacon/">BLE iBeacon</a> </li> @@ -271,7 +272,7 @@ <li > - <a href="../unit_test/">Write a Test Suite for a Package</a> + <a href="../eddystone/">BLE Eddystone</a> </li> @@ -279,20 +280,15 @@ <li > - <a href="../event_queue/">Events and Event Queues</a> + <a href="../add_newtmgr/">Enable Newt Manager in any app</a> </li> - - - <li><a href=" - ../project-slinky/ -">Project Slinky for remote comms</a> - - + <li > + <a href="../add_shell/">Enable the OS Shell and Console</a> </li> @@ -300,7 +296,7 @@ <li > - <a href="../add_newtmgr/">Enable Newt Manager in any app</a> + <a href="../tasks_lesson/">Tasks and Priority Management</a> </li> @@ -308,7 +304,7 @@ <li > - <a href="../add_shell/">Enable the OS Shell and Console</a> + <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> @@ -316,18 +312,15 @@ <li > - <a href="../bletiny_project/">BLE app to check stats via console</a> + <a href="../unit_test/">Write a Test Suite for a Package</a> </li> - - - <li ><a href="../bleprph/bleprph-intro/">BLE peripheral project</a> - - + <li > + <a href="../event_queue/">Events and Event Queues</a> </li> @@ -335,15 +328,18 @@ <li > - <a href="../ibeacon/">BLE iBeacon</a> + <a href="../bletiny_project/">BLE app to check stats via console</a> </li> - <li > - <a href="../eddystone/">BLE Eddystone</a> + + + <li ><a href="../bleprph/bleprph-intro/">BLE peripheral project</a> + + </li> @@ -493,18 +489,15 @@ support native compiling to build the project this tutorial creates. </li> </ul> <p><br></p> <h3 id="create-a-project">Create a project</h3> -<p>Use the Newt tool to create a new project directory containing a skeletal Mynewt framework. Change into the newly created directory. Make sure the downloaded version is 0.9.0 or later.</p> +<p>Use the Newt tool to create a new project directory containing a skeletal Mynewt framework. Change into the newly created directory. </p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt new blehciproj Downloading project skeleton from apache/incubator-mynewt-blinky... Installing skeleton in blehciproj ... Project blehciproj successfully created. $ cd mblehciproj -$ newt install -v +$ newt install apache-mynewt-core -Downloading repository description for apache-mynewt-core... success! -... -apache-mynewt-core successfully installed version 0.9.0-none </pre></div> @@ -548,13 +541,14 @@ $ newt target set myble2 build_profile=optimized <p>Then build the two targets.</p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt build nrf52_boot <snip> -App successfully built: ./bin/nrf52_boot/apps/boot/boot.elf +Linking ~/dev/blehciproj/bin/targets/nrf52_boot/app/apps/boot/boot.elf +Target successfully built: targets/nrf52_boot + $ newt build myble2 -Compiling hci_common.c -Compiling util.c -Archiving nimble.a -Compiling os.c <snip> +Linking ~/dev/blehciproj/bin/targets/myble2/app/apps/blehci/blehci.elf +Target successfully built: targets/myble2 +$ </pre></div> @@ -562,15 +556,25 @@ Compiling os.c <h3 id="create-the-app-image">Create the app image</h3> <p>Generate a signed application image for the <code>myble2</code> target. The version number is arbitrary.</p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt create-image myble2 1.0.0 -App image succesfully generated: ./bin/makerbeacon/apps/bletiny/bletiny.img -Build manifest: ./bin/makerbeacon/apps/bletiny/manifest.json +App image succesfully generated: ~/dev/blehciproj/bin/targets/myble2/app/apps/bletiny/bletiny.img </pre></div> <p><br></p> -<h3 id="load-the-image">Load the image</h3> +<h3 id="load-the-bootloader-and-the-application-image">Load the bootloader and the application image</h3> <p>Make sure the USB connector is in place and the power LED on the board is lit. Use the Power ON/OFF switch to reset the board after loading the image.</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt -v load myble +<p>Load the bootloader:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt load nrf52_boot +Loading bootloader +$ +</pre></div> + + +<p><br> +Load the application image:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt load myble2 +Loading app image into slot 1 +$ </pre></div> @@ -635,9 +639,9 @@ eir_len 23 <ul class="nav nav-pills" style="margin-bottom: 10px"> <li> - <a href=../eddystone/> + <a href=../bleprph/bleprph-app/> <span class="fa fa-arrow-left"></span> - Previous: BLE Eddystone + Previous: BLE Peripheral App </a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/40899401/latest/os/tutorials/bleprph/bleprph-adv/index.html ---------------------------------------------------------------------- diff --git a/latest/os/tutorials/bleprph/bleprph-adv/index.html b/latest/os/tutorials/bleprph/bleprph-adv/index.html index e50a352..b0f4dba 100644 --- a/latest/os/tutorials/bleprph/bleprph-adv/index.html +++ b/latest/os/tutorials/bleprph/bleprph-adv/index.html @@ -232,9 +232,7 @@ - <li><a href=" - ../../arduino_zero/ -">Project Blinky</a> + <li ><a href="../../blinky/">Project Blinky</a> </li> @@ -254,8 +252,19 @@ + + + <li ><a href="../../project-slinky/">Project Slinky for Remote Comms</a> + + + </li> + + + + + <li > - <a href="../../tasks_lesson/">Tasks and Priority Management</a> + <a href="../../ibeacon/">BLE iBeacon</a> </li> @@ -263,7 +272,7 @@ <li > - <a href="../../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> + <a href="../../eddystone/">BLE Eddystone</a> </li> @@ -271,7 +280,7 @@ <li > - <a href="../../unit_test/">Write a Test Suite for a Package</a> + <a href="../../add_newtmgr/">Enable Newt Manager in any app</a> </li> @@ -279,20 +288,15 @@ <li > - <a href="../../event_queue/">Events and Event Queues</a> + <a href="../../add_shell/">Enable the OS Shell and Console</a> </li> - - - <li><a href=" - ../../project-slinky/ -">Project Slinky for remote comms</a> - - + <li > + <a href="../../tasks_lesson/">Tasks and Priority Management</a> </li> @@ -300,7 +304,7 @@ <li > - <a href="../../add_newtmgr/">Enable Newt Manager in any app</a> + <a href="../../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> @@ -308,7 +312,15 @@ <li > - <a href="../../add_shell/">Enable the OS Shell and Console</a> + <a href="../../unit_test/">Write a Test Suite for a Package</a> + </li> + + + + + + <li > + <a href="../../event_queue/">Events and Event Queues</a> </li> @@ -381,22 +393,6 @@ <li > - <a href="../../ibeacon/">BLE iBeacon</a> - </li> - - - - - - <li > - <a href="../../eddystone/">BLE Eddystone</a> - </li> - - - - - - <li > <a href="../../blehci_project/">BLE HCI interface</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/40899401/latest/os/tutorials/bleprph/bleprph-app/index.html ---------------------------------------------------------------------- diff --git a/latest/os/tutorials/bleprph/bleprph-app/index.html b/latest/os/tutorials/bleprph/bleprph-app/index.html index d717455..c8b58dc 100644 --- a/latest/os/tutorials/bleprph/bleprph-app/index.html +++ b/latest/os/tutorials/bleprph/bleprph-app/index.html @@ -232,9 +232,7 @@ - <li><a href=" - ../../arduino_zero/ -">Project Blinky</a> + <li ><a href="../../blinky/">Project Blinky</a> </li> @@ -254,8 +252,19 @@ + + + <li ><a href="../../project-slinky/">Project Slinky for Remote Comms</a> + + + </li> + + + + + <li > - <a href="../../tasks_lesson/">Tasks and Priority Management</a> + <a href="../../ibeacon/">BLE iBeacon</a> </li> @@ -263,7 +272,7 @@ <li > - <a href="../../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> + <a href="../../eddystone/">BLE Eddystone</a> </li> @@ -271,7 +280,7 @@ <li > - <a href="../../unit_test/">Write a Test Suite for a Package</a> + <a href="../../add_newtmgr/">Enable Newt Manager in any app</a> </li> @@ -279,20 +288,15 @@ <li > - <a href="../../event_queue/">Events and Event Queues</a> + <a href="../../add_shell/">Enable the OS Shell and Console</a> </li> - - - <li><a href=" - ../../project-slinky/ -">Project Slinky for remote comms</a> - - + <li > + <a href="../../tasks_lesson/">Tasks and Priority Management</a> </li> @@ -300,7 +304,7 @@ <li > - <a href="../../add_newtmgr/">Enable Newt Manager in any app</a> + <a href="../../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> @@ -308,7 +312,15 @@ <li > - <a href="../../add_shell/">Enable the OS Shell and Console</a> + <a href="../../unit_test/">Write a Test Suite for a Package</a> + </li> + + + + + + <li > + <a href="../../event_queue/">Events and Event Queues</a> </li> @@ -381,22 +393,6 @@ <li > - <a href="../../ibeacon/">BLE iBeacon</a> - </li> - - - - - - <li > - <a href="../../eddystone/">BLE Eddystone</a> - </li> - - - - - - <li > <a href="../../blehci_project/">BLE HCI interface</a> </li> @@ -610,8 +606,8 @@ happen on the device as well.</p> </li> <li class="pull-right"> - <a href=../../ibeacon/> - Next: BLE iBeacon + <a href=../../blehci_project/> + Next: BLE HCI interface <span class="fa fa-arrow-right"></span> </a> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/40899401/latest/os/tutorials/bleprph/bleprph-chr-access/index.html ---------------------------------------------------------------------- diff --git a/latest/os/tutorials/bleprph/bleprph-chr-access/index.html b/latest/os/tutorials/bleprph/bleprph-chr-access/index.html index 182ed12..0c39d5b 100644 --- a/latest/os/tutorials/bleprph/bleprph-chr-access/index.html +++ b/latest/os/tutorials/bleprph/bleprph-chr-access/index.html @@ -232,9 +232,7 @@ - <li><a href=" - ../../arduino_zero/ -">Project Blinky</a> + <li ><a href="../../blinky/">Project Blinky</a> </li> @@ -254,8 +252,19 @@ + + + <li ><a href="../../project-slinky/">Project Slinky for Remote Comms</a> + + + </li> + + + + + <li > - <a href="../../tasks_lesson/">Tasks and Priority Management</a> + <a href="../../ibeacon/">BLE iBeacon</a> </li> @@ -263,7 +272,7 @@ <li > - <a href="../../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> + <a href="../../eddystone/">BLE Eddystone</a> </li> @@ -271,7 +280,7 @@ <li > - <a href="../../unit_test/">Write a Test Suite for a Package</a> + <a href="../../add_newtmgr/">Enable Newt Manager in any app</a> </li> @@ -279,20 +288,15 @@ <li > - <a href="../../event_queue/">Events and Event Queues</a> + <a href="../../add_shell/">Enable the OS Shell and Console</a> </li> - - - <li><a href=" - ../../project-slinky/ -">Project Slinky for remote comms</a> - - + <li > + <a href="../../tasks_lesson/">Tasks and Priority Management</a> </li> @@ -300,7 +304,7 @@ <li > - <a href="../../add_newtmgr/">Enable Newt Manager in any app</a> + <a href="../../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> @@ -308,7 +312,15 @@ <li > - <a href="../../add_shell/">Enable the OS Shell and Console</a> + <a href="../../unit_test/">Write a Test Suite for a Package</a> + </li> + + + + + + <li > + <a href="../../event_queue/">Events and Event Queues</a> </li> @@ -381,22 +393,6 @@ <li > - <a href="../../ibeacon/">BLE iBeacon</a> - </li> - - - - - - <li > - <a href="../../eddystone/">BLE Eddystone</a> - </li> - - - - - - <li > <a href="../../blehci_project/">BLE HCI interface</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/40899401/latest/os/tutorials/bleprph/bleprph-gap-event/index.html ---------------------------------------------------------------------- diff --git a/latest/os/tutorials/bleprph/bleprph-gap-event/index.html b/latest/os/tutorials/bleprph/bleprph-gap-event/index.html index 73ede47..2467831 100644 --- a/latest/os/tutorials/bleprph/bleprph-gap-event/index.html +++ b/latest/os/tutorials/bleprph/bleprph-gap-event/index.html @@ -232,9 +232,7 @@ - <li><a href=" - ../../arduino_zero/ -">Project Blinky</a> + <li ><a href="../../blinky/">Project Blinky</a> </li> @@ -254,8 +252,19 @@ + + + <li ><a href="../../project-slinky/">Project Slinky for Remote Comms</a> + + + </li> + + + + + <li > - <a href="../../tasks_lesson/">Tasks and Priority Management</a> + <a href="../../ibeacon/">BLE iBeacon</a> </li> @@ -263,7 +272,7 @@ <li > - <a href="../../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> + <a href="../../eddystone/">BLE Eddystone</a> </li> @@ -271,7 +280,7 @@ <li > - <a href="../../unit_test/">Write a Test Suite for a Package</a> + <a href="../../add_newtmgr/">Enable Newt Manager in any app</a> </li> @@ -279,20 +288,15 @@ <li > - <a href="../../event_queue/">Events and Event Queues</a> + <a href="../../add_shell/">Enable the OS Shell and Console</a> </li> - - - <li><a href=" - ../../project-slinky/ -">Project Slinky for remote comms</a> - - + <li > + <a href="../../tasks_lesson/">Tasks and Priority Management</a> </li> @@ -300,7 +304,7 @@ <li > - <a href="../../add_newtmgr/">Enable Newt Manager in any app</a> + <a href="../../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> @@ -308,7 +312,15 @@ <li > - <a href="../../add_shell/">Enable the OS Shell and Console</a> + <a href="../../unit_test/">Write a Test Suite for a Package</a> + </li> + + + + + + <li > + <a href="../../event_queue/">Events and Event Queues</a> </li> @@ -381,22 +393,6 @@ <li > - <a href="../../ibeacon/">BLE iBeacon</a> - </li> - - - - - - <li > - <a href="../../eddystone/">BLE Eddystone</a> - </li> - - - - - - <li > <a href="../../blehci_project/">BLE HCI interface</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/40899401/latest/os/tutorials/bleprph/bleprph-intro/index.html ---------------------------------------------------------------------- diff --git a/latest/os/tutorials/bleprph/bleprph-intro/index.html b/latest/os/tutorials/bleprph/bleprph-intro/index.html index ce4053c..28261e2 100644 --- a/latest/os/tutorials/bleprph/bleprph-intro/index.html +++ b/latest/os/tutorials/bleprph/bleprph-intro/index.html @@ -232,9 +232,7 @@ - <li><a href=" - ../../arduino_zero/ -">Project Blinky</a> + <li ><a href="../../blinky/">Project Blinky</a> </li> @@ -254,8 +252,19 @@ + + + <li ><a href="../../project-slinky/">Project Slinky for Remote Comms</a> + + + </li> + + + + + <li > - <a href="../../tasks_lesson/">Tasks and Priority Management</a> + <a href="../../ibeacon/">BLE iBeacon</a> </li> @@ -263,7 +272,7 @@ <li > - <a href="../../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> + <a href="../../eddystone/">BLE Eddystone</a> </li> @@ -271,7 +280,7 @@ <li > - <a href="../../unit_test/">Write a Test Suite for a Package</a> + <a href="../../add_newtmgr/">Enable Newt Manager in any app</a> </li> @@ -279,20 +288,15 @@ <li > - <a href="../../event_queue/">Events and Event Queues</a> + <a href="../../add_shell/">Enable the OS Shell and Console</a> </li> - - - <li><a href=" - ../../project-slinky/ -">Project Slinky for remote comms</a> - - + <li > + <a href="../../tasks_lesson/">Tasks and Priority Management</a> </li> @@ -300,7 +304,7 @@ <li > - <a href="../../add_newtmgr/">Enable Newt Manager in any app</a> + <a href="../../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> @@ -308,7 +312,15 @@ <li > - <a href="../../add_shell/">Enable the OS Shell and Console</a> + <a href="../../unit_test/">Write a Test Suite for a Package</a> + </li> + + + + + + <li > + <a href="../../event_queue/">Events and Event Queues</a> </li> @@ -381,22 +393,6 @@ <li > - <a href="../../ibeacon/">BLE iBeacon</a> - </li> - - - - - - <li > - <a href="../../eddystone/">BLE Eddystone</a> - </li> - - - - - - <li > <a href="../../blehci_project/">BLE HCI interface</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/40899401/latest/os/tutorials/bleprph/bleprph-svc-reg/index.html ---------------------------------------------------------------------- diff --git a/latest/os/tutorials/bleprph/bleprph-svc-reg/index.html b/latest/os/tutorials/bleprph/bleprph-svc-reg/index.html index 0cbd8a3..485a50d 100644 --- a/latest/os/tutorials/bleprph/bleprph-svc-reg/index.html +++ b/latest/os/tutorials/bleprph/bleprph-svc-reg/index.html @@ -232,9 +232,7 @@ - <li><a href=" - ../../arduino_zero/ -">Project Blinky</a> + <li ><a href="../../blinky/">Project Blinky</a> </li> @@ -254,8 +252,19 @@ + + + <li ><a href="../../project-slinky/">Project Slinky for Remote Comms</a> + + + </li> + + + + + <li > - <a href="../../tasks_lesson/">Tasks and Priority Management</a> + <a href="../../ibeacon/">BLE iBeacon</a> </li> @@ -263,7 +272,7 @@ <li > - <a href="../../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> + <a href="../../eddystone/">BLE Eddystone</a> </li> @@ -271,7 +280,7 @@ <li > - <a href="../../unit_test/">Write a Test Suite for a Package</a> + <a href="../../add_newtmgr/">Enable Newt Manager in any app</a> </li> @@ -279,20 +288,15 @@ <li > - <a href="../../event_queue/">Events and Event Queues</a> + <a href="../../add_shell/">Enable the OS Shell and Console</a> </li> - - - <li><a href=" - ../../project-slinky/ -">Project Slinky for remote comms</a> - - + <li > + <a href="../../tasks_lesson/">Tasks and Priority Management</a> </li> @@ -300,7 +304,7 @@ <li > - <a href="../../add_newtmgr/">Enable Newt Manager in any app</a> + <a href="../../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> @@ -308,7 +312,15 @@ <li > - <a href="../../add_shell/">Enable the OS Shell and Console</a> + <a href="../../unit_test/">Write a Test Suite for a Package</a> + </li> + + + + + + <li > + <a href="../../event_queue/">Events and Event Queues</a> </li> @@ -381,22 +393,6 @@ <li > - <a href="../../ibeacon/">BLE iBeacon</a> - </li> - - - - - - <li > - <a href="../../eddystone/">BLE Eddystone</a> - </li> - - - - - - <li > <a href="../../blehci_project/">BLE HCI interface</a> </li>
![https://www.arduino.cc/en/uploads/Main/Zero_Usb_Ports.jpg"](https://www.arduino.cc/en/uploads/Main/Zero_Usb_Ports.jpg"){kind=link}