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