blob: 11ee1833d6e3f68eb6612754501fa99535d4bf84 [file] [log] [blame]
<!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">
<title>newt vals &mdash; Apache Mynewt latest documentation</title>
<link rel="shortcut icon" href="../../_static/mynewt-logo-only-newt32x32.png"/>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/sphinx_theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/bootstrap-3.0.3.min.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/v2.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/custom.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/restructuredtext.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/overrides.css" type="text/css" />
<link rel="index" title="Index"
href="../../genindex.html"/>
<link rel="search" title="Search" href="../../search.html"/>
<link rel="top" title="Apache Mynewt latest documentation" href="../../index.html"/>
<link rel="up" title="Command Structure" href="../newt_ops.html"/>
<link rel="next" title="newt version" href="newt_version.html"/>
<link rel="prev" title="newt upgrade" href="newt_upgrade.html"/>
<script src="../../_static/js/modernizr.min.js"></script>
<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="not-front page-documentation" role="document" >
<div id="wrapper">
<div class="container">
<div id="banner" class="row v2-main-banner">
<a class="logo-cell" href="/">
<img class="logo" src="../../_static/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.11.0, Apache NimBLE 1.6.0 </a> released September 7, 2023)
</div>
</div>
</div>
</div>
<header>
<nav id="navbar" class="navbar navbar-inverse" 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>
<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>
<a href="/about/">About</a>
</li>
<li>
<a href="/talks/">Talks</a>
</li>
<li class="active">
<a href="/documentation/">Documentation</a>
</li>
<li>
<a href="/download/">Download</a>
</li>
<li>
<a href="/community/">Community</a>
</li>
<li>
<a href="/events/">Events</a>
</li>
</ul>
<!-- Search, Navigation and Repo links -->
<ul class="nav navbar-nav navbar-right">
</ul>
</div>
</div>
</nav>
</header>
<!-- STARTS MAIN CONTENT -->
<div id="main-content">
<div id="breadcrumb">
<div class="container">
<a href="/documentation/">Docs</a> /
<a href="../index.html">Newt Tool Guide</a> /
<a href="../newt_ops.html">Command Structure</a> /
newt vals
<div class="sourcelink">
<a href="https://github.com/apache/mynewt-newt/edit/master/docs/command_list/newt_vals.rst" class="icon icon-github"
rel="nofollow"> Edit on GitHub</a>
</div>
</div>
</div>
<!-- STARTS CONTAINER -->
<div class="container">
<!-- STARTS .content -->
<div id="content" class="row">
<!-- STARTS .container-sidebar -->
<div class="container-sidebar col-xs-12 col-sm-3">
<div id="docSidebar" class="sticky-container">
<div role="search" class="sphinx-search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search documentation" class="search-documentation" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<!-- Note: only works when deployed -->
<select class="form-control" onchange="if (this.value) window.location.href=this.value">
<option value="/latest" selected>
Version: latest
</option>
<option value="/v1_11_0" >
Version: 1.11.0
</option>
<option value="/v1_10_0" >
Version: 1.10.0
</option>
<option value="/v1_9_0" >
Version: 1.9.0
</option>
<option value="/v1_8_0" >
Version: 1.8.0
</option>
<option value="/v1_7_0" >
Version: 1.7.0
</option>
<option value="/v1_6_0" >
Version: 1.6.0
</option>
<option value="/v1_5_0" selected="selected" >
Version: 1.5.0
</option>
<option value="/v1_4_0" >
Version: 1.4.0
</option>
<option value="/v1_3_0/os/introduction" >
Version: 1.3.0
</option>
<option value="/v1_2_0/os/introduction" >
Version: 1.2.0
</option>
<option value="/v1_1_0/os/introduction" >
Version: 1.1.0
</option>
<option value="/v1_0_0/os/introduction" >
Version: 1.0.0
</option>
<option value="/v0_9_0/os/introduction" >
Version: 0.9.0
</option>
</select>
<div class="region region-sidebar">
<div class="docs-menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../get_started/index.html">Setup &amp; Get Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../concepts.html">Concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/tutorials.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../external_links.html">Third-party Resources</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../os/os_user_guide.html">OS User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../network/index.html">BLE User Guide</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Newt Tool Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../newt_operation.html">Theory of Operations</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../newt_ops.html">Command Structure</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="newt_build.html">newt build</a></li>
<li class="toctree-l3"><a class="reference internal" href="newt_clean.html">newt clean</a></li>
<li class="toctree-l3"><a class="reference internal" href="newt_complete.html">newt complete</a></li>
<li class="toctree-l3"><a class="reference internal" href="newt_create_image.html">newt create-image</a></li>
<li class="toctree-l3"><a class="reference internal" href="newt_debug.html">newt debug</a></li>
<li class="toctree-l3"><a class="reference internal" href="newt_help.html">newt help</a></li>
<li class="toctree-l3"><a class="reference internal" href="newt_info.html">newt info</a></li>
<li class="toctree-l3"><a class="reference internal" href="newt_install.html">newt install</a></li>
<li class="toctree-l3"><a class="reference internal" href="newt_load.html">newt load</a></li>
<li class="toctree-l3"><a class="reference internal" href="newt_mfg.html">newt mfg</a></li>
<li class="toctree-l3"><a class="reference internal" href="newt_new.html">newt new</a></li>
<li class="toctree-l3"><a class="reference internal" href="newt_pkg.html">newt pkg</a></li>
<li class="toctree-l3"><a class="reference internal" href="newt_resign_image.html">newt resign-image</a></li>
<li class="toctree-l3"><a class="reference internal" href="newt_run.html">newt run</a></li>
<li class="toctree-l3"><a class="reference internal" href="newt_size.html">newt size</a></li>
<li class="toctree-l3"><a class="reference internal" href="newt_sync.html">newt sync</a></li>
<li class="toctree-l3"><a class="reference internal" href="newt_target.html">newt target</a></li>
<li class="toctree-l3"><a class="reference internal" href="newt_test.html">newt test</a></li>
<li class="toctree-l3"><a class="reference internal" href="newt_upgrade.html">newt upgrade</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">newt vals</a></li>
<li class="toctree-l3"><a class="reference internal" href="newt_version.html">newt version</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../install/index.html">Install</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../newtmgr/index.html">Newt Manager Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../mynewt_faq/index.html">Mynewt FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../misc/index.html">Appendix</a></li>
</ul>
</div>
</div>
</div>
<!-- ENDS STICKY CONTAINER -->
</div>
<!-- ENDS .container-sidebar -->
<div class="col-xs-12 col-sm-9">
<div class="alert alert-warning">
<p>
Version 1.5.0 is not the most recent version of the
Apache Mynewt documentation. Click <a href="/latest">here</a> to
read the latest version.
</p>
</div>
<div class="">
<div class="rst-content">
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="newt-vals">
<h1>newt vals<a class="headerlink" href="#newt-vals" title="Permalink to this headline"></a></h1>
<p>Display valid values for the specified element type(s).</p>
<div class="section" id="usage">
<h2>Usage:<a class="headerlink" href="#usage" title="Permalink to this headline"></a></h2>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">newt vals &lt;element-type&gt; [element-types...] [flags]</span>
</pre></div>
</div>
</div>
<div class="section" id="global-flags">
<h2>Global Flags:<a class="headerlink" href="#global-flags" title="Permalink to this headline"></a></h2>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">-h, --help Help for newt commands</span>
<span class="go">-j, --jobs int Number of concurrent build jobs (default 8)</span>
<span class="go">-l, --loglevel string Log level (default &quot;WARN&quot;)</span>
<span class="go">-o, --outfile string Filename to tee output to</span>
<span class="go">-q, --quiet Be quiet; only display error output</span>
<span class="go">-s, --silent Be silent; don&#39;t output anything</span>
<span class="go">-v, --verbose Enable verbose output when executing commands</span>
</pre></div>
</div>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Displays valid values for the specified element type(s). You must set valid values for one or more elements when you define a package or a target. Valid element types are:</p>
<ul class="simple">
<li><p>api</p></li>
<li><p>app</p></li>
<li><p>bsp</p></li>
<li><p>build_profile</p></li>
<li><p>compiler</p></li>
<li><p>lib</p></li>
<li><p>sdk</p></li>
<li><p>target</p></li>
</ul>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<table class="docutils align-default">
<colgroup>
<col style="width: 8%" />
<col style="width: 92%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Usage</p></th>
<th class="head"><p>Explanation</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">newt</span> <span class="pre">vals</span> <span class="pre">api</span></code></p></td>
<td><p>Shows the possible values for APIs a package may specify as required. For example, the <code class="docutils literal notranslate"><span class="pre">pkg.yml</span></code> for <code class="docutils literal notranslate"><span class="pre">adc</span></code> specifies that it requires the api named <code class="docutils literal notranslate"><span class="pre">ADC_HW_IMPL</span></code>, one of the values listed by the command.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="example-output-for-newt-vals-bsp">
<h2>Example output for <code class="docutils literal notranslate"><span class="pre">newt</span> <span class="pre">vals</span> <span class="pre">bsp</span></code>:<a class="headerlink" href="#example-output-for-newt-vals-bsp" title="Permalink to this headline"></a></h2>
<p>This lists all possible values that may be assigned to a target’s bsp attribute.</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>newt<span class="w"> </span>vals<span class="w"> </span>bsp
<span class="go">bsp names:</span>
<span class="go"> @apache-mynewt-core/hw/bsp/arduino_primo_nrf52</span>
<span class="go"> @apache-mynewt-core/hw/bsp/bmd300eval</span>
<span class="go"> @apache-mynewt-core/hw/bsp/ci40</span>
<span class="go"> @apache-mynewt-core/hw/bsp/frdm-k64f</span>
<span class="go"> @apache-mynewt-core/hw/bsp/native</span>
<span class="go"> @apache-mynewt-core/hw/bsp/nrf51-arduino_101</span>
<span class="go"> @apache-mynewt-core/hw/bsp/nrf51-blenano</span>
<span class="go"> @apache-mynewt-core/hw/bsp/nrf51dk</span>
<span class="go"> @apache-mynewt-core/hw/bsp/nrf51dk-16kbram</span>
<span class="go"> @apache-mynewt-core/hw/bsp/nrf52dk</span>
<span class="go"> @apache-mynewt-core/hw/bsp/nucleo-f401re</span>
<span class="go"> @apache-mynewt-core/hw/bsp/olimex_stm32-e407_devboard</span>
<span class="go"> @apache-mynewt-core/hw/bsp/rb-nano2</span>
<span class="go"> @apache-mynewt-core/hw/bsp/stm32f4discovery</span>
<span class="gp">$ </span>newt<span class="w"> </span>target<span class="w"> </span><span class="nb">set</span><span class="w"> </span>sample_target<span class="w"> </span><span class="nv">bsp</span><span class="o">=</span>@apache-mynewt-core/hw/bsp/rb-nano2
</pre></div>
</div>
<p>Obviously, this output will grow as more board support packages are added for new boards and MCUs.</p>
</div>
</div>
</div>
</div>
<div class="rst-footer-buttons row" role="navigation" aria-label="footer navigation">
<a href="newt_version.html" class="btn btn-neutral float-right" title="newt version" accesskey="n">Next: newt version <span class="fa fa-arrow-circle-right"></span></a>
<a href="newt_upgrade.html" class="btn btn-neutral" title="newt upgrade" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous: newt upgrade</a>
</div>
</div>
</div>
</div>
<!-- ENDS CONTENT SECTION -->
</div>
<!-- ENDS .content -->
</div>
</div>
<footer>
<div class="container">
<div class="row">
<div class="col-xs-12">
<p class="copyright">Apache Mynewt is available under Apache License, version 2.0.</p>
</div>
<div class="col-xs-12">
<div class="logos">
<img src="../../_static/img/asf_logo_wide_small.png" alt="Apache" title="Apache">
<small class="footnote">
Apache Mynewt, Mynewt, Apache, the Apache feather logo, and the Apache Mynewt project logo are either
registered trademarks or trademarks of the Apache Software Foundation in the United States and other countries.
</small>
<a href="">
<img src="../../_static/img/add_to_slack.png" alt="Slack Icon" title="Join our Slack Community" />
</a>
</div>
</div>
</div>
</div>
</footer>
</div>
<!-- ENDS #wrapper -->
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'latest',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt',
LINK_SUFFIX: '.html'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/js/bootstrap-3.0.3.min.js"></script>
<script type="text/javascript" src="../../_static/js/affix.js"></script>
<script type="text/javascript" src="../../_static/js/main.js"></script>
</body>
</html>