diff options
Diffstat (limited to 'documentation/jsapi/LuCI.Network.WifiNetwork.html')
| -rw-r--r-- | documentation/jsapi/LuCI.Network.WifiNetwork.html | 6203 |
1 files changed, 3436 insertions, 2767 deletions
diff --git a/documentation/jsapi/LuCI.Network.WifiNetwork.html b/documentation/jsapi/LuCI.Network.WifiNetwork.html index 62e43aa5ec..20ba7447a6 100644 --- a/documentation/jsapi/LuCI.Network.WifiNetwork.html +++ b/documentation/jsapi/LuCI.Network.WifiNetwork.html @@ -1,195 +1,1234 @@ <!DOCTYPE html> -<html lang="en"> +<html> <head> <meta charset="utf-8"> - <title>JSDoc: Class: WifiNetwork</title> - - <script src="scripts/prettify/prettify.js"> </script> - <script src="scripts/prettify/lang-css.js"> </script> + <title>Class: WifiNetwork</title> + + + <script src="scripts/prettify/prettify.js"></script> + <script src="scripts/prettify/lang-css.js"></script> + <script src="scripts/jquery.min.js"></script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> - <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> -</head> + <link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css"> + <link type="text/css" rel="stylesheet" href="styles/jaguar.css"> + + + <script> + var config = {"monospaceLinks":true,"cleverLinks":true,"default":{}}; + </script> + + +</head> <body> - -<div id="main"> - - <h1 class="page-title">Class: WifiNetwork</h1> - +<div id="wrap" class="clearfix"> +<div class="navigation"> + <h3 class="applicationName"><a href="index.html"></a></h3> + <div class="search"> + <input id="search" type="text" class="form-control input-sm" placeholder="Search Documentations"> + </div> + <ul class="list"> + + <li class="item" data-name="LuCI"> + <span class="title"> + <a href="LuCI.html">LuCI</a> + + </span> + <ul class="members itemMembers"> + + <span class="subtitle">Members</span> + + <li data-name="LuCI#env"><a href="LuCI.html#env">env</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.requestCallbackFn"><a href="LuCI.html#.requestCallbackFn">requestCallbackFn</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI#bind"><a href="LuCI.html#bind">bind</a></li> + + <li data-name="LuCI#error"><a href="LuCI.html#error">error</a></li> + + <li data-name="LuCI#get"><a href="LuCI.html#get">get</a></li> + + <li data-name="LuCI#halt"><a href="LuCI.html#halt">halt</a></li> + + <li data-name="LuCI#hasSystemFeature"><a href="LuCI.html#hasSystemFeature">hasSystemFeature</a></li> + + <li data-name="LuCI#isObject"><a href="LuCI.html#isObject">isObject</a></li> + + <li data-name="LuCI#location"><a href="LuCI.html#location">location</a></li> + + <li data-name="LuCI#path"><a href="LuCI.html#path">path</a></li> + + <li data-name="LuCI#poll"><a href="LuCI.html#poll">poll</a></li> + + <li data-name="LuCI#post"><a href="LuCI.html#post">post</a></li> + + <li data-name="LuCI#raise"><a href="LuCI.html#raise">raise</a></li> + + <li data-name="LuCI#require"><a href="LuCI.html#require">require</a></li> + + <li data-name="LuCI#resolveDefault"><a href="LuCI.html#resolveDefault">resolveDefault</a></li> + + <li data-name="LuCI#resource"><a href="LuCI.html#resource">resource</a></li> + + <li data-name="LuCI#run"><a href="LuCI.html#run">run</a></li> + + <li data-name="LuCI#sortedKeys"><a href="LuCI.html#sortedKeys">sortedKeys</a></li> + + <li data-name="LuCI#stop"><a href="LuCI.html#stop">stop</a></li> + + <li data-name="LuCI#toArray"><a href="LuCI.html#toArray">toArray</a></li> + + <li data-name="LuCI#url"><a href="LuCI.html#url">url</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Class"> + <span class="title"> + <a href="LuCI.Class.html">LuCI.Class</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Class.extend"><a href="LuCI.Class.html#.extend">extend</a></li> + + <li data-name="LuCI.Class.instantiate"><a href="LuCI.Class.html#.instantiate">instantiate</a></li> + + <li data-name="LuCI.Class.isSubclass"><a href="LuCI.Class.html#.isSubclass">isSubclass</a></li> + + <li data-name="LuCI.Class.singleton"><a href="LuCI.Class.html#.singleton">singleton</a></li> + + <li data-name="LuCI.Class#super"><a href="LuCI.Class.html#super">super</a></li> + + <li data-name="LuCI.Class#varargs"><a href="LuCI.Class.html#varargs">varargs</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.dom"> + <span class="title"> + <a href="LuCI.dom.html">LuCI.dom</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.dom~ignoreCallbackFn"><a href="LuCI.dom.html#~ignoreCallbackFn">ignoreCallbackFn</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.dom#append"><a href="LuCI.dom.html#append">append</a></li> + + <li data-name="LuCI.dom#attr"><a href="LuCI.dom.html#attr">attr</a></li> + + <li data-name="LuCI.dom#bindClassInstance"><a href="LuCI.dom.html#bindClassInstance">bindClassInstance</a></li> + + <li data-name="LuCI.dom#callClassMethod"><a href="LuCI.dom.html#callClassMethod">callClassMethod</a></li> + + <li data-name="LuCI.dom#content"><a href="LuCI.dom.html#content">content</a></li> + + <li data-name="LuCI.dom#create"><a href="LuCI.dom.html#create">create</a></li> + + <li data-name="LuCI.dom#data"><a href="LuCI.dom.html#data">data</a></li> + + <li data-name="LuCI.dom#elem"><a href="LuCI.dom.html#elem">elem</a></li> + + <li data-name="LuCI.dom#findClassInstance"><a href="LuCI.dom.html#findClassInstance">findClassInstance</a></li> + + <li data-name="LuCI.dom#isEmpty"><a href="LuCI.dom.html#isEmpty">isEmpty</a></li> + + <li data-name="LuCI.dom#matches"><a href="LuCI.dom.html#matches">matches</a></li> + + <li data-name="LuCI.dom#parent"><a href="LuCI.dom.html#parent">parent</a></li> + + <li data-name="LuCI.dom#parse"><a href="LuCI.dom.html#parse">parse</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.fs"> + <span class="title"> + <a href="LuCI.fs.html">LuCI.fs</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.fs.FileExecResult"><a href="LuCI.fs.html#.FileExecResult">FileExecResult</a></li> + + <li data-name="LuCI.fs.FileStatEntry"><a href="LuCI.fs.html#.FileStatEntry">FileStatEntry</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.fs#exec"><a href="LuCI.fs.html#exec">exec</a></li> + + <li data-name="LuCI.fs#lines"><a href="LuCI.fs.html#lines">lines</a></li> + + <li data-name="LuCI.fs#list"><a href="LuCI.fs.html#list">list</a></li> + + <li data-name="LuCI.fs#read"><a href="LuCI.fs.html#read">read</a></li> + + <li data-name="LuCI.fs#remove"><a href="LuCI.fs.html#remove">remove</a></li> + + <li data-name="LuCI.fs#stat"><a href="LuCI.fs.html#stat">stat</a></li> + + <li data-name="LuCI.fs#trimmed"><a href="LuCI.fs.html#trimmed">trimmed</a></li> + + <li data-name="LuCI.fs#write"><a href="LuCI.fs.html#write">write</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Headers"> + <span class="title"> + <a href="LuCI.Headers.html">LuCI.Headers</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Headers#get"><a href="LuCI.Headers.html#get">get</a></li> + + <li data-name="LuCI.Headers#has"><a href="LuCI.Headers.html#has">has</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Network"> + <span class="title"> + <a href="LuCI.Network.html">LuCI.Network</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.Network.SwitchTopology"><a href="LuCI.Network.html#.SwitchTopology">SwitchTopology</a></li> + + <li data-name="LuCI.Network.WifiEncryption"><a href="LuCI.Network.html#.WifiEncryption">WifiEncryption</a></li> + + <li data-name="LuCI.Network.WifiPeerEntry"><a href="LuCI.Network.html#.WifiPeerEntry">WifiPeerEntry</a></li> + + <li data-name="LuCI.Network.WifiRateEntry"><a href="LuCI.Network.html#.WifiRateEntry">WifiRateEntry</a></li> + + <li data-name="LuCI.Network.WifiScanResult"><a href="LuCI.Network.html#.WifiScanResult">WifiScanResult</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Network#addNetwork"><a href="LuCI.Network.html#addNetwork">addNetwork</a></li> + + <li data-name="LuCI.Network#addWifiNetwork"><a href="LuCI.Network.html#addWifiNetwork">addWifiNetwork</a></li> + + <li data-name="LuCI.Network#deleteNetwork"><a href="LuCI.Network.html#deleteNetwork">deleteNetwork</a></li> + + <li data-name="LuCI.Network#deleteWifiNetwork"><a href="LuCI.Network.html#deleteWifiNetwork">deleteWifiNetwork</a></li> + + <li data-name="LuCI.Network#flushCache"><a href="LuCI.Network.html#flushCache">flushCache</a></li> + + <li data-name="LuCI.Network#formatWifiEncryption"><a href="LuCI.Network.html#formatWifiEncryption">formatWifiEncryption</a></li> + + <li data-name="LuCI.Network#getDevice"><a href="LuCI.Network.html#getDevice">getDevice</a></li> + + <li data-name="LuCI.Network#getDevices"><a href="LuCI.Network.html#getDevices">getDevices</a></li> + + <li data-name="LuCI.Network#getDSLModemType"><a href="LuCI.Network.html#getDSLModemType">getDSLModemType</a></li> + + <li data-name="LuCI.Network#getHostHints"><a href="LuCI.Network.html#getHostHints">getHostHints</a></li> + + <li data-name="LuCI.Network#getIfnameOf"><a href="LuCI.Network.html#getIfnameOf">getIfnameOf</a></li> + + <li data-name="LuCI.Network#getNetwork"><a href="LuCI.Network.html#getNetwork">getNetwork</a></li> + + <li data-name="LuCI.Network#getNetworks"><a href="LuCI.Network.html#getNetworks">getNetworks</a></li> + + <li data-name="LuCI.Network#getProtocol"><a href="LuCI.Network.html#getProtocol">getProtocol</a></li> + + <li data-name="LuCI.Network#getProtocols"><a href="LuCI.Network.html#getProtocols">getProtocols</a></li> + + <li data-name="LuCI.Network#getSwitchTopologies"><a href="LuCI.Network.html#getSwitchTopologies">getSwitchTopologies</a></li> + + <li data-name="LuCI.Network#getWAN6Networks"><a href="LuCI.Network.html#getWAN6Networks">getWAN6Networks</a></li> + + <li data-name="LuCI.Network#getWANNetworks"><a href="LuCI.Network.html#getWANNetworks">getWANNetworks</a></li> + + <li data-name="LuCI.Network#getWifiDevice"><a href="LuCI.Network.html#getWifiDevice">getWifiDevice</a></li> + + <li data-name="LuCI.Network#getWifiDevices"><a href="LuCI.Network.html#getWifiDevices">getWifiDevices</a></li> + + <li data-name="LuCI.Network#getWifiNetwork"><a href="LuCI.Network.html#getWifiNetwork">getWifiNetwork</a></li> + + <li data-name="LuCI.Network#isIgnoredDevice"><a href="LuCI.Network.html#isIgnoredDevice">isIgnoredDevice</a></li> + + <li data-name="LuCI.Network#maskToPrefix"><a href="LuCI.Network.html#maskToPrefix">maskToPrefix</a></li> + + <li data-name="LuCI.Network#prefixToMask"><a href="LuCI.Network.html#prefixToMask">prefixToMask</a></li> + + <li data-name="LuCI.Network#registerErrorCode"><a href="LuCI.Network.html#registerErrorCode">registerErrorCode</a></li> + + <li data-name="LuCI.Network#registerPatternVirtual"><a href="LuCI.Network.html#registerPatternVirtual">registerPatternVirtual</a></li> + + <li data-name="LuCI.Network#registerProtocol"><a href="LuCI.Network.html#registerProtocol">registerProtocol</a></li> + + <li data-name="LuCI.Network#renameNetwork"><a href="LuCI.Network.html#renameNetwork">renameNetwork</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Network.Device"> + <span class="title"> + <a href="LuCI.Network.Device.html">LuCI.Network.Device</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Network.Device#getBridgeID"><a href="LuCI.Network.Device.html#getBridgeID">getBridgeID</a></li> + + <li data-name="LuCI.Network.Device#getBridgeSTP"><a href="LuCI.Network.Device.html#getBridgeSTP">getBridgeSTP</a></li> + + <li data-name="LuCI.Network.Device#getI18n"><a href="LuCI.Network.Device.html#getI18n">getI18n</a></li> + + <li data-name="LuCI.Network.Device#getIP6Addrs"><a href="LuCI.Network.Device.html#getIP6Addrs">getIP6Addrs</a></li> + + <li data-name="LuCI.Network.Device#getIPAddrs"><a href="LuCI.Network.Device.html#getIPAddrs">getIPAddrs</a></li> + + <li data-name="LuCI.Network.Device#getMAC"><a href="LuCI.Network.Device.html#getMAC">getMAC</a></li> + + <li data-name="LuCI.Network.Device#getMTU"><a href="LuCI.Network.Device.html#getMTU">getMTU</a></li> + + <li data-name="LuCI.Network.Device#getName"><a href="LuCI.Network.Device.html#getName">getName</a></li> + + <li data-name="LuCI.Network.Device#getNetwork"><a href="LuCI.Network.Device.html#getNetwork">getNetwork</a></li> + + <li data-name="LuCI.Network.Device#getNetworks"><a href="LuCI.Network.Device.html#getNetworks">getNetworks</a></li> + + <li data-name="LuCI.Network.Device#getPorts"><a href="LuCI.Network.Device.html#getPorts">getPorts</a></li> + + <li data-name="LuCI.Network.Device#getRXBytes"><a href="LuCI.Network.Device.html#getRXBytes">getRXBytes</a></li> + + <li data-name="LuCI.Network.Device#getRXPackets"><a href="LuCI.Network.Device.html#getRXPackets">getRXPackets</a></li> + + <li data-name="LuCI.Network.Device#getShortName"><a href="LuCI.Network.Device.html#getShortName">getShortName</a></li> + + <li data-name="LuCI.Network.Device#getTXBytes"><a href="LuCI.Network.Device.html#getTXBytes">getTXBytes</a></li> + + <li data-name="LuCI.Network.Device#getTXPackets"><a href="LuCI.Network.Device.html#getTXPackets">getTXPackets</a></li> + + <li data-name="LuCI.Network.Device#getType"><a href="LuCI.Network.Device.html#getType">getType</a></li> + + <li data-name="LuCI.Network.Device#getTypeI18n"><a href="LuCI.Network.Device.html#getTypeI18n">getTypeI18n</a></li> + + <li data-name="LuCI.Network.Device#getWifiNetwork"><a href="LuCI.Network.Device.html#getWifiNetwork">getWifiNetwork</a></li> + + <li data-name="LuCI.Network.Device#isBridge"><a href="LuCI.Network.Device.html#isBridge">isBridge</a></li> + + <li data-name="LuCI.Network.Device#isBridgePort"><a href="LuCI.Network.Device.html#isBridgePort">isBridgePort</a></li> + + <li data-name="LuCI.Network.Device#isUp"><a href="LuCI.Network.Device.html#isUp">isUp</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Network.Hosts"> + <span class="title"> + <a href="LuCI.Network.Hosts.html">LuCI.Network.Hosts</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Network.Hosts#getHostnameByIP6Addr"><a href="LuCI.Network.Hosts.html#getHostnameByIP6Addr">getHostnameByIP6Addr</a></li> + + <li data-name="LuCI.Network.Hosts#getHostnameByIPAddr"><a href="LuCI.Network.Hosts.html#getHostnameByIPAddr">getHostnameByIPAddr</a></li> + + <li data-name="LuCI.Network.Hosts#getHostnameByMACAddr"><a href="LuCI.Network.Hosts.html#getHostnameByMACAddr">getHostnameByMACAddr</a></li> + + <li data-name="LuCI.Network.Hosts#getIP6AddrByMACAddr"><a href="LuCI.Network.Hosts.html#getIP6AddrByMACAddr">getIP6AddrByMACAddr</a></li> + + <li data-name="LuCI.Network.Hosts#getIPAddrByMACAddr"><a href="LuCI.Network.Hosts.html#getIPAddrByMACAddr">getIPAddrByMACAddr</a></li> + + <li data-name="LuCI.Network.Hosts#getMACAddrByIP6Addr"><a href="LuCI.Network.Hosts.html#getMACAddrByIP6Addr">getMACAddrByIP6Addr</a></li> + + <li data-name="LuCI.Network.Hosts#getMACAddrByIPAddr"><a href="LuCI.Network.Hosts.html#getMACAddrByIPAddr">getMACAddrByIPAddr</a></li> + + <li data-name="LuCI.Network.Hosts#getMACHints"><a href="LuCI.Network.Hosts.html#getMACHints">getMACHints</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Network.Protocol"> + <span class="title"> + <a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Network.Protocol#addDevice"><a href="LuCI.Network.Protocol.html#addDevice">addDevice</a></li> + + <li data-name="LuCI.Network.Protocol#containsDevice"><a href="LuCI.Network.Protocol.html#containsDevice">containsDevice</a></li> + + <li data-name="LuCI.Network.Protocol#deleteDevice"><a href="LuCI.Network.Protocol.html#deleteDevice">deleteDevice</a></li> + + <li data-name="LuCI.Network.Protocol#get"><a href="LuCI.Network.Protocol.html#get">get</a></li> + + <li data-name="LuCI.Network.Protocol#getDevice"><a href="LuCI.Network.Protocol.html#getDevice">getDevice</a></li> + + <li data-name="LuCI.Network.Protocol#getDevices"><a href="LuCI.Network.Protocol.html#getDevices">getDevices</a></li> + + <li data-name="LuCI.Network.Protocol#getDNS6Addrs"><a href="LuCI.Network.Protocol.html#getDNS6Addrs">getDNS6Addrs</a></li> + + <li data-name="LuCI.Network.Protocol#getDNSAddrs"><a href="LuCI.Network.Protocol.html#getDNSAddrs">getDNSAddrs</a></li> + + <li data-name="LuCI.Network.Protocol#getErrors"><a href="LuCI.Network.Protocol.html#getErrors">getErrors</a></li> + + <li data-name="LuCI.Network.Protocol#getExpiry"><a href="LuCI.Network.Protocol.html#getExpiry">getExpiry</a></li> + + <li data-name="LuCI.Network.Protocol#getGateway6Addr"><a href="LuCI.Network.Protocol.html#getGateway6Addr">getGateway6Addr</a></li> + + <li data-name="LuCI.Network.Protocol#getGatewayAddr"><a href="LuCI.Network.Protocol.html#getGatewayAddr">getGatewayAddr</a></li> + + <li data-name="LuCI.Network.Protocol#getI18n"><a href="LuCI.Network.Protocol.html#getI18n">getI18n</a></li> + + <li data-name="LuCI.Network.Protocol#getIfname"><a href="LuCI.Network.Protocol.html#getIfname">getIfname</a></li> + + <li data-name="LuCI.Network.Protocol#getIP6Addr"><a href="LuCI.Network.Protocol.html#getIP6Addr">getIP6Addr</a></li> + + <li data-name="LuCI.Network.Protocol#getIP6Addrs"><a href="LuCI.Network.Protocol.html#getIP6Addrs">getIP6Addrs</a></li> + + <li data-name="LuCI.Network.Protocol#getIP6Prefix"><a href="LuCI.Network.Protocol.html#getIP6Prefix">getIP6Prefix</a></li> + + <li data-name="LuCI.Network.Protocol#getIPAddr"><a href="LuCI.Network.Protocol.html#getIPAddr">getIPAddr</a></li> + + <li data-name="LuCI.Network.Protocol#getIPAddrs"><a href="LuCI.Network.Protocol.html#getIPAddrs">getIPAddrs</a></li> + + <li data-name="LuCI.Network.Protocol#getL2Device"><a href="LuCI.Network.Protocol.html#getL2Device">getL2Device</a></li> + + <li data-name="LuCI.Network.Protocol#getL3Device"><a href="LuCI.Network.Protocol.html#getL3Device">getL3Device</a></li> + + <li data-name="LuCI.Network.Protocol#getMetric"><a href="LuCI.Network.Protocol.html#getMetric">getMetric</a></li> + + <li data-name="LuCI.Network.Protocol#getName"><a href="LuCI.Network.Protocol.html#getName">getName</a></li> + + <li data-name="LuCI.Network.Protocol#getNetmask"><a href="LuCI.Network.Protocol.html#getNetmask">getNetmask</a></li> + + <li data-name="LuCI.Network.Protocol#getOpkgPackage"><a href="LuCI.Network.Protocol.html#getOpkgPackage">getOpkgPackage</a></li> + + <li data-name="LuCI.Network.Protocol#getProtocol"><a href="LuCI.Network.Protocol.html#getProtocol">getProtocol</a></li> + + <li data-name="LuCI.Network.Protocol#getType"><a href="LuCI.Network.Protocol.html#getType">getType</a></li> + + <li data-name="LuCI.Network.Protocol#getUptime"><a href="LuCI.Network.Protocol.html#getUptime">getUptime</a></li> + + <li data-name="LuCI.Network.Protocol#getZoneName"><a href="LuCI.Network.Protocol.html#getZoneName">getZoneName</a></li> + + <li data-name="LuCI.Network.Protocol#isAlias"><a href="LuCI.Network.Protocol.html#isAlias">isAlias</a></li> + + <li data-name="LuCI.Network.Protocol#isBridge"><a href="LuCI.Network.Protocol.html#isBridge">isBridge</a></li> + + <li data-name="LuCI.Network.Protocol#isDynamic"><a href="LuCI.Network.Protocol.html#isDynamic">isDynamic</a></li> + + <li data-name="LuCI.Network.Protocol#isEmpty"><a href="LuCI.Network.Protocol.html#isEmpty">isEmpty</a></li> + + <li data-name="LuCI.Network.Protocol#isFloating"><a href="LuCI.Network.Protocol.html#isFloating">isFloating</a></li> + + <li data-name="LuCI.Network.Protocol#isInstalled"><a href="LuCI.Network.Protocol.html#isInstalled">isInstalled</a></li> + + <li data-name="LuCI.Network.Protocol#isUp"><a href="LuCI.Network.Protocol.html#isUp">isUp</a></li> + + <li data-name="LuCI.Network.Protocol#isVirtual"><a href="LuCI.Network.Protocol.html#isVirtual">isVirtual</a></li> + + <li data-name="LuCI.Network.Protocol#set"><a href="LuCI.Network.Protocol.html#set">set</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Network.WifiDevice"> + <span class="title"> + <a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Network.WifiDevice#addWifiNetwork"><a href="LuCI.Network.WifiDevice.html#addWifiNetwork">addWifiNetwork</a></li> + + <li data-name="LuCI.Network.WifiDevice#deleteWifiNetwork"><a href="LuCI.Network.WifiDevice.html#deleteWifiNetwork">deleteWifiNetwork</a></li> + + <li data-name="LuCI.Network.WifiDevice#get"><a href="LuCI.Network.WifiDevice.html#get">get</a></li> + + <li data-name="LuCI.Network.WifiDevice#getHTModes"><a href="LuCI.Network.WifiDevice.html#getHTModes">getHTModes</a></li> + + <li data-name="LuCI.Network.WifiDevice#getHWModes"><a href="LuCI.Network.WifiDevice.html#getHWModes">getHWModes</a></li> + + <li data-name="LuCI.Network.WifiDevice#getI18n"><a href="LuCI.Network.WifiDevice.html#getI18n">getI18n</a></li> + + <li data-name="LuCI.Network.WifiDevice#getName"><a href="LuCI.Network.WifiDevice.html#getName">getName</a></li> + + <li data-name="LuCI.Network.WifiDevice#getScanList"><a href="LuCI.Network.WifiDevice.html#getScanList">getScanList</a></li> + + <li data-name="LuCI.Network.WifiDevice#getWifiNetwork"><a href="LuCI.Network.WifiDevice.html#getWifiNetwork">getWifiNetwork</a></li> + + <li data-name="LuCI.Network.WifiDevice#getWifiNetworks"><a href="LuCI.Network.WifiDevice.html#getWifiNetworks">getWifiNetworks</a></li> + + <li data-name="LuCI.Network.WifiDevice#isDisabled"><a href="LuCI.Network.WifiDevice.html#isDisabled">isDisabled</a></li> + + <li data-name="LuCI.Network.WifiDevice#isUp"><a href="LuCI.Network.WifiDevice.html#isUp">isUp</a></li> + + <li data-name="LuCI.Network.WifiDevice#set"><a href="LuCI.Network.WifiDevice.html#set">set</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Network.WifiNetwork"> + <span class="title"> + <a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Network.WifiNetwork#get"><a href="LuCI.Network.WifiNetwork.html#get">get</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getActiveBSSID"><a href="LuCI.Network.WifiNetwork.html#getActiveBSSID">getActiveBSSID</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getActiveEncryption"><a href="LuCI.Network.WifiNetwork.html#getActiveEncryption">getActiveEncryption</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getActiveMode"><a href="LuCI.Network.WifiNetwork.html#getActiveMode">getActiveMode</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getActiveModeI18n"><a href="LuCI.Network.WifiNetwork.html#getActiveModeI18n">getActiveModeI18n</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getActiveSSID"><a href="LuCI.Network.WifiNetwork.html#getActiveSSID">getActiveSSID</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getAssocList"><a href="LuCI.Network.WifiNetwork.html#getAssocList">getAssocList</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getBitRate"><a href="LuCI.Network.WifiNetwork.html#getBitRate">getBitRate</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getBSSID"><a href="LuCI.Network.WifiNetwork.html#getBSSID">getBSSID</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getChannel"><a href="LuCI.Network.WifiNetwork.html#getChannel">getChannel</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getCountryCode"><a href="LuCI.Network.WifiNetwork.html#getCountryCode">getCountryCode</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getDevice"><a href="LuCI.Network.WifiNetwork.html#getDevice">getDevice</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getFrequency"><a href="LuCI.Network.WifiNetwork.html#getFrequency">getFrequency</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getI18n"><a href="LuCI.Network.WifiNetwork.html#getI18n">getI18n</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getID"><a href="LuCI.Network.WifiNetwork.html#getID">getID</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getIfname"><a href="LuCI.Network.WifiNetwork.html#getIfname">getIfname</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getMeshID"><a href="LuCI.Network.WifiNetwork.html#getMeshID">getMeshID</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getMode"><a href="LuCI.Network.WifiNetwork.html#getMode">getMode</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getName"><a href="LuCI.Network.WifiNetwork.html#getName">getName</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getNetwork"><a href="LuCI.Network.WifiNetwork.html#getNetwork">getNetwork</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getNetworkNames"><a href="LuCI.Network.WifiNetwork.html#getNetworkNames">getNetworkNames</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getNetworks"><a href="LuCI.Network.WifiNetwork.html#getNetworks">getNetworks</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getNoise"><a href="LuCI.Network.WifiNetwork.html#getNoise">getNoise</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getShortName"><a href="LuCI.Network.WifiNetwork.html#getShortName">getShortName</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getSignal"><a href="LuCI.Network.WifiNetwork.html#getSignal">getSignal</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getSignalLevel"><a href="LuCI.Network.WifiNetwork.html#getSignalLevel">getSignalLevel</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getSignalPercent"><a href="LuCI.Network.WifiNetwork.html#getSignalPercent">getSignalPercent</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getSSID"><a href="LuCI.Network.WifiNetwork.html#getSSID">getSSID</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getTXPower"><a href="LuCI.Network.WifiNetwork.html#getTXPower">getTXPower</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getTXPowerOffset"><a href="LuCI.Network.WifiNetwork.html#getTXPowerOffset">getTXPowerOffset</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getWifiDevice"><a href="LuCI.Network.WifiNetwork.html#getWifiDevice">getWifiDevice</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getWifiDeviceName"><a href="LuCI.Network.WifiNetwork.html#getWifiDeviceName">getWifiDeviceName</a></li> + + <li data-name="LuCI.Network.WifiNetwork#isDisabled"><a href="LuCI.Network.WifiNetwork.html#isDisabled">isDisabled</a></li> + + <li data-name="LuCI.Network.WifiNetwork#isUp"><a href="LuCI.Network.WifiNetwork.html#isUp">isUp</a></li> + + <li data-name="LuCI.Network.WifiNetwork#set"><a href="LuCI.Network.WifiNetwork.html#set">set</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Poll"> + <span class="title"> + <a href="LuCI.Poll.html">LuCI.Poll</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Poll#active"><a href="LuCI.Poll.html#active">active</a></li> + + <li data-name="LuCI.Poll#add"><a href="LuCI.Poll.html#add">add</a></li> + + <li data-name="LuCI.Poll#remove"><a href="LuCI.Poll.html#remove">remove</a></li> + + <li data-name="LuCI.Poll#start"><a href="LuCI.Poll.html#start">start</a></li> + + <li data-name="LuCI.Poll#stop"><a href="LuCI.Poll.html#stop">stop</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Request"> + <span class="title"> + <a href="LuCI.Request.html">LuCI.Request</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.Request.interceptorFn"><a href="LuCI.Request.html#.interceptorFn">interceptorFn</a></li> + + <li data-name="LuCI.Request.RequestOptions"><a href="LuCI.Request.html#.RequestOptions">RequestOptions</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Request#addInterceptor"><a href="LuCI.Request.html#addInterceptor">addInterceptor</a></li> + + <li data-name="LuCI.Request#expandURL"><a href="LuCI.Request.html#expandURL">expandURL</a></li> + + <li data-name="LuCI.Request#get"><a href="LuCI.Request.html#get">get</a></li> + + <li data-name="LuCI.Request#post"><a href="LuCI.Request.html#post">post</a></li> + + <li data-name="LuCI.Request#removeInterceptor"><a href="LuCI.Request.html#removeInterceptor">removeInterceptor</a></li> + + <li data-name="LuCI.Request#request"><a href="LuCI.Request.html#request">request</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Request.poll"> + <span class="title"> + <a href="LuCI.Request.poll.html">LuCI.Request.poll</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.Request.poll~callbackFn"><a href="LuCI.Request.poll.html#~callbackFn">callbackFn</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Request.poll#active"><a href="LuCI.Request.poll.html#active">active</a></li> + + <li data-name="LuCI.Request.poll#add"><a href="LuCI.Request.poll.html#add">add</a></li> + + <li data-name="LuCI.Request.poll#remove"><a href="LuCI.Request.poll.html#remove">remove</a></li> + + <li data-name="LuCI.Request.poll#start"><a href="LuCI.Request.poll.html#start">start</a></li> + + <li data-name="LuCI.Request.poll#stop"><a href="LuCI.Request.poll.html#stop">stop</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Response"> + <span class="title"> + <a href="LuCI.Response.html">LuCI.Response</a> + + </span> + <ul class="members itemMembers"> + + <span class="subtitle">Members</span> + + <li data-name="LuCI.Response#duration"><a href="LuCI.Response.html#duration">duration</a></li> + + <li data-name="LuCI.Response#headers"><a href="LuCI.Response.html#headers">headers</a></li> + + <li data-name="LuCI.Response#ok"><a href="LuCI.Response.html#ok">ok</a></li> + + <li data-name="LuCI.Response#status"><a href="LuCI.Response.html#status">status</a></li> + + <li data-name="LuCI.Response#statusText"><a href="LuCI.Response.html#statusText">statusText</a></li> + + <li data-name="LuCI.Response#url"><a href="LuCI.Response.html#url">url</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Response#clone"><a href="LuCI.Response.html#clone">clone</a></li> + + <li data-name="LuCI.Response#json"><a href="LuCI.Response.html#json">json</a></li> + + <li data-name="LuCI.Response#text"><a href="LuCI.Response.html#text">text</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.rpc"> + <span class="title"> + <a href="LuCI.rpc.html">LuCI.rpc</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.rpc.DeclareOptions"><a href="LuCI.rpc.html#.DeclareOptions">DeclareOptions</a></li> + + <li data-name="LuCI.rpc~filterFn"><a href="LuCI.rpc.html#~filterFn">filterFn</a></li> + + <li data-name="LuCI.rpc~interceptorFn"><a href="LuCI.rpc.html#~interceptorFn">interceptorFn</a></li> + + <li data-name="LuCI.rpc~invokeFn"><a href="LuCI.rpc.html#~invokeFn">invokeFn</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.rpc#addInterceptor"><a href="LuCI.rpc.html#addInterceptor">addInterceptor</a></li> + + <li data-name="LuCI.rpc#declare"><a href="LuCI.rpc.html#declare">declare</a></li> + + <li data-name="LuCI.rpc#getBaseURL"><a href="LuCI.rpc.html#getBaseURL">getBaseURL</a></li> + + <li data-name="LuCI.rpc#getSessionID"><a href="LuCI.rpc.html#getSessionID">getSessionID</a></li> + + <li data-name="LuCI.rpc#getStatusText"><a href="LuCI.rpc.html#getStatusText">getStatusText</a></li> + + <li data-name="LuCI.rpc#list"><a href="LuCI.rpc.html#list">list</a></li> + + <li data-name="LuCI.rpc#removeInterceptor"><a href="LuCI.rpc.html#removeInterceptor">removeInterceptor</a></li> + + <li data-name="LuCI.rpc#setBaseURL"><a href="LuCI.rpc.html#setBaseURL">setBaseURL</a></li> + + <li data-name="LuCI.rpc#setSessionID"><a href="LuCI.rpc.html#setSessionID">setSessionID</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.uci"> + <span class="title"> + <a href="LuCI.uci.html">LuCI.uci</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.uci.ChangeRecord"><a href="LuCI.uci.html#.ChangeRecord">ChangeRecord</a></li> + + <li data-name="LuCI.uci.SectionObject"><a href="LuCI.uci.html#.SectionObject">SectionObject</a></li> + + <li data-name="LuCI.uci~sectionsFn"><a href="LuCI.uci.html#~sectionsFn">sectionsFn</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.uci#add"><a href="LuCI.uci.html#add">add</a></li> + + <li data-name="LuCI.uci#apply"><a href="LuCI.uci.html#apply">apply</a></li> + + <li data-name="LuCI.uci#changes"><a href="LuCI.uci.html#changes">changes</a></li> + + <li data-name="LuCI.uci#createSID"><a href="LuCI.uci.html#createSID">createSID</a></li> + + <li data-name="LuCI.uci#get"><a href="LuCI.uci.html#get">get</a></li> + + <li data-name="LuCI.uci#get_first"><a href="LuCI.uci.html#get_first">get_first</a></li> + + <li data-name="LuCI.uci#load"><a href="LuCI.uci.html#load">load</a></li> + + <li data-name="LuCI.uci#move"><a href="LuCI.uci.html#move">move</a></li> + + <li data-name="LuCI.uci#remove"><a href="LuCI.uci.html#remove">remove</a></li> + + <li data-name="LuCI.uci#resolveSID"><a href="LuCI.uci.html#resolveSID">resolveSID</a></li> + + <li data-name="LuCI.uci#save"><a href="LuCI.uci.html#save">save</a></li> + + <li data-name="LuCI.uci#sections"><a href="LuCI.uci.html#sections">sections</a></li> + + <li data-name="LuCI.uci#set"><a href="LuCI.uci.html#set">set</a></li> + + <li data-name="LuCI.uci#set_first"><a href="LuCI.uci.html#set_first">set_first</a></li> + + <li data-name="LuCI.uci#unload"><a href="LuCI.uci.html#unload">unload</a></li> + + <li data-name="LuCI.uci#unset"><a href="LuCI.uci.html#unset">unset</a></li> + + <li data-name="LuCI.uci#unset_first"><a href="LuCI.uci.html#unset_first">unset_first</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.view"> + <span class="title"> + <a href="LuCI.view.html">LuCI.view</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.view#addFooter"><a href="LuCI.view.html#addFooter">addFooter</a></li> + + <li data-name="LuCI.view#handleReset"><a href="LuCI.view.html#handleReset">handleReset</a></li> + + <li data-name="LuCI.view#handleSave"><a href="LuCI.view.html#handleSave">handleSave</a></li> + + <li data-name="LuCI.view#handleSaveApply"><a href="LuCI.view.html#handleSaveApply">handleSaveApply</a></li> + + <li data-name="LuCI.view#load"><a href="LuCI.view.html#load">load</a></li> + + <li data-name="LuCI.view#render"><a href="LuCI.view.html#render">render</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.XHR"> + <span class="title"> + <a href="LuCI.XHR.html">LuCI.XHR</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.XHR#abort"><a href="LuCI.XHR.html#abort">abort</a></li> + + <li data-name="LuCI.XHR#busy"><a href="LuCI.XHR.html#busy">busy</a></li> + + <li data-name="LuCI.XHR#cancel"><a href="LuCI.XHR.html#cancel">cancel</a></li> + + <li data-name="LuCI.XHR#get"><a href="LuCI.XHR.html#get">get</a></li> + + <li data-name="LuCI.XHR#post"><a href="LuCI.XHR.html#post">post</a></li> + + <li data-name="LuCI.XHR#send_form"><a href="LuCI.XHR.html#send_form">send_form</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + </ul> +</div> + <div class="main"> + <h1 class="page-title" data-filename="LuCI.Network.WifiNetwork.html">Class: WifiNetwork</h1> + <section> - + <header> + <h2> + <span class="ancestors"><a href="LuCI.html">LuCI</a><a href="LuCI.Network.html">.Network</a>.</span> - <h2><span class="attribs"><span class="type-signature"></span></span> - <span class="ancestors"><a href="LuCI.html">LuCI</a><a href="LuCI.Network.html">.Network</a>.</span>WifiNetwork</h2> - - <div class="class-description"><p>A <code>Network.WifiNetwork</code> instance represents a wireless network (vif) + WifiNetwork + </h2> + + <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> +</header> <article> <div class="container-overview"> + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="WifiNetwork"> + + new LuCI.Network.WifiNetwork<span class="signature">()</span> + </h4> + + + <div class="tag-source"> + network.js, line 3280 + </div> + + </div> + +</dt> +<dd> + + - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3280">line 3280</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> </div> - - - - - - - - + + + + + + <h3 class="subsection-title">Methods</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="get"> + + get<span class="signature">(opt)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string|Array.<string>}</span> + </h4> + + <div class="tag-source"> + network.js, line 3313 + </div> + + </div> - <h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(opt)</span><span class="type-signature"> → {null|string|Array.<string>}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Read the given UCI option value of this wireless network.</p> + </div> - - -<div class="description"> - <p>Read the given UCI option value of this wireless network.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <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"> @@ -198,422 +1237,387 @@ such networks in parallel.</p></div> </td> - - - - <td class="description last"><p>The UCI option name to read.</p></td> + + <td class="description last"> + + <p>The UCI option name to read.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3313">line 3313</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the UCI option value or <code>null</code> if the requested option is -not found.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">string</span> -| - -<span class="param-type">Array.<string></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + string + | + + Array.<string> + + + </td> + <td class="description last">Returns the UCI option value or <code>null</code> if the requested option is +not found.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getActiveBSSID"> + + getActiveBSSID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3566 + </div> + + </div> - <h4 class="name" id="getActiveBSSID"><span class="type-signature"></span>getActiveBSSID<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the current BSSID from runtime information.</p> + </div> - - -<div class="description"> - <p>Query the current BSSID from runtime information.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3566">line 3566</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the current BSSID or Mesh ID as reported by <code>ubus</code> runtime -information.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the current BSSID or Mesh ID as reported by <code>ubus</code> runtime +information.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getActiveEncryption"> + + getActiveEncryption<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3577 + </div> + + </div> - <h4 class="name" id="getActiveEncryption"><span class="type-signature"></span>getActiveEncryption<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the current encryption settings from runtime information.</p> + </div> - - -<div class="description"> - <p>Query the current encryption settings from runtime information.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3577">line 3577</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a string describing the current encryption or <code>-</code> if the the -encryption state could not be found in <code>ubus</code> runtime information.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns a string describing the current encryption or <code>-</code> if the the +encryption state could not be found in <code>ubus</code> runtime information.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getActiveMode"> + + getActiveMode<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3514 + </div> + + </div> - <h4 class="name" id="getActiveMode"><span class="type-signature"></span>getActiveMode<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the current operation mode from runtime information.</p> + </div> - - -<div class="description"> - <p>Query the current operation mode from runtime information.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3514">line 3514</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns the human readable mode name as reported by <code>ubus</code> runtime -state. Possible returned values are:</p> + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the human readable mode name as reported by <code>ubus</code> runtime +state. Possible returned values are: <ul> <li><code>Master</code></li> <li><code>Ad-Hoc</code></li> @@ -625,3475 +1629,3166 @@ state. Possible returned values are:</p> <li><code>P2P Client</code></li> <li><code>P2P Go</code></li> <li><code>Unknown</code></li> -</ul> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">string</span> - - - </dd> -</dl> - +</ul></td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getActiveModeI18n"> + + getActiveModeI18n<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3535 + </div> + + </div> - <h4 class="name" id="getActiveModeI18n"><span class="type-signature"></span>getActiveModeI18n<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Query the current operation mode from runtime information as + <div class="description"> + <p>Query the current operation mode from runtime information as translated string.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3535">line 3535</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the translated, human readable mode name as reported by -<code>ubus</code> runtime state.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the translated, human readable mode name as reported by +<code>ubus</code> runtime state.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getActiveSSID"> + + getActiveSSID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3555 + </div> + + </div> - <h4 class="name" id="getActiveSSID"><span class="type-signature"></span>getActiveSSID<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the current SSID from runtime information.</p> + </div> - - -<div class="description"> - <p>Query the current SSID from runtime information.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3555">line 3555</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the current SSID or Mesh ID as reported by <code>ubus</code> runtime -information.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the current SSID or Mesh ID as reported by <code>ubus</code> runtime +information.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getAssocList"> + + getAssocList<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Array.<<a href="LuCI.Network.html#.WifiPeerEntry">LuCI.Network.WifiPeerEntry</a>>>}</span> + </h4> + + <div class="tag-source"> + network.js, line 3757 + </div> + + </div> - <h4 class="name" 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></h4> +</dt> +<dd> - + + <div class="description"> + <p>Fetch the list of associated peers.</p> + </div> - - -<div class="description"> - <p>Fetch the list of associated peers.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3757">line 3757</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to an array of wireless peers associated -with this network.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Promise.<Array.<<a href="LuCI.Network.html#.WifiPeerEntry">LuCI.Network.WifiPeerEntry</a>>></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Promise.<Array.<<a href="LuCI.Network.html#.WifiPeerEntry">LuCI.Network.WifiPeerEntry</a>>> + + + </td> + <td class="description last">Returns a promise resolving to an array of wireless peers associated +with this network.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getBitRate"> + + getBitRate<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|number}</span> + </h4> + + <div class="tag-source"> + network.js, line 3787 + </div> + + </div> - <h4 class="name" id="getBitRate"><span class="type-signature"></span>getBitRate<span class="signature">()</span><span class="type-signature"> → {null|number}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Query the current average bitrate of all peers associated to this + <div class="description"> + <p>Query the current average bitrate of all peers associated to this wireless network.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3787">line 3787</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns the average bit rate among all peers associated to the network + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + number + + + </td> + <td class="description last">Returns the average bit rate among all peers associated to the network as reported by <code>ubus</code> runtime information or <code>null</code> if the information -is not available.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type">number</span> - - - </dd> -</dl> - +is not available.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getBSSID"> + + getBSSID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3392 + </div> + + </div> - <h4 class="name" id="getBSSID"><span class="type-signature"></span>getBSSID<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the configured BSSID of the wireless network.</p> + </div> - - -<div class="description"> - <p>Get the configured BSSID of the wireless network.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3392">line 3392</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the BSSID value or <code>null</code> if none has been specified.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the BSSID value or <code>null</code> if none has been specified.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getChannel"> + + getChannel<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|number}</span> + </h4> + + <div class="tag-source"> + network.js, line 3803 + </div> + + </div> - <h4 class="name" id="getChannel"><span class="type-signature"></span>getChannel<span class="signature">()</span><span class="type-signature"> → {null|number}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the current wireless channel.</p> + </div> - - -<div class="description"> - <p>Query the current wireless channel.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3803">line 3803</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<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> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">number</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + number + + + </td> + <td class="description last">Returns the wireless channel as reported by <code>ubus</code> runtime information +or <code>null</code> if it cannot be determined.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getCountryCode"> + + getCountryCode<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3836 + </div> + + </div> - <h4 class="name" id="getCountryCode"><span class="type-signature"></span>getCountryCode<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the current country code.</p> + </div> - - -<div class="description"> - <p>Query the current country code.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3836">line 3836</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<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> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the wireless country code as reported by <code>ubus</code> runtime +information or <code>00</code> if it cannot be determined.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getDevice"> + + getDevice<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>}</span> + </h4> + + <div class="tag-source"> + network.js, line 3982 + </div> + + </div> - <h4 class="name" 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></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the associated Linux network device.</p> + </div> - - -<div class="description"> - <p>Get the associated Linux network device.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3982">line 3982</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a <code>Network.Device</code> instance representing the Linux network -device associted with this wireless network.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type"><a href="LuCI.Network.Device.html">LuCI.Network.Device</a></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + <a href="LuCI.Network.Device.html">LuCI.Network.Device</a> + + + </td> + <td class="description last">Returns a <code>Network.Device</code> instance representing the Linux network +device associted with this wireless network.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getFrequency"> + + getFrequency<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3769 + </div> + + </div> - <h4 class="name" id="getFrequency"><span class="type-signature"></span>getFrequency<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the current operating frequency of the wireless network.</p> + </div> - - -<div class="description"> - <p>Query the current operating frequency of the wireless network.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3769">line 3769</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns the current operating frequency of the network from <code>ubus</code> + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">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> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> -</dl> - +available.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getI18n"> + + getI18n<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3930 + </div> + + </div> - <h4 class="name" id="getI18n"><span class="type-signature"></span>getI18n<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get a description string for this wireless network.</p> + </div> - - -<div class="description"> - <p>Get a description string for this wireless network.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3930">line 3930</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a string describing this network, consisting of the + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">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> - <dt> - Type - </dt> - <dd> - -<span class="param-type">string</span> - - - </dd> -</dl> - +name, depending on which information is available.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getID"> + + getID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3417 + </div> + + </div> - <h4 class="name" id="getID"><span class="type-signature"></span>getID<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Get the internal network ID of this wireless network.</p> + <div class="description"> + <p>Get the internal network ID of this wireless network.</p> <p>The network ID is a LuCI specific identifer in the form <code>radio#.network#</code> to identify wireless networks by their corresponding radio and network index numbers.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3417">line 3417</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the LuCI specific network ID.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the LuCI specific network ID.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getIfname"> + + getIfname<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3439 + </div> + + </div> - <h4 class="name" id="getIfname"><span class="type-signature"></span>getIfname<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the Linux network device name.</p> + </div> - - -<div class="description"> - <p>Get the Linux network device name.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3439">line 3439</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns the current Linux network device name as resolved from + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">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> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> -</dl> - +associated network device, e.g. when not configured or up.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getMeshID"> + + getMeshID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3379 + </div> + + </div> - <h4 class="name" id="getMeshID"><span class="type-signature"></span>getMeshID<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the configured Mesh ID of the wireless network.</p> + </div> - - -<div class="description"> - <p>Get the configured Mesh ID of the wireless network.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3379">line 3379</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<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> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the configured mesh ID value or <code>null</code> when this network +is not in mesh mode.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getMode"> + + getMode<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3354 + </div> + + </div> - <h4 class="name" id="getMode"><span class="type-signature"></span>getMode<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the configured operation mode of the wireless network.</p> + </div> - - -<div class="description"> - <p>Get the configured operation mode of the wireless network.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3354">line 3354</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns the configured operation mode. Possible values are:</p> + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the configured operation mode. Possible values are: <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> - <dt> - Type - </dt> - <dd> - -<span class="param-type">string</span> - - - </dd> -</dl> - +</ul></td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getName"> + + getName<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3427 + </div> + + </div> - <h4 class="name" id="getName"><span class="type-signature"></span>getName<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the configuration ID of this wireless network.</p> + </div> - - -<div class="description"> - <p>Get the configuration ID of this wireless network.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3427">line 3427</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the corresponding UCI section ID of the network.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the corresponding UCI section ID of the network.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getNetwork"> + + getNetwork<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>}</span> + </h4> + + <div class="tag-source"> + network.js, line 3946 + </div> + + </div> - <h4 class="name" 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></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the primary logical interface this wireless network is attached to.</p> + </div> - - -<div class="description"> - <p>Get the primary logical interface this wireless network is attached to.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3946">line 3946</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a <code>Network.Protocol</code> instance representing the logical + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + <a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a> + + + </td> + <td class="description last">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> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type"><a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a></span> - - - </dd> -</dl> - +interface.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getNetworkNames"> + + getNetworkNames<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<string>}</span> + </h4> + + <div class="tag-source"> + network.js, line 3403 + </div> + + </div> - <h4 class="name" id="getNetworkNames"><span class="type-signature"></span>getNetworkNames<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Get the names of the logical interfaces this wireless network is + <div class="description"> + <p>Get the names of the logical interfaces this wireless network is attached to.</p> -</div> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3403">line 3403</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns an array of logical interface names.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Array.<string></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Array.<string> + + + </td> + <td class="description last">Returns an array of logical interface names.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getNetworks"> + + getNetworks<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>}</span> + </h4> + + <div class="tag-source"> + network.js, line 3957 + </div> + + </div> - <h4 class="name" 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></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the logical interfaces this wireless network is attached to.</p> + </div> - - -<div class="description"> - <p>Get the logical interfaces this wireless network is attached to.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3957">line 3957</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<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> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>> + + + </td> + <td class="description last">Returns an array of <code>Network.Protocol</code> instances representing the +logical interfaces this wireless network is attached to.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getNoise"> + + getNoise<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span> + </h4> + + <div class="tag-source"> + network.js, line 3825 + </div> + + </div> - <h4 class="name" id="getNoise"><span class="type-signature"></span>getNoise<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the current radio noise floor.</p> + </div> - - -<div class="description"> - <p>Query the current radio noise floor.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3825">line 3825</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<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> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">number</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + number + + + </td> + <td class="description last">Returns the radio noise floor in dBm as reported by <code>ubus</code> runtime +information or <code>0</code> if it cannot be determined.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getShortName"> + + getShortName<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3915 + </div> + + </div> - <h4 class="name" id="getShortName"><span class="type-signature"></span>getShortName<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get a short description string for this wireless network.</p> + </div> - - -<div class="description"> - <p>Get a short description string for this wireless network.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3915">line 3915</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a string describing this network, consisting of the + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">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> - <dt> - Type - </dt> - <dd> - -<span class="param-type">string</span> - - - </dd> -</dl> - +internal network ID, depending on which information is available.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getSignal"> + + getSignal<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|number}</span> + </h4> + + <div class="tag-source"> + network.js, line 3814 + </div> + + </div> - <h4 class="name" id="getSignal"><span class="type-signature"></span>getSignal<span class="signature">()</span><span class="type-signature"> → {null|number}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the current wireless signal.</p> + </div> - - -<div class="description"> - <p>Query the current wireless signal.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3814">line 3814</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<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> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">number</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + number + + + </td> + <td class="description last">Returns the wireless signal in dBm as reported by <code>ubus</code> runtime +information or <code>null</code> if it cannot be determined.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getSignalLevel"> + + getSignalLevel<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span> + </h4> + + <div class="tag-source"> + network.js, line 3874 + </div> + + </div> - <h4 class="name" id="getSignalLevel"><span class="type-signature"></span>getSignalLevel<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Calculate the current signal.</p> + </div> - - -<div class="description"> - <p>Calculate the current signal.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + - - - <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3874">line 3874</a> - </li></ul></dd> - - - </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<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> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">number</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + number + + + </td> + <td class="description last">Returns the calculated signal level, which is the difference between +noise and signal (SNR), divided by 5.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getSignalPercent"> + + getSignalPercent<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span> + </h4> + + <div class="tag-source"> + network.js, line 3897 + </div> + + </div> - <h4 class="name" id="getSignalPercent"><span class="type-signature"></span>getSignalPercent<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Calculate the current signal quality percentage.</p> + </div> - - -<div class="description"> - <p>Calculate the current signal quality percentage.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3897">line 3897</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns the calculated signal quality in percent. The value is + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + number + + + </td> + <td class="description last">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> - <dt> - Type - </dt> - <dd> - -<span class="param-type">number</span> - - - </dd> -</dl> - +by <code>ubus</code> runtime state.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getSSID"> + + getSSID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3365 + </div> + + </div> - <h4 class="name" id="getSSID"><span class="type-signature"></span>getSSID<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the configured SSID of the wireless network.</p> + </div> - - -<div class="description"> - <p>Get the configured SSID of the wireless network.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3365">line 3365</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the configured SSID value or <code>null</code> when this network is -in mesh mode.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the configured SSID value or <code>null</code> when this network is +in mesh mode.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getTXPower"> + + getTXPower<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|number}</span> + </h4> + + <div class="tag-source"> + network.js, line 3847 + </div> + + </div> - <h4 class="name" id="getTXPower"><span class="type-signature"></span>getTXPower<span class="signature">()</span><span class="type-signature"> → {null|number}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Query the current radio TX power.</p> + </div> - - -<div class="description"> - <p>Query the current radio TX power.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3847">line 3847</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<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> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">number</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + number + + + </td> + <td class="description last">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.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getTXPowerOffset"> + + getTXPowerOffset<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span> + </h4> + + <div class="tag-source"> + network.js, line 3862 + </div> + + </div> - <h4 class="name" id="getTXPowerOffset"><span class="type-signature"></span>getTXPowerOffset<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Query the radio TX power offset.</p> + <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> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3862">line 3862</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns the wireless network transmit power offset in dBm as reported + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + number + + + </td> + <td class="description last">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> - <dt> - Type - </dt> - <dd> - -<span class="param-type">number</span> - - - </dd> -</dl> - +cannot be determined.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getWifiDevice"> + + getWifiDevice<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|<a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>}</span> + </h4> + + <div class="tag-source"> + network.js, line 3467 + </div> + + </div> - <h4 class="name" 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></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the corresponding wifi radio device.</p> + </div> - - -<div class="description"> - <p>Get the corresponding wifi radio device.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3467">line 3467</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns a <code>Network.WifiDevice</code> instance representing the corresponding + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + <a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a> + + + </td> + <td class="description last">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> - <dt> - Type - </dt> - <dd> - -<span class="param-type">null</span> -| - -<span class="param-type"><a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a></span> - - - </dd> -</dl> - +found.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="getWifiDeviceName"> + + getWifiDeviceName<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + <div class="tag-source"> + network.js, line 3455 + </div> + + </div> - <h4 class="name" id="getWifiDeviceName"><span class="type-signature"></span>getWifiDeviceName<span class="signature">()</span><span class="type-signature"> → {null|string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Get the name of the corresponding wifi radio device.</p> + </div> - - -<div class="description"> - <p>Get the name of the corresponding wifi radio device.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3455">line 3455</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<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> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">null</span> -| - -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the name of the radio device this network is configured on +or <code>null</code> if it cannot be determined.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="isDisabled"> + + isDisabled<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + network.js, line 3339 + </div> + + </div> - <h4 class="name" id="isDisabled"><span class="type-signature"></span>isDisabled<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Checks whether this wireless network is disabled.</p> + </div> - - -<div class="description"> - <p>Checks whether this wireless network is disabled.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3339">line 3339</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns <code>true</code> when the wireless radio is marked as disabled in <code>ubus</code> + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + boolean + + + </td> + <td class="description last">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> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> - - - </dd> -</dl> - +UCI configuration.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="isUp"> + + isUp<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + network.js, line 3488 + </div> + + </div> - <h4 class="name" id="isUp"><span class="type-signature"></span>isUp<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Check whether the radio network is up.</p> + <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> - - - - - - - - - - - - + </div> + + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3488">line 3488</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> when the network is up, else <code>false</code>.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="set"><span class="type-signature"></span>set<span class="signature">(opt, val)</span><span class="type-signature"></span></h4> - - - - -<div class="description"> - <p>Set the given UCI option of this network to the given value.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + boolean + + + </td> + <td class="description last">Returns <code>true</code> when the network is up, else <code>false</code>.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="set"> + + set<span class="signature">(opt, val)</span> + </h4> + + + <div class="tag-source"> + network.js, line 3327 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Set the given UCI option of this network to the given value.</p> + </div> + - <tbody> + + + + + +<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"> @@ -4102,21 +4797,21 @@ instance.</p> </td> - - - - <td class="description last"><p>The name of the UCI option to set.</p></td> + + <td class="description last"> + + <p>The name of the UCI option to set.</p></td> </tr> - - - + + + <tr> <td class="name"><code>val</code></td> - + <td class="type"> @@ -4131,109 +4826,83 @@ instance.</p> </td> - - - - <td class="description last"><p>The value to set or <code>null</code> to remove the given option from the + + <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> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="network.js.html">network.js</a>, <a href="network.js.html#line3327">line 3327</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - - - + + + + + + +</dd> + </dl> + + + + </article> -</section> - - +</section> -</div> -<nav> - <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="LuCI.html">LuCI</a></li><li><a href="LuCI.Class.html">Class</a></li><li><a href="LuCI.dom.html">dom</a></li><li><a href="LuCI.fs.html">fs</a></li><li><a href="LuCI.Headers.html">Headers</a></li><li><a href="LuCI.Network.html">Network</a></li><li><a href="LuCI.Network.Device.html">Device</a></li><li><a href="LuCI.Network.Hosts.html">Hosts</a></li><li><a href="LuCI.Network.Protocol.html">Protocol</a></li><li><a href="LuCI.Network.WifiDevice.html">WifiDevice</a></li><li><a href="LuCI.Network.WifiNetwork.html">WifiNetwork</a></li><li><a href="LuCI.Poll.html">Poll</a></li><li><a href="LuCI.Request.html">Request</a></li><li><a href="LuCI.Request.poll.html">poll</a></li><li><a href="LuCI.Response.html">Response</a></li><li><a href="LuCI.rpc.html">rpc</a></li><li><a href="LuCI.uci.html">uci</a></li><li><a href="LuCI.view.html">view</a></li><li><a href="LuCI.XHR.html">XHR</a></li></ul> -</nav> -<br class="clear"> -<footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) -</footer> + -<script> prettyPrint(); </script> -<script src="scripts/linenumber.js"> </script> + <footer> + Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) + </footer> + </div> +</div> +<script>prettyPrint();</script> +<script src="scripts/jaguar.js"></script> </body> </html>
\ No newline at end of file |