http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/facfa9ba/develop/os/core_os/time/os_time_ms_to_ticks/index.html ---------------------------------------------------------------------- diff --git a/develop/os/core_os/time/os_time_ms_to_ticks/index.html b/develop/os/core_os/time/os_time_ms_to_ticks/index.html new file mode 100644 index 0000000..64c6df5 --- /dev/null +++ b/develop/os/core_os/time/os_time_ms_to_ticks/index.html @@ -0,0 +1,853 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + + <!-- This is broken by doc revisioning. + <link rel="canonical" href="http://mynewt.apache.org/os/core_os/time/os_time_ms_to_ticks/";> --> + <link rel="shortcut icon" href="../../../../img/favicon.ico"> + + <title>os_time_ms_to_ticks - Apache Mynewt</title> + + <link href="../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> + <link rel="stylesheet" href="../../../../css/highlight.css"> + <link href="../../../../css/base.css" rel="stylesheet"> + <link href="../../../../css/custom.css" rel="stylesheet"> + <link href="../../../../css/v2.css" rel="stylesheet"> + <link href="https://fonts.googleapis.com/css?family=Lato"; rel="stylesheet"> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css";> + <link href="../../../../extra.css" rel="stylesheet"> + + <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js";></script> + <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js";></script> + <![endif]--> + + + <script> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-72162311-1', 'auto'); + ga('send', 'pageview'); + </script> + + </head> + + + <body class="os_time_ms_to_ticks"> + + + <div class="container"> + <div class="row v2-main-banner"> + <a class="logo-cell" href="/"> + <img class="logo" src="/img/logo.png"> + </a> + <div class="tagline-cell"> + <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> + </div> + <div class="news-cell"> + <div class="well"> + <h4>Latest News:</h4> <a href="/download">Apache Mynewt 1.0.0</a> released (March 22, 2017) + </div> + </div> + </div> +</div> + + + + + + + + +<nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" role="navigation"> + <div class="container"> + <!-- Collapsed navigation --> + <div class="navbar-header"> + <!-- Expander button --> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + + </div> + + <!-- Expanded navigation --> + <div class="navbar-collapse collapse"> + <!-- Main navigation --> + <ul class="nav navbar-nav navbar-right"> + <li + class="" +> + <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> + </li> + <li + class="important" +> + <a href="/quick-start/">Quick Start</a> + </li> + <li + class="" +> + <a href="/about/">About</a> + </li> + <li + class="" +> + <a href="/talks/">Talks</a> + </li> + <li + class="active" +> + <a href="/latest/os/introduction">Documentation</a> + </li> + <li + class="" +> + <a href="/download/">Download</a> + </li> + <li + class="" +> + <a href="/community/">Community</a> + </li> + <li + class="" +> + <a href="/events/">Events</a> + </li> + </ul> + + <!-- Search, Navigation and Repo links --> + <ul class="nav navbar-nav navbar-right"> + + </ul> + </div> + </div> +</nav> + + + + <div class="container"> + + <div class="row"> + <div class="col-md-3 v2-sidebar sidebar-container"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="top"> + <div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get"> + <div class="form-group"> + <input type="text" name="q" class="form-control" placeholder="Search documentation" /> + </div> + </form> + </div> + </div> + <ul class="toc-nav"> + <li class="doc-version"> +<select class="form-control" onchange="if (this.value) window.location.href=this.value"> + + <option + value="/develop/os/introduction" + selected="selected" + > + Version: develop (latest) + </option> + + <option + value="/v0_9_0/os/introduction" + + > + Version: 0.9.0 + </option> + +</select> +</li> + + + + + + + + + + + + + + + + + + + + + + <li ><a href="../../../introduction/">Mynewt Documentation</a> + + + <ul> + + + + + + + + <li ><a href="../../../get_started/get_started/">Basic Setup</a> + + + </li> + + + + + + <li > + <a href="../../../get_started/vocabulary/">Concepts</a> + </li> + + + + + + + + <li ><a href="../../../tutorials/tutorials/">Tutorials</a> + + + </li> + + + + + + + + <li ><a href="../../../os_user_guide/">OS User Guide</a> + + + <ul> + + + + + + + + <li ><a href="../../mynewt_os/">OS Core</a> + + + <ul> + + + + + + + + <li><a href=" + ../../os_started/ +">Functions</a> + + + </li> + + + + + + + + <li ><a href="../../context_switch/context_switch/">Scheduler</a> + + + </li> + + + + + + + + <li ><a href="../../cputime/os_cputime/">CPU Time</a> + + + </li> + + + + + + + + <li ><a href="../os_time/">OS Time</a> + + + <ul> + + + + + + + + <li><a href=" + ../os_time_advance/ +">Functions</a> + + + <ul> + + + + <li > + <a href="../os_time_advance/">os_time_advance</a> + </li> + + + + + + <li > + <a href="../os_time_delay/">os_time_delay</a> + </li> + + + + + + <li > + <a href="../os_time_get/">os_time_get</a> + </li> + + + + + + <li class="active"> + <a href="./">os_time_ms_to_ticks</a> + </li> + + + + + + <li > + <a href="../os_get_uptime_usec/">os_get_uptime_usec</a> + </li> + + + + + + <li > + <a href="../os_gettimeofday/">os_gettimeofday</a> + </li> + + + + + + <li > + <a href="../os_settimeofday/">os_settimeofday</a> + </li> + + + + </ul> + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../task/task/">Tasks</a> + + + </li> + + + + + + + + <li ><a href="../../event_queue/event_queue/">Event Queues</a> + + + </li> + + + + + + + + <li ><a href="../../semaphore/semaphore/">Semaphores</a> + + + </li> + + + + + + + + <li ><a href="../../mutex/mutex/">Mutexes</a> + + + </li> + + + + + + + + <li ><a href="../../memory_pool/memory_pool/">Memory Pools</a> + + + </li> + + + + + + + + <li ><a href="../../heap/heap/">Heap</a> + + + </li> + + + + + + + + <li><a href=" + + + ../../mbuf/mbuf/ + +">Memory Buffers</a> + + + </li> + + + + + + + + <li ><a href="../../sanity/sanity/">Sanity</a> + + + </li> + + + + + + + + <li ><a href="../../callout/callout/">Callouts</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../porting/port_os/">Porting to your Platform</a> + + + </li> + + + + + + + + <li ><a href="../../../modules/console/console/">Console</a> + + + </li> + + + + + + + + <li ><a href="../../../modules/shell/shell/">Shell</a> + + + </li> + + + + + + + + <li ><a href="../../../modules/split/split/">Split Images</a> + + + </li> + + + + + + + + <li ><a href="../../../modules/bootloader/bootloader/">Bootloader</a> + + + </li> + + + + + + + + <li><a href=" + + + ../../../modules/fs/fs/fs/ + +">File System</a> + + + </li> + + + + + + + + <li ><a href="../../../modules/hal/hal/">Hardware Abstraction Layer</a> + + + </li> + + + + + + + + <li ><a href="../../../modules/drivers/driver/">Drivers</a> + + + </li> + + + + + + + + <li ><a href="../../../modules/testutil/testutil/">Test Utilities</a> + + + </li> + + + + + + + + <li ><a href="../../../modules/devmgmt/newtmgr/">Device Management with Newt Manager</a> + + + </li> + + + + + + + + <li ><a href="../../../modules/imgmgr/imgmgr/">Image Manager</a> + + + </li> + + + + + + <li > + <a href="../../../modules/baselibc/">Baselibc library</a> + </li> + + + + + + + + <li ><a href="../../../modules/json/json/">JSON</a> + + + </li> + + + + + + + + <li ><a href="../../../modules/fcb/fcb/">Flash Circular Buffer</a> + + + </li> + + + + + + + + <li ><a href="../../../modules/stats/stats/">Stats</a> + + + </li> + + + + + + + + <li ><a href="../../../modules/logs/logs/">Logs</a> + + + </li> + + + + + + + + <li ><a href="../../../modules/sysinitconfig/sysinitconfig/">System Configuration And Initialization</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li><a href=" + ../../../../network/ble/ble_intro/ +">BLE User Guide</a> + + + </li> + + + + + + + + <li ><a href="../../../../newt/newt_intro/">Newt Tool Guide</a> + + + </li> + + + + + + + + <li ><a href="../../../../newtmgr/overview/">Newt Manager Guide</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li><a href=" + ../../../../faq/how_to_edit_docs/ +">Appendix</a> + + + </li> + + + + </ul> +</div></div> + + <div class="col-md-9" role="main"> + <div class="doc-header"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs pull-right"> + <li><a href="/develop/os/introduction">Docs</a></li> + + + + <li>» <a href="../os_time/">OS Time</a></li> + + + + <li>» <a href="../os_time_advance/">Functions</a></li> + + + + <li>» os_time_ms_to_ticks</li> + + + + </ul> +</div> + </div> + + <h2 id="os_time_ms_to_ticks"><font color="F2853F" style="font-size:24pt">os_time_ms_to_ticks</font></h2> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> <span style="color: #000000">os_time_ms_to_ticks</span>(<span style="color: #A90D91">uint32_t</span> <span style="color: #000000">ms</span>, <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">*out_ticks</span>) +</pre></div> + + +<p>Converts milliseconds to OS ticks.</p> +<h4 id="arguments">Arguments</h4> +<table> +<thead> +<tr> +<th>Arguments</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td><code>ms</code></td> +<td>Number of milliseconds to convert to OS ticks.</td> +</tr> +<tr> +<td><code>out_ticks</code></td> +<td>Pointer to an uint32_t to return the number of OS ticks for <code>ms</code> milliseconds.</td> +</tr> +</tbody> +</table> +<p>N/A</p> +<h4 id="returned-values">Returned values</h4> +<p><code>0</code>: Success +<br><code>OS_EINVAL</code>: Number of ticks is too large to fit in an uint32_t.</p> +<p>N/A</p> +<h4 id="notes">Notes</h4> +<h4 id="example">Example</h4> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">unint32_t</span> <span style="color: #000000">num_ticks</span>; +<span style="color: #000000">os_time_ms_to_ticks</span>(<span style="color: #1C01CE">50</span>, <span style="color: #000000">&num_ticks</span>); +</pre></div> + + <div class="row"> + + + + +<ul class="nav nav-pills" style="margin-bottom: 10px"> + <li> + + <a href=../os_time_get/> + <span class="fa fa-arrow-left"></span> + Previous: os_time_get + </a> + + </li> + <li class="pull-right"> + + <a href=../os_get_uptime_usec/> + Next: os_get_uptime_usec + <span class="fa fa-arrow-right"></span> + </a> + + </li> +</ul> + </div> + <footer class="row"> + <div class="col-xs-12"> + + <p class="copyright">Apache Mynewt (incubating) is available under Apache License, version 2.0.</p> + + </div> + <div class="col-xs-12"> + <div class="logos"> + <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> + <small class="footnote"> + MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. + </small> + <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> + </div> + </div> +</footer> + </div> + </div> + + + </div> + + <script src="../../../../js/jquery-1.10.2.min.js"></script> + <script src="../../../../js/bootstrap-3.0.3.min.js"></script> + <script src="../../../../js/highlight.pack.js"></script> + <script src="../../../../js/base.js"></script> + <script src="../../../../js/custom.js"></script> + + </body> +</html> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/facfa9ba/develop/os/core_os/time/os_time_tick/index.html ---------------------------------------------------------------------- diff --git a/develop/os/core_os/time/os_time_tick/index.html b/develop/os/core_os/time/os_time_tick/index.html deleted file mode 100644 index 9503db2..0000000 --- a/develop/os/core_os/time/os_time_tick/index.html +++ /dev/null @@ -1,807 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="utf-8"> - <meta http-equiv="X-UA-Compatible" content="IE=edge"> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - - <!-- This is broken by doc revisioning. - <link rel="canonical" href="http://mynewt.apache.org/os/core_os/time/os_time_tick/";> --> - <link rel="shortcut icon" href="../../../../img/favicon.ico"> - - <title>os_time_tick - Apache Mynewt</title> - - <link href="../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> - <link rel="stylesheet" href="../../../../css/highlight.css"> - <link href="../../../../css/base.css" rel="stylesheet"> - <link href="../../../../css/custom.css" rel="stylesheet"> - <link href="../../../../css/v2.css" rel="stylesheet"> - <link href="https://fonts.googleapis.com/css?family=Lato"; rel="stylesheet"> - <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css";> - <link href="../../../../extra.css" rel="stylesheet"> - - <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> - <!--[if lt IE 9]> - <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js";></script> - <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js";></script> - <![endif]--> - - - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - - ga('create', 'UA-72162311-1', 'auto'); - ga('send', 'pageview'); - </script> - - </head> - - - <body class="os_time_tick"> - - - <div class="container"> - <div class="row v2-main-banner"> - <a class="logo-cell" href="/"> - <img class="logo" src="/img/logo.png"> - </a> - <div class="tagline-cell"> - <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> - </div> - <div class="news-cell"> - <div class="well"> - <h4>Latest News:</h4> <a href="/download">Apache Mynewt 1.0.0</a> released (March 22, 2017) - </div> - </div> - </div> -</div> - - - - - - - - -<nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" role="navigation"> - <div class="container"> - <!-- Collapsed navigation --> - <div class="navbar-header"> - <!-- Expander button --> - <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> - - </div> - - <!-- Expanded navigation --> - <div class="navbar-collapse collapse"> - <!-- Main navigation --> - <ul class="nav navbar-nav navbar-right"> - <li - class="" -> - <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> - </li> - <li - class="important" -> - <a href="/quick-start/">Quick Start</a> - </li> - <li - class="" -> - <a href="/about/">About</a> - </li> - <li - class="" -> - <a href="/talks/">Talks</a> - </li> - <li - class="active" -> - <a href="/latest/os/introduction">Documentation</a> - </li> - <li - class="" -> - <a href="/download/">Download</a> - </li> - <li - class="" -> - <a href="/community/">Community</a> - </li> - <li - class="" -> - <a href="/events/">Events</a> - </li> - </ul> - - <!-- Search, Navigation and Repo links --> - <ul class="nav navbar-nav navbar-right"> - - </ul> - </div> - </div> -</nav> - - - - <div class="container"> - - <div class="row"> - <div class="col-md-3 v2-sidebar sidebar-container"><div id="docSidebar" class="hidden-print" role="complementary"> - <div class="top"> - <div role="search"> - <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get"> - <div class="form-group"> - <input type="text" name="q" class="form-control" placeholder="Search documentation" /> - </div> - </form> - </div> - </div> - <ul class="toc-nav"> - <li class="doc-version"> -<select class="form-control" onchange="if (this.value) window.location.href=this.value"> - - <option - value="/develop/os/introduction" - selected="selected" - > - Version: develop (latest) - </option> - - <option - value="/v0_9_0/os/introduction" - - > - Version: 0.9.0 - </option> - -</select> -</li> - - - - - - - - - - - - - - - - - - - - - - <li ><a href="../../../introduction/">Mynewt Documentation</a> - - - <ul> - - - - - - - - <li ><a href="../../../get_started/get_started/">Basic Setup</a> - - - </li> - - - - - - <li > - <a href="../../../get_started/vocabulary/">Concepts</a> - </li> - - - - - - - - <li ><a href="../../../tutorials/tutorials/">Tutorials</a> - - - </li> - - - - - - - - <li ><a href="../../../os_user_guide/">OS User Guide</a> - - - <ul> - - - - - - - - <li ><a href="../../mynewt_os/">OS Core</a> - - - <ul> - - - - - - - - <li><a href=" - ../../os_started/ -">Functions</a> - - - </li> - - - - - - - - <li ><a href="../../context_switch/context_switch/">Scheduler</a> - - - </li> - - - - - - - - <li ><a href="../os_time/">Time</a> - - - <ul> - - - - - - - - <li><a href=" - ../os_time_delay/ -">Functions</a> - - - <ul> - - - - <li > - <a href="../os_time_delay/">os_time_delay</a> - </li> - - - - - - <li > - <a href="../os_time_get/">os_time_get</a> - </li> - - - - - - <li class="active"> - <a href="./">os_time_tick</a> - </li> - - - - - - <li > - <a href="../os_gettimeofday/">os_gettimeofday</a> - </li> - - - - - - <li > - <a href="../os_settimeofday/">os_settimeofday</a> - </li> - - - - </ul> - - </li> - - - - </ul> - - </li> - - - - - - - - <li ><a href="../../task/task/">Tasks</a> - - - </li> - - - - - - - - <li ><a href="../../event_queue/event_queue/">Event Queues</a> - - - </li> - - - - - - - - <li ><a href="../../semaphore/semaphore/">Semaphores</a> - - - </li> - - - - - - - - <li ><a href="../../mutex/mutex/">Mutexes</a> - - - </li> - - - - - - - - <li ><a href="../../memory_pool/memory_pool/">Memory Pools</a> - - - </li> - - - - - - - - <li ><a href="../../heap/heap/">Heap</a> - - - </li> - - - - - - - - <li><a href=" - - - ../../mbuf/mbuf/ - -">Memory Buffers</a> - - - </li> - - - - - - - - <li ><a href="../../sanity/sanity/">Sanity</a> - - - </li> - - - - - - - - <li ><a href="../../callout/callout/">Callouts</a> - - - </li> - - - - </ul> - - </li> - - - - - - - - <li ><a href="../../porting/port_os/">Porting to your Platform</a> - - - </li> - - - - - - - - <li ><a href="../../../modules/console/console/">Console</a> - - - </li> - - - - - - - - <li ><a href="../../../modules/shell/shell/">Shell</a> - - - </li> - - - - - - - - <li ><a href="../../../modules/split/split/">Split Images</a> - - - </li> - - - - - - - - <li ><a href="../../../modules/bootloader/bootloader/">Bootloader</a> - - - </li> - - - - - - - - <li><a href=" - - - ../../../modules/fs/fs/fs/ - -">File System</a> - - - </li> - - - - - - - - <li ><a href="../../../modules/hal/hal/">Hardware Abstraction Layer</a> - - - </li> - - - - - - - - <li ><a href="../../../modules/drivers/driver/">Drivers</a> - - - </li> - - - - - - - - <li ><a href="../../../modules/testutil/testutil/">Test Utilities</a> - - - </li> - - - - - - - - <li ><a href="../../../modules/devmgmt/newtmgr/">Device Management with Newt Manager</a> - - - </li> - - - - - - - - <li ><a href="../../../modules/imgmgr/imgmgr/">Image Manager</a> - - - </li> - - - - - - <li > - <a href="../../../modules/baselibc/">Baselibc library</a> - </li> - - - - - - - - <li ><a href="../../../modules/json/json/">JSON</a> - - - </li> - - - - - - - - <li ><a href="../../../modules/fcb/fcb/">Flash Circular Buffer</a> - - - </li> - - - - - - - - <li ><a href="../../../modules/stats/stats/">Stats</a> - - - </li> - - - - - - - - <li ><a href="../../../modules/logs/logs/">Logs</a> - - - </li> - - - - - - - - <li ><a href="../../../modules/sysinitconfig/sysinitconfig/">System Configuration And Initialization</a> - - - </li> - - - - </ul> - - </li> - - - - - - - - <li><a href=" - ../../../../network/ble/ble_intro/ -">BLE User Guide</a> - - - </li> - - - - - - - - <li ><a href="../../../../newt/newt_intro/">Newt Tool Guide</a> - - - </li> - - - - - - - - <li ><a href="../../../../newtmgr/overview/">Newt Manager Guide</a> - - - </li> - - - - </ul> - - </li> - - - - - - - - <li><a href=" - ../../../../faq/how_to_edit_docs/ -">Appendix</a> - - - </li> - - - - </ul> -</div></div> - - <div class="col-md-9" role="main"> - <div class="doc-header"> - <div role="navigation" aria-label="breadcrumbs navigation"> - <ul class="wy-breadcrumbs pull-right"> - <li><a href="/develop/os/introduction">Docs</a></li> - - - - <li>» <a href="../os_time/">Time</a></li> - - - - <li>» <a href="../os_time_delay/">Functions</a></li> - - - - <li>» os_time_tick</li> - - - - </ul> -</div> - </div> - - <h2 id="os_time_tick"><font color="F2853F" style="font-size:24pt">os_time_tick</font></h2> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">void</span> <span style="color: #000000">os_time_tick</span>(<span style="color: #A90D91">void</span>) -</pre></div> - - -<p>Increments the OS time tick for the system. Typically, this is called in one place by the architecture specific OS code (<code>libs/os/arch</code>) <code>timer_handler</code> which is in turn called by the BSP specific code assigned to drive the OS timer tick. See <a href="../../porting/port_os">Porting Mynewt OS</a> for details.</p> -<h4 id="arguments">Arguments</h4> -<p>N/A</p> -<h4 id="returned-values">Returned values</h4> -<p>N/A</p> -<h4 id="notes">Notes</h4> -<p>Called for every single tick by the architecture specific functions.</p> -<h4 id="example">Example</h4> -<p><Add text to set up the context for the example here></p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> <span style="color: #000000">os_time_tick</span>(); -</pre></div> - - <div class="row"> - - - - -<ul class="nav nav-pills" style="margin-bottom: 10px"> - <li> - - <a href=../os_time_get/> - <span class="fa fa-arrow-left"></span> - Previous: os_time_get - </a> - - </li> - <li class="pull-right"> - - <a href=../os_gettimeofday/> - Next: os_gettimeofday - <span class="fa fa-arrow-right"></span> - </a> - - </li> -</ul> - </div> - <footer class="row"> - <div class="col-xs-12"> - - <p class="copyright">Apache Mynewt (incubating) is available under Apache License, version 2.0.</p> - - </div> - <div class="col-xs-12"> - <div class="logos"> - <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> - <small class="footnote"> - MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. - </small> - <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> - </div> - </div> -</footer> - </div> - </div> - - - </div> - - <script src="../../../../js/jquery-1.10.2.min.js"></script> - <script src="../../../../js/bootstrap-3.0.3.min.js"></script> - <script src="../../../../js/highlight.pack.js"></script> - <script src="../../../../js/base.js"></script> - <script src="../../../../js/custom.js"></script> - - </body> -</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/facfa9ba/develop/os/modules/logs/logs/index.html ---------------------------------------------------------------------- diff --git a/develop/os/modules/logs/logs/index.html b/develop/os/modules/logs/logs/index.html index ca484fe..173b815 100644 --- a/develop/os/modules/logs/logs/index.html +++ b/develop/os/modules/logs/logs/index.html @@ -530,15 +530,35 @@ </div> </div> - <h2 id="mynewt-logging">Mynewt Logging</h2> -<p>Apache Mynewt has a logging package (<code>apache-mynewt-core/sys/log</code>) to support -logging of information within a Mynewt application.</p> -<p><br></p> + <h2 id="logging">Logging</h2> +<p>Mynewt log package supports logging of information within a Mynewt application. It allows packages to define their own log streams with separate names. It also allows an application to control the output destination of logs. +<br></p> <h3 id="description">Description</h3> -<p>Logging API is provided in <code>apache-mynewt-core/sys/log/include/log/log.h</code>.</p> -<p>It allows packages to define their own log streams with separate -names. It also allows an application to control the output destinations -of logs. </p> +<p>In the Mynewt OS, the log package comes in two versions:</p> +<ul> +<li> +<p>The <code>sys/log/full</code> package implements the complete log functionality and API.</p> +</li> +<li> +<p>The <code>sys/log/stub</code> package implements stubs for the API.</p> +</li> +</ul> +<p>Both packages export the <code>log</code> API, and any package that uses the log API must list <code>log</code> as a requirement in its <code>pkg.yml</code> file as follows: </p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">pkg.req_apis: + - log +</pre></div> + + +<p><br> +The application's <code>pkg.yml</code> file specifies the version of the log package to use. +A project that requires the full logging capability must list the <code>sys/log/full</code> package as a dependency in its <code>pkg.yml</code> file:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">pkg.deps: + - sys/log/full +</pre></div> + + +<p><br> +You can use the <code>sys/log/stub</code> package if you want to build your application without logging to reduce code size.</p> <p><br></p> <h4 id="compile-time-settings">Compile Time Settings</h4> <p>To save space at compile time, there is a compile time log level that @@ -547,15 +567,15 @@ example, during debug, you can have significant logs present, but disable these at compile time to ensure the code size limits are met.</p> <p>A compiler flag <code>LOG_LEVEL</code> can be set in your <code>target.cflags</code> or within your app <code>pkg.cflags</code> files to set the compile time log level. The -log level are defined in <code>apache-mynewt-core/sys/log/include/log/log.h</code> +log level are defined in <code>/sys/log/full/include/log/log.h</code> but must be added by number to your <code>yml</code> file.</p> <p>For example:</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> pkg.cflags -DLOG_LEVEL=8 +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> pkg.cflags -DLOG_LEVEL=3 </pre></div> <p>or </p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> newt target set my_target cflags=-DLOG_LEVEL=8 +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> newt target set my_target cflags=-DLOG_LEVEL=3 </pre></div> @@ -566,17 +586,16 @@ time and take no space within the Mynewt application image.</p> system.</p> <p><br></p> <h3 id="log">Log</h3> -<p>Each log stream requires a log structure to define its logging properties. -It is typical for modules to extern this structure.</p> -<p><br></p> +<p>Each log stream requires a <code>log</code> structure to define its logging properties. +<br></p> <h3 id="log-handler">Log Handler</h3> -<p>To use logs, a log-handler is required, which is responsible for handling -the I/O from the log. The log package comes with two pre-built log handlers.</p> +<p>To use logs, a log handler that handles the I/O from the log is required. The log package comes with three pre-built log handlers:</p> <ul> <li>console -- streams log events directly to the console port. Does not support walking and reading.</li> <li>cbmem -- writes/reads log events to a circular buffer. Supports walking -and reading for access by <code>newtmgr</code> and shell commands.</li> +and reading for access by newtmgr and shell commands.</li> +<li>fcb -- writes/reads log events to a <a href="../../fcb/fcb/">flash circular buffer</a>. Supports walking and reading for access by newtmgr and shell commands.</li> </ul> <p>In addition, it is possible to create custom log handlers for other methods. Examples may include</p> @@ -585,87 +604,92 @@ Examples may include</p> <li>Flat flash buffer</li> <li>Streamed over some other interface</li> </ul> -<p>To use logging, you will not typically need to create your own log handler. -You can use one of the two supplied above. </p> -<p>In Mynewt today, each module will register its logs with a default log handler. -Its up to the application to use or override this log handler for its -specific purposes. See below for an example.</p> -<p><br></p> -<h3 id="typical-use-of-logging-when-writing-an-application">Typical use of logging when writing an application</h3> -<p>When writing an application that is using other's log modules, you -may want to override their log handlers and log levels.</p> -<p>Add the logging to your package file.</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> pkg.deps: - - "@apache-mynewt-core/sys/log" +<p>To use logging, you typically do not need to create your own log handler. You can use one of the pre-built ones.</p> +<p>A package or an application must define a variable of type <code>struct log</code> and register a log handler for it with the log package. It must call the <code>log_register()</code> function to specify the log handler to use:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #000000">log_register</span>(<span style="color: #A90D91">char</span> <span style="color: #000000">*name</span>, <span style="color: #A90D91">struct</span> <span style="color: #000000">log</span> <span style="color: #000000">*log</span>, <span style="color: #A90D91">const</span> <span style="color: #A90D91">struct</span> <span style="color: #000000">log_handler</span> <span style="color: #000000">*lh</span>, <span style="color: #A90D91">void</span> <span style="color: #000000">*arg</span>, <span style="color: #A90D91">uint8_t</span> <span style="color: #000000">level</span>) </pre></div> -<p><br></p> -<p>Initialize the logs in your startup code. It may look like this </p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #633820">#include <module1/module1.h></span> -<span style="color: #633820">#include <module3/module2.h></span> -<span style="color: #633820">#include <module3/module3.h></span> +<p>The parameters are:</p> +<ul> +<li><code>name</code>- Name of the log stream.</li> +<li><code>log</code> - Log instance to register,</li> +<li><code>lh</code> - Pointer to the log handler. You can specify one of the pre-built ones: <ul> +<li><code>&log_console_handler</code> for console</li> +<li><code>&log_cbm_handler</code> for circular buffer </li> +<li><code>&log_fcb_handler</code> for flash circular buffer</li> +</ul> +</li> +<li><code>arg</code> - Opaque argument that the specified log handler uses. The value of this argument depends on the log handler you specify:<ul> +<li>NULL for the <code>log_console_handler</code>.</li> +<li>Pointer to an initialized <code>cbmem</code> structure (see <code>util/cbmem</code> package) for the <code>log_cbm_handler</code>.</li> +<li>Pointer to an initialized <code>fcb_log</code> structure (see <code>fs/fcb</code> package) for the <code>log_fcb_handler</code>. </li> +</ul> +</li> +</ul> +<p>Typically, a package that uses logging defines a global variable, such as <code>my_package_log</code>, of type <code>struct log</code>. The package can call the <code>log_register()</code> function with default values, but usually an application will override the logging properties and where to log to. There are two ways a package can allow an application to override the values:</p> +<ul> +<li>Define system configuration settings that an application can set and the package can then call the <code>log_register()</code> function with the configuration values.</li> +<li>Make the <code>my_package_log</code> variable external and let the application call the <code>log_register()</code> function to specify a log handler for its specific purpose. </li> +</ul> +<h3 id="configuring-logging-for-packages-that-an-application-uses">Configuring Logging for Packages that an Application Uses</h3> +<p>Here is an example of how an application can set the log handlers for the logs of the packages that the application includes. </p> +<p>In this example, the <code>package1</code> package defines the variable <code>package1_log</code> of type <code>struct log</code> and externs the variable. Similarly, the <code>package2</code> package defines the variable <code>package2_log</code> and externs the variable. The application sets logs for <code>package1</code> to use console and sets logs for <code>package2</code> to use a circular buffer.</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #633820">#include <package1/package1.h></span> +<span style="color: #633820">#include <package2/package2.h></span> +<span style="color: #633820">#include <util/cbmem.h></span> + <span style="color: #633820">#include <log/log.h></span> -<span style="color: #177500">/* log to console */</span> -<span style="color: #A90D91">static</span> <span style="color: #A90D91">struct</span> <span style="color: #000000">log_handler</span> <span style="color: #000000">app_log_handler</span>; +<span style="color: #A90D91">static</span> <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">cbmem_buf</span>[<span style="color: #000000">MAX_CBMEM_BUF</span>]; +<span style="color: #A90D91">static</span> <span style="color: #A90D91">struct</span> <span style="color: #000000">cbmem</span> <span style="color: #000000">cbmem</span>; + -<span style="color: #177500">/* this has to be after all the modules are </span> -<span style="color: #177500"> * initialized and have registered</span> -<span style="color: #177500"> * their log modules */</span> <span style="color: #A90D91">void</span> <span style="color: #000000">app_log_init</span>(<span style="color: #A90D91">void</span>) { - <span style="color: #177500">/* create a log handler for all logs . FOr this application</span> -<span style="color: #177500"> ** send them directly to the console port */</span> - <span style="color: #000000">log_console_handler_init</span>(<span style="color: #000000">&app_log_handler</span>); - ... - <span style="color: #177500">/* set up logging for the modules appropriately */</span> - <span style="color: #000000">module1_log</span>.<span style="color: #000000">log_level</span> <span style="color: #000000">=</span> <span style="color: #000000">LOG_LEVEL_WARN</span>; - <span style="color: #000000">module2_log</span>.<span style="color: #000000">log_level</span> <span style="color: #000000">=</span> <span style="color: #000000">LOG_LEVEL_INFO</span>; - <span style="color: #000000">module3_log</span>.<span style="color: #000000">log_level</span> <span style="color: #000000">=</span> <span style="color: #000000">LOG_LEVEL_DEBUG</span>; - - <span style="color: #177500">/* set up a single handler for all modules */</span> - <span style="color: #000000">module1_log</span>.<span style="color: #000000">log_handler</span> <span style="color: #000000">=</span> <span style="color: #000000">&app_log_handler</span>; - <span style="color: #000000">module2_log</span>.<span style="color: #000000">log_handler</span> <span style="color: #000000">=</span> <span style="color: #000000">&app_log_handler</span>; - <span style="color: #000000">module3_log</span>.<span style="color: #000000">log_handler</span> <span style="color: #000000">=</span> <span style="color: #000000">&app_log_handler</span>; + + + <span style="color: #000000">log_register</span>(<span style="color: #C41A16">"package1_log"</span>, <span style="color: #000000">&package1_log</span>, <span style="color: #000000">&log_console_handler</span>, <span style="color: #A90D91">NULL</span>, <span style="color: #000000">LOG_SYSLEVEL</span>); + + <span style="color: #000000">cbmem_init</span>(<span style="color: #000000">&cbmem</span>, <span style="color: #000000">cbmem_buf</span>, <span style="color: #000000">MAX_CBMEM_BUF</span>); + <span style="color: #000000">log_register</span>(<span style="color: #C41A16">"package2_log"</span>, <span style="color: #000000">&package2_log</span>, <span style="color: #000000">&log_cbmem_handler</span>, <span style="color: #000000">&cbmem</span>, <span style="color: #000000">LOG_SYSLEVEL</span>); + } </pre></div> <p><br></p> -<h3 id="typical-use-of-logging-when-writing-a-module">Typical use of Logging when writing a module</h3> -<p>When creating a package using its own logging, you can have this type of -structure. </p> +<h3 id="implementing-a-package-that-uses-logging">Implementing a Package that Uses Logging</h3> +<p>This example shows how a package logs to console. The package registers default logging properties to use the console, but allows an application to override the values. It defines the <code>my_package_log</code> variable and makes it external so an application can override log handler.</p> +<p>Make the <code>my_package_log</code> variable external:</p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #177500">/* my_package.h*/</span> <span style="color: #177500">/* pick a unique name here */</span> -<span style="color: #A90D91">extern</span> <span style="color: #A90D91">struct</span> <span style="color: #000000">log</span> <span style="color: #000000">my_log</span>; +<span style="color: #A90D91">extern</span> <span style="color: #A90D91">struct</span> <span style="color: #000000">log</span> <span style="color: #000000">my_package_log</span>; </pre></div> <p><br></p> -<p>with an implementation in your module that looks like this: </p> +<p>Define the <code>my_package_log</code> variable and register the console log handler: </p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #177500">/* my_package.c */</span> -<span style="color: #A90D91">struct</span> <span style="color: #000000">log_handler</span> <span style="color: #000000">log_console_handler</span>; -<span style="color: #A90D91">struct</span> <span style="color: #000000">log</span> <span style="color: #000000">my_log</span>; +<span style="color: #A90D91">struct</span> <span style="color: #000000">log</span> <span style="color: #000000">my_package_log</span>; { ... - <span style="color: #177500">/* create a default handler for this log stream */</span> - <span style="color: #000000">log_console_handler_init</span>(<span style="color: #000000">&log_console_handler</span>); <span style="color: #177500">/* register my log with a name to the system */</span> - <span style="color: #000000">log_register</span>(<span style="color: #C41A16">"log"</span>, <span style="color: #000000">&my_log</span>, <span style="color: #000000">&log_console_handler</span>); - - <span style="color: #177500">/* set up default log level for my package */</span> - <span style="color: #000000">my_log</span>.<span style="color: #000000">log_level</span> <span style="color: #000000">=</span> <span style="color: #000000">LOG_LEVEL_DEBUG</span>; + <span style="color: #000000">log_register</span>(<span style="color: #C41A16">"log"</span>, <span style="color: #000000">&my_package_log</span>, <span style="color: #000000">&log_console_handler</span>, <span style="color: #A90D91">NULL</span>, <span style="color: #000000">LOG_LEVEL_DEBUG</span>); - <span style="color: #000000">LOG_DEBUG</span>(<span style="color: #000000">&my_log</span>, <span style="color: #000000">LOG_MODULE_DEFAULT</span>, <span style="color: #C41A16">"bla"</span>); - <span style="color: #000000">LOG_DEBUG</span>(<span style="color: #000000">&my_log</span>, <span style="color: #000000">LOG_MODULE_DEFAULT</span>, <span style="color: #C41A16">"bab"</span>); + <span style="color: #000000">LOG_DEBUG</span>(<span style="color: #000000">&my_package_log</span>, <span style="color: #000000">LOG_MODULE_DEFAULT</span>, <span style="color: #C41A16">"bla"</span>); + <span style="color: #000000">LOG_DEBUG</span>(<span style="color: #000000">&my_package_log</span>, <span style="color: #000000">LOG_MODULE_DEFAULT</span>, <span style="color: #C41A16">"bab"</span>); } </pre></div> + + +<h3 id="log-api-and-log-levels">Log API and Log Levels</h3> +<p>For more information on the <code>log</code> API and log levels, see the <code>sys/log/full/include/log/log.h</code> header file.</p> <div class="row"> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/facfa9ba/develop/os/tutorials/STM32F303/index.html ---------------------------------------------------------------------- diff --git a/develop/os/tutorials/STM32F303/index.html b/develop/os/tutorials/STM32F303/index.html index 93ee5f2..02d9003 100644 --- a/develop/os/tutorials/STM32F303/index.html +++ b/develop/os/tutorials/STM32F303/index.html @@ -299,7 +299,7 @@ <li > - <a href="../blinky_sram_olimex/">Run Blinky from SRAM, no bootloader</a> + <a href="../rbnano2/">Blinky on RedBear Nano 2</a> </li> @@ -340,7 +340,7 @@ <li > - <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino Zero</a> + <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/facfa9ba/develop/os/tutorials/add_newtmgr/index.html ---------------------------------------------------------------------- diff --git a/develop/os/tutorials/add_newtmgr/index.html b/develop/os/tutorials/add_newtmgr/index.html index 071be1e..aef9601 100644 --- a/develop/os/tutorials/add_newtmgr/index.html +++ b/develop/os/tutorials/add_newtmgr/index.html @@ -263,7 +263,7 @@ <li > - <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino Zero</a> + <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> @@ -645,10 +645,10 @@ Stats Name: ble_att To configure the transport protocols that are supported, modify the <code>pkg.yml</code> and <code>syscfg.yml</code> files as follows:</p> <ul> -<li>Add the <code>mgmt/newtmgr/transport/ble</code> package to <code>pkg.deps</code> parameter to enable BLE transport.</li> +<li>Add the <code>mgmt/newtmgr/transport/ble</code> package to the <code>pkg.deps</code> parameter to enable BLE transport.</li> <li>Add the <code>mgmt/newtmgr/transport/nmgr_shell</code> package to -the <code>pkg.deps</code> parameter, and add <code>SHELL_TASK: 1</code> to the <code>syscfg.vals</code> parameter to enable serial transport.</li> -<li>Add the <code>mgmt/newtmgr/transport/nmgr_uart</code> package, and add <code>SHELL_TASK: 1</code> to enable serial communication over a UARTport.</li> +the <code>pkg.deps</code> parameter, and add <code>SHELL_TASK: 1</code> to the <code>syscfg.vals</code> parameter to enable serial transport when your application also uses the <a href="../../modules/shell/shell/">Shell</a>.</li> +<li>Add the <code>mgmt/newtmgr/transport/nmgr_uart</code> package to the <code>pkg.deps</code> parameter to enable serial transport over a UART port. You can use this package instead of the <code>nmgr_shell</code> package when your application does not use the <a href="../../modules/shell/shell/">Shell</a> or you want to use a dedicated UART port to communicate with newtmgr. You can change the <code>NMGR_UART</code> and <code>NMGR_URART_SPEED</code> sysconfig values to specify a different port.</li> </ul> <p><br></p> <h4 id="oicmgr-framework-options">Oicmgr Framework Options</h4> @@ -696,9 +696,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-target-slinky/> + <a href=../project-stm32-slinky/> <span class="fa fa-arrow-left"></span> - Previous: Slinky on Nordic nRF52 board + Previous: Slinky on STM32 board </a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/facfa9ba/develop/os/tutorials/add_shell/index.html ---------------------------------------------------------------------- diff --git a/develop/os/tutorials/add_shell/index.html b/develop/os/tutorials/add_shell/index.html index 66fb4ca..cfe597e 100644 --- a/develop/os/tutorials/add_shell/index.html +++ b/develop/os/tutorials/add_shell/index.html @@ -263,7 +263,7 @@ <li > - <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino Zero</a> + <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/facfa9ba/develop/os/tutorials/air_quality_ble/index.html ---------------------------------------------------------------------- diff --git a/develop/os/tutorials/air_quality_ble/index.html b/develop/os/tutorials/air_quality_ble/index.html index a74b1a8..5460676 100644 --- a/develop/os/tutorials/air_quality_ble/index.html +++ b/develop/os/tutorials/air_quality_ble/index.html @@ -263,7 +263,7 @@ <li > - <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino Zero</a> + <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/facfa9ba/develop/os/tutorials/air_quality_sensor/index.html ---------------------------------------------------------------------- diff --git a/develop/os/tutorials/air_quality_sensor/index.html b/develop/os/tutorials/air_quality_sensor/index.html index a3893dc..876db13 100644 --- a/develop/os/tutorials/air_quality_sensor/index.html +++ b/develop/os/tutorials/air_quality_sensor/index.html @@ -263,7 +263,7 @@ <li > - <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino Zero</a> + <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/facfa9ba/develop/os/tutorials/arduino_zero/index.html ---------------------------------------------------------------------- diff --git a/develop/os/tutorials/arduino_zero/index.html b/develop/os/tutorials/arduino_zero/index.html index 30dde87..6029eff 100644 --- a/develop/os/tutorials/arduino_zero/index.html +++ b/develop/os/tutorials/arduino_zero/index.html @@ -285,7 +285,7 @@ <li > - <a href="../blinky_sram_olimex/">Run Blinky from SRAM, no bootloader</a> + <a href="../rbnano2/">Blinky on RedBear Nano 2</a> </li> @@ -326,7 +326,7 @@ <li > - <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino Zero</a> + <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/facfa9ba/develop/os/tutorials/blehci_project/index.html ---------------------------------------------------------------------- diff --git a/develop/os/tutorials/blehci_project/index.html b/develop/os/tutorials/blehci_project/index.html index e7f924f..8e9844d 100644 --- a/develop/os/tutorials/blehci_project/index.html +++ b/develop/os/tutorials/blehci_project/index.html @@ -263,7 +263,7 @@ <li > - <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino Zero</a> + <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/facfa9ba/develop/os/tutorials/bleprph/bleprph-adv/index.html ---------------------------------------------------------------------- diff --git a/develop/os/tutorials/bleprph/bleprph-adv/index.html b/develop/os/tutorials/bleprph/bleprph-adv/index.html index 0e3be00..ce1114e 100644 --- a/develop/os/tutorials/bleprph/bleprph-adv/index.html +++ b/develop/os/tutorials/bleprph/bleprph-adv/index.html @@ -263,7 +263,7 @@ <li > - <a href="../../wi-fi_on_arduino/">Enable Wi-Fi on Arduino Zero</a> + <a href="../../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/facfa9ba/develop/os/tutorials/bleprph/bleprph-app/index.html ---------------------------------------------------------------------- diff --git a/develop/os/tutorials/bleprph/bleprph-app/index.html b/develop/os/tutorials/bleprph/bleprph-app/index.html index eb41da4..97b571a 100644 --- a/develop/os/tutorials/bleprph/bleprph-app/index.html +++ b/develop/os/tutorials/bleprph/bleprph-app/index.html @@ -263,7 +263,7 @@ <li > - <a href="../../wi-fi_on_arduino/">Enable Wi-Fi on Arduino Zero</a> + <a href="../../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/facfa9ba/develop/os/tutorials/bleprph/bleprph-chr-access/index.html ---------------------------------------------------------------------- diff --git a/develop/os/tutorials/bleprph/bleprph-chr-access/index.html b/develop/os/tutorials/bleprph/bleprph-chr-access/index.html index 1030ad9..37dc1ea 100644 --- a/develop/os/tutorials/bleprph/bleprph-chr-access/index.html +++ b/develop/os/tutorials/bleprph/bleprph-chr-access/index.html @@ -263,7 +263,7 @@ <li > - <a href="../../wi-fi_on_arduino/">Enable Wi-Fi on Arduino Zero</a> + <a href="../../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/facfa9ba/develop/os/tutorials/bleprph/bleprph-gap-event/index.html ---------------------------------------------------------------------- diff --git a/develop/os/tutorials/bleprph/bleprph-gap-event/index.html b/develop/os/tutorials/bleprph/bleprph-gap-event/index.html index a365e0d..fd9b3b7 100644 --- a/develop/os/tutorials/bleprph/bleprph-gap-event/index.html +++ b/develop/os/tutorials/bleprph/bleprph-gap-event/index.html @@ -263,7 +263,7 @@ <li > - <a href="../../wi-fi_on_arduino/">Enable Wi-Fi on Arduino Zero</a> + <a href="../../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/facfa9ba/develop/os/tutorials/bleprph/bleprph-intro/index.html ---------------------------------------------------------------------- diff --git a/develop/os/tutorials/bleprph/bleprph-intro/index.html b/develop/os/tutorials/bleprph/bleprph-intro/index.html index 7325eb6..141640a 100644 --- a/develop/os/tutorials/bleprph/bleprph-intro/index.html +++ b/develop/os/tutorials/bleprph/bleprph-intro/index.html @@ -263,7 +263,7 @@ <li > - <a href="../../wi-fi_on_arduino/">Enable Wi-Fi on Arduino Zero</a> + <a href="../../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/facfa9ba/develop/os/tutorials/bleprph/bleprph-svc-reg/index.html ---------------------------------------------------------------------- diff --git a/develop/os/tutorials/bleprph/bleprph-svc-reg/index.html b/develop/os/tutorials/bleprph/bleprph-svc-reg/index.html index adf79b7..6535a13 100644 --- a/develop/os/tutorials/bleprph/bleprph-svc-reg/index.html +++ b/develop/os/tutorials/bleprph/bleprph-svc-reg/index.html @@ -263,7 +263,7 @@ <li > - <a href="../../wi-fi_on_arduino/">Enable Wi-Fi on Arduino Zero</a> + <a href="../../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/facfa9ba/develop/os/tutorials/bletiny_project/index.html ---------------------------------------------------------------------- diff --git a/develop/os/tutorials/bletiny_project/index.html b/develop/os/tutorials/bletiny_project/index.html index 029421a..01ebb02 100644 --- a/develop/os/tutorials/bletiny_project/index.html +++ b/develop/os/tutorials/bletiny_project/index.html @@ -263,7 +263,7 @@ <li > - <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino Zero</a> + <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/facfa9ba/develop/os/tutorials/blinky_console/index.html ---------------------------------------------------------------------- diff --git a/develop/os/tutorials/blinky_console/index.html b/develop/os/tutorials/blinky_console/index.html index 3054a9e..b19b882 100644 --- a/develop/os/tutorials/blinky_console/index.html +++ b/develop/os/tutorials/blinky_console/index.html @@ -285,7 +285,7 @@ <li > - <a href="../blinky_sram_olimex/">Run Blinky from SRAM, no bootloader</a> + <a href="../rbnano2/">Blinky on RedBear Nano 2</a> </li> @@ -326,7 +326,7 @@ <li > - <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino Zero</a> + <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> @@ -540,30 +540,21 @@ <h2 id="enabling-the-console-and-shell-for-blinky">Enabling The Console and Shell for Blinky</h2> <p><br></p> -<p>This tutorial explains how to add the Console and Shell task to the blinky app so that you -can interact with it over a serial line connection.</p> +<p>This tutorial explains how to add the Console and Shell task to the blinky application so that you can interact with it over a serial line connection.</p> <p><br></p> -<h3 id="pre-requisites">Pre-Requisites</h3> +<h3 id="prerequisites">Prerequisites</h3> <ul> -<li>Ensure you have installed <a href="../../../newt/install/newt_mac/">newt</a> and that the -newt command is in your system path. </li> -<li>You must have Internet connectivity to fetch remote Mynewt components.</li> -<li>You must <a href="../../get_started/native_tools/">install the compiler tools</a> to -support native compiling to build the project this tutorial creates. </li> -<li>You must install the <a href="https://www.segger.com/jlink-software.html";>Segger JLINK package</a> to -load your project on the board.</li> -<li>Cable to establish a serial USB connection between the board and the laptop</li> +<li>Work through one of the Blinky Tutorials to create and build a Blinky application for one of the boards.</li> </ul> <p><br></p> -<h3 id="use-an-existing-project">Use an existing project</h3> +<h3 id="use-an-existing-project">Use an Existing Project</h3> <p>Since all we're doing is adding the shell and console capability to blinky, we assume that you have worked through at least some of the other tutorials, and have an existing project. For this example, we'll be modifying the <a href="../nRF52/">blinky on nrf52</a> project to enable -the shell and console connectivity. Feel free to use whatever version of blinky you'd like though.</p> +the shell and console connectivity. You can use blinky on a different board.</p> <p><br></p> <h3 id="modify-the-dependencies-and-configuration">Modify the Dependencies and Configuration</h3> -<p>The first thing you'll need to add is a few new dependencies for your app. To add shell support to -your app make sure the following <code>pkg.deps</code> are defined in your target's pkg.yml file:</p> +<p>Add the following dependencies to your application target's <code>pkg.yml</code> file:</p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">pkg.deps: - "@apache-mynewt-core/sys/console/full" - "@apache-mynewt-core/sys/shell" @@ -572,12 +563,8 @@ your app make sure the following <code>pkg.deps</code> are defined in your targe <p>This lets the newt system know that it needs to pull in the code for the console and the shell.</p> -<p>Now we'll need to modify the settings for the app to turn on the shell, etc. by modifying the -<code>syscfg.yml</code> file for your target. (Remember, these files are in the targets/<app-name> directory.) -If there isn't a <code>syscfg.yml</code> file in your target's directory, you will need to create one.</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"># Package: apps/bletiny - -syscfg.vals: +<p>Modify the system configuration settings to enable Shell and Console ticks and prompt. Add the following to your application target's <code>syscfg.yml</code> file:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">syscfg.vals: # Enable the shell task. SHELL_TASK: 1 # Enable Console OS Ticks @@ -587,91 +574,117 @@ syscfg.vals: </pre></div> -<h3 id="add-an-event-queue">Add an Event Queue</h3> -<p>Blinky is a small app that doesn't make use of tasks or an event queue as many other apps do, so -we'll have to modify the source for the app in order to add one. </p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #177500">/* System event queue task handler */</span> -<span style="color: #633820">#define SYSEVQ_PRIO (1)</span> -<span style="color: #633820">#define SYSEVQ_STACK_SIZE OS_STACK_ALIGN(512)</span> -<span style="color: #A90D91">static</span> <span style="color: #A90D91">struct</span> <span style="color: #000000">os_task</span> <span style="color: #000000">task_sysevq</span>; -<span style="color: #A90D91">os_stack_t</span> <span style="color: #000000">sysevq_stack</span>[<span style="color: #000000">SYSEVQ_STACK_SIZE</span>]; +<p><br></p> +<h3 id="use-the-os-default-event-queue-to-process-blinky-timer-and-shell-events">Use the OS Default Event Queue to Process Blinky Timer and Shell Events</h3> +<p>Mynewt creates a default task that executes the application <code>main()</code> function. It also creates an OS default event queue that packages can use to queue their events. Shell uses the OS default event queue for Shell events, and <code>main()</code> can process the events in the context of the default task. </p> +<p>Blinky's main.c is very simple. It only has a <code>main()</code> function that executes an infinite loop to toggle the LED and sleep for one second. We will modify blinky:</p> +<ul> +<li>To use os_callout to generate a timer event every one second instead of sleeping. The timer events are added to the OS default event queue.</li> +<li>To process events from the OS default event queue inside the infinite loop in <code>main()</code>.</li> +</ul> +<p>This allows the default task to process both Shell events and the timer events to toggle the LED from the OS default event queue.</p> +<p><br></p> +<h3 id="modify-mainc">Modify main.c</h3> +<p>Initialize a os_callout timer and move the toggle code from the while loop in <code>main()</code> to the event callback function. Add the following code above the <code>main()</code> function:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #177500">/* The timer callout */</span> +<span style="color: #A90D91">static</span> <span style="color: #A90D91">struct</span> <span style="color: #000000">os_callout</span> <span style="color: #000000">blinky_callout</span>; -<span style="color: #177500">/* Event queue for events handled by the system (shell, etc.) */</span> -<span style="color: #A90D91">static</span> <span style="color: #A90D91">struct</span> <span style="color: #000000">os_eventq</span> <span style="color: #000000">sys_evq</span>; -</pre></div> +<span style="color: #177500">/*</span> +<span style="color: #177500"> * Event callback function for timer events. It toggles the led pin.</span> +<span style="color: #177500"> */</span> +<span style="color: #A90D91">static</span> <span style="color: #A90D91">void</span> <span style="color: #000000">timer_ev_cb</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">os_event</span> <span style="color: #000000">*ev</span>) +{ + <span style="color: #000000">assert</span>(<span style="color: #000000">ev</span> <span style="color: #000000">!=</span> <span style="color: #A90D91">NULL</span>); + + <span style="color: #000000">++g_task1_loops</span>; + <span style="color: #000000">hal_gpio_toggle</span>(<span style="color: #000000">g_led_pin</span>); + + <span style="color: #000000">os_callout_reset</span>(<span style="color: #000000">&blinky_callout</span>, <span style="color: #000000">OS_TICKS_PER_SEC</span>); +} + +<span style="color: #A90D91">static</span> <span style="color: #A90D91">void</span> <span style="color: #000000">init_timer</span>(<span style="color: #A90D91">void</span>) +{ + <span style="color: #177500">/*</span> +<span style="color: #177500"> * Initialize the callout for a timer event.</span> +<span style="color: #177500"> */</span> + <span style="color: #000000">os_callout_init</span>(<span style="color: #000000">&blinky_callout</span>, <span style="color: #000000">os_eventq_dflt_get</span>(), + <span style="color: #000000">timer_ev_cb</span>, <span style="color: #A90D91">NULL</span>); + <span style="color: #000000">os_callout_reset</span>(<span style="color: #000000">&blinky_callout</span>, <span style="color: #000000">OS_TICKS_PER_SEC</span>); -<p>We define a new <code>os_task</code> a task stack (<code>sysevq_stack</code>) and new system event queue -(<code>sys_evq</code>) so that the shell and console will have an event queue to run in.</p> -<p>Next we go down to our <code>init_tasks()</code> function and initialize it</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #000000">os_task_init</span>(<span style="color: #000000">&task_sysevq</span>, <span style="color: #C41A16">"sysevq"</span>, <span style="color: #000000">sysevq_handler</span>, <span style="color: #A90D91">NULL</span>, - <span style="color: #000000">SYSEVQ_PRIO</span>, <span style="color: #000000">OS_WAIT_FOREVER</span>, <span style="color: #000000">sysevq_stack</span>, <span style="color: #000000">SYSEVQ_STACK_SIZE</span>); -<span style="color: #000000">os_eventq_init</span>(<span style="color: #000000">&sys_evq</span>); -<span style="color: #000000">os_eventq_dflt_set</span>(<span style="color: #000000">&sys_evq</span>); +} </pre></div> -<p>This will initialize the task, initialize the event queue, and then set the new event queue as -the default event queue. </p> -<p>Finally, we need to add the task handler for the event queue:</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #177500">/**</span> -<span style="color: #177500"> * This task serves as a container for the shell and newtmgr packages. These</span> -<span style="color: #177500"> * packages enqueue timer events when they need this task to do work.</span> -<span style="color: #177500"> */</span> -<span style="color: #A90D91">static</span> <span style="color: #A90D91">void</span> -<span style="color: #000000">sysevq_handler</span>(<span style="color: #A90D91">void</span> <span style="color: #000000">*arg</span>) +<p>In <code>main()</code>, add the call to the <code>init_timer()</code> function before the while loop and modify the while loop to process events from the OS default event queue:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #000000">main</span>(<span style="color: #A90D91">int</span> <span style="color: #000000">argc</span>, <span style="color: #A90D91">char</span> <span style="color: #000000">**argv</span>) { + + <span style="color: #A90D91">int</span> <span style="color: #000000">rc</span>; + +<span style="color: #633820">#ifdef ARCH_sim</span> + <span style="color: #000000">mcu_sim_parse_args</span>(<span style="color: #000000">argc</span>, <span style="color: #000000">argv</span>); +<span style="color: #633820">#endif</span> + + <span style="color: #000000">sysinit</span>(); + + <span style="color: #000000">g_led_pin</span> <span style="color: #000000">=</span> <span style="color: #000000">LED_BLINK_PIN</span>; + <span style="color: #000000">hal_gpio_init_out</span>(<span style="color: #000000">g_led_pin</span>, <span style="color: #1C01CE">1</span>); + <span style="color: #000000">init_timer</span>(); <span style="color: #A90D91">while</span> (<span style="color: #1C01CE">1</span>) { - <span style="color: #000000">os_eventq_run</span>(<span style="color: #000000">&sys_evq</span>); + <span style="color: #000000">os_eventq_run</span>(<span style="color: #000000">os_eventq_dflt_get</span>()); } + <span style="color: #000000">assert</span>(<span style="color: #1C01CE">0</span>) + <span style="color: #A90D91">return</span> <span style="color: #000000">rc</span>; } </pre></div> -<h3 id="build-targets">Build targets</h3> +<p><br></p> +<h3 id="build-the-blinky-application-target">Build the Blinky Application Target</h3> <p>We're not going to build the bootloader here since we are assuming that you have already built and loaded it during previous tutorials.</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt build blinky -Archiving cbmem.a -Compiling crc16.c -Compiling crc8.c -Archiving crc.a -Compiling mem.c -Archiving mem.a -Linking ~/dev/myproj/bin/targets/blinky/app/apps/blinky/blinky.elf -Target successfully built: targets/blinky +<p>Run the <code>newt build nrf52_blinky</code> command to build the Blinky application:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt build nrf52_blinky + + ... + +Archiving util_mem.a +Linking ~/dev/myproj/bin/targets/nrf52_blinky/app/apps/blinky/blinky.elf +Target successfully built: targets/nrf52_blinky </pre></div> <p><br></p> -<h3 id="create-the-app-image">Create the app image</h3> -<p>Generate a signed application image for the <code>blinky</code> target. The version number is arbitrary.</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt create-image blinky 1.0.0 -App image succesfully generated: ~/dev/myproj/bin/targets/blinky/app/apps/blinky/blinky.img +<h3 id="sign-and-create-the-blinky-application-image">Sign and Create the Blinky Application Image</h3> +<p>Run the <code>newt create-image nrf52_blinky 1.0.0</code> command to create and sign the application image. You may assign an arbitrary version (e.g. 1.0.0) to the image.</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt create-image nrf52_blinky 1.0.0 +App image succesfully generated: ~/dev/myproj/bin/targets/nrf52_blinky/app/apps/blinky/blinky.img </pre></div> <p><br></p> -<h3 id="load-the-image">Load the image</h3> +<h3 id="load-the-image">Load the 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 load blinky +<p>Run the <code>newt load nrf52_blinky</code> command to load the Blinky application image onto the board.</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt load nrf52_blinky +Loading app image into slot 1 </pre></div> <p><br></p> -<h3 id="set-up-serial-connection">Set up Serial connection</h3> +<h3 id="set-up-a-serial-connection">Set Up a Serial Connection</h3> <p>You'll need a Serial connection to see the output of your program. You can reference the <a href="../../get_started/serial_access/">Serial Port Setup</a> -Tutorial for more information on setting up your serial communications.</p> +Tutorial for more information on setting up your serial communication.</p> <p><br></p> -<h3 id="connecting-with-your-app">Connecting with your app</h3> -<p>Once you have a connection set up, you can connect to your device with <code>minicom -D /dev/tty.usbmodem<port> -b 115200</code> to run connect -to the console of your app. </p> +<h3 id="communicate-with-the-application">Communicate with the Application</h3> +<p>Once you have a connection set up, run <code>minicom -D /dev/tty.usbmodem<port> -b 115200</code> to connect to the application console.</p> <p>To test and make sure that the Shell is running, first just hit <return>:</p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">3534: > </pre></div> -<p>Remember, we turned the CONSOLE_PROMPT and the CONSOLE_TICKS on earlier. You can try some commands now:</p> +<p>You can try some commands:</p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">3609: > ? Commands: 8841: echo ? prompt ticks tasks mempools @@ -688,9 +701,6 @@ prompt on 39108: Prompt now on. 39108: > </pre></div> - - -<p>And there you have the Console and Shell working in an app that previously had no event queue! </p> <div class="row"> @@ -700,9 +710,9 @@ prompt on <ul class="nav nav-pills" style="margin-bottom: 10px"> <li> - <a href=../blinky_sram_olimex/> + <a href=../rbnano2/> <span class="fa fa-arrow-left"></span> - Previous: Run Blinky from SRAM, no bootloader + Previous: Blinky on RedBear Nano 2 </a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/facfa9ba/develop/os/tutorials/blinky_primo/index.html ---------------------------------------------------------------------- diff --git a/develop/os/tutorials/blinky_primo/index.html b/develop/os/tutorials/blinky_primo/index.html index 272f6e5..8001c04 100644 --- a/develop/os/tutorials/blinky_primo/index.html +++ b/develop/os/tutorials/blinky_primo/index.html @@ -285,7 +285,7 @@ <li > - <a href="../blinky_sram_olimex/">Run Blinky from SRAM, no bootloader</a> + <a href="../rbnano2/">Blinky on RedBear Nano 2</a> </li> @@ -326,7 +326,7 @@ <li > - <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino Zero</a> + <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> </li> @@ -555,13 +555,14 @@ <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> -<li>Install a debugger - choose one of the two options below. Option 1 requires additional hardware but very easy to set up. Option 2 is free software install but not as simple as Option 1.</li> +<li>Install a debugger - choose one of the two options below. Option 1 requires additional hardware but very easy to set up. Option 2 is free software but not as simple as Option 1.</li> </ul> <p><br></p> <h5 id="option-1">Option 1</h5> <ul> <li><a href="https://www.segger.com/jlink-debug-probes.html";>Segger J-Link Debug Probe</a> - any model (this tutorial has been tested with J-Link EDU and J-Link Pro)</li> <li><a href="https://www.segger.com/jlink-adapters.html#CM_9pin";>J-Link 9 pin Cortex-M Adapter</a> that allows JTAG, SWD and SWO connections between J-Link and Cortex M based target hardware systems</li> +<li>Install the <a href="https://www.segger.com/jlink-software.html";>Segger JLINK Software and documentation pack</a>. </li> </ul> <h5 id="option-2">Option 2</h5> <p>No additional hardware is required but a version of OpenOCD 0.10.0 that is currently in development needs to be installed. A patch for the nRF52 has been applied to the OpenOCD code in development and a tarball has been made available for download <a href="../downloads/openocd-wnrf52.tgz">here</a>. Untar it. From the top of the directory tree ("openocd-code-89bf96ffe6ac66c80407af8383b9d5adc0dc35f4"), build it using the following configuration:</p> @@ -578,21 +579,8 @@ For bug reports, read </pre></div> -<p>Next, make sure that you have checked out the newt develop branch and rebuilt newt.</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ cd $GOPATH/src/mynewt.apache.org/newt -$ git checkout develop -$ git pull -$ cd newt -$ go install -</pre></div> - - -<p><strong>Note:</strong> This step can be removed once the changes have been pushed to master.</p> <p>You can now use openocd to upload to Arduino Primo board via the USB port itself.</p> <p><br></p> -<h3 id="install-jlinkexe">Install jlinkEXE</h3> -<p>In order to be able to communicate with the SEGGER J-Link debugger on the dev board, you have to download and install the J-Link GDB Server software on to your laptop. You may download the "Software and documentation pack for Mac OS X" from <a href="https://www.segger.com/jlink-software.html";>https://www.segger.com/jlink-software.html</a>. </p> -<p><br></p> <h3 id="create-a-project">Create a Project</h3> <p>Create a new project if you do not have an existing one. You can skip this step and proceed to <a href="#create_targets">create the targets</a> if you already created a project.</p> <p>Run the following commands to create a new project:</p> @@ -727,10 +715,10 @@ $ </pre></div> -<p>You should see the LED on the board blink!</p> +<p>You should see the orange LED (L13), below the ON LED, on the board blink!</p> <p>Note: If the LED does not blink, try resetting the board.</p> <p><br></p> -<p><strong>Note:</strong> If you want to erase the flash and load the image again, you can use JLinkExe to issue an <code>erase</code> command.</p> +<p><strong>Note:</strong> If you want to erase the flash and load the image again, use JLinkExe and issue the <code>erase</code> command when you are using the Jlink debug probe: </p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ JLinkExe -device nRF52 -speed 4000 -if SWD SEGGER J-Link Commander V5.12c (Compiled Apr 21 2016 16:05:51) DLL version V5.12c, compiled Apr 21 2016 16:05:45 @@ -757,6 +745,22 @@ $ <p><br></p> +<p>If you are using the OpenOCD debugger, run the <code>newt debug primoblinky</code> command and issue the highlighted command at the (gdb) prompt:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$newt debug primoblinky +[~/dev/myproj/repos/apache-mynewt-core/hw/bsp/arduino_primo_nrf52/primo_debug.sh ~/dev/myproj/repos/apache-mynewt-core/hw/bsp/arduino_primo_nrf52 ~/dev/myproj/bin/targets/primoblinky/app/apps/blinky/blinky] +Open On-Chip Debugger 0.10.0-dev-snapshot (2017-03-28-11:24) + + ... + +os_tick_idle (ticks=128) + at repos/apache-mynewt-core/hw/mcu/nordic/nrf52xxx/src/hal_os_tick.c:200 +warning: Source file is more recent than executable. +200 if (ticks > 0) { +<span style="background-color: #ffffcc">(gdb) mon nrf52 mass_erase +</span></pre></div> + + +<p><br></p> <h3 id="conclusion">Conclusion</h3> <p>You have created, setup, compiled, loaded, and ran your first mynewt application for an Arduino Primo board.</p>
