docs/jsapi/LuCI.Network.html

   1 <!DOCTYPE html>
   2 <html>
   3 <head>
   4     <meta charset="utf-8">
   5     <title>Class: Network</title>
   6
   7
   8     <script src="scripts/prettify/prettify.js"></script>
   9     <script src="scripts/prettify/lang-css.js"></script>
  10     <script src="scripts/jquery.min.js"></script>
  11     <!--[if lt IE 9]>
  12       <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  13     <![endif]-->
  14     <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  15     <link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css">
  16     <link type="text/css" rel="stylesheet" href="styles/jaguar.css">
  17
  18
  19     <script>
  20     var config = {"monospaceLinks":true,"cleverLinks":true,"default":{}};
  21     </script>
  22
  23
  24
  25 </head>
  26 <body>
  27 <div id="wrap" class="clearfix">
  28
  29 <div class="navigation">
  30     <h3 class="applicationName"><a href="index.html"></a></h3>
  31
  32     <div class="search">
  33         <input id="search" type="text" class="form-control input-sm" placeholder="Search Documentations">
  34     </div>
  35     <ul class="list">
  36
  37         <li class="item" data-name="LuCI">
  38             <span class="title">
  39                 <a href="LuCI.html">LuCI</a>
  40
  41             </span>
  42             <ul class="members itemMembers">
  43
  44             <span class="subtitle">Members</span>
  45
  46                 <li data-name="LuCI#env"><a href="LuCI.html#env">env</a></li>
  47
  48             </ul>
  49             <ul class="typedefs itemMembers">
  50
  51             <span class="subtitle">Typedefs</span>
  52
  53                 <li data-name="LuCI.requestCallbackFn"><a href="LuCI.html#.requestCallbackFn">requestCallbackFn</a></li>
  54
  55             </ul>
  56             <ul class="typedefs itemMembers">
  57
  58             </ul>
  59             <ul class="methods itemMembers">
  60
  61             <span class="subtitle">Methods</span>
  62
  63                 <li data-name="LuCI#bind"><a href="LuCI.html#bind">bind</a></li>
  64
  65                 <li data-name="LuCI#error"><a href="LuCI.html#error">error</a></li>
  66
  67                 <li data-name="LuCI#get"><a href="LuCI.html#get">get</a></li>
  68
  69                 <li data-name="LuCI#halt"><a href="LuCI.html#halt">halt</a></li>
  70
  71                 <li data-name="LuCI#hasSystemFeature"><a href="LuCI.html#hasSystemFeature">hasSystemFeature</a></li>
  72
  73                 <li data-name="LuCI#isObject"><a href="LuCI.html#isObject">isObject</a></li>
  74
  75                 <li data-name="LuCI#location"><a href="LuCI.html#location">location</a></li>
  76
  77                 <li data-name="LuCI#path"><a href="LuCI.html#path">path</a></li>
  78
  79                 <li data-name="LuCI#poll"><a href="LuCI.html#poll">poll</a></li>
  80
  81                 <li data-name="LuCI#post"><a href="LuCI.html#post">post</a></li>
  82
  83                 <li data-name="LuCI#raise"><a href="LuCI.html#raise">raise</a></li>
  84
  85                 <li data-name="LuCI#require"><a href="LuCI.html#require">require</a></li>
  86
  87                 <li data-name="LuCI#resolveDefault"><a href="LuCI.html#resolveDefault">resolveDefault</a></li>
  88
  89                 <li data-name="LuCI#resource"><a href="LuCI.html#resource">resource</a></li>
  90
  91                 <li data-name="LuCI#run"><a href="LuCI.html#run">run</a></li>
  92
  93                 <li data-name="LuCI#sortedKeys"><a href="LuCI.html#sortedKeys">sortedKeys</a></li>
  94
  95                 <li data-name="LuCI#stop"><a href="LuCI.html#stop">stop</a></li>
  96
  97                 <li data-name="LuCI#toArray"><a href="LuCI.html#toArray">toArray</a></li>
  98
  99                 <li data-name="LuCI#url"><a href="LuCI.html#url">url</a></li>
 100
 101             </ul>
 102             <ul class="events itemMembers">
 103
 104             </ul>
 105         </li>
 106
 107         <li class="item" data-name="LuCI.Class">
 108             <span class="title">
 109                 <a href="LuCI.Class.html">LuCI.Class</a>
 110
 111             </span>
 112             <ul class="members itemMembers">
 113
 114             </ul>
 115             <ul class="typedefs itemMembers">
 116
 117             </ul>
 118             <ul class="typedefs itemMembers">
 119
 120             </ul>
 121             <ul class="methods itemMembers">
 122
 123             <span class="subtitle">Methods</span>
 124
 125                 <li data-name="LuCI.Class.extend"><a href="LuCI.Class.html#.extend">extend</a></li>
 126
 127                 <li data-name="LuCI.Class.instantiate"><a href="LuCI.Class.html#.instantiate">instantiate</a></li>
 128
 129                 <li data-name="LuCI.Class.isSubclass"><a href="LuCI.Class.html#.isSubclass">isSubclass</a></li>
 130
 131                 <li data-name="LuCI.Class.singleton"><a href="LuCI.Class.html#.singleton">singleton</a></li>
 132
 133                 <li data-name="LuCI.Class#super"><a href="LuCI.Class.html#super">super</a></li>
 134
 135                 <li data-name="LuCI.Class#varargs"><a href="LuCI.Class.html#varargs">varargs</a></li>
 136
 137             </ul>
 138             <ul class="events itemMembers">
 139
 140             </ul>
 141         </li>
 142
 143         <li class="item" data-name="LuCI.dom">
 144             <span class="title">
 145                 <a href="LuCI.dom.html">LuCI.dom</a>
 146
 147             </span>
 148             <ul class="members itemMembers">
 149
 150             </ul>
 151             <ul class="typedefs itemMembers">
 152
 153             <span class="subtitle">Typedefs</span>
 154
 155                 <li data-name="LuCI.dom~ignoreCallbackFn"><a href="LuCI.dom.html#~ignoreCallbackFn">ignoreCallbackFn</a></li>
 156
 157             </ul>
 158             <ul class="typedefs itemMembers">
 159
 160             </ul>
 161             <ul class="methods itemMembers">
 162
 163             <span class="subtitle">Methods</span>
 164
 165                 <li data-name="LuCI.dom#append"><a href="LuCI.dom.html#append">append</a></li>
 166
 167                 <li data-name="LuCI.dom#attr"><a href="LuCI.dom.html#attr">attr</a></li>
 168
 169                 <li data-name="LuCI.dom#bindClassInstance"><a href="LuCI.dom.html#bindClassInstance">bindClassInstance</a></li>
 170
 171                 <li data-name="LuCI.dom#callClassMethod"><a href="LuCI.dom.html#callClassMethod">callClassMethod</a></li>
 172
 173                 <li data-name="LuCI.dom#content"><a href="LuCI.dom.html#content">content</a></li>
 174
 175                 <li data-name="LuCI.dom#create"><a href="LuCI.dom.html#create">create</a></li>
 176
 177                 <li data-name="LuCI.dom#data"><a href="LuCI.dom.html#data">data</a></li>
 178
 179                 <li data-name="LuCI.dom#elem"><a href="LuCI.dom.html#elem">elem</a></li>
 180
 181                 <li data-name="LuCI.dom#findClassInstance"><a href="LuCI.dom.html#findClassInstance">findClassInstance</a></li>
 182
 183                 <li data-name="LuCI.dom#isEmpty"><a href="LuCI.dom.html#isEmpty">isEmpty</a></li>
 184
 185                 <li data-name="LuCI.dom#matches"><a href="LuCI.dom.html#matches">matches</a></li>
 186
 187                 <li data-name="LuCI.dom#parent"><a href="LuCI.dom.html#parent">parent</a></li>
 188
 189                 <li data-name="LuCI.dom#parse"><a href="LuCI.dom.html#parse">parse</a></li>
 190
 191             </ul>
 192             <ul class="events itemMembers">
 193
 194             </ul>
 195         </li>
 196
 197         <li class="item" data-name="LuCI.fs">
 198             <span class="title">
 199                 <a href="LuCI.fs.html">LuCI.fs</a>
 200
 201             </span>
 202             <ul class="members itemMembers">
 203
 204             </ul>
 205             <ul class="typedefs itemMembers">
 206
 207             <span class="subtitle">Typedefs</span>
 208
 209                 <li data-name="LuCI.fs.FileExecResult"><a href="LuCI.fs.html#.FileExecResult">FileExecResult</a></li>
 210
 211                 <li data-name="LuCI.fs.FileStatEntry"><a href="LuCI.fs.html#.FileStatEntry">FileStatEntry</a></li>
 212
 213             </ul>
 214             <ul class="typedefs itemMembers">
 215
 216             </ul>
 217             <ul class="methods itemMembers">
 218
 219             <span class="subtitle">Methods</span>
 220
 221                 <li data-name="LuCI.fs#exec"><a href="LuCI.fs.html#exec">exec</a></li>
 222
 223                 <li data-name="LuCI.fs#lines"><a href="LuCI.fs.html#lines">lines</a></li>
 224
 225                 <li data-name="LuCI.fs#list"><a href="LuCI.fs.html#list">list</a></li>
 226
 227                 <li data-name="LuCI.fs#read"><a href="LuCI.fs.html#read">read</a></li>
 228
 229                 <li data-name="LuCI.fs#remove"><a href="LuCI.fs.html#remove">remove</a></li>
 230
 231                 <li data-name="LuCI.fs#stat"><a href="LuCI.fs.html#stat">stat</a></li>
 232
 233                 <li data-name="LuCI.fs#trimmed"><a href="LuCI.fs.html#trimmed">trimmed</a></li>
 234
 235                 <li data-name="LuCI.fs#write"><a href="LuCI.fs.html#write">write</a></li>
 236
 237             </ul>
 238             <ul class="events itemMembers">
 239
 240             </ul>
 241         </li>
 242
 243         <li class="item" data-name="LuCI.Headers">
 244             <span class="title">
 245                 <a href="LuCI.Headers.html">LuCI.Headers</a>
 246
 247             </span>
 248             <ul class="members itemMembers">
 249
 250             </ul>
 251             <ul class="typedefs itemMembers">
 252
 253             </ul>
 254             <ul class="typedefs itemMembers">
 255
 256             </ul>
 257             <ul class="methods itemMembers">
 258
 259             <span class="subtitle">Methods</span>
 260
 261                 <li data-name="LuCI.Headers#get"><a href="LuCI.Headers.html#get">get</a></li>
 262
 263                 <li data-name="LuCI.Headers#has"><a href="LuCI.Headers.html#has">has</a></li>
 264
 265             </ul>
 266             <ul class="events itemMembers">
 267
 268             </ul>
 269         </li>
 270
 271         <li class="item" data-name="LuCI.Network">
 272             <span class="title">
 273                 <a href="LuCI.Network.html">LuCI.Network</a>
 274
 275             </span>
 276             <ul class="members itemMembers">
 277
 278             </ul>
 279             <ul class="typedefs itemMembers">
 280
 281             <span class="subtitle">Typedefs</span>
 282
 283                 <li data-name="LuCI.Network.SwitchTopology"><a href="LuCI.Network.html#.SwitchTopology">SwitchTopology</a></li>
 284
 285                 <li data-name="LuCI.Network.WifiEncryption"><a href="LuCI.Network.html#.WifiEncryption">WifiEncryption</a></li>
 286
 287                 <li data-name="LuCI.Network.WifiPeerEntry"><a href="LuCI.Network.html#.WifiPeerEntry">WifiPeerEntry</a></li>
 288
 289                 <li data-name="LuCI.Network.WifiRateEntry"><a href="LuCI.Network.html#.WifiRateEntry">WifiRateEntry</a></li>
 290
 291                 <li data-name="LuCI.Network.WifiScanResult"><a href="LuCI.Network.html#.WifiScanResult">WifiScanResult</a></li>
 292
 293             </ul>
 294             <ul class="typedefs itemMembers">
 295
 296             </ul>
 297             <ul class="methods itemMembers">
 298
 299             <span class="subtitle">Methods</span>
 300
 301                 <li data-name="LuCI.Network#addNetwork"><a href="LuCI.Network.html#addNetwork">addNetwork</a></li>
 302
 303                 <li data-name="LuCI.Network#addWifiNetwork"><a href="LuCI.Network.html#addWifiNetwork">addWifiNetwork</a></li>
 304
 305                 <li data-name="LuCI.Network#deleteNetwork"><a href="LuCI.Network.html#deleteNetwork">deleteNetwork</a></li>
 306
 307                 <li data-name="LuCI.Network#deleteWifiNetwork"><a href="LuCI.Network.html#deleteWifiNetwork">deleteWifiNetwork</a></li>
 308
 309                 <li data-name="LuCI.Network#flushCache"><a href="LuCI.Network.html#flushCache">flushCache</a></li>
 310
 311                 <li data-name="LuCI.Network#formatWifiEncryption"><a href="LuCI.Network.html#formatWifiEncryption">formatWifiEncryption</a></li>
 312
 313                 <li data-name="LuCI.Network#getDevice"><a href="LuCI.Network.html#getDevice">getDevice</a></li>
 314
 315                 <li data-name="LuCI.Network#getDevices"><a href="LuCI.Network.html#getDevices">getDevices</a></li>
 316
 317                 <li data-name="LuCI.Network#getDSLModemType"><a href="LuCI.Network.html#getDSLModemType">getDSLModemType</a></li>
 318
 319                 <li data-name="LuCI.Network#getHostHints"><a href="LuCI.Network.html#getHostHints">getHostHints</a></li>
 320
 321                 <li data-name="LuCI.Network#getIfnameOf"><a href="LuCI.Network.html#getIfnameOf">getIfnameOf</a></li>
 322
 323                 <li data-name="LuCI.Network#getNetwork"><a href="LuCI.Network.html#getNetwork">getNetwork</a></li>
 324
 325                 <li data-name="LuCI.Network#getNetworks"><a href="LuCI.Network.html#getNetworks">getNetworks</a></li>
 326
 327                 <li data-name="LuCI.Network#getProtocol"><a href="LuCI.Network.html#getProtocol">getProtocol</a></li>
 328
 329                 <li data-name="LuCI.Network#getProtocols"><a href="LuCI.Network.html#getProtocols">getProtocols</a></li>
 330
 331                 <li data-name="LuCI.Network#getSwitchTopologies"><a href="LuCI.Network.html#getSwitchTopologies">getSwitchTopologies</a></li>
 332
 333                 <li data-name="LuCI.Network#getWAN6Networks"><a href="LuCI.Network.html#getWAN6Networks">getWAN6Networks</a></li>
 334
 335                 <li data-name="LuCI.Network#getWANNetworks"><a href="LuCI.Network.html#getWANNetworks">getWANNetworks</a></li>
 336
 337                 <li data-name="LuCI.Network#getWifiDevice"><a href="LuCI.Network.html#getWifiDevice">getWifiDevice</a></li>
 338
 339                 <li data-name="LuCI.Network#getWifiDevices"><a href="LuCI.Network.html#getWifiDevices">getWifiDevices</a></li>
 340
 341                 <li data-name="LuCI.Network#getWifiNetwork"><a href="LuCI.Network.html#getWifiNetwork">getWifiNetwork</a></li>
 342
 343                 <li data-name="LuCI.Network#getWifiNetworks"><a href="LuCI.Network.html#getWifiNetworks">getWifiNetworks</a></li>
 344
 345                 <li data-name="LuCI.Network#isIgnoredDevice"><a href="LuCI.Network.html#isIgnoredDevice">isIgnoredDevice</a></li>
 346
 347                 <li data-name="LuCI.Network#maskToPrefix"><a href="LuCI.Network.html#maskToPrefix">maskToPrefix</a></li>
 348
 349                 <li data-name="LuCI.Network#prefixToMask"><a href="LuCI.Network.html#prefixToMask">prefixToMask</a></li>
 350
 351                 <li data-name="LuCI.Network#registerErrorCode"><a href="LuCI.Network.html#registerErrorCode">registerErrorCode</a></li>
 352
 353                 <li data-name="LuCI.Network#registerPatternVirtual"><a href="LuCI.Network.html#registerPatternVirtual">registerPatternVirtual</a></li>
 354
 355                 <li data-name="LuCI.Network#registerProtocol"><a href="LuCI.Network.html#registerProtocol">registerProtocol</a></li>
 356
 357                 <li data-name="LuCI.Network#renameNetwork"><a href="LuCI.Network.html#renameNetwork">renameNetwork</a></li>
 358
 359             </ul>
 360             <ul class="events itemMembers">
 361
 362             </ul>
 363         </li>
 364
 365         <li class="item" data-name="LuCI.Network.Device">
 366             <span class="title">
 367                 <a href="LuCI.Network.Device.html">LuCI.Network.Device</a>
 368
 369             </span>
 370             <ul class="members itemMembers">
 371
 372             </ul>
 373             <ul class="typedefs itemMembers">
 374
 375             </ul>
 376             <ul class="typedefs itemMembers">
 377
 378             </ul>
 379             <ul class="methods itemMembers">
 380
 381             <span class="subtitle">Methods</span>
 382
 383                 <li data-name="LuCI.Network.Device#getBridgeID"><a href="LuCI.Network.Device.html#getBridgeID">getBridgeID</a></li>
 384
 385                 <li data-name="LuCI.Network.Device#getBridgeSTP"><a href="LuCI.Network.Device.html#getBridgeSTP">getBridgeSTP</a></li>
 386
 387                 <li data-name="LuCI.Network.Device#getI18n"><a href="LuCI.Network.Device.html#getI18n">getI18n</a></li>
 388
 389                 <li data-name="LuCI.Network.Device#getIP6Addrs"><a href="LuCI.Network.Device.html#getIP6Addrs">getIP6Addrs</a></li>
 390
 391                 <li data-name="LuCI.Network.Device#getIPAddrs"><a href="LuCI.Network.Device.html#getIPAddrs">getIPAddrs</a></li>
 392
 393                 <li data-name="LuCI.Network.Device#getMAC"><a href="LuCI.Network.Device.html#getMAC">getMAC</a></li>
 394
 395                 <li data-name="LuCI.Network.Device#getMTU"><a href="LuCI.Network.Device.html#getMTU">getMTU</a></li>
 396
 397                 <li data-name="LuCI.Network.Device#getName"><a href="LuCI.Network.Device.html#getName">getName</a></li>
 398
 399                 <li data-name="LuCI.Network.Device#getNetwork"><a href="LuCI.Network.Device.html#getNetwork">getNetwork</a></li>
 400
 401                 <li data-name="LuCI.Network.Device#getNetworks"><a href="LuCI.Network.Device.html#getNetworks">getNetworks</a></li>
 402
 403                 <li data-name="LuCI.Network.Device#getPorts"><a href="LuCI.Network.Device.html#getPorts">getPorts</a></li>
 404
 405                 <li data-name="LuCI.Network.Device#getRXBytes"><a href="LuCI.Network.Device.html#getRXBytes">getRXBytes</a></li>
 406
 407                 <li data-name="LuCI.Network.Device#getRXPackets"><a href="LuCI.Network.Device.html#getRXPackets">getRXPackets</a></li>
 408
 409                 <li data-name="LuCI.Network.Device#getShortName"><a href="LuCI.Network.Device.html#getShortName">getShortName</a></li>
 410
 411                 <li data-name="LuCI.Network.Device#getTXBytes"><a href="LuCI.Network.Device.html#getTXBytes">getTXBytes</a></li>
 412
 413                 <li data-name="LuCI.Network.Device#getTXPackets"><a href="LuCI.Network.Device.html#getTXPackets">getTXPackets</a></li>
 414
 415                 <li data-name="LuCI.Network.Device#getType"><a href="LuCI.Network.Device.html#getType">getType</a></li>
 416
 417                 <li data-name="LuCI.Network.Device#getTypeI18n"><a href="LuCI.Network.Device.html#getTypeI18n">getTypeI18n</a></li>
 418
 419                 <li data-name="LuCI.Network.Device#getWifiNetwork"><a href="LuCI.Network.Device.html#getWifiNetwork">getWifiNetwork</a></li>
 420
 421                 <li data-name="LuCI.Network.Device#isBridge"><a href="LuCI.Network.Device.html#isBridge">isBridge</a></li>
 422
 423                 <li data-name="LuCI.Network.Device#isBridgePort"><a href="LuCI.Network.Device.html#isBridgePort">isBridgePort</a></li>
 424
 425                 <li data-name="LuCI.Network.Device#isUp"><a href="LuCI.Network.Device.html#isUp">isUp</a></li>
 426
 427             </ul>
 428             <ul class="events itemMembers">
 429
 430             </ul>
 431         </li>
 432
 433         <li class="item" data-name="LuCI.Network.Hosts">
 434             <span class="title">
 435                 <a href="LuCI.Network.Hosts.html">LuCI.Network.Hosts</a>
 436
 437             </span>
 438             <ul class="members itemMembers">
 439
 440             </ul>
 441             <ul class="typedefs itemMembers">
 442
 443             </ul>
 444             <ul class="typedefs itemMembers">
 445
 446             </ul>
 447             <ul class="methods itemMembers">
 448
 449             <span class="subtitle">Methods</span>
 450
 451                 <li data-name="LuCI.Network.Hosts#getHostnameByIP6Addr"><a href="LuCI.Network.Hosts.html#getHostnameByIP6Addr">getHostnameByIP6Addr</a></li>
 452
 453                 <li data-name="LuCI.Network.Hosts#getHostnameByIPAddr"><a href="LuCI.Network.Hosts.html#getHostnameByIPAddr">getHostnameByIPAddr</a></li>
 454
 455                 <li data-name="LuCI.Network.Hosts#getHostnameByMACAddr"><a href="LuCI.Network.Hosts.html#getHostnameByMACAddr">getHostnameByMACAddr</a></li>
 456
 457                 <li data-name="LuCI.Network.Hosts#getIP6AddrByMACAddr"><a href="LuCI.Network.Hosts.html#getIP6AddrByMACAddr">getIP6AddrByMACAddr</a></li>
 458
 459                 <li data-name="LuCI.Network.Hosts#getIPAddrByMACAddr"><a href="LuCI.Network.Hosts.html#getIPAddrByMACAddr">getIPAddrByMACAddr</a></li>
 460
 461                 <li data-name="LuCI.Network.Hosts#getMACAddrByIP6Addr"><a href="LuCI.Network.Hosts.html#getMACAddrByIP6Addr">getMACAddrByIP6Addr</a></li>
 462
 463                 <li data-name="LuCI.Network.Hosts#getMACAddrByIPAddr"><a href="LuCI.Network.Hosts.html#getMACAddrByIPAddr">getMACAddrByIPAddr</a></li>
 464
 465                 <li data-name="LuCI.Network.Hosts#getMACHints"><a href="LuCI.Network.Hosts.html#getMACHints">getMACHints</a></li>
 466
 467             </ul>
 468             <ul class="events itemMembers">
 469
 470             </ul>
 471         </li>
 472
 473         <li class="item" data-name="LuCI.Network.Protocol">
 474             <span class="title">
 475                 <a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>
 476
 477             </span>
 478             <ul class="members itemMembers">
 479
 480             </ul>
 481             <ul class="typedefs itemMembers">
 482
 483             </ul>
 484             <ul class="typedefs itemMembers">
 485
 486             </ul>
 487             <ul class="methods itemMembers">
 488
 489             <span class="subtitle">Methods</span>
 490
 491                 <li data-name="LuCI.Network.Protocol#addDevice"><a href="LuCI.Network.Protocol.html#addDevice">addDevice</a></li>
 492
 493                 <li data-name="LuCI.Network.Protocol#containsDevice"><a href="LuCI.Network.Protocol.html#containsDevice">containsDevice</a></li>
 494
 495                 <li data-name="LuCI.Network.Protocol#deleteDevice"><a href="LuCI.Network.Protocol.html#deleteDevice">deleteDevice</a></li>
 496
 497                 <li data-name="LuCI.Network.Protocol#get"><a href="LuCI.Network.Protocol.html#get">get</a></li>
 498
 499                 <li data-name="LuCI.Network.Protocol#getDevice"><a href="LuCI.Network.Protocol.html#getDevice">getDevice</a></li>
 500
 501                 <li data-name="LuCI.Network.Protocol#getDevices"><a href="LuCI.Network.Protocol.html#getDevices">getDevices</a></li>
 502
 503                 <li data-name="LuCI.Network.Protocol#getDNS6Addrs"><a href="LuCI.Network.Protocol.html#getDNS6Addrs">getDNS6Addrs</a></li>
 504
 505                 <li data-name="LuCI.Network.Protocol#getDNSAddrs"><a href="LuCI.Network.Protocol.html#getDNSAddrs">getDNSAddrs</a></li>
 506
 507                 <li data-name="LuCI.Network.Protocol#getErrors"><a href="LuCI.Network.Protocol.html#getErrors">getErrors</a></li>
 508
 509                 <li data-name="LuCI.Network.Protocol#getExpiry"><a href="LuCI.Network.Protocol.html#getExpiry">getExpiry</a></li>
 510
 511                 <li data-name="LuCI.Network.Protocol#getGateway6Addr"><a href="LuCI.Network.Protocol.html#getGateway6Addr">getGateway6Addr</a></li>
 512
 513                 <li data-name="LuCI.Network.Protocol#getGatewayAddr"><a href="LuCI.Network.Protocol.html#getGatewayAddr">getGatewayAddr</a></li>
 514
 515                 <li data-name="LuCI.Network.Protocol#getI18n"><a href="LuCI.Network.Protocol.html#getI18n">getI18n</a></li>
 516
 517                 <li data-name="LuCI.Network.Protocol#getIfname"><a href="LuCI.Network.Protocol.html#getIfname">getIfname</a></li>
 518
 519                 <li data-name="LuCI.Network.Protocol#getIP6Addr"><a href="LuCI.Network.Protocol.html#getIP6Addr">getIP6Addr</a></li>
 520
 521                 <li data-name="LuCI.Network.Protocol#getIP6Addrs"><a href="LuCI.Network.Protocol.html#getIP6Addrs">getIP6Addrs</a></li>
 522
 523                 <li data-name="LuCI.Network.Protocol#getIP6Prefix"><a href="LuCI.Network.Protocol.html#getIP6Prefix">getIP6Prefix</a></li>
 524
 525                 <li data-name="LuCI.Network.Protocol#getIPAddr"><a href="LuCI.Network.Protocol.html#getIPAddr">getIPAddr</a></li>
 526
 527                 <li data-name="LuCI.Network.Protocol#getIPAddrs"><a href="LuCI.Network.Protocol.html#getIPAddrs">getIPAddrs</a></li>
 528
 529                 <li data-name="LuCI.Network.Protocol#getL2Device"><a href="LuCI.Network.Protocol.html#getL2Device">getL2Device</a></li>
 530
 531                 <li data-name="LuCI.Network.Protocol#getL3Device"><a href="LuCI.Network.Protocol.html#getL3Device">getL3Device</a></li>
 532
 533                 <li data-name="LuCI.Network.Protocol#getMetric"><a href="LuCI.Network.Protocol.html#getMetric">getMetric</a></li>
 534
 535                 <li data-name="LuCI.Network.Protocol#getName"><a href="LuCI.Network.Protocol.html#getName">getName</a></li>
 536
 537                 <li data-name="LuCI.Network.Protocol#getNetmask"><a href="LuCI.Network.Protocol.html#getNetmask">getNetmask</a></li>
 538
 539                 <li data-name="LuCI.Network.Protocol#getOpkgPackage"><a href="LuCI.Network.Protocol.html#getOpkgPackage">getOpkgPackage</a></li>
 540
 541                 <li data-name="LuCI.Network.Protocol#getProtocol"><a href="LuCI.Network.Protocol.html#getProtocol">getProtocol</a></li>
 542
 543                 <li data-name="LuCI.Network.Protocol#getType"><a href="LuCI.Network.Protocol.html#getType">getType</a></li>
 544
 545                 <li data-name="LuCI.Network.Protocol#getUptime"><a href="LuCI.Network.Protocol.html#getUptime">getUptime</a></li>
 546
 547                 <li data-name="LuCI.Network.Protocol#getZoneName"><a href="LuCI.Network.Protocol.html#getZoneName">getZoneName</a></li>
 548
 549                 <li data-name="LuCI.Network.Protocol#isAlias"><a href="LuCI.Network.Protocol.html#isAlias">isAlias</a></li>
 550
 551                 <li data-name="LuCI.Network.Protocol#isBridge"><a href="LuCI.Network.Protocol.html#isBridge">isBridge</a></li>
 552
 553                 <li data-name="LuCI.Network.Protocol#isDynamic"><a href="LuCI.Network.Protocol.html#isDynamic">isDynamic</a></li>
 554
 555                 <li data-name="LuCI.Network.Protocol#isEmpty"><a href="LuCI.Network.Protocol.html#isEmpty">isEmpty</a></li>
 556
 557                 <li data-name="LuCI.Network.Protocol#isFloating"><a href="LuCI.Network.Protocol.html#isFloating">isFloating</a></li>
 558
 559                 <li data-name="LuCI.Network.Protocol#isInstalled"><a href="LuCI.Network.Protocol.html#isInstalled">isInstalled</a></li>
 560
 561                 <li data-name="LuCI.Network.Protocol#isUp"><a href="LuCI.Network.Protocol.html#isUp">isUp</a></li>
 562
 563                 <li data-name="LuCI.Network.Protocol#isVirtual"><a href="LuCI.Network.Protocol.html#isVirtual">isVirtual</a></li>
 564
 565                 <li data-name="LuCI.Network.Protocol#set"><a href="LuCI.Network.Protocol.html#set">set</a></li>
 566
 567             </ul>
 568             <ul class="events itemMembers">
 569
 570             </ul>
 571         </li>
 572
 573         <li class="item" data-name="LuCI.Network.WifiDevice">
 574             <span class="title">
 575                 <a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>
 576
 577             </span>
 578             <ul class="members itemMembers">
 579
 580             </ul>
 581             <ul class="typedefs itemMembers">
 582
 583             </ul>
 584             <ul class="typedefs itemMembers">
 585
 586             </ul>
 587             <ul class="methods itemMembers">
 588
 589             <span class="subtitle">Methods</span>
 590
 591                 <li data-name="LuCI.Network.WifiDevice#addWifiNetwork"><a href="LuCI.Network.WifiDevice.html#addWifiNetwork">addWifiNetwork</a></li>
 592
 593                 <li data-name="LuCI.Network.WifiDevice#deleteWifiNetwork"><a href="LuCI.Network.WifiDevice.html#deleteWifiNetwork">deleteWifiNetwork</a></li>
 594
 595                 <li data-name="LuCI.Network.WifiDevice#get"><a href="LuCI.Network.WifiDevice.html#get">get</a></li>
 596
 597                 <li data-name="LuCI.Network.WifiDevice#getHTModes"><a href="LuCI.Network.WifiDevice.html#getHTModes">getHTModes</a></li>
 598
 599                 <li data-name="LuCI.Network.WifiDevice#getHWModes"><a href="LuCI.Network.WifiDevice.html#getHWModes">getHWModes</a></li>
 600
 601                 <li data-name="LuCI.Network.WifiDevice#getI18n"><a href="LuCI.Network.WifiDevice.html#getI18n">getI18n</a></li>
 602
 603                 <li data-name="LuCI.Network.WifiDevice#getName"><a href="LuCI.Network.WifiDevice.html#getName">getName</a></li>
 604
 605                 <li data-name="LuCI.Network.WifiDevice#getScanList"><a href="LuCI.Network.WifiDevice.html#getScanList">getScanList</a></li>
 606
 607                 <li data-name="LuCI.Network.WifiDevice#getWifiNetwork"><a href="LuCI.Network.WifiDevice.html#getWifiNetwork">getWifiNetwork</a></li>
 608
 609                 <li data-name="LuCI.Network.WifiDevice#getWifiNetworks"><a href="LuCI.Network.WifiDevice.html#getWifiNetworks">getWifiNetworks</a></li>
 610
 611                 <li data-name="LuCI.Network.WifiDevice#isDisabled"><a href="LuCI.Network.WifiDevice.html#isDisabled">isDisabled</a></li>
 612
 613                 <li data-name="LuCI.Network.WifiDevice#isUp"><a href="LuCI.Network.WifiDevice.html#isUp">isUp</a></li>
 614
 615                 <li data-name="LuCI.Network.WifiDevice#set"><a href="LuCI.Network.WifiDevice.html#set">set</a></li>
 616
 617             </ul>
 618             <ul class="events itemMembers">
 619
 620             </ul>
 621         </li>
 622
 623         <li class="item" data-name="LuCI.Network.WifiNetwork">
 624             <span class="title">
 625                 <a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>
 626
 627             </span>
 628             <ul class="members itemMembers">
 629
 630             </ul>
 631             <ul class="typedefs itemMembers">
 632
 633             </ul>
 634             <ul class="typedefs itemMembers">
 635
 636             </ul>
 637             <ul class="methods itemMembers">
 638
 639             <span class="subtitle">Methods</span>
 640
 641                 <li data-name="LuCI.Network.WifiNetwork#disconnectClient"><a href="LuCI.Network.WifiNetwork.html#disconnectClient">disconnectClient</a></li>
 642
 643                 <li data-name="LuCI.Network.WifiNetwork#get"><a href="LuCI.Network.WifiNetwork.html#get">get</a></li>
 644
 645                 <li data-name="LuCI.Network.WifiNetwork#getActiveBSSID"><a href="LuCI.Network.WifiNetwork.html#getActiveBSSID">getActiveBSSID</a></li>
 646
 647                 <li data-name="LuCI.Network.WifiNetwork#getActiveEncryption"><a href="LuCI.Network.WifiNetwork.html#getActiveEncryption">getActiveEncryption</a></li>
 648
 649                 <li data-name="LuCI.Network.WifiNetwork#getActiveMode"><a href="LuCI.Network.WifiNetwork.html#getActiveMode">getActiveMode</a></li>
 650
 651                 <li data-name="LuCI.Network.WifiNetwork#getActiveModeI18n"><a href="LuCI.Network.WifiNetwork.html#getActiveModeI18n">getActiveModeI18n</a></li>
 652
 653                 <li data-name="LuCI.Network.WifiNetwork#getActiveSSID"><a href="LuCI.Network.WifiNetwork.html#getActiveSSID">getActiveSSID</a></li>
 654
 655                 <li data-name="LuCI.Network.WifiNetwork#getAssocList"><a href="LuCI.Network.WifiNetwork.html#getAssocList">getAssocList</a></li>
 656
 657                 <li data-name="LuCI.Network.WifiNetwork#getBitRate"><a href="LuCI.Network.WifiNetwork.html#getBitRate">getBitRate</a></li>
 658
 659                 <li data-name="LuCI.Network.WifiNetwork#getBSSID"><a href="LuCI.Network.WifiNetwork.html#getBSSID">getBSSID</a></li>
 660
 661                 <li data-name="LuCI.Network.WifiNetwork#getChannel"><a href="LuCI.Network.WifiNetwork.html#getChannel">getChannel</a></li>
 662
 663                 <li data-name="LuCI.Network.WifiNetwork#getCountryCode"><a href="LuCI.Network.WifiNetwork.html#getCountryCode">getCountryCode</a></li>
 664
 665                 <li data-name="LuCI.Network.WifiNetwork#getDevice"><a href="LuCI.Network.WifiNetwork.html#getDevice">getDevice</a></li>
 666
 667                 <li data-name="LuCI.Network.WifiNetwork#getFrequency"><a href="LuCI.Network.WifiNetwork.html#getFrequency">getFrequency</a></li>
 668
 669                 <li data-name="LuCI.Network.WifiNetwork#getI18n"><a href="LuCI.Network.WifiNetwork.html#getI18n">getI18n</a></li>
 670
 671                 <li data-name="LuCI.Network.WifiNetwork#getID"><a href="LuCI.Network.WifiNetwork.html#getID">getID</a></li>
 672
 673                 <li data-name="LuCI.Network.WifiNetwork#getIfname"><a href="LuCI.Network.WifiNetwork.html#getIfname">getIfname</a></li>
 674
 675                 <li data-name="LuCI.Network.WifiNetwork#getMeshID"><a href="LuCI.Network.WifiNetwork.html#getMeshID">getMeshID</a></li>
 676
 677                 <li data-name="LuCI.Network.WifiNetwork#getMode"><a href="LuCI.Network.WifiNetwork.html#getMode">getMode</a></li>
 678
 679                 <li data-name="LuCI.Network.WifiNetwork#getName"><a href="LuCI.Network.WifiNetwork.html#getName">getName</a></li>
 680
 681                 <li data-name="LuCI.Network.WifiNetwork#getNetwork"><a href="LuCI.Network.WifiNetwork.html#getNetwork">getNetwork</a></li>
 682
 683                 <li data-name="LuCI.Network.WifiNetwork#getNetworkNames"><a href="LuCI.Network.WifiNetwork.html#getNetworkNames">getNetworkNames</a></li>
 684
 685                 <li data-name="LuCI.Network.WifiNetwork#getNetworks"><a href="LuCI.Network.WifiNetwork.html#getNetworks">getNetworks</a></li>
 686
 687                 <li data-name="LuCI.Network.WifiNetwork#getNoise"><a href="LuCI.Network.WifiNetwork.html#getNoise">getNoise</a></li>
 688
 689                 <li data-name="LuCI.Network.WifiNetwork#getShortName"><a href="LuCI.Network.WifiNetwork.html#getShortName">getShortName</a></li>
 690
 691                 <li data-name="LuCI.Network.WifiNetwork#getSignal"><a href="LuCI.Network.WifiNetwork.html#getSignal">getSignal</a></li>
 692
 693                 <li data-name="LuCI.Network.WifiNetwork#getSignalLevel"><a href="LuCI.Network.WifiNetwork.html#getSignalLevel">getSignalLevel</a></li>
 694
 695                 <li data-name="LuCI.Network.WifiNetwork#getSignalPercent"><a href="LuCI.Network.WifiNetwork.html#getSignalPercent">getSignalPercent</a></li>
 696
 697                 <li data-name="LuCI.Network.WifiNetwork#getSSID"><a href="LuCI.Network.WifiNetwork.html#getSSID">getSSID</a></li>
 698
 699                 <li data-name="LuCI.Network.WifiNetwork#getTXPower"><a href="LuCI.Network.WifiNetwork.html#getTXPower">getTXPower</a></li>
 700
 701                 <li data-name="LuCI.Network.WifiNetwork#getTXPowerOffset"><a href="LuCI.Network.WifiNetwork.html#getTXPowerOffset">getTXPowerOffset</a></li>
 702
 703                 <li data-name="LuCI.Network.WifiNetwork#getWifiDevice"><a href="LuCI.Network.WifiNetwork.html#getWifiDevice">getWifiDevice</a></li>
 704
 705                 <li data-name="LuCI.Network.WifiNetwork#getWifiDeviceName"><a href="LuCI.Network.WifiNetwork.html#getWifiDeviceName">getWifiDeviceName</a></li>
 706
 707                 <li data-name="LuCI.Network.WifiNetwork#isClientDisconnectSupported"><a href="LuCI.Network.WifiNetwork.html#isClientDisconnectSupported">isClientDisconnectSupported</a></li>
 708
 709                 <li data-name="LuCI.Network.WifiNetwork#isDisabled"><a href="LuCI.Network.WifiNetwork.html#isDisabled">isDisabled</a></li>
 710
 711                 <li data-name="LuCI.Network.WifiNetwork#isUp"><a href="LuCI.Network.WifiNetwork.html#isUp">isUp</a></li>
 712
 713                 <li data-name="LuCI.Network.WifiNetwork#set"><a href="LuCI.Network.WifiNetwork.html#set">set</a></li>
 714
 715             </ul>
 716             <ul class="events itemMembers">
 717
 718             </ul>
 719         </li>
 720
 721         <li class="item" data-name="LuCI.Poll">
 722             <span class="title">
 723                 <a href="LuCI.Poll.html">LuCI.Poll</a>
 724
 725             </span>
 726             <ul class="members itemMembers">
 727
 728             </ul>
 729             <ul class="typedefs itemMembers">
 730
 731             </ul>
 732             <ul class="typedefs itemMembers">
 733
 734             </ul>
 735             <ul class="methods itemMembers">
 736
 737             <span class="subtitle">Methods</span>
 738
 739                 <li data-name="LuCI.Poll#active"><a href="LuCI.Poll.html#active">active</a></li>
 740
 741                 <li data-name="LuCI.Poll#add"><a href="LuCI.Poll.html#add">add</a></li>
 742
 743                 <li data-name="LuCI.Poll#remove"><a href="LuCI.Poll.html#remove">remove</a></li>
 744
 745                 <li data-name="LuCI.Poll#start"><a href="LuCI.Poll.html#start">start</a></li>
 746
 747                 <li data-name="LuCI.Poll#stop"><a href="LuCI.Poll.html#stop">stop</a></li>
 748
 749             </ul>
 750             <ul class="events itemMembers">
 751
 752             </ul>
 753         </li>
 754
 755         <li class="item" data-name="LuCI.Request">
 756             <span class="title">
 757                 <a href="LuCI.Request.html">LuCI.Request</a>
 758
 759             </span>
 760             <ul class="members itemMembers">
 761
 762             </ul>
 763             <ul class="typedefs itemMembers">
 764
 765             <span class="subtitle">Typedefs</span>
 766
 767                 <li data-name="LuCI.Request.interceptorFn"><a href="LuCI.Request.html#.interceptorFn">interceptorFn</a></li>
 768
 769                 <li data-name="LuCI.Request.RequestOptions"><a href="LuCI.Request.html#.RequestOptions">RequestOptions</a></li>
 770
 771             </ul>
 772             <ul class="typedefs itemMembers">
 773
 774             </ul>
 775             <ul class="methods itemMembers">
 776
 777             <span class="subtitle">Methods</span>
 778
 779                 <li data-name="LuCI.Request#addInterceptor"><a href="LuCI.Request.html#addInterceptor">addInterceptor</a></li>
 780
 781                 <li data-name="LuCI.Request#expandURL"><a href="LuCI.Request.html#expandURL">expandURL</a></li>
 782
 783                 <li data-name="LuCI.Request#get"><a href="LuCI.Request.html#get">get</a></li>
 784
 785                 <li data-name="LuCI.Request#post"><a href="LuCI.Request.html#post">post</a></li>
 786
 787                 <li data-name="LuCI.Request#removeInterceptor"><a href="LuCI.Request.html#removeInterceptor">removeInterceptor</a></li>
 788
 789                 <li data-name="LuCI.Request#request"><a href="LuCI.Request.html#request">request</a></li>
 790
 791             </ul>
 792             <ul class="events itemMembers">
 793
 794             </ul>
 795         </li>
 796
 797         <li class="item" data-name="LuCI.Request.poll">
 798             <span class="title">
 799                 <a href="LuCI.Request.poll.html">LuCI.Request.poll</a>
 800
 801             </span>
 802             <ul class="members itemMembers">
 803
 804             </ul>
 805             <ul class="typedefs itemMembers">
 806
 807             <span class="subtitle">Typedefs</span>
 808
 809                 <li data-name="LuCI.Request.poll~callbackFn"><a href="LuCI.Request.poll.html#~callbackFn">callbackFn</a></li>
 810
 811             </ul>
 812             <ul class="typedefs itemMembers">
 813
 814             </ul>
 815             <ul class="methods itemMembers">
 816
 817             <span class="subtitle">Methods</span>
 818
 819                 <li data-name="LuCI.Request.poll#active"><a href="LuCI.Request.poll.html#active">active</a></li>
 820
 821                 <li data-name="LuCI.Request.poll#add"><a href="LuCI.Request.poll.html#add">add</a></li>
 822
 823                 <li data-name="LuCI.Request.poll#remove"><a href="LuCI.Request.poll.html#remove">remove</a></li>
 824
 825                 <li data-name="LuCI.Request.poll#start"><a href="LuCI.Request.poll.html#start">start</a></li>
 826
 827                 <li data-name="LuCI.Request.poll#stop"><a href="LuCI.Request.poll.html#stop">stop</a></li>
 828
 829             </ul>
 830             <ul class="events itemMembers">
 831
 832             </ul>
 833         </li>
 834
 835         <li class="item" data-name="LuCI.Response">
 836             <span class="title">
 837                 <a href="LuCI.Response.html">LuCI.Response</a>
 838
 839             </span>
 840             <ul class="members itemMembers">
 841
 842             <span class="subtitle">Members</span>
 843
 844                 <li data-name="LuCI.Response#duration"><a href="LuCI.Response.html#duration">duration</a></li>
 845
 846                 <li data-name="LuCI.Response#headers"><a href="LuCI.Response.html#headers">headers</a></li>
 847
 848                 <li data-name="LuCI.Response#ok"><a href="LuCI.Response.html#ok">ok</a></li>
 849
 850                 <li data-name="LuCI.Response#status"><a href="LuCI.Response.html#status">status</a></li>
 851
 852                 <li data-name="LuCI.Response#statusText"><a href="LuCI.Response.html#statusText">statusText</a></li>
 853
 854                 <li data-name="LuCI.Response#url"><a href="LuCI.Response.html#url">url</a></li>
 855
 856             </ul>
 857             <ul class="typedefs itemMembers">
 858
 859             </ul>
 860             <ul class="typedefs itemMembers">
 861
 862             </ul>
 863             <ul class="methods itemMembers">
 864
 865             <span class="subtitle">Methods</span>
 866
 867                 <li data-name="LuCI.Response#clone"><a href="LuCI.Response.html#clone">clone</a></li>
 868
 869                 <li data-name="LuCI.Response#json"><a href="LuCI.Response.html#json">json</a></li>
 870
 871                 <li data-name="LuCI.Response#text"><a href="LuCI.Response.html#text">text</a></li>
 872
 873             </ul>
 874             <ul class="events itemMembers">
 875
 876             </ul>
 877         </li>
 878
 879         <li class="item" data-name="LuCI.rpc">
 880             <span class="title">
 881                 <a href="LuCI.rpc.html">LuCI.rpc</a>
 882
 883             </span>
 884             <ul class="members itemMembers">
 885
 886             </ul>
 887             <ul class="typedefs itemMembers">
 888
 889             <span class="subtitle">Typedefs</span>
 890
 891                 <li data-name="LuCI.rpc.DeclareOptions"><a href="LuCI.rpc.html#.DeclareOptions">DeclareOptions</a></li>
 892
 893                 <li data-name="LuCI.rpc~filterFn"><a href="LuCI.rpc.html#~filterFn">filterFn</a></li>
 894
 895                 <li data-name="LuCI.rpc~interceptorFn"><a href="LuCI.rpc.html#~interceptorFn">interceptorFn</a></li>
 896
 897                 <li data-name="LuCI.rpc~invokeFn"><a href="LuCI.rpc.html#~invokeFn">invokeFn</a></li>
 898
 899             </ul>
 900             <ul class="typedefs itemMembers">
 901
 902             </ul>
 903             <ul class="methods itemMembers">
 904
 905             <span class="subtitle">Methods</span>
 906
 907                 <li data-name="LuCI.rpc#addInterceptor"><a href="LuCI.rpc.html#addInterceptor">addInterceptor</a></li>
 908
 909                 <li data-name="LuCI.rpc#declare"><a href="LuCI.rpc.html#declare">declare</a></li>
 910
 911                 <li data-name="LuCI.rpc#getBaseURL"><a href="LuCI.rpc.html#getBaseURL">getBaseURL</a></li>
 912
 913                 <li data-name="LuCI.rpc#getSessionID"><a href="LuCI.rpc.html#getSessionID">getSessionID</a></li>
 914
 915                 <li data-name="LuCI.rpc#getStatusText"><a href="LuCI.rpc.html#getStatusText">getStatusText</a></li>
 916
 917                 <li data-name="LuCI.rpc#list"><a href="LuCI.rpc.html#list">list</a></li>
 918
 919                 <li data-name="LuCI.rpc#removeInterceptor"><a href="LuCI.rpc.html#removeInterceptor">removeInterceptor</a></li>
 920
 921                 <li data-name="LuCI.rpc#setBaseURL"><a href="LuCI.rpc.html#setBaseURL">setBaseURL</a></li>
 922
 923                 <li data-name="LuCI.rpc#setSessionID"><a href="LuCI.rpc.html#setSessionID">setSessionID</a></li>
 924
 925             </ul>
 926             <ul class="events itemMembers">
 927
 928             </ul>
 929         </li>
 930
 931         <li class="item" data-name="LuCI.uci">
 932             <span class="title">
 933                 <a href="LuCI.uci.html">LuCI.uci</a>
 934
 935             </span>
 936             <ul class="members itemMembers">
 937
 938             </ul>
 939             <ul class="typedefs itemMembers">
 940
 941             <span class="subtitle">Typedefs</span>
 942
 943                 <li data-name="LuCI.uci.ChangeRecord"><a href="LuCI.uci.html#.ChangeRecord">ChangeRecord</a></li>
 944
 945                 <li data-name="LuCI.uci.SectionObject"><a href="LuCI.uci.html#.SectionObject">SectionObject</a></li>
 946
 947                 <li data-name="LuCI.uci~sectionsFn"><a href="LuCI.uci.html#~sectionsFn">sectionsFn</a></li>
 948
 949             </ul>
 950             <ul class="typedefs itemMembers">
 951
 952             </ul>
 953             <ul class="methods itemMembers">
 954
 955             <span class="subtitle">Methods</span>
 956
 957                 <li data-name="LuCI.uci#add"><a href="LuCI.uci.html#add">add</a></li>
 958
 959                 <li data-name="LuCI.uci#apply"><a href="LuCI.uci.html#apply">apply</a></li>
 960
 961                 <li data-name="LuCI.uci#changes"><a href="LuCI.uci.html#changes">changes</a></li>
 962
 963                 <li data-name="LuCI.uci#createSID"><a href="LuCI.uci.html#createSID">createSID</a></li>
 964
 965                 <li data-name="LuCI.uci#get"><a href="LuCI.uci.html#get">get</a></li>
 966
 967                 <li data-name="LuCI.uci#get_first"><a href="LuCI.uci.html#get_first">get_first</a></li>
 968
 969                 <li data-name="LuCI.uci#load"><a href="LuCI.uci.html#load">load</a></li>
 970
 971                 <li data-name="LuCI.uci#move"><a href="LuCI.uci.html#move">move</a></li>
 972
 973                 <li data-name="LuCI.uci#remove"><a href="LuCI.uci.html#remove">remove</a></li>
 974
 975                 <li data-name="LuCI.uci#resolveSID"><a href="LuCI.uci.html#resolveSID">resolveSID</a></li>
 976
 977                 <li data-name="LuCI.uci#save"><a href="LuCI.uci.html#save">save</a></li>
 978
 979                 <li data-name="LuCI.uci#sections"><a href="LuCI.uci.html#sections">sections</a></li>
 980
 981                 <li data-name="LuCI.uci#set"><a href="LuCI.uci.html#set">set</a></li>
 982
 983                 <li data-name="LuCI.uci#set_first"><a href="LuCI.uci.html#set_first">set_first</a></li>
 984
 985                 <li data-name="LuCI.uci#unload"><a href="LuCI.uci.html#unload">unload</a></li>
 986
 987                 <li data-name="LuCI.uci#unset"><a href="LuCI.uci.html#unset">unset</a></li>
 988
 989                 <li data-name="LuCI.uci#unset_first"><a href="LuCI.uci.html#unset_first">unset_first</a></li>
 990
 991             </ul>
 992             <ul class="events itemMembers">
 993
 994             </ul>
 995         </li>
 996
 997         <li class="item" data-name="LuCI.view">
 998             <span class="title">
 999                 <a href="LuCI.view.html">LuCI.view</a>
