docs/jsapi/LuCI.Network.html

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