Google Git
Sign in
apache / mynewt-site / refs/heads/asf-site / . / v1_1_0 / os / modules / shell / shell_register / index.html
blob: a3f7784100dc41328c0dbf4e89c6cdd6ade91431 [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">
<!-- This is broken by doc revisioning.
-->
<link rel="shortcut icon" href="../../../../img/favicon.ico">
<title>shell_register - 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">
<!-- 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="shell_register">
<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.12.0, Apache NimBLE 1.7.0 </a> released (April 4, 2024)
</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="/documentation/">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>
</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="/latest">
Version: master
</option>
<option value="/v1_12_0/" >
Version: 1.12.0
</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/" >
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" selected="selected" >
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></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="../../../core_os/mynewt_os/">OS Core</a>
</li>
<li ><a href="../../../core_os/porting/port_os/">Porting to your Platform</a>
</li>
<li ><a href="../../console/console/">Console</a>
</li>
<li ><a href="../shell/">Shell</a>
<ul>
<li><a href="
../shell_cmd_register/
">Functions</a>
<ul>
<li >
<a href="../shell_cmd_register/">shell_cmd_register</a>
</li>
<li >
<a href="../shell_evq_set/">shell_evq_set</a>
</li>
<li >
<a href="../shell_nlip_input_register/">shell_nlip_input_register</a>
</li>
<li >
<a href="../shell_nlip_output/">shell_nlip_output</a>
</li>
<li class="active">
<a href="./">shell_register</a>
</li>
<li >
<a href="../shell_register_app_cmd_handler/">shell_register_app_cmd_handler</a>
</li>
<li >
<a href="../shell_register_default_module/">shell_register_default_module</a>
</li>
</ul>
</li>
</ul>
</li>
<li ><a href="../../split/split/">Split Images</a>
</li>
<li ><a href="../../bootloader/bootloader/">Bootloader</a>
</li>
<li><a href="
../../fs/fs/fs/
">File System</a>
</li>
<li ><a href="../../hal/hal/">Hardware Abstraction Layer</a>
</li>
<li ><a href="../../sensor_framework/sensor_framework_overview/">Sensor Framework</a>
</li>
<li ><a href="../../drivers/driver/">Drivers</a>
</li>
<li ><a href="../../testutil/testutil/">Test Utilities</a>
</li>
<li ><a href="../../devmgmt/newtmgr/">Device Management with Newt Manager</a>
</li>
<li ><a href="../../imgmgr/imgmgr/">Image Manager</a>
</li>
<li >
<a href="../../baselibc/">Baselibc library</a>
</li>
<li ><a href="../../json/json/">JSON</a>
</li>
<li ><a href="../../fcb/fcb/">Flash Circular Buffer</a>
</li>
<li ><a href="../../stats/stats/">Stats</a>
</li>
<li ><a href="../../logs/logs/">Logs</a>
</li>
<li ><a href="../../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>
<li >
<a href="../../../../known_issues/">Known Issues</a>
</li>
</ul>
</li>
<li><a href="
../../../../faq/go_env/
">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">
<li><a href="/documentation/">Docs</a></li>
<li>&raquo; <a href="os/modules/shell/shell_cmd_register/">Functions</a></li>
<li>&raquo; <a href="os/modules/shell/shell/">Shell</a></li>
<li>&raquo; <a href="os/os_user_guide/">OS User Guide</a></li>
<li>&raquo; <a href="os/introduction/">Mynewt Documentation</a></li>
<li>&raquo; shell_register</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/apache/mynewt-site/blob/master/docs/os/modules/shell/shell_register.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
</div>
</div>
<div class="alert alert-warning">
<p>
Version 1.1.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>
<h2 id="shell_register"><font color="#F2853F" style="font-size:24pt"> shell_register </font></h2>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code><span style="color: #000000">shell_register</span>(<span style="color: #A90D91">const</span> <span style="color: #A90D91">char</span> <span style="color: #000000">*module_name</span>, <span style="color: #A90D91">const</span> <span style="color: #A90D91">struct</span> <span style="color: #3F6E75">shell_cmd</span> <span style="color: #000000">*commands</span>)
</code></pre></div>
<p>Registers a module named <code>module_name</code> and the commands that the module supports. The caller must allocate and not free the memory for the <code>module_name</code> and the array of <code>shell_cmd</code> structures for the command. The shell keeps references to these structures for internal use. </p>
<p>Each entry in the <code>commands</code> array specifies a shell command for the module and must be initialized with the command name and the pointer to the command handler. The help field is initialized with help information if the command supports help.</p>
<h4 id="arguments">Arguments</h4>
<table>
<thead>
<tr>
<th>Arguments</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>module_name</code></td>
<td>Character string of the module name.</td>
</tr>
<tr>
<td><code>commands</code></td>
<td>Array of <code>shell_cmd</code> structures that specify the commands for the module. The <code>sc_cmd</code>, <code>sc_cmd_func</code>, and <code>help</code> fields in the last entry must be set to NULL to indicate the last entry in the array.</td>
</tr>
</tbody>
</table>
<h4 id="returned-values">Returned values</h4>
<p>Returns 0 on success.</p>
<p>Non-zero on failure.
<br></p>
<h4 id="notes">Notes</h4>
<p>The <code>SHELL_MAX_MODULES</code> syscfg setting specifies the maximum number of modules the shell supports. This function aborts if the number of registered modules exceeds this limit. You can increase the value for this setting.
<br></p>
<h4 id="example">Example</h4>
<p>This is an example excerpt that shows how to declare and initialize the data structures for a module and some shell commands for the. Variables for the help structures are only declared and intialized if the <code>SHELL_CMD_HELP</code> syscfg setting is enabled. The <code>sample_commands</code> array of <code>shell_cmd</code> structures are declared and initialized. The fields in the last entry are all set to NULL to indicate the last entry in the array.</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code><span style="color: #A90D91">static</span> <span style="color: #A90D91">int</span> <span style="color: #000000">shell_sample_tasks_display_cmd</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">static</span> <span style="color: #A90D91">int</span> <span style="color: #000000">shell_sample_mpool_display_cmd</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">static</span> <span style="color: #A90D91">const</span> <span style="color: #A90D91">char</span> <span style="color: #000000">*sample_module</span> <span style="color: #000000">=</span> <span style="color: #C41A16">&quot;sample_module&quot;</span>;
<span style="color: #177500">/* </span>
<span style="color: #177500"> * Initialize param and command help information if SHELL_CMD_HELP </span>
<span style="color: #177500"> * is enabled.</span>
<span style="color: #177500"> */</span>
<span style="color: #633820">#if MYNEWT_VAL(SHELL_CMD_HELP)</span>
<span style="color: #A90D91">static</span> <span style="color: #A90D91">const</span> <span style="color: #A90D91">struct</span> <span style="color: #3F6E75">shell_param</span> <span style="color: #000000">sample_tasks_params</span>[] <span style="color: #000000">=</span> {
{<span style="color: #C41A16">&quot;&quot;</span>, <span style="color: #C41A16">&quot;task name&quot;</span>},
{<span style="color: #A90D91">NULL</span>, <span style="color: #A90D91">NULL</span>}
};
<span style="color: #A90D91">static</span> <span style="color: #A90D91">const</span> <span style="color: #A90D91">struct</span> <span style="color: #3F6E75">shell_cmd_help</span> <span style="color: #000000">sample_tasks_help</span> <span style="color: #000000">=</span> {
.<span style="color: #000000">summary</span> <span style="color: #000000">=</span> <span style="color: #C41A16">&quot;show tasks info&quot;</span>,
.<span style="color: #000000">usage</span> <span style="color: #000000">=</span> <span style="color: #A90D91">NULL</span>,
.<span style="color: #000000">params</span> <span style="color: #000000">=</span> <span style="color: #000000">sample_tasks_params</span>,
};
<span style="color: #A90D91">static</span> <span style="color: #A90D91">const</span> <span style="color: #A90D91">struct</span> <span style="color: #3F6E75">shell_param</span> <span style="color: #000000">sample_mpool_params</span>[] <span style="color: #000000">=</span> {
{<span style="color: #C41A16">&quot;&quot;</span>, <span style="color: #C41A16">&quot;mpool name&quot;</span>},
{<span style="color: #A90D91">NULL</span>, <span style="color: #A90D91">NULL</span>}
};
<span style="color: #A90D91">static</span> <span style="color: #A90D91">const</span> <span style="color: #A90D91">struct</span> <span style="color: #3F6E75">shell_cmd_help</span> <span style="color: #000000">sample_mpool_help</span> <span style="color: #000000">=</span> {
.<span style="color: #000000">summary</span> <span style="color: #000000">=</span> <span style="color: #C41A16">&quot;show system mpool&quot;</span>,
.<span style="color: #000000">usage</span> <span style="color: #000000">=</span> <span style="color: #A90D91">NULL</span>,
.<span style="color: #000000">params</span> <span style="color: #000000">=</span> <span style="color: #000000">sample_mpool_params</span>,
};
<span style="color: #633820">#endif </span>
<span style="color: #177500">/* </span>
<span style="color: #177500"> * Initialize an array of shell_cmd structures for the commands</span>
<span style="color: #177500"> * in the os module.</span>
<span style="color: #177500"> */</span>
<span style="color: #A90D91">static</span> <span style="color: #A90D91">const</span> <span style="color: #A90D91">struct</span> <span style="color: #3F6E75">shell_cmd</span> <span style="color: #000000">sample_module_commands</span>[] <span style="color: #000000">=</span> {
{
.<span style="color: #000000">sc_cmd</span> <span style="color: #000000">=</span> <span style="color: #C41A16">&quot;tasks&quot;</span>,
.<span style="color: #000000">sc_cmd_func</span> <span style="color: #000000">=</span> <span style="color: #000000">shell_sample_tasks_display_cmd</span>,
<span style="color: #633820">#if MYNEWT_VAL(SHELL_CMD_HELP)</span>
.<span style="color: #000000">help</span> <span style="color: #000000">=</span> <span style="color: #000000">&amp;sample_tasks_help</span>,
<span style="color: #633820">#endif</span>
},
{
.<span style="color: #000000">sc_cmd</span> <span style="color: #000000">=</span> <span style="color: #C41A16">&quot;sample_mpool&quot;</span>,
.<span style="color: #000000">sc_cmd_func</span> <span style="color: #000000">=</span> <span style="color: #000000">shell_sample_mpool_display_cmd</span>,
<span style="color: #633820">#if MYNEWT_VAL(SHELL_CMD_HELP)</span>
.<span style="color: #000000">help</span> <span style="color: #000000">=</span> <span style="color: #000000">&amp;sample_mpool_help</span>,
<span style="color: #633820">#endif</span>
},
{ <span style="color: #A90D91">NULL</span>, <span style="color: #A90D91">NULL</span>, <span style="color: #A90D91">NULL</span> },
};
<span style="color: #A90D91">void</span>
<span style="color: #000000">sample_module_init</span>(<span style="color: #A90D91">void</span>)
{
<span style="color: #000000">shell_register</span>(<span style="color: #000000">sample_module</span>, <span style="color: #000000">sample_module_commands</span>);
}
</code></pre></div>
<div class="row">
<ul class="nav nav-pills" style="margin-bottom: 10px">
<li>
</li>
<li class="pull-right">
</li>
</ul>
</div>
<footer 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">
<a href="https://www.apache.org/">
<img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache">
</a>
<p>
Copyright © 2015-2021 The Apache Software Foundation.<br>
<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>
</p>
<a href="">
<img src="https://www.countit.com/images/add_to_slack.png" alt="Slack Icon" title="Join our Slack Community" />
</a>
</div>
</div>
<a href="https://www.apache.org/licenses/">
<button class="button-footer-asf">
License
</button>
</a>
<a href="https://www.apache.org/foundation/sponsorship.html">
<button class="button-footer-asf">
Sponsorship
</button>
</a>
<a href="https://www.apache.org/foundation/thanks.html">
<button class="button-footer-asf">
Thanks
</button>
</a>
<a href="https://www.apache.org/security/">
<button class="button-footer-asf">
Security
</button>
</a>
<a href="https://apache.org/events/current-event">
<button class="button-footer-asf">
ASF Events
</button>
</a>
</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>
<script src="search/main.js"></script>
</body>
</html>