mirror of
https://github.com/openwrt/luci.git
synced 2026-04-15 19:01:56 +00:00
3 lines
62 KiB
HTML
3 lines
62 KiB
HTML
<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="icon" href="themes/luci-theme-bootstrap/htdocs/luci-static/bootstrap/logo.svg"><link type="text/css" rel="stylesheet" href="extra.css"><title>Class: WifiNetwork</title><!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="fallback-dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">LuCI Documentation</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-JsonRpcHowTo.html">Using JSON RPC daemon</a></div><div class="sidebar-section-children"><a href="tutorial-Modules.html">Modules</a></div><div class="sidebar-section-children"><a href="tutorial-ThemesHowTo.html">Making Themes</a></div><div class="sidebar-section-children"><a href="tutorial-i18n.html">Internationalisation - i18n</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="LuCI.module_cbi.html">cbi</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="LuCI.html">LuCI</a></div><div class="sidebar-section-children"><a href="LuCI.baseclass.html">baseclass</a></div><div class="sidebar-section-children"><a href="LuCI.dom.html">dom</a></div><div class="sidebar-section-children"><a href="LuCI.form.html">form</a></div><div class="sidebar-section-children"><a href="LuCI.form.AbstractElement.html">AbstractElement</a></div><div class="sidebar-section-children"><a href="LuCI.form.AbstractSection.html">AbstractSection</a></div><div class="sidebar-section-children"><a href="LuCI.form.AbstractValue.html">AbstractValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.Button.html">Button</a></div><div class="sidebar-section-children"><a href="LuCI.form.DirectoryPicker.html">DirectoryPicker</a></div><div class="sidebar-section-children"><a href="LuCI.form.DummyValue.html">DummyValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.DynamicList.html">DynamicList</a></div><div class="sidebar-section-children"><a href="LuCI.form.FileUpload.html">FileUpload</a></div><div class="sidebar-section-children"><a href="LuCI.form.Flag.html">Flag</a></div><div class="sidebar-section-children"><a href="LuCI.form.GridSection.html">GridSection</a></div><div class="sidebar-section-children"><a href="LuCI.form.HiddenValue.html">HiddenValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.JSONMap.html">JSONMap</a></div><div class="sidebar-section-children"><a href="LuCI.form.ListValue.html">ListValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.Map.html">Map</a></div><div class="sidebar-section-children"><a href="LuCI.form.MultiValue.html">MultiValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.NamedSection.html">NamedSection</a></div><div class="sidebar-section-children"><a href="LuCI.form.RangeSliderValue.html">RangeSliderValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.RichListValue.html">RichListValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.SectionValue.html">SectionValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.TableSection.html">TableSection</a></div><div class="sidebar-section-children"><a href="LuCI.form.TextValue.html">TextValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.TypedSection.html">TypedSection</a></div><div class="sidebar-section-children"><a href="LuCI.form.Value.html">Value</a></div><div class="sidebar-section-children"><a href="LuCI.fs.html">fs</a></div><div class="sidebar-section-children"><a href="LuCI.headers.html">headers</a></div><div class="sidebar-section-children"><a href="LuCI.network.html">network</a></div><div class="sidebar-section-children"><a href="LuCI.network.Device.html">Device</a></div><div class="sidebar-section-children"><a href="LuCI.network.Hosts.html">Hosts</a></div><div class="sidebar-section-children"><a href="LuCI.network.Protocol.html">Protocol</a></div><div class="sidebar-section-children"><a href="LuCI.network.WifiDevice.html">WifiDevice</a></div><div class="sidebar-section-children"><a href="LuCI.network.WifiNetwork.html">WifiNetwork</a></div><div class="sidebar-section-children"><a href="LuCI.network.WifiVlan.html">WifiVlan</a></div><div class="sidebar-section-children"><a href="LuCI.poll.html">poll</a></div><div class="sidebar-section-children"><a href="LuCI.request.html">request</a></div><div class="sidebar-section-children"><a href="LuCI.request.poll.html">poll</a></div><div class="sidebar-section-children"><a href="LuCI.response.html">response</a></div><div class="sidebar-section-children"><a href="LuCI.rpc.html">rpc</a></div><div class="sidebar-section-children"><a href="LuCI.session.html">session</a></div><div class="sidebar-section-children"><a href="LuCI.uci.html">uci</a></div><div class="sidebar-section-children"><a href="LuCI.ui.html">ui</a></div><div class="sidebar-section-children"><a href="LuCI.ui.AbstractElement.html">AbstractElement</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Checkbox.html">Checkbox</a></div><div class="sidebar-section-children"><a href="LuCI.ui.ComboButton.html">ComboButton</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Combobox.html">Combobox</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Dropdown.html">Dropdown</a></div><div class="sidebar-section-children"><a href="LuCI.ui.DynamicList.html">DynamicList</a></div><div class="sidebar-section-children"><a href="LuCI.ui.FileUpload.html">FileUpload</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Hiddenfield.html">Hiddenfield</a></div><div class="sidebar-section-children"><a href="LuCI.ui.RangeSlider.html">RangeSlider</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Select.html">Select</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Textarea.html">Textarea</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Textfield.html">Textfield</a></div><div class="sidebar-section-children"><a href="LuCI.ui.changes.html">changes</a></div><div class="sidebar-section-children"><a href="LuCI.ui.menu.html">menu</a></div><div class="sidebar-section-children"><a href="LuCI.ui.tabs.html">tabs</a></div><div class="sidebar-section-children"><a href="LuCI.validation.html">validation</a></div><div class="sidebar-section-children"><a href="LuCI.validation.Validator.html">Validator</a></div><div class="sidebar-section-children"><a href="LuCI.validation.ValidatorFactory.html">ValidatorFactory</a></div><div class="sidebar-section-children"><a href="LuCI.view.html">view</a></div><div class="sidebar-section-children"><a href="LuCI.xhr.html">xhr</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-externals"><div>Externals</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="external-String.html">String</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="github-home navbar-item"><a id="" href="https://github.com/openwrt/luci" target="">GitHub Project Page</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section><header><h1 id="WifiNetwork-title" class="has-anchor"><span class="ancestors"><a href="LuCI.html">LuCI</a><a href="LuCI.network.html">.network</a>.</span> WifiNetwork</h1><div class="class-description"><p>A <code>Network.WifiNetwork</code> instance represents a wireless network (vif) configured on top of a radio device and provides functions for querying the runtime state of the network. Most radio devices support multiple such networks in parallel.</p></div></header><article><div class="container-overview"><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line3700">line 3700</a></li></ul></dd></div></dl></div><h2 id="methods" class="subsection-title has-anchor">Methods</h2><h3 class="name has-anchor" id="disconnectClient"><span class="type-signature"></span>disconnectClient<span class="signature">(mac, deauth<span class="signature-attributes">opt</span>, reason<span class="signature-attributes">opt</span>, ban_time<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<number>}</span></h3><div class="description"><p>Forcibly disconnect the given client from the wireless network.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>mac</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The MAC address of the client to disconnect.</p></td></tr><tr><td class="name"><code>deauth</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="default">false</td><td class="description last"><p>Specifies whether to de-authenticate (<code>true</code>) or disassociate (<code>false</code>) the client.</p></td></tr><tr><td class="name"><code>reason</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">1</td><td class="description last"><p>Specifies the IEEE 802.11 reason code to disassoc/deauth the client with. Default is <code>1</code> which corresponds to <code>Unspecified reason</code>.</p></td></tr><tr><td class="name"><code>ban_time</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">0</td><td class="description last"><p>Specifies the number of milliseconds to ban the client from reconnecting. By default, no ban time is set which allows the client to re-associate / reauthenticate immediately.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line4525">line 4525</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns a promise resolving to the underlying ubus call result code which is typically <code>0</code>, even for not existing MAC addresses. The promise might reject with an error in case invalid arguments are passed.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<number></span></dd></dl></div><h3 class="name has-anchor" id="get"><span class="type-signature"></span>get<span class="signature">(opt)</span><span class="type-signature"> → {null|string|Array.<string>}</span></h3><div class="description"><p>Read the given UCI option value of this wireless network.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>opt</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>The UCI option name to read.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line3734">line 3734</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns the UCI option value or <code>null</code> if the requested option is not found.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">null</span> |<wbr> <span class="param-type">string</span> |<wbr> <span class="param-type">Array.<string></span></dd></dl></div><h3 class="name has-anchor" id="getActiveBSSID"><span class="type-signature"></span>getActiveBSSID<span class="signature">()</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Query the current BSSID from runtime information.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line4011">line 4011</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns the current BSSID or Mesh ID as reported by <code>ubus</code> runtime information.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="getActiveEncryption"><span class="type-signature"></span>getActiveEncryption<span class="signature">()</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Query the current encryption settings from runtime information.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line4022">line 4022</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns a string describing the current encryption or <code>-</code> if the encryption state could not be found in <code>ubus</code> runtime information.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="getActiveMode"><span class="type-signature"></span>getActiveMode<span class="signature">()</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Query the current operation mode from runtime information.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line3954">line 3954</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns the human readable mode name as reported by iwinfo or uci mode. Possible returned values are:</p><ul><li><code>Master</code></li><li><code>Ad-Hoc</code></li><li><code>Client</code></li><li><code>Monitor</code></li><li><code>Master (VLAN)</code></li><li><code>WDS</code></li><li><code>Mesh Point</code></li><li><code>P2P Client</code></li><li><code>P2P Go</code></li><li><code>Unknown</code></li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="getActiveModeI18n"><span class="type-signature"></span>getActiveModeI18n<span class="signature">()</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Query the current operation mode from runtime information as translated string.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line3975">line 3975</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns the translated, human readable mode name as reported by <code>ubus</code> runtime state.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="getActiveSSID"><span class="type-signature"></span>getActiveSSID<span class="signature">()</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Query the current SSID from runtime information.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line4000">line 4000</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns the current SSID or Mesh ID as reported by <code>ubus</code> runtime information.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="getAssocList"><span class="type-signature"></span>getAssocList<span class="signature">()</span><span class="type-signature"> → {Promise.<Array.<<a href="LuCI.network.html#.WifiPeerEntry">LuCI.network.WifiPeerEntry</a>>>}</span></h3><div class="description"><p>Fetch the list of associated peers.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line4224">line 4224</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns a promise resolving to an array of wireless peers associated with this network.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<Array.<<a href="LuCI.network.html#.WifiPeerEntry">LuCI.network.WifiPeerEntry</a>>></span></dd></dl></div><h3 class="name has-anchor" id="getBSSID"><span class="type-signature"></span>getBSSID<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h3><div class="description"><p>Get the configured BSSID of the wireless network.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line3814">line 3814</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns the BSSID value or <code>null</code> if none has been specified.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">null</span> |<wbr> <span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="getBitRate"><span class="type-signature"></span>getBitRate<span class="signature">()</span><span class="type-signature"> → {null|number}</span></h3><div class="description"><p>Query the current average bit-rate of all peers associated with this wireless network.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line4288">line 4288</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns the average bit rate among all peers associated with the network as reported by <code>ubus</code> runtime information or <code>null</code> if the information is not available.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">null</span> |<wbr> <span class="param-type">number</span></dd></dl></div><h3 class="name has-anchor" id="getChannel"><span class="type-signature"></span>getChannel<span class="signature">()</span><span class="type-signature"> → {null|number}</span></h3><div class="description"><p>Query the current wireless channel.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line4304">line 4304</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns the wireless channel as reported by <code>ubus</code> runtime information or <code>null</code> if it cannot be determined.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">null</span> |<wbr> <span class="param-type">number</span></dd></dl></div><h3 class="name has-anchor" id="getCountryCode"><span class="type-signature"></span>getCountryCode<span class="signature">()</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Query the current country code.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line4337">line 4337</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns the wireless country code as reported by <code>ubus</code> runtime information or <code>00</code> if it cannot be determined.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="getDevice"><span class="type-signature"></span>getDevice<span class="signature">()</span><span class="type-signature"> → {<a href="LuCI.network.Device.html">LuCI.network.Device</a>}</span></h3><div class="description"><p>Get the associated Linux network device.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line4485">line 4485</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns a <code>Network.Device</code> instance representing the Linux network device associated with this wireless network.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type"><a href="LuCI.network.Device.html">LuCI.<wbr>network.<wbr>Device</a></span></dd></dl></div><h3 class="name has-anchor" id="getFrequency"><span class="type-signature"></span>getFrequency<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h3><div class="description"><p>Query the current operating frequency of the wireless network.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line4270">line 4270</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns the current operating frequency of the network from <code>ubus</code> runtime information in GHz or <code>null</code> if the information is not available.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">null</span> |<wbr> <span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="getI18n"><span class="type-signature"></span>getI18n<span class="signature">()</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Get a description string for this wireless network.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line4433">line 4433</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns a string describing this network, consisting of the term <code>Wireless Network</code>, followed by the active operation mode, the SSID, BSSID or internal network ID and the Linux network device name, depending on which information is available.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="getID"><span class="type-signature"></span>getID<span class="signature">()</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Get the internal network ID of this wireless network.</p><p>The network ID is a LuCI specific identifier in the form <code>radio#.network#</code> to identify wireless networks by their corresponding radio and network index numbers.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line3839">line 3839</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns the LuCI specific network ID.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="getIfname"><span class="type-signature"></span>getIfname<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h3><div class="description"><p>Get the Linux network device name.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line3861">line 3861</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns the current Linux network device name as resolved from <code>ubus</code> runtime information or <code>null</code> if this network has no associated network device, e.g. when not configured or up.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">null</span> |<wbr> <span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="getMeshID"><span class="type-signature"></span>getMeshID<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h3><div class="description"><p>Get the configured Mesh ID of the wireless network.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line3801">line 3801</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns the configured mesh ID value or <code>null</code> when this network is not in mesh mode.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">null</span> |<wbr> <span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="getMode"><span class="type-signature"></span>getMode<span class="signature">()</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Get the configured operation mode of the wireless network.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line3776">line 3776</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns the configured operation mode. Possible values are:</p><ul><li><code>ap</code> - Master (Access Point) mode</li><li><code>sta</code> - Station (client) mode</li><li><code>adhoc</code> - Ad-Hoc (IBSS) mode</li><li><code>mesh</code> - Mesh (IEEE 802.11s) mode</li><li><code>monitor</code> - Monitor mode</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="getName"><span class="type-signature"></span>getName<span class="signature">()</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Get the configuration ID of this wireless network.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line3849">line 3849</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns the corresponding UCI section ID of the network.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="getNetwork"><span class="type-signature"></span>getNetwork<span class="signature">()</span><span class="type-signature"> → {null|<a href="LuCI.network.Protocol.html">LuCI.network.Protocol</a>}</span></h3><div class="description"><p>Get the primary logical interface this network is attached to.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line4449">line 4449</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns a <code>Network.Protocol</code> instance representing the logical interface or <code>null</code> if this network is not attached to any logical interface.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">null</span> |<wbr> <span class="param-type"><a href="LuCI.network.Protocol.html">LuCI.<wbr>network.<wbr>Protocol</a></span></dd></dl></div><h3 class="name has-anchor" id="getNetworkNames"><span class="type-signature"></span>getNetworkNames<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h3><div class="description"><p>Get the names of the logical interfaces this wireless network is attached to.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line3825">line 3825</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns an array of logical interface names.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Array.<string></span></dd></dl></div><h3 class="name has-anchor" id="getNetworks"><span class="type-signature"></span>getNetworks<span class="signature">()</span><span class="type-signature"> → {Array.<<a href="LuCI.network.Protocol.html">LuCI.network.Protocol</a>>}</span></h3><div class="description"><p>Get the logical interfaces this network is attached to.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line4460">line 4460</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns an array of <code>Network.Protocol</code> instances representing the logical interfaces this wireless network is attached to.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Array.<<a href="LuCI.network.Protocol.html">LuCI.network.Protocol</a>></span></dd></dl></div><h3 class="name has-anchor" id="getNoise"><span class="type-signature"></span>getNoise<span class="signature">()</span><span class="type-signature"> → {number}</span></h3><div class="description"><p>Query the current radio noise floor.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line4326">line 4326</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns the radio noise floor in dBm as reported by <code>ubus</code> runtime information or <code>0</code> if it cannot be determined.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">number</span></dd></dl></div><h3 class="name has-anchor" id="getSSID"><span class="type-signature"></span>getSSID<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h3><div class="description"><p>Get the configured SSID of the wireless network.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line3787">line 3787</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns the configured SSID value or <code>null</code> when this network is in mesh mode.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">null</span> |<wbr> <span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="getShortName"><span class="type-signature"></span>getShortName<span class="signature">()</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Get a short description string for this wireless network.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line4418">line 4418</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns a string describing this network, consisting of the active operation mode, followed by either the SSID, BSSID or internal network ID, depending on which information is available.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="getSignal"><span class="type-signature"></span>getSignal<span class="signature">()</span><span class="type-signature"> → {null|number}</span></h3><div class="description"><p>Query the current wireless signal.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line4315">line 4315</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns the wireless signal in dBm as reported by <code>ubus</code> runtime information or <code>null</code> if it cannot be determined.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">null</span> |<wbr> <span class="param-type">number</span></dd></dl></div><h3 class="name has-anchor" id="getSignalLevel"><span class="type-signature"></span>getSignalLevel<span class="signature">(signal, noise)</span><span class="type-signature"> → {number}</span></h3><div class="description"><p>Calculate the current signal.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>signal</code></td><td class="type"><span class="param-type">number</span></td><td class="description last"></td></tr><tr><td class="name"><code>noise</code></td><td class="type"><span class="param-type">number</span></td><td class="description last"></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="important tag-deprecated bold">Deprecated</dt><dd class="tag-deprecated"><ul><li>Yes</li></ul></dd></div><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line4377">line 4377</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns the calculated signal level, which is the difference between noise and signal (SNR), divided by 5.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">number</span></dd></dl></div><h3 class="name has-anchor" id="getSignalPercent"><span class="type-signature"></span>getSignalPercent<span class="signature">()</span><span class="type-signature"> → {number}</span></h3><div class="description"><p>Calculate the current signal quality percentage.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line4400">line 4400</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns the calculated signal quality in percent. The value is calculated from the <code>quality</code> and <code>quality_max</code> indicators reported by <code>ubus</code> runtime state.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">number</span></dd></dl></div><h3 class="name has-anchor" id="getTXPower"><span class="type-signature"></span>getTXPower<span class="signature">()</span><span class="type-signature"> → {null|number}</span></h3><div class="description"><p>Query the current radio TX power.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line4348">line 4348</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns the wireless network transmit power in dBm as reported by <code>ubus</code> runtime information or <code>null</code> if it cannot be determined.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">null</span> |<wbr> <span class="param-type">number</span></dd></dl></div><h3 class="name has-anchor" id="getTXPowerOffset"><span class="type-signature"></span>getTXPowerOffset<span class="signature">()</span><span class="type-signature"> → {number}</span></h3><div class="description"><p>Query the radio TX power offset.</p><p>Some wireless radios have a fixed power offset, e.g. due to the use of external amplifiers.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line4363">line 4363</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns the wireless network transmit power offset in dBm as reported by <code>ubus</code> runtime information or <code>0</code> if there is no offset, or if it cannot be determined.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">number</span></dd></dl></div><h3 class="name has-anchor" id="getVlanIfnames"><span class="type-signature"></span>getVlanIfnames<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h3><div class="description"><p>Get the Linux VLAN network device names.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line3878">line 3878</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns the current Linux VLAN network device name as resolved from <code>ubus</code> runtime information or empty array if this network has no associated VLAN network devices.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Array.<string></span></dd></dl></div><h3 class="name has-anchor" id="getVlans"><span class="type-signature"></span>getVlans<span class="signature">()</span><span class="type-signature"> → {Array.<<a href="LuCI.network.WifiVlan.html">LuCI.network.WifiVlan</a>>}</span></h3><div class="description"><p>Fetch the vlans for this network.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line4251">line 4251</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns an array of vlans for this network.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Array.<<a href="LuCI.network.WifiVlan.html">LuCI.network.WifiVlan</a>></span></dd></dl></div><h3 class="name has-anchor" id="getWifiDevice"><span class="type-signature"></span>getWifiDevice<span class="signature">()</span><span class="type-signature"> → {null|<a href="LuCI.network.WifiDevice.html">LuCI.network.WifiDevice</a>}</span></h3><div class="description"><p>Get the corresponding WiFi radio device.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line3907">line 3907</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns a <code>Network.WifiDevice</code> instance representing the corresponding WiFi radio device or <code>null</code> if the related radio device could not be found.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">null</span> |<wbr> <span class="param-type"><a href="LuCI.network.WifiDevice.html">LuCI.<wbr>network.<wbr>WifiDevice</a></span></dd></dl></div><h3 class="name has-anchor" id="getWifiDeviceName"><span class="type-signature"></span>getWifiDeviceName<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h3><div class="description"><p>Get the name of the corresponding WiFi radio device.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line3895">line 3895</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns the name of the radio device this network is configured on or <code>null</code> if it cannot be determined.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">null</span> |<wbr> <span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="isClientDisconnectSupported"><span class="type-signature"></span>isClientDisconnectSupported<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h3><div class="description"><p>Check whether this WiFi network supports de-authenticating clients.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line4496">line 4496</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns <code>true</code> when this WiFi network instance supports forcibly de-authenticating clients, otherwise <code>false</code>.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id="isDisabled"><span class="type-signature"></span>isDisabled<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h3><div class="description"><p>Checks whether this wireless network is disabled.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line3761">line 3761</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns <code>true</code> when the wireless radio is marked as disabled in <code>ubus</code> runtime state or when the <code>disabled</code> option is set in the corresponding UCI configuration.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id="isUp"><span class="type-signature"></span>isUp<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h3><div class="description"><p>Check whether the radio network is up.</p><p>This function actually queries the up state of the related radio device and assumes this network to be up as well when the parent radio is up. This is due to the fact that OpenWrt does not control virtual interfaces individually but within one common hostapd instance.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line3928">line 3928</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Returns <code>true</code> when the network is up, else <code>false</code>.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id="set"><span class="type-signature"></span>set<span class="signature">(opt, value)</span><span class="type-signature"> → {null}</span></h3><div class="description"><p>Set the given UCI option of this network to the given value.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>opt</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>The name of the UCI option to set.</p></td></tr><tr><td class="name"><code>value</code></td><td class="type"><span class="param-type">null</span> |<wbr> <span class="param-type">string</span> |<wbr> <span class="param-type">Array.<string></span></td><td class="description last"><p>The value to set or <code>null</code> to remove the given option from the configuration.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="network.js.html">network.js</a>, <a href="network.js.html#line3749">line 3749</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">null</span></dd></dl></div></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">LuCI Documentation</a><div class="mobile-nav-links"><div class="github-home navbar-item"><a id="" href="https://github.com/openwrt/luci" target="">GitHub Project Page</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-JsonRpcHowTo.html">Using JSON RPC daemon</a></div><div class="sidebar-section-children"><a href="tutorial-Modules.html">Modules</a></div><div class="sidebar-section-children"><a href="tutorial-ThemesHowTo.html">Making Themes</a></div><div class="sidebar-section-children"><a href="tutorial-i18n.html">Internationalisation - i18n</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="LuCI.module_cbi.html">cbi</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="LuCI.html">LuCI</a></div><div class="sidebar-section-children"><a href="LuCI.baseclass.html">baseclass</a></div><div class="sidebar-section-children"><a href="LuCI.dom.html">dom</a></div><div class="sidebar-section-children"><a href="LuCI.form.html">form</a></div><div class="sidebar-section-children"><a href="LuCI.form.AbstractElement.html">AbstractElement</a></div><div class="sidebar-section-children"><a href="LuCI.form.AbstractSection.html">AbstractSection</a></div><div class="sidebar-section-children"><a href="LuCI.form.AbstractValue.html">AbstractValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.Button.html">Button</a></div><div class="sidebar-section-children"><a href="LuCI.form.DirectoryPicker.html">DirectoryPicker</a></div><div class="sidebar-section-children"><a href="LuCI.form.DummyValue.html">DummyValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.DynamicList.html">DynamicList</a></div><div class="sidebar-section-children"><a href="LuCI.form.FileUpload.html">FileUpload</a></div><div class="sidebar-section-children"><a href="LuCI.form.Flag.html">Flag</a></div><div class="sidebar-section-children"><a href="LuCI.form.GridSection.html">GridSection</a></div><div class="sidebar-section-children"><a href="LuCI.form.HiddenValue.html">HiddenValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.JSONMap.html">JSONMap</a></div><div class="sidebar-section-children"><a href="LuCI.form.ListValue.html">ListValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.Map.html">Map</a></div><div class="sidebar-section-children"><a href="LuCI.form.MultiValue.html">MultiValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.NamedSection.html">NamedSection</a></div><div class="sidebar-section-children"><a href="LuCI.form.RangeSliderValue.html">RangeSliderValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.RichListValue.html">RichListValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.SectionValue.html">SectionValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.TableSection.html">TableSection</a></div><div class="sidebar-section-children"><a href="LuCI.form.TextValue.html">TextValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.TypedSection.html">TypedSection</a></div><div class="sidebar-section-children"><a href="LuCI.form.Value.html">Value</a></div><div class="sidebar-section-children"><a href="LuCI.fs.html">fs</a></div><div class="sidebar-section-children"><a href="LuCI.headers.html">headers</a></div><div class="sidebar-section-children"><a href="LuCI.network.html">network</a></div><div class="sidebar-section-children"><a href="LuCI.network.Device.html">Device</a></div><div class="sidebar-section-children"><a href="LuCI.network.Hosts.html">Hosts</a></div><div class="sidebar-section-children"><a href="LuCI.network.Protocol.html">Protocol</a></div><div class="sidebar-section-children"><a href="LuCI.network.WifiDevice.html">WifiDevice</a></div><div class="sidebar-section-children"><a href="LuCI.network.WifiNetwork.html">WifiNetwork</a></div><div class="sidebar-section-children"><a href="LuCI.network.WifiVlan.html">WifiVlan</a></div><div class="sidebar-section-children"><a href="LuCI.poll.html">poll</a></div><div class="sidebar-section-children"><a href="LuCI.request.html">request</a></div><div class="sidebar-section-children"><a href="LuCI.request.poll.html">poll</a></div><div class="sidebar-section-children"><a href="LuCI.response.html">response</a></div><div class="sidebar-section-children"><a href="LuCI.rpc.html">rpc</a></div><div class="sidebar-section-children"><a href="LuCI.session.html">session</a></div><div class="sidebar-section-children"><a href="LuCI.uci.html">uci</a></div><div class="sidebar-section-children"><a href="LuCI.ui.html">ui</a></div><div class="sidebar-section-children"><a href="LuCI.ui.AbstractElement.html">AbstractElement</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Checkbox.html">Checkbox</a></div><div class="sidebar-section-children"><a href="LuCI.ui.ComboButton.html">ComboButton</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Combobox.html">Combobox</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Dropdown.html">Dropdown</a></div><div class="sidebar-section-children"><a href="LuCI.ui.DynamicList.html">DynamicList</a></div><div class="sidebar-section-children"><a href="LuCI.ui.FileUpload.html">FileUpload</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Hiddenfield.html">Hiddenfield</a></div><div class="sidebar-section-children"><a href="LuCI.ui.RangeSlider.html">RangeSlider</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Select.html">Select</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Textarea.html">Textarea</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Textfield.html">Textfield</a></div><div class="sidebar-section-children"><a href="LuCI.ui.changes.html">changes</a></div><div class="sidebar-section-children"><a href="LuCI.ui.menu.html">menu</a></div><div class="sidebar-section-children"><a href="LuCI.ui.tabs.html">tabs</a></div><div class="sidebar-section-children"><a href="LuCI.validation.html">validation</a></div><div class="sidebar-section-children"><a href="LuCI.validation.Validator.html">Validator</a></div><div class="sidebar-section-children"><a href="LuCI.validation.ValidatorFactory.html">ValidatorFactory</a></div><div class="sidebar-section-children"><a href="LuCI.view.html">view</a></div><div class="sidebar-section-children"><a href="LuCI.xhr.html">xhr</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-externals"><div>Externals</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="external-String.html">String</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html> |