1000
1001             </span>
1002             <ul class="members itemMembers">
1003
1004             </ul>
1005             <ul class="typedefs itemMembers">
1006
1007             </ul>
1008             <ul class="typedefs itemMembers">
1009
1010             </ul>
1011             <ul class="methods itemMembers">
1012
1013             <span class="subtitle">Methods</span>
1014
1015                 <li data-name="LuCI.view#addFooter"><a href="LuCI.view.html#addFooter">addFooter</a></li>
1016
1017                 <li data-name="LuCI.view#handleReset"><a href="LuCI.view.html#handleReset">handleReset</a></li>
1018
1019                 <li data-name="LuCI.view#handleSave"><a href="LuCI.view.html#handleSave">handleSave</a></li>
1020
1021                 <li data-name="LuCI.view#handleSaveApply"><a href="LuCI.view.html#handleSaveApply">handleSaveApply</a></li>
1022
1023                 <li data-name="LuCI.view#load"><a href="LuCI.view.html#load">load</a></li>
1024
1025                 <li data-name="LuCI.view#render"><a href="LuCI.view.html#render">render</a></li>
1026
1027             </ul>
1028             <ul class="events itemMembers">
1029
1030             </ul>
1031         </li>
1032
1033         <li class="item" data-name="LuCI.XHR">
1034             <span class="title">
1035                 <a href="LuCI.XHR.html">LuCI.XHR</a>
1036
1037             </span>
1038             <ul class="members itemMembers">
1039
1040             </ul>
1041             <ul class="typedefs itemMembers">
1042
1043             </ul>
1044             <ul class="typedefs itemMembers">
1045
1046             </ul>
1047             <ul class="methods itemMembers">
1048
1049             <span class="subtitle">Methods</span>
1050
1051                 <li data-name="LuCI.XHR#abort"><a href="LuCI.XHR.html#abort">abort</a></li>
1052
1053                 <li data-name="LuCI.XHR#busy"><a href="LuCI.XHR.html#busy">busy</a></li>
1054
1055                 <li data-name="LuCI.XHR#cancel"><a href="LuCI.XHR.html#cancel">cancel</a></li>
1056
1057                 <li data-name="LuCI.XHR#get"><a href="LuCI.XHR.html#get">get</a></li>
1058
1059                 <li data-name="LuCI.XHR#post"><a href="LuCI.XHR.html#post">post</a></li>
1060
1061                 <li data-name="LuCI.XHR#send_form"><a href="LuCI.XHR.html#send_form">send_form</a></li>
1062
1063             </ul>
1064             <ul class="events itemMembers">
1065
1066             </ul>
1067         </li>
1068
1069     </ul>
1070 </div>
1071     <div class="main">
1072         <h1 class="page-title" data-filename="LuCI.Network.html">Class: Network</h1>
1073
1074
1075
1076
1077 <section>
1078
1079 <header>
1080     <h2>
1081         <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span>
1082
1083     Network
1084     </h2>
1085
1086         <div class="class-description"><p>The <code>LuCI.Network</code> class combines data from multiple <code>ubus</code> apis to
1087 provide an abstraction of the current network configuration state.</p>
1088 <p>It provides methods to enumerate interfaces and devices, to query
1089 current configuration details and to manipulate settings.</p></div>
1090
1091 </header>
1092
1093 <article>
1094     <div class="container-overview">
1095
1096
1097
1098
1099 <dt>
1100     <div class="nameContainer">
1101         <h4 class="name" id="Network">
1102
1103             new LuCI.Network<span class="signature">()</span>
1104         </h4>
1105
1106
1107         <div class="tag-source">
1108             network.js, line 645
1109         </div>
1110
1111     </div>
1112
1113
1114 </dt>
1115 <dd>
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126 <dl class="details">
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148 </dl>
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162 </dd>
1163
1164
1165     </div>
1166
1167
1168
1169
1170
1171
1172
1173
1174         <h3 class="subsection-title">Classes</h3>
1175
1176         <dl>
1177             <dt><a href="LuCI.Network.Device.html">Device</a></dt>
1178             <dd></dd>
1179
1180             <dt><a href="LuCI.Network.Hosts.html">Hosts</a></dt>
1181             <dd></dd>
1182
1183             <dt><a href="LuCI.Network.Protocol.html">Protocol</a></dt>
1184             <dd></dd>
1185
1186             <dt><a href="LuCI.Network.WifiDevice.html">WifiDevice</a></dt>
1187             <dd></dd>
1188
1189             <dt><a href="LuCI.Network.WifiNetwork.html">WifiNetwork</a></dt>
1190             <dd></dd>
1191         </dl>
1192
1193
1194
1195
1196
1197
1198
1199         <h3 class="subsection-title">Methods</h3>
1200
1201         <dl>
1202
1203 <dt>
1204     <div class="nameContainer">
1205         <h4 class="name" id="addNetwork">
1206
1207             addNetwork<span class="signature">(name, <span class="optional">options</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;(null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>)>}</span>
1208         </h4>
1209
1210
1211         <div class="tag-source">
1212             network.js, line 901
1213         </div>
1214
1215     </div>
1216
1217
1218 </dt>
1219 <dd>
1220
1221
1222     <div class="description">
1223         <p>Adds a new network of the given name and update it with the given
1224 uci option values.</p>
1225 <p>If a network with the given name already exist but is empty, then
1226 this function will update its option, otherwise it will do nothing.</p>
1227     </div>
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237 <table class="params">
1238     <thead>
1239         <tr>
1240
1241                 <th>Name</th>
1242
1243
1244                 <th>Type</th>
1245
1246
1247
1248                 <th class="last">Description</th>
1249         </tr>
1250         </thead>
1251
1252         <tbody>
1253
1254
1255         <tr>
1256
1257                 <td class="name"><code>name</code></td>
1258
1259
1260             <td class="type">
1261
1262
1263 <span class="param-type">string</span>
1264
1265
1266
1267             </td>
1268
1269
1270
1271             <td class="description last">
1272
1273
1274
1275
1276
1277
1278                 <p>The name of the network to add. Must be in the format <code>[a-zA-Z0-9_]+</code>.</p></td>
1279         </tr>
1280
1281
1282
1283         <tr>
1284
1285                 <td class="name"><code>options</code></td>
1286
1287
1288             <td class="type">
1289
1290
1291 <span class="param-type">Object.&lt;string, (string|Array.&lt;string>)></span>
1292
1293
1294
1295             </td>
1296
1297
1298
1299             <td class="description last">
1300
1301
1302                         <span class="optional">optional</span>
1303
1304
1305
1306
1307
1308                 <p>An object of uci option values to set on the new network or to
1309 update in an existing, empty network.</p></td>
1310         </tr>
1311
1312
1313         </tbody>
1314 </table>
1315
1316
1317
1318 <dl class="details">
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340 </dl>
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352     <h5>Returns:</h5>
1353
1354
1355
1356 <table class="params">
1357     <thead>
1358     <tr>
1359
1360         <th>Type</th>
1361         <th class="last">Description</th>
1362     </tr>
1363     </thead>
1364     <tbody>
1365
1366         <tr>
1367
1368             <td class="type">
1369
1370                         Promise.&lt;(null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>)>
1371
1372
1373             </td>
1374             <td class="description last">Returns a promise resolving to the <code>Protocol</code> subclass instance
1375 describing the added network or resolving to <code>null</code> if the name
1376 was invalid or if a non-empty network of the given name already
1377 existed.</td>
1378         </tr>
1379
1380     </tbody>
1381 </table>
1382
1383
1384
1385
1386 </dd>
1387
1388
1389
1390 <dt>
1391     <div class="nameContainer">
1392         <h4 class="name" id="addWifiNetwork">
1393
1394             addWifiNetwork<span class="signature">(options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;(null|<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>)>}</span>
1395         </h4>
1396
1397
1398         <div class="tag-source">
1399             network.js, line 1350
1400         </div>
1401
1402     </div>
1403
1404
1405 </dt>
1406 <dd>
1407
1408
1409     <div class="description">
1410         <p>Adds a new wireless network to the configuration and sets its options
1411 to the provided values.</p>
1412     </div>
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422 <table class="params">
1423     <thead>
1424         <tr>
1425
1426                 <th>Name</th>
1427
1428
1429                 <th>Type</th>
1430
1431
1432
1433                 <th class="last">Description</th>
1434         </tr>
1435         </thead>
1436
1437         <tbody>
1438
1439
1440         <tr>
1441
1442                 <td class="name"><code>options</code></td>
1443
1444
1445             <td class="type">
1446
1447
1448 <span class="param-type">Object.&lt;string, (string|Array.&lt;string>)></span>
1449
1450
1451
1452             </td>
1453
1454
1455
1456             <td class="description last">
1457
1458                 <p>The options to set for the newly added wireless network. This object
1459 must at least contain a <code>device</code> property which is set to the radio
1460 name the new network belongs to.</p></td>
1461         </tr>
1462
1463
1464         </tbody>
1465 </table>
1466
1467
1468
1469 <dl class="details">
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491 </dl>
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503     <h5>Returns:</h5>
1504
1505
1506
1507 <table class="params">
1508     <thead>
1509     <tr>
1510
1511         <th>Type</th>
1512         <th class="last">Description</th>
1513     </tr>
1514     </thead>
1515     <tbody>
1516
1517         <tr>
1518
1519             <td class="type">
1520
1521                         Promise.&lt;(null|<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>)>
1522
1523
1524             </td>
1525             <td class="description last">Returns a promise resolving to a <code>WifiNetwork</code> instance describing
1526 the newly added wireless network or <code>null</code> if the given options
1527 were invalid or if the associated radio device could not be found.</td>
1528         </tr>
1529
1530     </tbody>
1531 </table>
1532
1533
1534
1535
1536 </dd>
1537
1538
1539
1540 <dt>
1541     <div class="nameContainer">
1542         <h4 class="name" id="deleteNetwork">
1543
1544             deleteNetwork<span class="signature">(name)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;boolean>}</span>
1545         </h4>
1546
1547
1548         <div class="tag-source">
1549             network.js, line 979
1550         </div>
1551
1552     </div>
1553
1554
1555 </dt>
1556 <dd>
1557
1558
1559     <div class="description">
1560         <p>Deletes the given network and its references from the network and
1561 firewall configuration.</p>
1562     </div>
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572 <table class="params">
1573     <thead>
1574         <tr>
1575
1576                 <th>Name</th>
1577
1578
1579                 <th>Type</th>
1580
1581
1582
1583                 <th class="last">Description</th>
1584         </tr>
1585         </thead>
1586
1587         <tbody>
1588
1589
1590         <tr>
1591
1592                 <td class="name"><code>name</code></td>
1593
1594
1595             <td class="type">
1596
1597
1598 <span class="param-type">string</span>
1599
1600
1601
1602             </td>
1603
1604
1605
1606             <td class="description last">
1607
1608                 <p>The name of the network to delete.</p></td>
1609         </tr>
1610
1611
1612         </tbody>
1613 </table>
1614
1615
1616
1617 <dl class="details">
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639 </dl>
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651     <h5>Returns:</h5>
1652
1653
1654
1655 <table class="params">
1656     <thead>
1657     <tr>
1658
1659         <th>Type</th>
1660         <th class="last">Description</th>
1661     </tr>
1662     </thead>
1663     <tbody>
1664
1665         <tr>
1666
1667             <td class="type">
1668
1669                         Promise.&lt;boolean>
1670
1671
1672             </td>
1673             <td class="description last">Returns a promise resolving to either <code>true</code> if the network and
1674 references to it were successfully deleted from the configuration or
1675 <code>false</code> if the given network could not be found.</td>
1676         </tr>
1677
1678     </tbody>
1679 </table>
1680
1681
1682
1683
1684 </dd>
1685
1686
1687
1688 <dt>
1689     <div class="nameContainer">
1690         <h4 class="name" id="deleteWifiNetwork">
1691
1692             deleteWifiNetwork<span class="signature">(netname)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;boolean>}</span>
1693         </h4>
1694
1695
1696         <div class="tag-source">
1697             network.js, line 1388
1698         </div>
1699
1700     </div>
1701
1702
1703 </dt>
1704 <dd>
1705
1706
1707     <div class="description">
1708         <p>Deletes the given wireless network from the configuration.</p>
1709     </div>
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719 <table class="params">
1720     <thead>
1721         <tr>
1722
1723                 <th>Name</th>
1724
1725
1726                 <th>Type</th>
1727
1728
1729
1730                 <th class="last">Description</th>
1731         </tr>
1732         </thead>
1733
1734         <tbody>
1735
1736
1737         <tr>
1738
1739                 <td class="name"><code>netname</code></td>
1740
1741
1742             <td class="type">
1743
1744
1745 <span class="param-type">string</span>
1746
1747
1748
1749             </td>
1750
1751
1752
1753             <td class="description last">
1754
1755                 <p>The name of the network to remove. This may be either a
1756 network ID in the form <code>radio#.network#</code> or a Linux network device
1757 name like <code>wlan0</code> which is resolved to the corresponding configuration
1758 section through <code>ubus</code> runtime information.</p></td>
1759         </tr>
1760
1761
1762         </tbody>
1763 </table>
1764
1765
1766
1767 <dl class="details">
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789 </dl>
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801     <h5>Returns:</h5>
1802
1803
1804
1805 <table class="params">
1806     <thead>
1807     <tr>
1808
1809         <th>Type</th>
1810         <th class="last">Description</th>
1811     </tr>
1812     </thead>
1813     <tbody>
1814
1815         <tr>
1816
1817             <td class="type">
1818
1819                         Promise.&lt;boolean>
1820
1821
1822             </td>
1823             <td class="description last">Returns a promise resolving to <code>true</code> if the wireless network has been
1824 successfully deleted from the configuration or <code>false</code> if it could not
1825 be found.</td>
1826         </tr>
1827
1828     </tbody>
1829 </table>
1830
1831
1832
1833
1834 </dd>
1835
1836
1837
1838 <dt>
1839     <div class="nameContainer">
1840         <h4 class="name" id="flushCache">
1841
1842             flushCache<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;Object>}</span>
1843         </h4>
1844
1845
1846         <div class="tag-source">
1847             network.js, line 745
1848         </div>
1849
1850     </div>
1851
1852
1853 </dt>
1854 <dd>
1855
1856
1857     <div class="description">
1858         <p>Flushes the local network state cache and fetches updated information
1859 from the remote <code>ubus</code> apis.</p>
1860     </div>
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870 <dl class="details">
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892 </dl>
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904     <h5>Returns:</h5>
1905
1906
1907
1908 <table class="params">
1909     <thead>
1910     <tr>
1911
1912         <th>Type</th>
1913         <th class="last">Description</th>
1914     </tr>
1915     </thead>
1916     <tbody>
1917
1918         <tr>
1919
1920             <td class="type">
1921
1922                         Promise.&lt;Object>
1923
1924
1925             </td>
1926             <td class="description last">Returns a promise resolving to the internal network state object.</td>
1927         </tr>
1928
1929     </tbody>
1930 </table>
1931
1932
1933
1934
1935 </dd>
1936
1937
1938
1939 <dt>
1940     <div class="nameContainer">
1941         <h4 class="name" id="formatWifiEncryption">
1942
1943             formatWifiEncryption<span class="signature">(encryption)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span>
1944         </h4>
1945
1946
1947         <div class="tag-source">
1948             network.js, line 736
1949         </div>
1950
1951     </div>
1952
1953
1954 </dt>
1955 <dd>
1956
1957
1958     <div class="description">
1959         <p>Converts a given <a href="LuCI.Network.html#.WifiEncryption"><code>encryption entry</code></a>
1960 into a human readable string such as <code>mixed WPA/WPA2 PSK (TKIP, CCMP)</code>
1961 or <code>WPA3 SAE (CCMP)</code>.</p>
1962     </div>
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972 <table class="params">
1973     <thead>
1974         <tr>
1975
1976                 <th>Name</th>
1977
1978
1979                 <th>Type</th>
1980
1981
1982
1983                 <th class="last">Description</th>
1984         </tr>
1985         </thead>
1986
1987         <tbody>
1988
1989
1990         <tr>
1991
1992                 <td class="name"><code>encryption</code></td>
1993
1994
1995             <td class="type">
1996
1997
1998 <span class="param-type"><a href="LuCI.Network.html#.WifiEncryption">LuCI.Network.WifiEncryption</a></span>
1999
2000
2001
2002             </td>
2003
2004
2005
2006             <td class="description last">
2007
2008                 <p>The wireless encryption entry to convert.</p></td>
2009         </tr>
2010
2011
2012         </tbody>
2013 </table>
2014
2015
2016
2017 <dl class="details">
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039 </dl>
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051     <h5>Returns:</h5>
2052
2053
2054
2055 <table class="params">
2056     <thead>
2057     <tr>
2058
2059         <th>Type</th>
2060         <th class="last">Description</th>
2061     </tr>
2062     </thead>
2063     <tbody>
2064
2065         <tr>
2066
2067             <td class="type">
2068
2069                         null
2070                          |
2071
2072                         string
2073
2074
2075             </td>
2076             <td class="description last">Returns the description string for the given encryption entry or
2077 <code>null</code> if the given entry was invalid.</td>
2078         </tr>
2079
2080     </tbody>
2081 </table>
2082
2083
2084
2085
2086 </dd>
2087
2088
2089
2090 <dt>
2091     <div class="nameContainer">
2092         <h4 class="name" id="getDevice">
2093
2094             getDevice<span class="signature">(name)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;(null|<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>)>}</span>
2095         </h4>
2096
2097
2098         <div class="tag-source">
2099             network.js, line 1104
2100         </div>
2101
2102     </div>
2103
2104
2105 </dt>
2106 <dd>
2107
2108
2109     <div class="description">
2110         <p>Get a <a href="LuCI.Network.Device.html"><code>Device</code></a> instance describing the
2111 given network device.</p>
2112     </div>
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122 <table class="params">
2123     <thead>
2124         <tr>
2125
2126                 <th>Name</th>
2127
2128
2129                 <th>Type</th>
2130
2131
2132
2133                 <th class="last">Description</th>
2134         </tr>
2135         </thead>
2136
2137         <tbody>
2138
2139
2140         <tr>
2141
2142                 <td class="name"><code>name</code></td>
2143
2144
2145             <td class="type">
2146
2147
2148 <span class="param-type">string</span>
2149
2150
2151
2152             </td>
2153
2154
2155
2156             <td class="description last">
2157
2158                 <p>The name of the network device to get, e.g. <code>eth0</code> or <code>br-lan</code>.</p></td>
2159         </tr>
2160
2161
2162         </tbody>
2163 </table>
2164
2165
2166
2167 <dl class="details">
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189 </dl>
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201     <h5>Returns:</h5>
2202
2203
2204
2205 <table class="params">
2206     <thead>
2207     <tr>
2208
2209         <th>Type</th>
2210         <th class="last">Description</th>
2211     </tr>
2212     </thead>
2213     <tbody>
2214
2215         <tr>
2216
2217             <td class="type">
2218
2219                         Promise.&lt;(null|<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>)>
2220
2221
2222             </td>
2223             <td class="description last">Returns a promise resolving to the <code>Device</code> instance describing
2224 the network device or <code>null</code> if the given device name could not
2225 be found.</td>
2226         </tr>
2227
2228     </tbody>
2229 </table>
2230
2231
2232
2233
2234 </dd>
2235
2236
2237
2238 <dt>
2239     <div class="nameContainer">
2240         <h4 class="name" id="getDevices">
2241
2242             getDevices<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;Array.&lt;<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>>>}</span>
2243         </h4>
2244
2245
2246         <div class="tag-source">
2247             network.js, line 1127
2248         </div>
2249
2250     </div>
2251
2252
2253 </dt>
2254 <dd>
2255
2256
2257     <div class="description">
2258         <p>Get a sorted list of all found network devices.</p>
2259     </div>
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269 <dl class="details">
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291 </dl>
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303     <h5>Returns:</h5>
2304
2305
2306
2307 <table class="params">
2308     <thead>
2309     <tr>
2310
2311         <th>Type</th>
2312         <th class="last">Description</th>
2313     </tr>
2314     </thead>
2315     <tbody>
2316
2317         <tr>
2318
2319             <td class="type">
2320
2321                         Promise.&lt;Array.&lt;<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>>>
2322
2323
2324             </td>
2325             <td class="description last">Returns a promise resolving to a sorted array of <code>Device</code> class
2326 instances describing the network devices found on the system.</td>
2327         </tr>
2328
2329     </tbody>
2330 </table>
2331
2332
2333
2334
2335 </dd>
2336
2337
2338
2339 <dt>
2340     <div class="nameContainer">
2341         <h4 class="name" id="getDSLModemType">
2342
2343             getDSLModemType<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;(null|string)>}</span>
2344         </h4>
2345
2346
2347         <div class="tag-source">
2348             network.js, line 1650
2349         </div>
2350
2351     </div>
2352
2353
2354 </dt>
2355 <dd>
2356
2357
2358     <div class="description">
2359         <p>Queries the internal DSL modem type from board information.</p>
2360     </div>
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370 <dl class="details">
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392 </dl>
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404     <h5>Returns:</h5>
2405
2406
2407
2408 <table class="params">
2409     <thead>
2410     <tr>
2411
2412         <th>Type</th>
2413         <th class="last">Description</th>
2414     </tr>
2415     </thead>
2416     <tbody>
2417
2418         <tr>
2419
2420             <td class="type">
2421
2422                         Promise.&lt;(null|string)>
2423
2424
2425             </td>
2426             <td class="description last">Returns a promise resolving to the type of the internal modem
2427 (e.g. <code>vdsl</code>) or to <code>null</code> if no internal modem is present.</td>
2428         </tr>
2429
2430     </tbody>
2431 </table>
2432
2433
2434
2435
2436 </dd>
2437
2438
2439
2440 <dt>
2441     <div class="nameContainer">
2442         <h4 class="name" id="getHostHints">
2443
2444             getHostHints<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;<a href="LuCI.Network.Hosts.html">LuCI.Network.Hosts</a>>}</span>
2445         </h4>
2446
2447
2448         <div class="tag-source">
2449             network.js, line 1667
2450         </div>
2451
2452     </div>
2453
2454
2455 </dt>
2456 <dd>
2457
2458
2459     <div class="description">
2460         <p>Queries aggregated information about known hosts.</p>
2461 <p>This function aggregates information from various sources such as
2462 DHCP lease databases, ARP and IPv6 neighbour entries, wireless
2463 association list etc. and returns a <a href="LuCI.Network.Hosts.html"><code>Hosts</code></a>
2464 class instance describing the found hosts.</p>
2465     </div>
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475 <dl class="details">
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497 </dl>
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509     <h5>Returns:</h5>
2510
2511
2512
2513 <table class="params">
2514     <thead>
2515     <tr>
2516
2517         <th>Type</th>
2518         <th class="last">Description</th>
2519     </tr>
2520     </thead>
2521     <tbody>
2522
2523         <tr>
2524
2525             <td class="type">
2526
2527                         Promise.&lt;<a href="LuCI.Network.Hosts.html">LuCI.Network.Hosts</a>>
2528
2529
2530             </td>
2531             <td class="description last">Returns a <code>Hosts</code> instance describing host known on the system.</td>
2532         </tr>
2533
2534     </tbody>
2535 </table>
2536
2537
2538
2539
2540 </dd>
2541
2542
2543
2544 <dt>
2545     <div class="nameContainer">
2546         <h4 class="name" id="getIfnameOf">
2547
2548             getIfnameOf<span class="signature">(obj)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span>
2549         </h4>
2550
2551
2552         <div class="tag-source">
2553             network.js, line 1639
2554         </div>
2555
2556     </div>
2557
2558
2559 </dt>
2560 <dd>
2561
2562
2563     <div class="description">
2564         <p>Obtains the the network device name of the given object.</p>
2565     </div>
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575 <table class="params">
2576     <thead>
2577         <tr>
2578
2579                 <th>Name</th>
2580
2581
2582                 <th>Type</th>
2583
2584
2585
2586                 <th class="last">Description</th>
2587         </tr>
2588         </thead>
2589
2590         <tbody>
2591
2592
2593         <tr>
2594
2595                 <td class="name"><code>obj</code></td>
2596
2597
2598             <td class="type">
2599
2600
2601 <span class="param-type"><a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a></span>
2602 |
2603
2604 <span class="param-type"><a href="LuCI.Network.Device.html">LuCI.Network.Device</a></span>
2605 |
2606
2607 <span class="param-type"><a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a></span>
2608 |
2609
2610 <span class="param-type"><a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a></span>
2611 |
2612
2613 <span class="param-type">string</span>
2614
2615
2616
2617             </td>
2618
2619
2620
2621             <td class="description last">
2622
2623                 <p>The object to get the device name from.</p></td>
2624         </tr>
2625
2626
2627         </tbody>
2628 </table>
2629
2630
2631
2632 <dl class="details">
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654 </dl>
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666     <h5>Returns:</h5>
2667
2668
2669
2670 <table class="params">
2671     <thead>
2672     <tr>
2673
2674         <th>Type</th>
2675         <th class="last">Description</th>
2676     </tr>
2677     </thead>
2678     <tbody>
2679
2680         <tr>
2681
2682             <td class="type">
2683
2684                         null
2685                          |
2686
2687                         string
2688
2689
2690             </td>
2691             <td class="description last">Returns a string containing the device name or <code>null</code> if the given
2692 object could not be converted to a name.</td>
2693         </tr>
2694
2695     </tbody>
2696 </table>
2697
2698
2699
2700
2701 </dd>
2702
2703
2704
2705 <dt>
2706     <div class="nameContainer">
2707         <h4 class="name" id="getNetwork">
2708
2709             getNetwork<span class="signature">(name)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;(null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>)>}</span>
2710         </h4>
2711
2712
2713         <div class="tag-source">
2714             network.js, line 938
2715         </div>
2716
2717     </div>
2718
2719
2720 </dt>
2721 <dd>
2722
2723
2724     <div class="description">
2725         <p>Get a <a href="LuCI.Network.Protocol.html"><code>Protocol</code></a> instance describing
2726 the network with the given name.</p>
2727     </div>
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737 <table class="params">
2738     <thead>
2739         <tr>
2740
2741                 <th>Name</th>
2742
2743
2744                 <th>Type</th>
2745
2746
2747
2748                 <th class="last">Description</th>
2749         </tr>
2750         </thead>
2751
2752         <tbody>
2753
2754
2755         <tr>
2756
2757                 <td class="name"><code>name</code></td>
2758
2759
2760             <td class="type">
2761
2762
2763 <span class="param-type">string</span>
2764
2765
2766
2767             </td>
2768
2769
2770
2771             <td class="description last">
2772
2773                 <p>The logical interface name of the network get, e.g. <code>lan</code> or <code>wan</code>.</p></td>
2774         </tr>
2775
2776
2777         </tbody>
2778 </table>
2779
2780
2781
2782 <dl class="details">
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804 </dl>
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816     <h5>Returns:</h5>
2817
2818
2819
2820 <table class="params">
2821     <thead>
2822     <tr>
2823
2824         <th>Type</th>
2825         <th class="last">Description</th>
2826     </tr>
2827     </thead>
2828     <tbody>
2829
2830         <tr>
2831
2832             <td class="type">
2833
2834                         Promise.&lt;(null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>)>
2835
2836
2837             </td>
2838             <td class="description last">Returns a promise resolving to a
2839 <a href="LuCI.Network.Protocol.html"><code>Protocol</code></a> subclass instance describing
2840 the network or <code>null</code> if the network did not exist.</td>
2841         </tr>
2842
2843     </tbody>
2844 </table>
2845
2846
2847
2848
2849 </dd>
2850
2851
2852
2853 <dt>
2854     <div class="nameContainer">
2855         <h4 class="name" id="getNetworks">
2856
2857             getNetworks<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;Array.&lt;<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>>}</span>
2858         </h4>
2859
2860
2861         <div class="tag-source">
2862             network.js, line 963
2863         </div>
2864
2865     </div>
2866
2867
2868 </dt>
2869 <dd>
2870
2871
2872     <div class="description">
2873         <p>Gets an array containing all known networks.</p>
2874     </div>
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884 <dl class="details">
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906 </dl>
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918     <h5>Returns:</h5>
2919
2920
2921
2922 <table class="params">
2923     <thead>
2924     <tr>
2925
2926         <th>Type</th>
2927         <th class="last">Description</th>
2928     </tr>
2929     </thead>
2930     <tbody>
2931
2932         <tr>
2933
2934             <td class="type">
2935
2936                         Promise.&lt;Array.&lt;<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>>
2937
2938
2939             </td>
2940             <td class="description last">Returns a promise resolving to a name-sorted array of
2941 <a href="LuCI.Network.Protocol.html"><code>Protocol</code></a> subclass instances
2942 describing all known networks.</td>
2943         </tr>
2944
2945     </tbody>
2946 </table>
2947
2948
2949
2950
2951 </dd>
2952
2953
2954
2955 <dt>
2956     <div class="nameContainer">
2957         <h4 class="name" id="getProtocol">
2958
2959             getProtocol<span class="signature">(protoname, <span class="optional">netname</span>)</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>
2960         </h4>
2961
2962
2963         <div class="tag-source">
2964             network.js, line 767
2965         </div>
2966
2967     </div>
2968
2969
2970 </dt>
2971 <dd>
2972
2973
2974     <div class="description">
2975         <p>Instantiates the given <a href="LuCI.Network.Protocol.html"><code>Protocol</code></a> backend,
2976 optionally using the given network name.</p>
2977     </div>
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987 <table class="params">
2988     <thead>
2989         <tr>
2990
2991                 <th>Name</th>
2992
2993
2994                 <th>Type</th>
2995
2996
2997                 <th>Default</th>
2998
2999
3000                 <th class="last">Description</th>
3001         </tr>
3002         </thead>
3003
3004         <tbody>
3005
3006
3007         <tr>
3008
3009                 <td class="name"><code>protoname</code></td>
3010
3011
3012             <td class="type">
3013
3014
3015 <span class="param-type">string</span>
3016
3017
3018
3019             </td>
3020
3021
3022                 <td class="default">
3023
3024                 </td>
3025
3026
3027             <td class="description last">
3028
3029
3030
3031
3032
3033
3034                 <p>The protocol backend to use, e.g. <code>static</code> or <code>dhcp</code>.</p></td>
3035         </tr>
3036
3037
3038
3039         <tr>
3040
3041                 <td class="name"><code>netname</code></td>
3042
3043
3044             <td class="type">
3045
3046
3047 <span class="param-type">string</span>
3048
3049
3050
3051             </td>
3052
3053
3054                 <td class="default">
3055
3056                     __dummy__
3057
3058                 </td>
3059
3060
3061             <td class="description last">
3062
3063
3064                         <span class="optional">optional</span>
3065
3066
3067
3068
3069
3070                 <p>The network name to use for the instantiated protocol. This should be
3071 usually set to one of the interfaces described in /etc/config/network
3072 but it is allowed to omit it, e.g. to query protocol capabilities
3073 without the need for an existing interface.</p></td>
3074         </tr>
3075
3076
3077         </tbody>
3078 </table>
3079
3080
3081
3082 <dl class="details">
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104 </dl>
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116     <h5>Returns:</h5>
3117
3118
3119
3120 <table class="params">
3121     <thead>
3122     <tr>
3123
3124         <th>Type</th>
3125         <th class="last">Description</th>
3126     </tr>
3127     </thead>
3128     <tbody>
3129
3130         <tr>
3131
3132             <td class="type">
3133
3134                         null
3135                          |
3136
3137                         <a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>
3138
3139
3140             </td>
3141             <td class="description last">Returns the instantiated protocol backend class or <code>null</code> if the given
3142 protocol isn't known.</td>
3143         </tr>
3144
3145     </tbody>
3146 </table>
3147
3148
3149
3150
3151 </dd>
3152
3153
3154
3155 <dt>
3156     <div class="nameContainer">
3157         <h4 class="name" id="getProtocols">
3158
3159             getProtocols<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.&lt;<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>}</span>
3160         </h4>
3161
3162
3163         <div class="tag-source">
3164             network.js, line 782
3165         </div>
3166
3167     </div>
3168
3169
3170 </dt>
3171 <dd>
3172
3173
3174     <div class="description">
3175         <p>Obtains instances of all known <a href="LuCI.Network.Protocol.html"><code>Protocol</code></a>
3176 backend classes.</p>
3177     </div>
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187 <dl class="details">
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209 </dl>
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221     <h5>Returns:</h5>
3222
3223
3224
3225 <table class="params">
3226     <thead>
3227     <tr>
3228
3229         <th>Type</th>
3230         <th class="last">Description</th>
3231     </tr>
3232     </thead>
3233     <tbody>
3234
3235         <tr>
3236
3237             <td class="type">
3238
3239                         Array.&lt;<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>
3240
3241
3242             </td>
3243             <td class="description last">Returns an array of protocol class instances.</td>
3244         </tr>
3245
3246     </tbody>
3247 </table>
3248
3249
3250
3251
3252 </dd>
3253
3254
3255
3256 <dt>
3257     <div class="nameContainer">
3258         <h4 class="name" id="getSwitchTopologies">
3259
3260             getSwitchTopologies<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;Object.&lt;string, <a href="LuCI.Network.html#.SwitchTopology">LuCI.Network.SwitchTopology</a>>>}</span>
3261         </h4>
3262
3263
3264         <div class="tag-source">
3265             network.js, line 1544
3266         </div>
3267
3268     </div>
3269
3270
3271 </dt>
3272 <dd>
3273
3274
3275     <div class="description">
3276         <p>Returns the topologies of all swconfig switches found on the system.</p>
3277     </div>
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287 <dl class="details">
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309 </dl>
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321     <h5>Returns:</h5>
3322
3323
3324
3325 <table class="params">
3326     <thead>
3327     <tr>
3328
3329         <th>Type</th>
3330         <th class="last">Description</th>
3331     </tr>
3332     </thead>
3333     <tbody>
3334
3335         <tr>
3336
3337             <td class="type">
3338
3339                         Promise.&lt;Object.&lt;string, <a href="LuCI.Network.html#.SwitchTopology">LuCI.Network.SwitchTopology</a>>>
3340
3341
3342             </td>
3343             <td class="description last">Returns a promise resolving to an object containing the topologies
3344 of each switch. The object keys correspond to the name of the switches
3345 such as <code>switch0</code>, the values are
3346 <a href="LuCI.Network.html#.SwitchTopology"><code>SwitchTopology</code></a> objects describing
3347 the layout.</td>
3348         </tr>
3349
3350     </tbody>
3351 </table>
3352
3353
3354
3355
3356 </dd>
3357
3358
3359
3360 <dt>
3361     <div class="nameContainer">
3362         <h4 class="name" id="getWAN6Networks">
3363
3364             getWAN6Networks<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;Array.&lt;<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>>}</span>
3365         </h4>
3366
3367
3368         <div class="tag-source">
3369             network.js, line 1495
3370         </div>
3371
3372     </div>
3373
3374
3375 </dt>
3376 <dd>
3377
3378
3379     <div class="description">
3380         <p>Get IPv6 wan networks.</p>
3381 <p>This function looks up all networks having a default <code>::/0</code> route
3382 and returns them as array.</p>
3383     </div>
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393 <dl class="details">
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415 </dl>
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427     <h5>Returns:</h5>
3428
3429
3430
3431 <table class="params">
3432     <thead>
3433     <tr>
3434
3435         <th>Type</th>
3436         <th class="last">Description</th>
3437     </tr>
3438     </thead>
3439     <tbody>
3440
3441         <tr>
3442
3443             <td class="type">
3444
3445                         Promise.&lt;Array.&lt;<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>>
3446
3447
3448             </td>
3449             <td class="description last">Returns a promise resolving to an array of <code>Protocol</code> subclass
3450 instances describing the found IPv6 default route interfaces.</td>
3451         </tr>
3452
3453     </tbody>
3454 </table>
3455
3456
3457
3458
3459 </dd>
3460
3461
3462
3463 <dt>
3464     <div class="nameContainer">
3465         <h4 class="name" id="getWANNetworks">
3466
3467             getWANNetworks<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;Array.&lt;<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>>}</span>
3468         </h4>
3469
3470
3471         <div class="tag-source">
3472             network.js, line 1470
3473         </div>
3474
3475     </div>
3476
3477
3478 </dt>
3479 <dd>
3480
3481
3482     <div class="description">
3483         <p>Get IPv4 wan networks.</p>
3484 <p>This function looks up all networks having a default <code>0.0.0.0/0</code> route
3485 and returns them as array.</p>
3486     </div>
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496 <dl class="details">
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518 </dl>
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530     <h5>Returns:</h5>
3531
3532
3533
3534 <table class="params">
3535     <thead>
3536     <tr>
3537
3538         <th>Type</th>
3539         <th class="last">Description</th>
3540     </tr>
3541     </thead>
3542     <tbody>
3543
3544         <tr>
3545
3546             <td class="type">
3547
3548                         Promise.&lt;Array.&lt;<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>>
3549
3550
3551             </td>
3552             <td class="description last">Returns a promise resolving to an array of <code>Protocol</code> subclass
3553 instances describing the found default route interfaces.</td>
3554         </tr>
3555
3556     </tbody>
3557 </table>
3558
3559
3560
3561
3562 </dd>
3563
3564
3565
3566 <dt>
3567     <div class="nameContainer">
3568         <h4 class="name" id="getWifiDevice">
3569
3570             getWifiDevice<span class="signature">(devname)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;(null|<a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>)>}</span>
3571         </h4>
3572
3573
3574         <div class="tag-source">
3575             network.js, line 1257
3576         </div>
3577
3578     </div>
3579
3580
3581 </dt>
3582 <dd>
3583
3584
3585     <div class="description">
3586         <p>Get a <a href="LuCI.Network.WifiDevice.html"><code>WifiDevice</code></a> instance describing
3587 the given wireless radio.</p>
3588     </div>
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598 <table class="params">
3599     <thead>
3600         <tr>
3601
3602                 <th>Name</th>
3603
3604
3605                 <th>Type</th>
3606
3607
3608
3609                 <th class="last">Description</th>
3610         </tr>
3611         </thead>
3612
3613         <tbody>
3614
3615
3616         <tr>
3617
3618                 <td class="name"><code>devname</code></td>
3619
3620
3621             <td class="type">
3622
3623
3624 <span class="param-type">string</span>
3625
3626
3627
3628             </td>
3629
3630
3631
3632             <td class="description last">
3633
3634                 <p>The configuration name of the wireless radio to lookup, e.g. <code>radio0</code>
3635 for the first mac80211 phy on the system.</p></td>
3636         </tr>
3637
3638
3639         </tbody>
3640 </table>
3641
3642
3643
3644 <dl class="details">
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666 </dl>
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678     <h5>Returns:</h5>
3679
3680
3681
3682 <table class="params">
3683     <thead>
3684     <tr>
3685
3686         <th>Type</th>
3687         <th class="last">Description</th>
3688     </tr>
3689     </thead>
3690     <tbody>
3691
3692         <tr>
3693
3694             <td class="type">
3695
3696                         Promise.&lt;(null|<a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>)>
3697
3698
3699             </td>
3700             <td class="description last">Returns a promise resolving to the <code>WifiDevice</code> instance describing
3701 the underlying radio device or <code>null</code> if the wireless radio could not
3702 be found.</td>
3703         </tr>
3704
3705     </tbody>
3706 </table>
3707
3708
3709
3710
3711 </dd>
3712
3713
3714
3715 <dt>
3716     <div class="nameContainer">
3717         <h4 class="name" id="getWifiDevices">
3718
3719             getWifiDevices<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;Array.&lt;<a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>>>}</span>
3720         </h4>
3721
3722
3723         <div class="tag-source">
3724             network.js, line 1277
3725         </div>
3726
3727     </div>
3728
3729
3730 </dt>
3731 <dd>
3732
3733
3734     <div class="description">
3735         <p>Obtain a list of all configured radio devices.</p>
3736     </div>
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746 <dl class="details">
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768 </dl>
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780     <h5>Returns:</h5>
3781
3782
3783
3784 <table class="params">
3785     <thead>
3786     <tr>
3787
3788         <th>Type</th>
3789         <th class="last">Description</th>
3790     </tr>
3791     </thead>
3792     <tbody>
3793
3794         <tr>
3795
3796             <td class="type">
3797
3798                         Promise.&lt;Array.&lt;<a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>>>
3799
3800
3801             </td>
3802             <td class="description last">Returns a promise resolving to an array of <code>WifiDevice</code> instances
3803 describing the wireless radios configured in the system.
3804 The order of the array corresponds to the order of the radios in
3805 the configuration.</td>
3806         </tr>
3807
3808     </tbody>
3809 </table>
3810
3811
3812
3813
3814 </dd>
3815
3816
3817
3818 <dt>
3819     <div class="nameContainer">
3820         <h4 class="name" id="getWifiNetwork">
3821
3822             getWifiNetwork<span class="signature">(netname)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;(null|<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>)>}</span>
3823         </h4>
3824
3825
3826         <div class="tag-source">
3827             network.js, line 1306
3828         </div>
3829
3830     </div>
3831
3832
3833 </dt>
3834 <dd>
3835
3836
3837     <div class="description">
3838         <p>Get a <a href="LuCI.Network.WifiNetwork.html"><code>WifiNetwork</code></a> instance describing
3839 the given wireless network.</p>
3840     </div>
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850 <table class="params">
3851     <thead>
3852         <tr>
3853
3854                 <th>Name</th>
3855
3856
3857                 <th>Type</th>
3858
3859
3860
3861                 <th class="last">Description</th>
3862         </tr>
3863         </thead>
3864
3865         <tbody>
3866
3867
3868         <tr>
3869
3870                 <td class="name"><code>netname</code></td>
3871
3872
3873             <td class="type">
3874
3875
3876 <span class="param-type">string</span>
3877
3878
3879
3880             </td>
3881
3882
3883
3884             <td class="description last">
3885
3886                 <p>The name of the wireless network to lookup. This may be either an uci
3887 configuration section ID, a network ID in the form <code>radio#.network#</code>
3888 or a Linux network device name like <code>wlan0</code> which is resolved to the
3889 corresponding configuration section through <code>ubus</code> runtime information.</p></td>
3890         </tr>
3891
3892
3893         </tbody>
3894 </table>
3895
3896
3897
3898 <dl class="details">
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920 </dl>
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932     <h5>Returns:</h5>
3933
3934
3935
3936 <table class="params">
3937     <thead>
3938     <tr>
3939
3940         <th>Type</th>
3941         <th class="last">Description</th>
3942     </tr>
3943     </thead>
3944     <tbody>
3945
3946         <tr>
3947
3948             <td class="type">
3949
3950                         Promise.&lt;(null|<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>)>
3951
3952
3953             </td>
3954             <td class="description last">Returns a promise resolving to the <code>WifiNetwork</code> instance describing
3955 the wireless network or <code>null</code> if the corresponding network could not
3956 be found.</td>
3957         </tr>
3958
3959     </tbody>
3960 </table>
3961
3962
3963
3964
3965 </dd>
3966
3967
3968
3969 <dt>
3970     <div class="nameContainer">
3971         <h4 class="name" id="getWifiNetworks">
3972
3973             getWifiNetworks<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;Array.&lt;<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>>>}</span>
3974         </h4>
3975
3976
3977         <div class="tag-source">
3978             network.js, line 1320
3979         </div>
3980
3981     </div>
3982
3983
3984 </dt>
3985 <dd>
3986
3987
3988     <div class="description">
3989         <p>Get an array of all <a href="LuCI.Network.WifiNetwork.html"><code>WifiNetwork</code></a>
3990 instances describing the wireless networks present on the system.</p>
3991     </div>
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001 <dl class="details">
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023 </dl>
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035     <h5>Returns:</h5>
4036
4037
4038
4039 <table class="params">
4040     <thead>
4041     <tr>
4042
4043         <th>Type</th>
4044         <th class="last">Description</th>
4045     </tr>
4046     </thead>
4047     <tbody>
4048
4049         <tr>
4050
4051             <td class="type">
4052
4053                         Promise.&lt;Array.&lt;<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>>>
4054
4055
4056             </td>
4057             <td class="description last">Returns a promise resolving to an array of <code>WifiNetwork</code> instances
4058 describing the wireless networks. The array will be empty if no networks
4059 are found.</td>
4060         </tr>
4061
4062     </tbody>
4063 </table>
4064
4065
4066
4067
4068 </dd>
4069
4070
4071
4072 <dt>
4073     <div class="nameContainer">
4074         <h4 class="name" id="isIgnoredDevice">
4075
4076             isIgnoredDevice<span class="signature">(name)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
4077         </h4>
4078
4079
4080         <div class="tag-source">
4081             network.js, line 1240
4082         </div>
4083
4084     </div>
4085
4086
4087 </dt>
4088 <dd>
4089
4090
4091     <div class="description">
4092         <p>Test if a given network device name is in the list of patterns for
4093 device names to ignore.</p>
4094 <p>Ignored device names are usually Linux network devices which are
4095 spawned implicitly by kernel modules such as <code>tunl0</code> or <code>hwsim0</code>
4096 and which are unsuitable for use in network configuration.</p>
4097     </div>
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107 <table class="params">
4108     <thead>
4109         <tr>
4110
4111                 <th>Name</th>
4112
4113
4114                 <th>Type</th>
4115
4116
4117
4118                 <th class="last">Description</th>
4119         </tr>
4120         </thead>
4121
4122         <tbody>
4123
4124
4125         <tr>
4126
4127                 <td class="name"><code>name</code></td>
4128
4129
4130             <td class="type">
4131
4132
4133 <span class="param-type">string</span>
4134
4135
4136
4137             </td>
4138
4139
4140
4141             <td class="description last">
4142
4143                 <p>The device name to test.</p></td>
4144         </tr>
4145
4146
4147         </tbody>
4148 </table>
4149
4150
4151
4152 <dl class="details">
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174 </dl>
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186     <h5>Returns:</h5>
4187
4188
4189
4190 <table class="params">
4191     <thead>
4192     <tr>
4193
4194         <th>Type</th>
4195         <th class="last">Description</th>
4196     </tr>
4197     </thead>
4198     <tbody>
4199
4200         <tr>
4201
4202             <td class="type">
4203
4204                         boolean
4205
4206
4207             </td>
4208             <td class="description last">Returns <code>true</code> if the given name is in the ignore pattern list,
4209 else returns <code>false</code>.</td>
4210         </tr>
4211
4212     </tbody>
4213 </table>
4214
4215
4216
4217
4218 </dd>
4219
4220
4221
4222 <dt>
4223     <div class="nameContainer">
4224         <h4 class="name" id="maskToPrefix">
4225
4226             maskToPrefix<span class="signature">(netmask, <span class="optional">v6</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|number}</span>
4227         </h4>
4228
4229
4230         <div class="tag-source">
4231             network.js, line 681
4232         </div>
4233
4234     </div>
4235
4236
4237 </dt>
4238 <dd>
4239
4240
4241     <div class="description">
4242         <p>Converts the given netmask to a prefix size in bits.</p>
4243     </div>
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253 <table class="params">
4254     <thead>
4255         <tr>
4256
4257                 <th>Name</th>
4258
4259
4260                 <th>Type</th>
4261
4262
4263                 <th>Default</th>
4264
4265
4266                 <th class="last">Description</th>
4267         </tr>
4268         </thead>
4269
4270         <tbody>
4271
4272
4273         <tr>
4274
4275                 <td class="name"><code>netmask</code></td>
4276
4277
4278             <td class="type">
4279
4280
4281 <span class="param-type">string</span>
4282
4283
4284
4285             </td>
4286
4287
4288                 <td class="default">
4289
4290                 </td>
4291
4292
4293             <td class="description last">
4294
4295
4296
4297
4298
4299
4300                 <p>The netmask to convert into a bit count.</p></td>
4301         </tr>
4302
4303
4304
4305         <tr>
4306
4307                 <td class="name"><code>v6</code></td>
4308
4309
4310             <td class="type">
4311
4312
4313 <span class="param-type">boolean</span>
4314
4315
4316
4317             </td>
4318
4319
4320                 <td class="default">
4321
4322                     false
4323
4324                 </td>
4325
4326
4327             <td class="description last">
4328
4329
4330                         <span class="optional">optional</span>
4331
4332
4333
4334
4335
4336                 <p>Whether to parse the given netmask as IPv4 (<code>false</code>) or IPv6 (<code>true</code>)
4337 address.</p></td>
4338         </tr>
4339
4340
4341         </tbody>
4342 </table>
4343
4344
4345
4346 <dl class="details">
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368 </dl>
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380     <h5>Returns:</h5>
4381
4382
4383
4384 <table class="params">
4385     <thead>
4386     <tr>
4387
4388         <th>Type</th>
4389         <th class="last">Description</th>
4390     </tr>
4391     </thead>
4392     <tbody>
4393
4394         <tr>
4395
4396             <td class="type">
4397
4398                         null
4399                          |
4400
4401                         number
4402
4403
4404             </td>
4405             <td class="description last">Returns the number of prefix bits contained in the netmask or <code>null</code>
4406 if the given netmask value was invalid.</td>
4407         </tr>
4408
4409     </tbody>
4410 </table>
4411
4412
4413
4414
4415 </dd>
4416
4417
4418
4419 <dt>
4420     <div class="nameContainer">
4421         <h4 class="name" id="prefixToMask">
4422
4423             prefixToMask<span class="signature">(bits, <span class="optional">v6</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span>
4424         </h4>
4425
4426
4427         <div class="tag-source">
4428             network.js, line 663
4429         </div>
4430
4431     </div>
4432
4433
4434 </dt>
4435 <dd>
4436
4437
4438     <div class="description">
4439         <p>Converts the given prefix size in bits to a netmask.</p>
4440     </div>
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450 <table class="params">
4451     <thead>
4452         <tr>
4453
4454                 <th>Name</th>
4455
4456
4457                 <th>Type</th>
4458
4459
4460                 <th>Default</th>
4461
4462
4463                 <th class="last">Description</th>
4464         </tr>
4465         </thead>
4466
4467         <tbody>
4468
4469
4470         <tr>
4471
4472                 <td class="name"><code>bits</code></td>
4473
4474
4475             <td class="type">
4476
4477
4478 <span class="param-type">number</span>
4479
4480
4481
4482             </td>
4483
4484
4485                 <td class="default">
4486
4487                 </td>
4488
4489
4490             <td class="description last">
4491
4492
4493
4494
4495
4496
4497                 <p>The prefix size in bits.</p></td>
4498         </tr>
4499
4500
4501
4502         <tr>
4503
4504                 <td class="name"><code>v6</code></td>
4505
4506
4507             <td class="type">
4508
4509
4510 <span class="param-type">boolean</span>
4511
4512
4513
4514             </td>
4515
4516
4517                 <td class="default">
4518
4519                     false
4520
4521                 </td>
4522
4523
4524             <td class="description last">
4525
4526
4527                         <span class="optional">optional</span>
4528
4529
4530
4531
4532
4533                 <p>Whether to convert the bits value into an IPv4 netmask (<code>false</code>) or
4534 an IPv6 netmask (<code>true</code>).</p></td>
4535         </tr>
4536
4537
4538         </tbody>
4539 </table>
4540
4541
4542
4543 <dl class="details">
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565 </dl>
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577     <h5>Returns:</h5>
4578
4579
4580
4581 <table class="params">
4582     <thead>
4583     <tr>
4584
4585         <th>Type</th>
4586         <th class="last">Description</th>
4587     </tr>
4588     </thead>
4589     <tbody>
4590
4591         <tr>
4592
4593             <td class="type">
4594
4595                         null
4596                          |
4597
4598                         string
4599
4600
4601             </td>
4602             <td class="description last">Returns a string containing the netmask corresponding to the bit count
4603 or <code>null</code> when the given amount of bits exceeds the maximum possible
4604 value of <code>32</code> for IPv4 or <code>128</code> for IPv6.</td>
4605         </tr>
4606
4607     </tbody>
4608 </table>
4609
4610
4611
4612
4613 </dd>
4614
4615
4616
4617 <dt>
4618     <div class="nameContainer">
4619         <h4 class="name" id="registerErrorCode">
4620
4621             registerErrorCode<span class="signature">(code, message)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
4622         </h4>
4623
4624
4625         <div class="tag-source">
4626             network.js, line 870
4627         </div>
4628
4629     </div>
4630
4631
4632 </dt>
4633 <dd>
4634
4635
4636     <div class="description">
4637         <p>Registers a new human readable translation string for a <code>Protocol</code>
4638 error code.</p>
4639     </div>
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649 <table class="params">
4650     <thead>
4651         <tr>
4652
4653                 <th>Name</th>
4654
4655
4656                 <th>Type</th>
4657
4658
4659
4660                 <th class="last">Description</th>
4661         </tr>
4662         </thead>
4663
4664         <tbody>
4665
4666
4667         <tr>
4668
4669                 <td class="name"><code>code</code></td>
4670
4671
4672             <td class="type">
4673
4674
4675 <span class="param-type">string</span>
4676
4677
4678
4679             </td>
4680
4681
4682
4683             <td class="description last">
4684
4685                 <p>The <code>ubus</code> protocol error code to register a translation for, e.g.
4686 <code>NO_DEVICE</code>.</p></td>
4687         </tr>
4688
4689
4690
4691         <tr>
4692
4693                 <td class="name"><code>message</code></td>
4694
4695
4696             <td class="type">
4697
4698
4699 <span class="param-type">string</span>
4700
4701
4702
4703             </td>
4704
4705
4706
4707             <td class="description last">
4708
4709                 <p>The message to use as translation for the given protocol error code.</p></td>
4710         </tr>
4711
4712
4713         </tbody>
4714 </table>
4715
4716
4717
4718 <dl class="details">
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740 </dl>
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752     <h5>Returns:</h5>
4753
4754
4755
4756 <table class="params">
4757     <thead>
4758     <tr>
4759
4760         <th>Type</th>
4761         <th class="last">Description</th>
4762     </tr>
4763     </thead>
4764     <tbody>
4765
4766         <tr>
4767
4768             <td class="type">
4769
4770                         boolean
4771
4772
4773             </td>
4774             <td class="description last">Returns <code>true</code> if the error code description has been added or <code>false</code>
4775 if either the arguments were invalid or if there already was a
4776 description for the given code.</td>
4777         </tr>
4778
4779     </tbody>
4780 </table>
4781
4782
4783
4784
4785 </dd>
4786
4787
4788
4789 <dt>
4790     <div class="nameContainer">
4791         <h4 class="name" id="registerPatternVirtual">
4792
4793             registerPatternVirtual<span class="signature">(pat)</span>
4794         </h4>
4795
4796
4797         <div class="tag-source">
4798             network.js, line 850
4799         </div>
4800
4801     </div>
4802
4803
4804 </dt>
4805 <dd>
4806
4807
4808     <div class="description">
4809         <p>Registers a new regular expression pattern to recognize
4810 virtual interfaces.</p>
4811     </div>
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821 <table class="params">
4822     <thead>
4823         <tr>
4824
4825                 <th>Name</th>
4826
4827
4828                 <th>Type</th>
4829
4830
4831
4832                 <th class="last">Description</th>
4833         </tr>
4834         </thead>
4835
4836         <tbody>
4837
4838
4839         <tr>
4840
4841                 <td class="name"><code>pat</code></td>
4842
4843
4844             <td class="type">
4845
4846
4847 <span class="param-type">RegExp</span>
4848
4849
4850
4851             </td>
4852
4853
4854
4855             <td class="description last">
4856
4857                 <p>A <code>RegExp</code> instance to match a virtual interface name
4858 such as <code>6in4-wan</code> or <code>tun0</code>.</p></td>
4859         </tr>
4860
4861
4862         </tbody>
4863 </table>
4864
4865
4866
4867 <dl class="details">
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889 </dl>
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903 </dd>
4904
4905
4906
4907 <dt>
4908     <div class="nameContainer">
4909         <h4 class="name" id="registerProtocol">
4910
4911             registerProtocol<span class="signature">(protoname, methods)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>}</span>
4912         </h4>
4913
4914
4915         <div class="tag-source">
4916             network.js, line 809
4917         </div>
4918
4919     </div>
4920
4921
4922 </dt>
4923 <dd>
4924
4925
4926     <div class="description">
4927         <p>Registers a new <a href="LuCI.Network.Protocol.html"><code>Protocol</code></a> subclass
4928 with the given methods and returns the resulting subclass value.</p>
4929 <p>This functions internally calls
4930 <a href="LuCI.Class.html#.extend"><code>Class.extend()</code></a> on the <code>Network.Protocol</code>
4931 base class.</p>
4932     </div>
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942 <table class="params">
4943     <thead>
4944         <tr>
4945
4946                 <th>Name</th>
4947
4948
4949                 <th>Type</th>
4950
4951
4952
4953                 <th class="last">Description</th>
4954         </tr>
4955         </thead>
4956
4957         <tbody>
4958
4959
4960         <tr>
4961
4962                 <td class="name"><code>protoname</code></td>
4963
4964
4965             <td class="type">
4966
4967
4968 <span class="param-type">string</span>
4969
4970
4971
4972             </td>
4973
4974
4975
4976             <td class="description last">
4977
4978                 <p>The name of the new protocol to register.</p></td>
4979         </tr>
4980
4981
4982
4983         <tr>
4984
4985                 <td class="name"><code>methods</code></td>
4986
4987
4988             <td class="type">
4989
4990
4991 <span class="param-type">Object.&lt;string, *></span>
4992
4993
4994
4995             </td>
4996
4997
4998
4999             <td class="description last">
5000
5001                 <p>The member methods and values of the new <code>Protocol</code> subclass to
5002 be passed to <a href="LuCI.Class.html#.extend"><code>Class.extend()</code></a>.</p></td>
5003         </tr>
5004
5005
5006         </tbody>
5007 </table>
5008
5009
5010
5011 <dl class="details">
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033 </dl>
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045     <h5>Returns:</h5>
5046
5047
5048
5049 <table class="params">
5050     <thead>
5051     <tr>
5052
5053         <th>Type</th>
5054         <th class="last">Description</th>
5055     </tr>
5056     </thead>
5057     <tbody>
5058
5059         <tr>
5060
5061             <td class="type">
5062
5063                         <a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>
5064
5065
5066             </td>
5067             <td class="description last">Returns the new <code>Protocol</code> subclass.</td>
5068         </tr>
5069
5070     </tbody>
5071 </table>
5072
5073
5074
5075
5076 </dd>
5077
5078
5079
5080 <dt>
5081     <div class="nameContainer">
5082         <h4 class="name" id="renameNetwork">
5083
5084             renameNetwork<span class="signature">(oldName, newName)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;boolean>}</span>
5085         </h4>
5086
5087
5088         <div class="tag-source">
5089             network.js, line 1043
5090         </div>
5091
5092     </div>
5093
5094
5095 </dt>
5096 <dd>
5097
5098
5099     <div class="description">
5100         <p>Rename the given network and its references to a new name.</p>
5101     </div>
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111 <table class="params">
5112     <thead>
5113         <tr>
5114
5115                 <th>Name</th>
5116
5117
5118                 <th>Type</th>
5119
5120
5121
5122                 <th class="last">Description</th>
5123         </tr>
5124         </thead>
5125
5126         <tbody>
5127
5128
5129         <tr>
5130
5131                 <td class="name"><code>oldName</code></td>
5132
5133
5134             <td class="type">
5135
5136
5137 <span class="param-type">string</span>
5138
5139
5140
5141             </td>
5142
5143
5144
5145             <td class="description last">
5146
5147                 <p>The current name of the network.</p></td>
5148         </tr>
5149
5150
5151
5152         <tr>
5153
5154                 <td class="name"><code>newName</code></td>
5155
5156
5157             <td class="type">
5158
5159
5160 <span class="param-type">string</span>
5161
5162
5163
5164             </td>
5165
5166
5167
5168             <td class="description last">
5169
5170                 <p>The name to rename the network to, must be in the format
5171 <code>[a-z-A-Z0-9_]+</code>.</p></td>
5172         </tr>
5173
5174
5175         </tbody>
5176 </table>
5177
5178
5179
5180 <dl class="details">
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202 </dl>
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214     <h5>Returns:</h5>
5215
5216
5217
5218 <table class="params">
5219     <thead>
5220     <tr>
5221
5222         <th>Type</th>
5223         <th class="last">Description</th>
5224     </tr>
5225     </thead>
5226     <tbody>
5227
5228         <tr>
5229
5230             <td class="type">
5231
5232                         Promise.&lt;boolean>
5233
5234
5235             </td>
5236             <td class="description last">Returns a promise resolving to either <code>true</code> if the network was
5237 successfully renamed or <code>false</code> if the new name was invalid, if
5238 a network with the new name already exists or if the network to
5239 rename could not be found.</td>
5240         </tr>
5241
5242     </tbody>
5243 </table>
5244
5245
5246
5247
5248 </dd>
5249
5250         </dl>
5251
5252
5253
5254         <h3 class="subsection-title">Type Definitions</h3>
5255
5256         <dl>
5257
5258 <dt>
5259     <div class="nameContainer">
5260         <h4 class="name" id=".SwitchTopology">LuCI.Network.SwitchTopology<span class="type-signature type object.<string, (object|array)>">Object.&lt;string, (Object|Array)></span> </h4>
5261     </div>
5262
5263
5264 </dt>
5265 <dd>
5266
5267     <div class="description">
5268         <p>Describes an swconfig switch topology by specifying the CPU
5269 connections and external port labels of a switch.</p>
5270     </div>
5271
5272
5273
5274 <dl class="details">
5275
5276
5277         <h5 class="subsection-title">Properties:</h5>
5278
5279         <dl>
5280
5281 <table class="props">
5282     <thead>
5283         <tr>
5284
5285                 <th>Name</th>
5286
5287
5288                 <th>Type</th>
5289
5290
5291
5292
5293
5294                 <th class="last">Description</th>
5295         </tr>
5296         </thead>
5297
5298         <tbody>
5299
5300
5301         <tr>
5302
5303                 <td class="name"><code>netdevs</code></td>
5304
5305
5306             <td class="type">
5307
5308
5309 <span class="param-type">Object.&lt;number, string></span>
5310
5311
5312
5313             </td>
5314
5315
5316
5317
5318
5319             <td class="description last"><p>The <code>netdevs</code> property points to an object describing the CPU port
5320 connections of the switch. The numeric key of the enclosed object is
5321 the port number, the value contains the Linux network device name the
5322 port is hardwired to.</p></td>
5323         </tr>
5324
5325
5326
5327         <tr>
5328
5329                 <td class="name"><code>ports</code></td>
5330
5331
5332             <td class="type">
5333
5334
5335 <span class="param-type">Array.&lt;Object.&lt;string, (boolean|number|string)>></span>
5336
5337
5338
5339             </td>
5340
5341
5342
5343
5344
5345             <td class="description last"><p>The <code>ports</code> property points to an array describing the populated
5346 ports of the switch in the external label order. Each array item is
5347 an object containg the following keys:</p>
5348 <ul>
5349 <li><code>num</code> - the internal switch port number</li>
5350 <li><code>label</code> - the label of the port, e.g. <code>LAN 1</code> or <code>CPU (eth0)</code></li>
5351 <li><code>device</code> - the connected Linux network device name (CPU ports only)</li>
5352 <li><code>tagged</code> - a boolean indicating whether the port must be tagged to
5353 function (CPU ports only)</li>
5354 </ul></td>
5355         </tr>
5356
5357
5358         </tbody>
5359 </table></dl>
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382 </dl>
5383
5384
5385
5386 </dd>
5387
5388
5389
5390 <dt>
5391     <div class="nameContainer">
5392         <h4 class="name" id=".WifiEncryption">LuCI.Network.WifiEncryption<span class="type-signature type object.<string, (boolean|array.<(number|string)>)>">Object.&lt;string, (boolean|Array.&lt;(number|string)>)></span> </h4>
5393     </div>
5394
5395
5396 </dt>
5397 <dd>
5398
5399     <div class="description">
5400         <p>An encryption entry describes active wireless encryption settings
5401 such as the used key management protocols, active ciphers and
5402 protocol versions.</p>
5403     </div>
5404
5405
5406
5407 <dl class="details">
5408
5409
5410         <h5 class="subsection-title">Properties:</h5>
5411
5412         <dl>
5413
5414 <table class="props">
5415     <thead>
5416         <tr>
5417
5418                 <th>Name</th>
5419
5420
5421                 <th>Type</th>
5422
5423
5424                 <th>Argument</th>
5425
5426
5427
5428
5429                 <th class="last">Description</th>
5430         </tr>
5431         </thead>
5432
5433         <tbody>
5434
5435
5436         <tr>
5437
5438                 <td class="name"><code>enabled</code></td>
5439
5440
5441             <td class="type">
5442
5443
5444 <span class="param-type">boolean</span>
5445
5446
5447
5448             </td>
5449
5450
5451                 <td class="attributes">
5452
5453
5454
5455                 </td>
5456
5457
5458
5459
5460             <td class="description last"><p>Specifies whether any kind of encryption, such as <code>WEP</code> or <code>WPA</code> is
5461 enabled. If set to <code>false</code>, then no encryption is active and the
5462 corresponding network is open.</p></td>
5463         </tr>
5464
5465
5466
5467         <tr>
5468
5469                 <td class="name"><code>wep</code></td>
5470
5471
5472             <td class="type">
5473
5474
5475 <span class="param-type">Array.&lt;string></span>
5476
5477
5478
5479             </td>
5480
5481
5482                 <td class="attributes">
5483
5484                     &lt;optional><br>
5485
5486
5487
5488                 </td>
5489
5490
5491
5492
5493             <td class="description last"><p>When the <code>wep</code> property exists, the network uses WEP encryption.
5494 In this case, the property is set to an array of active WEP modes
5495 which might be either <code>open</code>, <code>shared</code> or both.</p></td>
5496         </tr>
5497
5498
5499
5500         <tr>
5501
5502                 <td class="name"><code>wpa</code></td>
5503
5504
5505             <td class="type">
5506
5507
5508 <span class="param-type">Array.&lt;number></span>
5509
5510
5511
5512             </td>
5513
5514
5515                 <td class="attributes">
5516
5517                     &lt;optional><br>
5518
5519
5520
5521                 </td>
5522
5523
5524
5525
5526             <td class="description last"><p>When the <code>wpa</code> property exists, the network uses WPA security.
5527 In this case, the property is set to an array containing the WPA
5528 protocol versions used, e.g. <code>[ 1, 2 ]</code> for WPA/WPA2 mixed mode or
5529 <code>[ 3 ]</code> for WPA3-SAE.</p></td>
5530         </tr>
5531
5532
5533
5534         <tr>
5535
5536                 <td class="name"><code>authentication</code></td>
5537
5538
5539             <td class="type">
5540
5541
5542 <span class="param-type">Array.&lt;string></span>
5543
5544
5545
5546             </td>
5547
5548
5549                 <td class="attributes">
5550
5551                     &lt;optional><br>
5552
5553
5554
5555                 </td>
5556
5557
5558
5559
5560             <td class="description last"><p>The <code>authentication</code> property only applies to WPA encryption and
5561 is defined when the <code>wpa</code> property is set as well. It points to
5562 an array of active authentication suites used by the network, e.g.
5563 <code>[ &quot;psk&quot; ]</code> for a WPA(2)-PSK network or <code>[ &quot;psk&quot;, &quot;sae&quot; ]</code> for
5564 mixed WPA2-PSK/WPA3-SAE encryption.</p></td>
5565         </tr>
5566
5567
5568
5569         <tr>
5570
5571                 <td class="name"><code>ciphers</code></td>
5572
5573
5574             <td class="type">
5575
5576
5577 <span class="param-type">Array.&lt;string></span>
5578
5579
5580
5581             </td>
5582
5583
5584                 <td class="attributes">
5585
5586                     &lt;optional><br>
5587
5588
5589
5590                 </td>
5591
5592
5593
5594
5595             <td class="description last"><p>If either WEP or WPA encryption is active, then the <code>ciphers</code>
5596 property will be set to an array describing the active encryption
5597 ciphers used by the network, e.g. <code>[ &quot;tkip&quot;, &quot;ccmp&quot; ]</code> for a
5598 WPA/WPA2-PSK mixed network or <code>[ &quot;wep-40&quot;, &quot;wep-104&quot; ]</code> for an
5599 WEP network.</p></td>
5600         </tr>
5601
5602
5603         </tbody>
5604 </table></dl>
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627 </dl>
5628
5629
5630
5631 </dd>
5632
5633
5634
5635 <dt>
5636     <div class="nameContainer">
5637         <h4 class="name" id=".WifiPeerEntry">LuCI.Network.WifiPeerEntry<span class="type-signature type object.<string, (boolean|number|string|luci.network.wifirateentry)>">Object.&lt;string, (boolean|number|string|<a href="LuCI.Network.html#.WifiRateEntry">LuCI.Network.WifiRateEntry</a>)></span> </h4>
5638     </div>
5639
5640
5641 </dt>
5642 <dd>
5643
5644     <div class="description">
5645         <p>A wireless peer entry describes the properties of a remote wireless
5646 peer associated with a local network.</p>
5647     </div>
5648
5649
5650
5651 <dl class="details">
5652
5653
5654         <h5 class="subsection-title">Properties:</h5>
5655
5656         <dl>
5657
5658 <table class="props">
5659     <thead>
5660         <tr>
5661
5662                 <th>Name</th>
5663
5664
5665                 <th>Type</th>
5666
5667
5668                 <th>Argument</th>
5669
5670
5671
5672
5673                 <th class="last">Description</th>
5674         </tr>
5675         </thead>
5676
5677         <tbody>
5678
5679
5680         <tr>
5681
5682                 <td class="name"><code>mac</code></td>
5683
5684
5685             <td class="type">
5686
5687
5688 <span class="param-type">string</span>
5689
5690
5691
5692             </td>
5693
5694
5695                 <td class="attributes">
5696
5697
5698
5699                 </td>
5700
5701
5702
5703
5704             <td class="description last"><p>The MAC address (BSSID).</p></td>
5705         </tr>
5706
5707
5708
5709         <tr>
5710
5711                 <td class="name"><code>signal</code></td>
5712
5713
5714             <td class="type">
5715
5716
5717 <span class="param-type">number</span>
5718
5719
5720
5721             </td>
5722
5723
5724                 <td class="attributes">
5725
5726
5727
5728                 </td>
5729
5730
5731
5732
5733             <td class="description last"><p>The received signal strength.</p></td>
5734         </tr>
5735
5736
5737
5738         <tr>
5739
5740                 <td class="name"><code>signal_avg</code></td>
5741
5742
5743             <td class="type">
5744
5745
5746 <span class="param-type">number</span>
5747
5748
5749
5750             </td>
5751
5752
5753                 <td class="attributes">
5754
5755                     &lt;optional><br>
5756
5757
5758
5759                 </td>
5760
5761
5762
5763
5764             <td class="description last"><p>The average signal strength if supported by the driver.</p></td>
5765         </tr>
5766
5767
5768
5769         <tr>
5770
5771                 <td class="name"><code>noise</code></td>
5772
5773
5774             <td class="type">
5775
5776
5777 <span class="param-type">number</span>
5778
5779
5780
5781             </td>
5782
5783
5784                 <td class="attributes">
5785
5786                     &lt;optional><br>
5787
5788
5789
5790                 </td>
5791
5792
5793
5794
5795             <td class="description last"><p>The current noise floor of the radio. May be <code>0</code> or absent if not
5796 supported by the driver.</p></td>
5797         </tr>
5798
5799
5800
5801         <tr>
5802
5803                 <td class="name"><code>inactive</code></td>
5804
5805
5806             <td class="type">
5807
5808
5809 <span class="param-type">number</span>
5810
5811
5812
5813             </td>
5814
5815
5816                 <td class="attributes">
5817
5818
5819
5820                 </td>
5821
5822
5823
5824
5825             <td class="description last"><p>The amount of milliseconds the peer has been inactive, e.g. due
5826 to powersave.</p></td>
5827         </tr>
5828
5829
5830
5831         <tr>
5832
5833                 <td class="name"><code>connected_time</code></td>
5834
5835
5836             <td class="type">
5837
5838
5839 <span class="param-type">number</span>
5840
5841
5842
5843             </td>
5844
5845
5846                 <td class="attributes">
5847
5848
5849
5850                 </td>
5851
5852
5853
5854
5855             <td class="description last"><p>The amount of milliseconds the peer is associated to this network.</p></td>
5856         </tr>
5857
5858
5859
5860         <tr>
5861
5862                 <td class="name"><code>thr</code></td>
5863
5864
5865             <td class="type">
5866
5867
5868 <span class="param-type">number</span>
5869
5870
5871
5872             </td>
5873
5874
5875                 <td class="attributes">
5876
5877                     &lt;optional><br>
5878
5879
5880
5881                 </td>
5882
5883
5884
5885
5886             <td class="description last"><p>The estimated throughput of the peer, May be <code>0</code> or absent if not
5887 supported by the driver.</p></td>
5888         </tr>
5889
5890
5891
5892         <tr>
5893
5894                 <td class="name"><code>authorized</code></td>
5895
5896
5897             <td class="type">
5898
5899
5900 <span class="param-type">boolean</span>
5901
5902
5903
5904             </td>
5905
5906
5907                 <td class="attributes">
5908
5909
5910
5911                 </td>
5912
5913
5914
5915
5916             <td class="description last"><p>Specifies whether the peer is authorized to associate to this network.</p></td>
5917         </tr>
5918
5919
5920
5921         <tr>
5922
5923                 <td class="name"><code>authenticated</code></td>
5924
5925
5926             <td class="type">
5927
5928
5929 <span class="param-type">boolean</span>
5930
5931
5932
5933             </td>
5934
5935
5936                 <td class="attributes">
5937
5938
5939
5940                 </td>
5941
5942
5943
5944
5945             <td class="description last"><p>Specifies whether the peer completed authentication to this network.</p></td>
5946         </tr>
5947
5948
5949
5950         <tr>
5951
5952                 <td class="name"><code>preamble</code></td>
5953
5954
5955             <td class="type">
5956
5957
5958 <span class="param-type">string</span>
5959
5960
5961
5962             </td>
5963
5964
5965                 <td class="attributes">
5966
5967
5968
5969                 </td>
5970
5971
5972
5973
5974             <td class="description last"><p>The preamble mode used by the peer. May be <code>long</code> or <code>short</code>.</p></td>
5975         </tr>
5976
5977
5978
5979         <tr>
5980
5981                 <td class="name"><code>wme</code></td>
5982
5983
5984             <td class="type">
5985
5986
5987 <span class="param-type">boolean</span>
5988
5989
5990
5991             </td>
5992
5993
5994                 <td class="attributes">
5995
5996
5997
5998                 </td>
5999
6000
6001
6002
6003             <td class="description last"><p>Specifies whether the peer supports WME/WMM capabilities.</p></td>
6004         </tr>
6005
6006
6007
6008         <tr>
6009
6010                 <td class="name"><code>mfp</code></td>
6011
6012
6013             <td class="type">
6014
6015
6016 <span class="param-type">boolean</span>
6017
6018
6019
6020             </td>
6021
6022
6023                 <td class="attributes">
6024
6025
6026
6027                 </td>
6028
6029
6030
6031
6032             <td class="description last"><p>Specifies whether management frame protection is active.</p></td>
6033         </tr>
6034
6035
6036
6037         <tr>
6038
6039                 <td class="name"><code>tdls</code></td>
6040
6041
6042             <td class="type">
6043
6044
6045 <span class="param-type">boolean</span>
6046
6047
6048
6049             </td>
6050
6051
6052                 <td class="attributes">
6053
6054
6055
6056                 </td>
6057
6058
6059
6060
6061             <td class="description last"><p>Specifies whether TDLS is active.</p></td>
6062         </tr>
6063
6064
6065
6066         <tr>
6067
6068                 <td class="name"><code>mesh llid</code></td>
6069
6070
6071             <td class="type">
6072
6073
6074 <span class="param-type">number</span>
6075
6076
6077
6078             </td>
6079
6080
6081                 <td class="attributes">
6082
6083                     &lt;optional><br>
6084
6085
6086
6087                 </td>
6088
6089
6090
6091
6092             <td class="description last"><p>The mesh LLID, may be <code>0</code> or absent if not applicable or supported
6093 by the driver.</p></td>
6094         </tr>
6095
6096
6097
6098         <tr>
6099
6100                 <td class="name"><code>mesh plid</code></td>
6101
6102
6103             <td class="type">
6104
6105
6106 <span class="param-type">number</span>
6107
6108
6109
6110             </td>
6111
6112
6113                 <td class="attributes">
6114
6115                     &lt;optional><br>
6116
6117
6118
6119                 </td>
6120
6121
6122
6123
6124             <td class="description last"><p>The mesh PLID, may be <code>0</code> or absent if not applicable or supported
6125 by the driver.</p></td>
6126         </tr>
6127
6128
6129
6130         <tr>
6131
6132                 <td class="name"><code>mesh plink</code></td>
6133
6134
6135             <td class="type">
6136
6137
6138 <span class="param-type">string</span>
6139
6140
6141
6142             </td>
6143
6144
6145                 <td class="attributes">
6146
6147                     &lt;optional><br>
6148
6149
6150
6151                 </td>
6152
6153
6154
6155
6156             <td class="description last"><p>The mesh peer link state description, may be an empty string (<code>''</code>)
6157 or absent if not applicable or supported by the driver.</p>
6158 <p>The following states are known:</p>
6159 <ul>
6160 <li><code>LISTEN</code></li>
6161 <li><code>OPN_SNT</code></li>
6162 <li><code>OPN_RCVD</code></li>
6163 <li><code>CNF_RCVD</code></li>
6164 <li><code>ESTAB</code></li>
6165 <li><code>HOLDING</code></li>
6166 <li><code>BLOCKED</code></li>
6167 <li><code>UNKNOWN</code></li>
6168 </ul></td>
6169         </tr>
6170
6171
6172
6173         <tr>
6174
6175                 <td class="name"><code>mesh local PS</code></td>
6176
6177
6178             <td class="type">
6179
6180
6181 <span class="param-type">number</span>
6182
6183
6184
6185             </td>
6186
6187
6188                 <td class="attributes">
6189
6190                     &lt;optional><br>
6191
6192
6193
6194                 </td>
6195
6196
6197
6198
6199             <td class="description last"><p>The local powersafe mode for the peer link, may be an empty
6200 string (<code>''</code>) or absent if not applicable or supported by
6201 the driver.</p>
6202 <p>The following modes are known:</p>
6203 <ul>
6204 <li><code>ACTIVE</code> (no power save)</li>
6205 <li><code>LIGHT SLEEP</code></li>
6206 <li><code>DEEP SLEEP</code></li>
6207 <li><code>UNKNOWN</code></li>
6208 </ul></td>
6209         </tr>
6210
6211
6212
6213         <tr>
6214
6215                 <td class="name"><code>mesh peer PS</code></td>
6216
6217
6218             <td class="type">
6219
6220
6221 <span class="param-type">number</span>
6222
6223
6224
6225             </td>
6226
6227
6228                 <td class="attributes">
6229
6230                     &lt;optional><br>
6231
6232
6233
6234                 </td>
6235
6236
6237
6238
6239             <td class="description last"><p>The remote powersafe mode for the peer link, may be an empty
6240 string (<code>''</code>) or absent if not applicable or supported by
6241 the driver.</p>
6242 <p>The following modes are known:</p>
6243 <ul>
6244 <li><code>ACTIVE</code> (no power save)</li>
6245 <li><code>LIGHT SLEEP</code></li>
6246 <li><code>DEEP SLEEP</code></li>
6247 <li><code>UNKNOWN</code></li>
6248 </ul></td>
6249         </tr>
6250
6251
6252
6253         <tr>
6254
6255                 <td class="name"><code>mesh non-peer PS</code></td>
6256
6257
6258             <td class="type">
6259
6260
6261 <span class="param-type">number</span>
6262
6263
6264
6265             </td>
6266
6267
6268                 <td class="attributes">
6269
6270                     &lt;optional><br>
6271
6272
6273
6274                 </td>
6275
6276
6277
6278
6279             <td class="description last"><p>The powersafe mode for all non-peer neigbours, may be an empty
6280 string (<code>''</code>) or absent if not applicable or supported by the driver.</p>
6281 <p>The following modes are known:</p>
6282 <ul>
6283 <li><code>ACTIVE</code> (no power save)</li>
6284 <li><code>LIGHT SLEEP</code></li>
6285 <li><code>DEEP SLEEP</code></li>
6286 <li><code>UNKNOWN</code></li>
6287 </ul></td>
6288         </tr>
6289
6290
6291
6292         <tr>
6293
6294                 <td class="name"><code>rx</code></td>
6295
6296
6297             <td class="type">
6298
6299
6300 <span class="param-type"><a href="LuCI.Network.html#.WifiRateEntry">LuCI.Network.WifiRateEntry</a></span>
6301
6302
6303
6304             </td>
6305
6306
6307                 <td class="attributes">
6308
6309
6310
6311                 </td>
6312
6313
6314
6315
6316             <td class="description last"><p>Describes the receiving wireless rate from the peer.</p></td>
6317         </tr>
6318
6319
6320
6321         <tr>
6322
6323                 <td class="name"><code>tx</code></td>
6324
6325
6326             <td class="type">
6327
6328
6329 <span class="param-type"><a href="LuCI.Network.html#.WifiRateEntry">LuCI.Network.WifiRateEntry</a></span>
6330
6331
6332
6333             </td>
6334
6335
6336                 <td class="attributes">
6337
6338
6339
6340                 </td>
6341
6342
6343
6344
6345             <td class="description last"><p>Describes the transmitting wireless rate to the peer.</p></td>
6346         </tr>
6347
6348
6349         </tbody>
6350 </table></dl>
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373 </dl>
6374
6375
6376
6377 </dd>
6378
6379
6380
6381 <dt>
6382     <div class="nameContainer">
6383         <h4 class="name" id=".WifiRateEntry">LuCI.Network.WifiRateEntry<span class="type-signature type object.<string, (boolean|number)>">Object.&lt;string, (boolean|number)></span> </h4>
6384     </div>
6385
6386
6387 </dt>
6388 <dd>
6389
6390     <div class="description">
6391         <p>A wireless rate entry describes the properties of a wireless
6392 transmission rate to or from a peer.</p>
6393     </div>
6394
6395
6396
6397 <dl class="details">
6398
6399
6400         <h5 class="subsection-title">Properties:</h5>
6401
6402         <dl>
6403
6404 <table class="props">
6405     <thead>
6406         <tr>
6407
6408                 <th>Name</th>
6409
6410
6411                 <th>Type</th>
6412
6413
6414                 <th>Argument</th>
6415
6416
6417
6418
6419                 <th class="last">Description</th>
6420         </tr>
6421         </thead>
6422
6423         <tbody>
6424
6425
6426         <tr>
6427
6428                 <td class="name"><code>drop_misc</code></td>
6429
6430
6431             <td class="type">
6432
6433
6434 <span class="param-type">number</span>
6435
6436
6437
6438             </td>
6439
6440
6441                 <td class="attributes">
6442
6443                     &lt;optional><br>
6444
6445
6446
6447                 </td>
6448
6449
6450
6451
6452             <td class="description last"><p>The amount of received misc. packages that have been dropped, e.g.
6453 due to corruption or missing authentication. Only applicable to
6454 receiving rates.</p></td>
6455         </tr>
6456
6457
6458
6459         <tr>
6460
6461                 <td class="name"><code>packets</code></td>
6462
6463
6464             <td class="type">
6465
6466
6467 <span class="param-type">number</span>
6468
6469
6470
6471             </td>
6472
6473
6474                 <td class="attributes">
6475
6476
6477
6478                 </td>
6479
6480
6481
6482
6483             <td class="description last"><p>The amount of packets that have been received or sent.</p></td>
6484         </tr>
6485
6486
6487
6488         <tr>
6489
6490                 <td class="name"><code>bytes</code></td>
6491
6492
6493             <td class="type">
6494
6495
6496 <span class="param-type">number</span>
6497
6498
6499
6500             </td>
6501
6502
6503                 <td class="attributes">
6504
6505
6506
6507                 </td>
6508
6509
6510
6511
6512             <td class="description last"><p>The amount of bytes that have been received or sent.</p></td>
6513         </tr>
6514
6515
6516
6517         <tr>
6518
6519                 <td class="name"><code>failed</code></td>
6520
6521
6522             <td class="type">
6523
6524
6525 <span class="param-type">number</span>
6526
6527
6528
6529             </td>
6530
6531
6532                 <td class="attributes">
6533
6534                     &lt;optional><br>
6535
6536
6537
6538                 </td>
6539
6540
6541
6542
6543             <td class="description last"><p>The amount of failed tranmission attempts. Only applicable to
6544 transmit rates.</p></td>
6545         </tr>
6546
6547
6548
6549         <tr>
6550
6551                 <td class="name"><code>retries</code></td>
6552
6553
6554             <td class="type">
6555
6556
6557 <span class="param-type">number</span>
6558
6559
6560
6561             </td>
6562
6563
6564                 <td class="attributes">
6565
6566                     &lt;optional><br>
6567
6568
6569
6570                 </td>
6571
6572
6573
6574
6575             <td class="description last"><p>The amount of retried transmissions. Only applicable to transmit
6576 rates.</p></td>
6577         </tr>
6578
6579
6580
6581         <tr>
6582
6583                 <td class="name"><code>is_ht</code></td>
6584
6585
6586             <td class="type">
6587
6588
6589 <span class="param-type">boolean</span>
6590
6591
6592
6593             </td>
6594
6595
6596                 <td class="attributes">
6597
6598
6599
6600                 </td>
6601
6602
6603
6604
6605             <td class="description last"><p>Specifies whether this rate is an HT (IEEE 802.11n) rate.</p></td>
6606         </tr>
6607
6608
6609
6610         <tr>
6611
6612                 <td class="name"><code>is_vht</code></td>
6613
6614
6615             <td class="type">
6616
6617
6618 <span class="param-type">boolean</span>
6619
6620
6621
6622             </td>
6623
6624
6625                 <td class="attributes">
6626
6627
6628
6629                 </td>
6630
6631
6632
6633
6634             <td class="description last"><p>Specifies whether this rate is an VHT (IEEE 802.11ac) rate.</p></td>
6635         </tr>
6636
6637
6638
6639         <tr>
6640
6641                 <td class="name"><code>mhz</code></td>
6642
6643
6644             <td class="type">
6645
6646
6647 <span class="param-type">number</span>
6648
6649
6650
6651             </td>
6652
6653
6654                 <td class="attributes">
6655
6656
6657
6658                 </td>
6659
6660
6661
6662
6663             <td class="description last"><p>The channel width in MHz used for the transmission.</p></td>
6664         </tr>
6665
6666
6667
6668         <tr>
6669
6670                 <td class="name"><code>rate</code></td>
6671
6672
6673             <td class="type">
6674
6675
6676 <span class="param-type">number</span>
6677
6678
6679
6680             </td>
6681
6682
6683                 <td class="attributes">
6684
6685
6686
6687                 </td>
6688
6689
6690
6691
6692             <td class="description last"><p>The bitrate in bit/s of the transmission.</p></td>
6693         </tr>
6694
6695
6696
6697         <tr>
6698
6699                 <td class="name"><code>mcs</code></td>
6700
6701
6702             <td class="type">
6703
6704
6705 <span class="param-type">number</span>
6706
6707
6708
6709             </td>
6710
6711
6712                 <td class="attributes">
6713
6714                     &lt;optional><br>
6715
6716
6717
6718                 </td>
6719
6720
6721
6722
6723             <td class="description last"><p>The MCS index of the used transmission rate. Only applicable to
6724 HT or VHT rates.</p></td>
6725         </tr>
6726
6727
6728
6729         <tr>
6730
6731                 <td class="name"><code>40mhz</code></td>
6732
6733
6734             <td class="type">
6735
6736
6737 <span class="param-type">number</span>
6738
6739
6740
6741             </td>
6742
6743
6744                 <td class="attributes">
6745
6746                     &lt;optional><br>
6747
6748
6749
6750                 </td>
6751
6752
6753
6754
6755             <td class="description last"><p>Specifies whether the tranmission rate used 40MHz wide channel.
6756 Only applicable to HT or VHT rates.</p>
6757 <p>Note: this option exists for backwards compatibility only and its
6758 use is discouraged. The <code>mhz</code> field should be used instead to
6759 determine the channel width.</p></td>
6760         </tr>
6761
6762
6763
6764         <tr>
6765
6766                 <td class="name"><code>short_gi</code></td>
6767
6768
6769             <td class="type">
6770
6771
6772 <span class="param-type">boolean</span>
6773
6774
6775
6776             </td>
6777
6778
6779                 <td class="attributes">
6780
6781                     &lt;optional><br>
6782
6783
6784
6785                 </td>
6786
6787
6788
6789
6790             <td class="description last"><p>Specifies whether a short guard interval is used for the transmission.
6791 Only applicable to HT or VHT rates.</p></td>
6792         </tr>
6793
6794
6795
6796         <tr>
6797
6798                 <td class="name"><code>nss</code></td>
6799
6800
6801             <td class="type">
6802
6803
6804 <span class="param-type">number</span>
6805
6806
6807
6808             </td>
6809
6810
6811                 <td class="attributes">
6812
6813                     &lt;optional><br>
6814
6815
6816
6817                 </td>
6818
6819
6820
6821
6822             <td class="description last"><p>Specifies the number of spatial streams used by the transmission.
6823 Only applicable to VHT rates.</p></td>
6824         </tr>
6825
6826
6827         </tbody>
6828 </table></dl>
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851 </dl>
6852
6853
6854
6855 </dd>
6856
6857
6858
6859 <dt>
6860     <div class="nameContainer">
6861         <h4 class="name" id=".WifiScanResult">LuCI.Network.WifiScanResult<span class="type-signature type object.<string, (number|string|luci.network.wifiencryption)>">Object.&lt;string, (number|string|<a href="LuCI.Network.html#.WifiEncryption">LuCI.Network.WifiEncryption</a>)></span> </h4>
6862     </div>
6863
6864
6865 </dt>
6866 <dd>
6867
6868     <div class="description">
6869         <p>A wireless scan result object describes a neighbouring wireless
6870 network found in the vincinity.</p>
6871     </div>
6872
6873
6874
6875 <dl class="details">
6876
6877
6878         <h5 class="subsection-title">Properties:</h5>
6879
6880         <dl>
6881
6882 <table class="props">
6883     <thead>
6884         <tr>
6885
6886                 <th>Name</th>
6887
6888
6889                 <th>Type</th>
6890
6891
6892
6893
6894
6895                 <th class="last">Description</th>
6896         </tr>
6897         </thead>
6898
6899         <tbody>
6900
6901
6902         <tr>
6903
6904                 <td class="name"><code>ssid</code></td>
6905
6906
6907             <td class="type">
6908
6909
6910 <span class="param-type">string</span>
6911
6912
6913
6914             </td>
6915
6916
6917
6918
6919
6920             <td class="description last"><p>The SSID / Mesh ID of the network.</p></td>
6921         </tr>
6922
6923
6924
6925         <tr>
6926
6927                 <td class="name"><code>bssid</code></td>
6928
6929
6930             <td class="type">
6931
6932
6933 <span class="param-type">string</span>
6934
6935
6936
6937             </td>
6938
6939
6940
6941
6942
6943             <td class="description last"><p>The BSSID if the network.</p></td>
6944         </tr>
6945
6946
6947
6948         <tr>
6949
6950                 <td class="name"><code>mode</code></td>
6951
6952
6953             <td class="type">
6954
6955
6956 <span class="param-type">string</span>
6957
6958
6959
6960             </td>
6961
6962
6963
6964
6965
6966             <td class="description last"><p>The operation mode of the network (<code>Master</code>, <code>Ad-Hoc</code>, <code>Mesh Point</code>).</p></td>
6967         </tr>
6968
6969
6970
6971         <tr>
6972
6973                 <td class="name"><code>channel</code></td>
6974
6975
6976             <td class="type">
6977
6978
6979 <span class="param-type">number</span>
6980
6981
6982
6983             </td>
6984
6985
6986
6987
6988
6989             <td class="description last"><p>The wireless channel of the network.</p></td>
6990         </tr>
6991
6992
6993
6994         <tr>
6995
6996                 <td class="name"><code>signal</code></td>
6997
6998
6999             <td class="type">
7000
7001
7002 <span class="param-type">number</span>
7003
7004
7005
7006             </td>
7007
7008
7009
7010
7011
7012             <td class="description last"><p>The received signal strength of the network in dBm.</p></td>
7013         </tr>
7014
7015
7016
7017         <tr>
7018
7019                 <td class="name"><code>quality</code></td>
7020
7021
7022             <td class="type">
7023
7024
7025 <span class="param-type">number</span>
7026
7027
7028
7029             </td>
7030
7031
7032
7033
7034
7035             <td class="description last"><p>The numeric quality level of the signal, can be used in conjunction
7036 with <code>quality_max</code> to calculate a quality percentage.</p></td>
7037         </tr>
7038
7039
7040
7041         <tr>
7042
7043                 <td class="name"><code>quality_max</code></td>
7044
7045
7046             <td class="type">
7047
7048
7049 <span class="param-type">number</span>
7050
7051
7052
7053             </td>
7054
7055
7056
7057
7058
7059             <td class="description last"><p>The maximum possible quality level of the signal, can be used in
7060 conjunction with <code>quality</code> to calculate a quality percentage.</p></td>
7061         </tr>
7062
7063
7064
7065         <tr>
7066
7067                 <td class="name"><code>encryption</code></td>
7068
7069
7070             <td class="type">
7071
7072
7073 <span class="param-type"><a href="LuCI.Network.html#.WifiEncryption">LuCI.Network.WifiEncryption</a></span>
7074
7075
7076
7077             </td>
7078
7079
7080
7081
7082
7083             <td class="description last"><p>The encryption used by the wireless network.</p></td>
7084         </tr>
7085
7086
7087         </tbody>
7088 </table></dl>
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111 </dl>
7112
7113
7114
7115 </dd>
7116
7117             </dl>
7118
7119
7120
7121
7122
7123 </article>
7124
7125 </section>
7126
7127
7128
7129
7130
7131
7132
7133         <footer>
7134             Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Nov 07 2019 12:20:51 GMT+0100 (Central European Standard Time)
7135         </footer>
7136     </div>
7137 </div>
7138 <script>prettyPrint();</script>
7139 <script src="scripts/jaguar.js"></script>
7140 </body>
7141 </html>