| <!-- |
| Documentation/_templates/layout.html |
| |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. The |
| ASF licenses this file to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance with the |
| License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| License for the specific language governing permissions and limitations |
| under the License. |
| --> |
| |
| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" > |
| <head> |
| <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>Commands — NuttX latest documentation</title> |
| <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> |
| <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../_static/copybutton.css" type="text/css" /> |
| <link rel="stylesheet" href="../../_static/tabs.css" type="text/css" /> |
| <link rel="stylesheet" href="../../_static/custom.css" type="text/css" /> |
| <link rel="shortcut icon" href="../../_static/favicon.ico"/> |
| <!--[if lt IE 9]> |
| <script src="../../_static/js/html5shiv.min.js"></script> |
| <![endif]--> |
| |
| <script src="../../_static/jquery.js"></script> |
| <script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script> |
| <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> |
| <script src="../../_static/doctools.js"></script> |
| <script src="../../_static/sphinx_highlight.js"></script> |
| <script src="../../_static/clipboard.min.js"></script> |
| <script src="../../_static/copybutton.js"></script> |
| <script src="../../_static/js/theme.js"></script> |
| <link rel="index" title="Index" href="../../genindex.html" /> |
| <link rel="search" title="Search" href="../../search.html" /> |
| <link rel="next" title="Configuring a Wireless Network" href="wireless.html" /> |
| <link rel="prev" title="WAPI (Wireless API)" href="index.html" /> |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| <div class="wy-grid-for-nav"> |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| <a href="../../index.html" class="icon icon-home"> NuttX |
| |
| |
| |
| </a> |
| |
| <!-- this version selector is quite ugly, should be probably replaced by something |
| more modern --> |
| |
| <div class="version-selector"> |
| <select onchange="javascript:location.href = this.value;"> |
| |
| <option value="../../../latest" selected="selected">latest</option> |
| |
| <option value="../../../10.0.0" >10.0.0</option> |
| |
| <option value="../../../10.0.1" >10.0.1</option> |
| |
| <option value="../../../10.1.0" >10.1.0</option> |
| |
| <option value="../../../10.2.0" >10.2.0</option> |
| |
| <option value="../../../10.3.0" >10.3.0</option> |
| |
| <option value="../../../11.0.0" >11.0.0</option> |
| |
| <option value="../../../12.0.0" >12.0.0</option> |
| |
| <option value="../../../12.1.0" >12.1.0</option> |
| |
| <option value="../../../12.2.0" >12.2.0</option> |
| |
| <option value="../../../12.2.1" >12.2.1</option> |
| |
| <option value="../../../12.3.0" >12.3.0</option> |
| |
| <option value="../../../12.4.0" >12.4.0</option> |
| |
| <option value="../../../12.5.0" >12.5.0</option> |
| |
| <option value="../../../12.5.1" >12.5.1</option> |
| |
| </select> |
| </div> |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> |
| <p class="caption" role="heading"><span class="caption-text">Table of Contents</span></p> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../contributing/index.html">Contributing</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../platforms/index.html">Supported Platforms</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="../index.html">Applications</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="../nsh/index.html">NuttShell (NSH)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../nxdiag/index.html">NuttX Diagnostic Tool (Nxdiag)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../nxdiag/index.html#usage">Usage</a></li> |
| <li class="toctree-l2 current"><a class="reference internal" href="index.html">WAPI (Wireless API)</a><ul class="current"> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">Commands</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#arguments">Arguments</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#ifname"><code class="docutils literal notranslate"><span class="pre"><ifname></span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#index-flag"><code class="docutils literal notranslate"><span class="pre"><index/flag></span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="wireless.html">Configuring a Wireless Network</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../../reference/index.html">API Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../guides/index.html">Guides</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li> |
| </ul> |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../../index.html">NuttX</a> |
| </nav> |
| |
| <div class="wy-nav-content"> |
| <div class="rst-content"> |
| <div role="navigation" aria-label="Page navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="../../index.html" class="icon icon-home" aria-label="Home"></a></li> |
| <li class="breadcrumb-item"><a href="../index.html">Applications</a></li> |
| <li class="breadcrumb-item"><a href="index.html">WAPI (Wireless API)</a></li> |
| <li class="breadcrumb-item active">Commands</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="../../_sources/applications/wapi/commands.rst.txt" rel="nofollow"> View page source</a> |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <section id="commands"> |
| <h1>Commands<a class="headerlink" href="#commands" title="Permalink to this heading"></a></h1> |
| <p>This page shows <code class="docutils literal notranslate"><span class="pre">wapi</span></code> commands, their arguments and outputs. For a |
| complete list of <code class="docutils literal notranslate"><span class="pre">wapi</span></code> commands available to the system, just run |
| <code class="docutils literal notranslate"><span class="pre">wapi</span></code>:</p> |
| <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>nsh> wapi |
| Usage: |
| wapi show <ifname> |
| wapi scan <ifname> |
| wapi scan_results <ifname> |
| wapi ip <ifname> <IP address> |
| wapi mask <ifname> <mask> |
| wapi freq <ifname> <frequency> <index/flag> |
| wapi essid <ifname> <essid> <index/flag> |
| wapi psk <ifname> <passphrase> <index/flag> <wpa> |
| wapi disconnect <ifname> |
| wapi mode <ifname> <index/mode> |
| wapi ap <ifname> <MAC address> |
| wapi bitrate <ifname> <bitrate> <index/flag> |
| wapi txpower <ifname> <txpower> <index/flag> |
| wapi country <ifname> <country code> |
| wapi sense <ifname> |
| wapi pta_prio <ifname> <index/flag> |
| wapi help |
| |
| Frequency Flags: |
| [0] WAPI_FREQ_AUTO |
| [1] WAPI_FREQ_FIXED |
| |
| ESSID Flags: |
| [0] WAPI_ESSID_OFF |
| [1] WAPI_ESSID_ON |
| |
| Passphrase algorithm Flags: |
| [0] WPA_ALG_NONE |
| [1] WPA_ALG_WEP |
| [2] WPA_ALG_TKIP |
| [3] WPA_ALG_CCMP |
| |
| Passphrase WPA version: |
| [0] WPA_VER_NONE |
| [1] WPA_VER_1 |
| [2] WPA_VER_2 |
| [3] WPA_VER_3 |
| |
| Operating Modes: |
| [0] WAPI_MODE_AUTO |
| [1] WAPI_MODE_ADHOC |
| [2] WAPI_MODE_MANAGED |
| [3] WAPI_MODE_MASTER |
| [4] WAPI_MODE_REPEAT |
| [5] WAPI_MODE_SECOND |
| [6] WAPI_MODE_MONITOR |
| [7] WAPI_MODE_MESH |
| |
| Bitrate Flags: |
| [0] WAPI_BITRATE_AUTO |
| [1] WAPI_BITRATE_FIXED |
| |
| TX power Flags: |
| [0] WAPI_TXPOWER_DBM |
| [1] WAPI_TXPOWER_MWATT |
| [2] WAPI_TXPOWER_RELATIVE |
| |
| pta prio Flags: |
| [0] WAPI_PTA_PRIORITY_COEX_MAXIMIZED |
| [1] WAPI_PTA_PRIORITY_COEX_HIGH |
| [2] WAPI_PTA_PRIORITY_BALANCED |
| [3] WAPI_PTA_PRIORITY_WLAN_HIGHD |
| [4] WAPI_PTA_PRIORITY_WLAN_MAXIMIZED |
| </pre></div> |
| </div> |
| <section id="arguments"> |
| <h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this heading"></a></h2> |
| <p>Command’s arguments are available on <code class="docutils literal notranslate"><span class="pre">wapi</span></code>’s usage helper.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p><code class="docutils literal notranslate"><span class="pre"><></span></code> means a required argument and <code class="docutils literal notranslate"><span class="pre">[]</span></code> an optional one.</p> |
| </div> |
| <p>A short explanation of them follows:</p> |
| <section id="ifname"> |
| <h3><code class="docutils literal notranslate"><span class="pre"><ifname></span></code><a class="headerlink" href="#ifname" title="Permalink to this heading"></a></h3> |
| <p>The interface name is arch-dependent and it’s usually set for a specific |
| operating mode. For instance, <code class="docutils literal notranslate"><span class="pre">wlan0</span></code> would be an interface used for STA |
| mode and <code class="docutils literal notranslate"><span class="pre">wlan1</span></code> for SoftAP.</p> |
| <p>Please refer to the <a class="reference internal" href="../../platforms/index.html"><span class="doc">Supported Platforms</span></a> for |
| platform-specific definitions. As an example, please check |
| <a class="reference internal" href="../../platforms/xtensa/esp32/index.html#esp32-wi-fi-sta"><span class="std std-ref">ESP32 Wi-Fi Station Mode</span></a> and |
| <a class="reference internal" href="../../platforms/xtensa/esp32/index.html#esp32-wi-fi-softap"><span class="std std-ref">ESP32 Wi-Fi SoftAP Mode</span></a> Wi-Fi sections.</p> |
| </section> |
| <section id="index-flag"> |
| <h3><code class="docutils literal notranslate"><span class="pre"><index/flag></span></code><a class="headerlink" href="#index-flag" title="Permalink to this heading"></a></h3> |
| <p>The <code class="docutils literal notranslate"><span class="pre"><index/flag></span></code> can be used as a numerical or textual value. For |
| instance, considering the <code class="docutils literal notranslate"><span class="pre">wapi</span> <span class="pre">psk</span></code> command, one could use indistinctly:</p> |
| <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>nsh> wapi psk wlan0 mypasswd 3 |
| nsh> wapi psk wlan0 mypasswd WPA_ALG_CCMP |
| </pre></div> |
| </div> |
| </section> |
| </section> |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="index.html" class="btn btn-neutral float-left" title="WAPI (Wireless API)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="wireless.html" class="btn btn-neutral float-right" title="Configuring a Wireless Network" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright 2020, The Apache Software Foundation.</p> |
| </div> |
| |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| <script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
