docs: update JS api docs
[project/luci.git] / docs / jsapi / LuCI.Network.WifiNetwork.html
1 <!DOCTYPE html>
2 <html>
3 <head>
4 <meta charset="utf-8">
5 <title>Class: WifiNetwork</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.WifiNetwork.html">Class: WifiNetwork</h1>
1081
1082
1083
1084
1085 <section>
1086
1087 <header>
1088 <h2>
1089 <span class="ancestors"><a href="LuCI.html">LuCI</a><a href="LuCI.Network.html">.Network</a>.</span>
1090
1091 WifiNetwork
1092 </h2>
1093
1094 <div class="class-description"><p>A <code>Network.WifiNetwork</code> instance represents a wireless network (vif)
1095 configured on top of a radio device and provides functions for querying
1096 the runtime state of the network. Most radio devices support multiple
1097 such networks in parallel.</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="WifiNetwork">
1110
1111 new LuCI.Network.WifiNetwork<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#line3341">line 3341</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
1183
1184
1185
1186
1187
1188 <h3 class="subsection-title">Methods</h3>
1189
1190 <dl>
1191
1192 <dt>
1193 <div class="nameContainer">
1194 <h4 class="name" id="disconnectClient">
1195
1196 disconnectClient<span class="signature">(mac, <span class="optional">deauth</span>, <span class="optional">reason</span>, <span class="optional">ban_time</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;number>}</span>
1197 </h4>
1198
1199
1200 <div class="tag-source">
1201 <a href="network.js.html">network.js</a>, <a href="network.js.html#line4084">line 4084</a>
1202 </div>
1203
1204 </div>
1205
1206
1207 </dt>
1208 <dd>
1209
1210
1211 <div class="description">
1212 <p>Forcibly disconnect the given client from the wireless network.</p>
1213 </div>
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223 <table class="params">
1224 <thead>
1225 <tr>
1226
1227 <th>Name</th>
1228
1229
1230 <th>Type</th>
1231
1232
1233 <th>Default</th>
1234
1235
1236 <th class="last">Description</th>
1237 </tr>
1238 </thead>
1239
1240 <tbody>
1241
1242
1243 <tr>
1244
1245 <td class="name"><code>mac</code></td>
1246
1247
1248 <td class="type">
1249
1250
1251 <span class="param-type">string</span>
1252
1253
1254
1255 </td>
1256
1257
1258 <td class="default">
1259
1260 </td>
1261
1262
1263 <td class="description last">
1264
1265
1266
1267
1268
1269
1270 <p>The MAC address of the client to disconnect.</p></td>
1271 </tr>
1272
1273
1274
1275 <tr>
1276
1277 <td class="name"><code>deauth</code></td>
1278
1279
1280 <td class="type">
1281
1282
1283 <span class="param-type">boolean</span>
1284
1285
1286
1287 </td>
1288
1289
1290 <td class="default">
1291
1292 false
1293
1294 </td>
1295
1296
1297 <td class="description last">
1298
1299
1300 <span class="optional">optional</span>
1301
1302
1303
1304
1305
1306 <p>Specifies whether to deauthenticate (<code>true</code>) or disassociate (<code>false</code>)
1307 the client.</p></td>
1308 </tr>
1309
1310
1311
1312 <tr>
1313
1314 <td class="name"><code>reason</code></td>
1315
1316
1317 <td class="type">
1318
1319
1320 <span class="param-type">number</span>
1321
1322
1323
1324 </td>
1325
1326
1327 <td class="default">
1328
1329 1
1330
1331 </td>
1332
1333
1334 <td class="description last">
1335
1336
1337 <span class="optional">optional</span>
1338
1339
1340
1341
1342
1343 <p>Specifies the IEEE 802.11 reason code to disassoc/deauth the client
1344 with. Default is <code>1</code> which corresponds to <code>Unspecified reason</code>.</p></td>
1345 </tr>
1346
1347
1348
1349 <tr>
1350
1351 <td class="name"><code>ban_time</code></td>
1352
1353
1354 <td class="type">
1355
1356
1357 <span class="param-type">number</span>
1358
1359
1360
1361 </td>
1362
1363
1364 <td class="default">
1365
1366 0
1367
1368 </td>
1369
1370
1371 <td class="description last">
1372
1373
1374 <span class="optional">optional</span>
1375
1376
1377
1378
1379
1380 <p>Specifies the amount of milliseconds to ban the client from
1381 reconnecting. By default, no ban time is set which allows the client
1382 to reassociate / reauthenticate immediately.</p></td>
1383 </tr>
1384
1385
1386 </tbody>
1387 </table>
1388
1389
1390
1391 <dl class="details">
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413 </dl>
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425 <h5>Returns:</h5>
1426
1427
1428
1429 <table class="params">
1430 <thead>
1431 <tr>
1432
1433 <th>Type</th>
1434 <th class="last">Description</th>
1435 </tr>
1436 </thead>
1437 <tbody>
1438
1439 <tr>
1440
1441 <td class="type">
1442
1443 Promise.&lt;number>
1444
1445
1446 </td>
1447 <td class="description last">Returns a promise resolving to the underlying ubus call result code
1448 which is typically <code>0</code>, even for not existing MAC addresses.
1449 The promise might reject with an error in case invalid arguments
1450 are passed.</td>
1451 </tr>
1452
1453 </tbody>
1454 </table>
1455
1456
1457
1458
1459 </dd>
1460
1461
1462
1463 <dt>
1464 <div class="nameContainer">
1465 <h4 class="name" id="get">
1466
1467 get<span class="signature">(opt)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string|Array.&lt;string>}</span>
1468 </h4>
1469
1470
1471 <div class="tag-source">
1472 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3375">line 3375</a>
1473 </div>
1474
1475 </div>
1476
1477
1478 </dt>
1479 <dd>
1480
1481
1482 <div class="description">
1483 <p>Read the given UCI option value of this wireless network.</p>
1484 </div>
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494 <table class="params">
1495 <thead>
1496 <tr>
1497
1498 <th>Name</th>
1499
1500
1501 <th>Type</th>
1502
1503
1504
1505 <th class="last">Description</th>
1506 </tr>
1507 </thead>
1508
1509 <tbody>
1510
1511
1512 <tr>
1513
1514 <td class="name"><code>opt</code></td>
1515
1516
1517 <td class="type">
1518
1519
1520 <span class="param-type">string</span>
1521
1522
1523
1524 </td>
1525
1526
1527
1528 <td class="description last">
1529
1530 <p>The UCI option name to read.</p></td>
1531 </tr>
1532
1533
1534 </tbody>
1535 </table>
1536
1537
1538
1539 <dl class="details">
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561 </dl>
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573 <h5>Returns:</h5>
1574
1575
1576
1577 <table class="params">
1578 <thead>
1579 <tr>
1580
1581 <th>Type</th>
1582 <th class="last">Description</th>
1583 </tr>
1584 </thead>
1585 <tbody>
1586
1587 <tr>
1588
1589 <td class="type">
1590
1591 null
1592 |
1593
1594 string
1595 |
1596
1597 Array.&lt;string>
1598
1599
1600 </td>
1601 <td class="description last">Returns the UCI option value or <code>null</code> if the requested option is
1602 not found.</td>
1603 </tr>
1604
1605 </tbody>
1606 </table>
1607
1608
1609
1610
1611 </dd>
1612
1613
1614
1615 <dt>
1616 <div class="nameContainer">
1617 <h4 class="name" id="getActiveBSSID">
1618
1619 getActiveBSSID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
1620 </h4>
1621
1622
1623 <div class="tag-source">
1624 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3628">line 3628</a>
1625 </div>
1626
1627 </div>
1628
1629
1630 </dt>
1631 <dd>
1632
1633
1634 <div class="description">
1635 <p>Query the current BSSID from runtime information.</p>
1636 </div>
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646 <dl class="details">
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668 </dl>
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680 <h5>Returns:</h5>
1681
1682
1683
1684 <table class="params">
1685 <thead>
1686 <tr>
1687
1688 <th>Type</th>
1689 <th class="last">Description</th>
1690 </tr>
1691 </thead>
1692 <tbody>
1693
1694 <tr>
1695
1696 <td class="type">
1697
1698 string
1699
1700
1701 </td>
1702 <td class="description last">Returns the current BSSID or Mesh ID as reported by <code>ubus</code> runtime
1703 information.</td>
1704 </tr>
1705
1706 </tbody>
1707 </table>
1708
1709
1710
1711
1712 </dd>
1713
1714
1715
1716 <dt>
1717 <div class="nameContainer">
1718 <h4 class="name" id="getActiveEncryption">
1719
1720 getActiveEncryption<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
1721 </h4>
1722
1723
1724 <div class="tag-source">
1725 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3639">line 3639</a>
1726 </div>
1727
1728 </div>
1729
1730
1731 </dt>
1732 <dd>
1733
1734
1735 <div class="description">
1736 <p>Query the current encryption settings from runtime information.</p>
1737 </div>
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747 <dl class="details">
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769 </dl>
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781 <h5>Returns:</h5>
1782
1783
1784
1785 <table class="params">
1786 <thead>
1787 <tr>
1788
1789 <th>Type</th>
1790 <th class="last">Description</th>
1791 </tr>
1792 </thead>
1793 <tbody>
1794
1795 <tr>
1796
1797 <td class="type">
1798
1799 string
1800
1801
1802 </td>
1803 <td class="description last">Returns a string describing the current encryption or <code>-</code> if the the
1804 encryption state could not be found in <code>ubus</code> runtime information.</td>
1805 </tr>
1806
1807 </tbody>
1808 </table>
1809
1810
1811
1812
1813 </dd>
1814
1815
1816
1817 <dt>
1818 <div class="nameContainer">
1819 <h4 class="name" id="getActiveMode">
1820
1821 getActiveMode<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
1822 </h4>
1823
1824
1825 <div class="tag-source">
1826 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3576">line 3576</a>
1827 </div>
1828
1829 </div>
1830
1831
1832 </dt>
1833 <dd>
1834
1835
1836 <div class="description">
1837 <p>Query the current operation mode from runtime information.</p>
1838 </div>
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848 <dl class="details">
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870 </dl>
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882 <h5>Returns:</h5>
1883
1884
1885
1886 <table class="params">
1887 <thead>
1888 <tr>
1889
1890 <th>Type</th>
1891 <th class="last">Description</th>
1892 </tr>
1893 </thead>
1894 <tbody>
1895
1896 <tr>
1897
1898 <td class="type">
1899
1900 string
1901
1902
1903 </td>
1904 <td class="description last">Returns the human readable mode name as reported by <code>ubus</code> runtime
1905 state. Possible returned values are:
1906 <ul>
1907 <li><code>Master</code></li>
1908 <li><code>Ad-Hoc</code></li>
1909 <li><code>Client</code></li>
1910 <li><code>Monitor</code></li>
1911 <li><code>Master (VLAN)</code></li>
1912 <li><code>WDS</code></li>
1913 <li><code>Mesh Point</code></li>
1914 <li><code>P2P Client</code></li>
1915 <li><code>P2P Go</code></li>
1916 <li><code>Unknown</code></li>
1917 </ul></td>
1918 </tr>
1919
1920 </tbody>
1921 </table>
1922
1923
1924
1925
1926 </dd>
1927
1928
1929
1930 <dt>
1931 <div class="nameContainer">
1932 <h4 class="name" id="getActiveModeI18n">
1933
1934 getActiveModeI18n<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
1935 </h4>
1936
1937
1938 <div class="tag-source">
1939 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3597">line 3597</a>
1940 </div>
1941
1942 </div>
1943
1944
1945 </dt>
1946 <dd>
1947
1948
1949 <div class="description">
1950 <p>Query the current operation mode from runtime information as
1951 translated string.</p>
1952 </div>
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962 <dl class="details">
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984 </dl>
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996 <h5>Returns:</h5>
1997
1998
1999
2000 <table class="params">
2001 <thead>
2002 <tr>
2003
2004 <th>Type</th>
2005 <th class="last">Description</th>
2006 </tr>
2007 </thead>
2008 <tbody>
2009
2010 <tr>
2011
2012 <td class="type">
2013
2014 string
2015
2016
2017 </td>
2018 <td class="description last">Returns the translated, human readable mode name as reported by
2019 <code>ubus</code> runtime state.</td>
2020 </tr>
2021
2022 </tbody>
2023 </table>
2024
2025
2026
2027
2028 </dd>
2029
2030
2031
2032 <dt>
2033 <div class="nameContainer">
2034 <h4 class="name" id="getActiveSSID">
2035
2036 getActiveSSID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
2037 </h4>
2038
2039
2040 <div class="tag-source">
2041 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3617">line 3617</a>
2042 </div>
2043
2044 </div>
2045
2046
2047 </dt>
2048 <dd>
2049
2050
2051 <div class="description">
2052 <p>Query the current SSID from runtime information.</p>
2053 </div>
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063 <dl class="details">
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085 </dl>
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097 <h5>Returns:</h5>
2098
2099
2100
2101 <table class="params">
2102 <thead>
2103 <tr>
2104
2105 <th>Type</th>
2106 <th class="last">Description</th>
2107 </tr>
2108 </thead>
2109 <tbody>
2110
2111 <tr>
2112
2113 <td class="type">
2114
2115 string
2116
2117
2118 </td>
2119 <td class="description last">Returns the current SSID or Mesh ID as reported by <code>ubus</code> runtime
2120 information.</td>
2121 </tr>
2122
2123 </tbody>
2124 </table>
2125
2126
2127
2128
2129 </dd>
2130
2131
2132
2133 <dt>
2134 <div class="nameContainer">
2135 <h4 class="name" id="getAssocList">
2136
2137 getAssocList<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.html#.WifiPeerEntry">LuCI.Network.WifiPeerEntry</a>>>}</span>
2138 </h4>
2139
2140
2141 <div class="tag-source">
2142 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3819">line 3819</a>
2143 </div>
2144
2145 </div>
2146
2147
2148 </dt>
2149 <dd>
2150
2151
2152 <div class="description">
2153 <p>Fetch the list of associated peers.</p>
2154 </div>
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164 <dl class="details">
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186 </dl>
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198 <h5>Returns:</h5>
2199
2200
2201
2202 <table class="params">
2203 <thead>
2204 <tr>
2205
2206 <th>Type</th>
2207 <th class="last">Description</th>
2208 </tr>
2209 </thead>
2210 <tbody>
2211
2212 <tr>
2213
2214 <td class="type">
2215
2216 Promise.&lt;Array.&lt;<a href="LuCI.Network.html#.WifiPeerEntry">LuCI.Network.WifiPeerEntry</a>>>
2217
2218
2219 </td>
2220 <td class="description last">Returns a promise resolving to an array of wireless peers associated
2221 with this network.</td>
2222 </tr>
2223
2224 </tbody>
2225 </table>
2226
2227
2228
2229
2230 </dd>
2231
2232
2233
2234 <dt>
2235 <div class="nameContainer">
2236 <h4 class="name" id="getBitRate">
2237
2238 getBitRate<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|number}</span>
2239 </h4>
2240
2241
2242 <div class="tag-source">
2243 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3849">line 3849</a>
2244 </div>
2245
2246 </div>
2247
2248
2249 </dt>
2250 <dd>
2251
2252
2253 <div class="description">
2254 <p>Query the current average bitrate of all peers associated to this
2255 wireless network.</p>
2256 </div>
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266 <dl class="details">
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288 </dl>
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300 <h5>Returns:</h5>
2301
2302
2303
2304 <table class="params">
2305 <thead>
2306 <tr>
2307
2308 <th>Type</th>
2309 <th class="last">Description</th>
2310 </tr>
2311 </thead>
2312 <tbody>
2313
2314 <tr>
2315
2316 <td class="type">
2317
2318 null
2319 |
2320
2321 number
2322
2323
2324 </td>
2325 <td class="description last">Returns the average bit rate among all peers associated to the network
2326 as reported by <code>ubus</code> runtime information or <code>null</code> if the information
2327 is not available.</td>
2328 </tr>
2329
2330 </tbody>
2331 </table>
2332
2333
2334
2335
2336 </dd>
2337
2338
2339
2340 <dt>
2341 <div class="nameContainer">
2342 <h4 class="name" id="getBSSID">
2343
2344 getBSSID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span>
2345 </h4>
2346
2347
2348 <div class="tag-source">
2349 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3454">line 3454</a>
2350 </div>
2351
2352 </div>
2353
2354
2355 </dt>
2356 <dd>
2357
2358
2359 <div class="description">
2360 <p>Get the configured BSSID of the wireless network.</p>
2361 </div>
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371 <dl class="details">
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393 </dl>
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405 <h5>Returns:</h5>
2406
2407
2408
2409 <table class="params">
2410 <thead>
2411 <tr>
2412
2413 <th>Type</th>
2414 <th class="last">Description</th>
2415 </tr>
2416 </thead>
2417 <tbody>
2418
2419 <tr>
2420
2421 <td class="type">
2422
2423 null
2424 |
2425
2426 string
2427
2428
2429 </td>
2430 <td class="description last">Returns the BSSID value or <code>null</code> if none has been specified.</td>
2431 </tr>
2432
2433 </tbody>
2434 </table>
2435
2436
2437
2438
2439 </dd>
2440
2441
2442
2443 <dt>
2444 <div class="nameContainer">
2445 <h4 class="name" id="getChannel">
2446
2447 getChannel<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|number}</span>
2448 </h4>
2449
2450
2451 <div class="tag-source">
2452 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3865">line 3865</a>
2453 </div>
2454
2455 </div>
2456
2457
2458 </dt>
2459 <dd>
2460
2461
2462 <div class="description">
2463 <p>Query the current wireless channel.</p>
2464 </div>
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474 <dl class="details">
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496 </dl>
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508 <h5>Returns:</h5>
2509
2510
2511
2512 <table class="params">
2513 <thead>
2514 <tr>
2515
2516 <th>Type</th>
2517 <th class="last">Description</th>
2518 </tr>
2519 </thead>
2520 <tbody>
2521
2522 <tr>
2523
2524 <td class="type">
2525
2526 null
2527 |
2528
2529 number
2530
2531
2532 </td>
2533 <td class="description last">Returns the wireless channel as reported by <code>ubus</code> runtime information
2534 or <code>null</code> if it cannot be determined.</td>
2535 </tr>
2536
2537 </tbody>
2538 </table>
2539
2540
2541
2542
2543 </dd>
2544
2545
2546
2547 <dt>
2548 <div class="nameContainer">
2549 <h4 class="name" id="getCountryCode">
2550
2551 getCountryCode<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
2552 </h4>
2553
2554
2555 <div class="tag-source">
2556 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3898">line 3898</a>
2557 </div>
2558
2559 </div>
2560
2561
2562 </dt>
2563 <dd>
2564
2565
2566 <div class="description">
2567 <p>Query the current country code.</p>
2568 </div>
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578 <dl class="details">
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600 </dl>
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612 <h5>Returns:</h5>
2613
2614
2615
2616 <table class="params">
2617 <thead>
2618 <tr>
2619
2620 <th>Type</th>
2621 <th class="last">Description</th>
2622 </tr>
2623 </thead>
2624 <tbody>
2625
2626 <tr>
2627
2628 <td class="type">
2629
2630 string
2631
2632
2633 </td>
2634 <td class="description last">Returns the wireless country code as reported by <code>ubus</code> runtime
2635 information or <code>00</code> if it cannot be determined.</td>
2636 </tr>
2637
2638 </tbody>
2639 </table>
2640
2641
2642
2643
2644 </dd>
2645
2646
2647
2648 <dt>
2649 <div class="nameContainer">
2650 <h4 class="name" id="getDevice">
2651
2652 getDevice<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>}</span>
2653 </h4>
2654
2655
2656 <div class="tag-source">
2657 <a href="network.js.html">network.js</a>, <a href="network.js.html#line4044">line 4044</a>
2658 </div>
2659
2660 </div>
2661
2662
2663 </dt>
2664 <dd>
2665
2666
2667 <div class="description">
2668 <p>Get the associated Linux network device.</p>
2669 </div>
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679 <dl class="details">
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701 </dl>
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713 <h5>Returns:</h5>
2714
2715
2716
2717 <table class="params">
2718 <thead>
2719 <tr>
2720
2721 <th>Type</th>
2722 <th class="last">Description</th>
2723 </tr>
2724 </thead>
2725 <tbody>
2726
2727 <tr>
2728
2729 <td class="type">
2730
2731 <a href="LuCI.Network.Device.html">LuCI.Network.Device</a>
2732
2733
2734 </td>
2735 <td class="description last">Returns a <code>Network.Device</code> instance representing the Linux network
2736 device associted with this wireless network.</td>
2737 </tr>
2738
2739 </tbody>
2740 </table>
2741
2742
2743
2744
2745 </dd>
2746
2747
2748
2749 <dt>
2750 <div class="nameContainer">
2751 <h4 class="name" id="getFrequency">
2752
2753 getFrequency<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span>
2754 </h4>
2755
2756
2757 <div class="tag-source">
2758 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3831">line 3831</a>
2759 </div>
2760
2761 </div>
2762
2763
2764 </dt>
2765 <dd>
2766
2767
2768 <div class="description">
2769 <p>Query the current operating frequency of the wireless network.</p>
2770 </div>
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780 <dl class="details">
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802 </dl>
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814 <h5>Returns:</h5>
2815
2816
2817
2818 <table class="params">
2819 <thead>
2820 <tr>
2821
2822 <th>Type</th>
2823 <th class="last">Description</th>
2824 </tr>
2825 </thead>
2826 <tbody>
2827
2828 <tr>
2829
2830 <td class="type">
2831
2832 null
2833 |
2834
2835 string
2836
2837
2838 </td>
2839 <td class="description last">Returns the current operating frequency of the network from <code>ubus</code>
2840 runtime information in GHz or <code>null</code> if the information is not
2841 available.</td>
2842 </tr>
2843
2844 </tbody>
2845 </table>
2846
2847
2848
2849
2850 </dd>
2851
2852
2853
2854 <dt>
2855 <div class="nameContainer">
2856 <h4 class="name" id="getI18n">
2857
2858 getI18n<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
2859 </h4>
2860
2861
2862 <div class="tag-source">
2863 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3992">line 3992</a>
2864 </div>
2865
2866 </div>
2867
2868
2869 </dt>
2870 <dd>
2871
2872
2873 <div class="description">
2874 <p>Get a description string for this wireless network.</p>
2875 </div>
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885 <dl class="details">
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907 </dl>
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919 <h5>Returns:</h5>
2920
2921
2922
2923 <table class="params">
2924 <thead>
2925 <tr>
2926
2927 <th>Type</th>
2928 <th class="last">Description</th>
2929 </tr>
2930 </thead>
2931 <tbody>
2932
2933 <tr>
2934
2935 <td class="type">
2936
2937 string
2938
2939
2940 </td>
2941 <td class="description last">Returns a string describing this network, consisting of the
2942 term <code>Wireless Network</code>, followed by the active operation mode,
2943 the SSID, BSSID or internal network ID and the Linux network device
2944 name, depending on which information is available.</td>
2945 </tr>
2946
2947 </tbody>
2948 </table>
2949
2950
2951
2952
2953 </dd>
2954
2955
2956
2957 <dt>
2958 <div class="nameContainer">
2959 <h4 class="name" id="getID">
2960
2961 getID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
2962 </h4>
2963
2964
2965 <div class="tag-source">
2966 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3479">line 3479</a>
2967 </div>
2968
2969 </div>
2970
2971
2972 </dt>
2973 <dd>
2974
2975
2976 <div class="description">
2977 <p>Get the internal network ID of this wireless network.</p>
2978 <p>The network ID is a LuCI specific identifer in the form
2979 <code>radio#.network#</code> to identify wireless networks by their corresponding
2980 radio and network index numbers.</p>
2981 </div>
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991 <dl class="details">
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013 </dl>
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025 <h5>Returns:</h5>
3026
3027
3028
3029 <table class="params">
3030 <thead>
3031 <tr>
3032
3033 <th>Type</th>
3034 <th class="last">Description</th>
3035 </tr>
3036 </thead>
3037 <tbody>
3038
3039 <tr>
3040
3041 <td class="type">
3042
3043 string
3044
3045
3046 </td>
3047 <td class="description last">Returns the LuCI specific network ID.</td>
3048 </tr>
3049
3050 </tbody>
3051 </table>
3052
3053
3054
3055
3056 </dd>
3057
3058
3059
3060 <dt>
3061 <div class="nameContainer">
3062 <h4 class="name" id="getIfname">
3063
3064 getIfname<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span>
3065 </h4>
3066
3067
3068 <div class="tag-source">
3069 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3501">line 3501</a>
3070 </div>
3071
3072 </div>
3073
3074
3075 </dt>
3076 <dd>
3077
3078
3079 <div class="description">
3080 <p>Get the Linux network device name.</p>
3081 </div>
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091 <dl class="details">
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113 </dl>
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125 <h5>Returns:</h5>
3126
3127
3128
3129 <table class="params">
3130 <thead>
3131 <tr>
3132
3133 <th>Type</th>
3134 <th class="last">Description</th>
3135 </tr>
3136 </thead>
3137 <tbody>
3138
3139 <tr>
3140
3141 <td class="type">
3142
3143 null
3144 |
3145
3146 string
3147
3148
3149 </td>
3150 <td class="description last">Returns the current Linux network device name as resolved from
3151 <code>ubus</code> runtime information or <code>null</code> if this network has no
3152 associated network device, e.g. when not configured or up.</td>
3153 </tr>
3154
3155 </tbody>
3156 </table>
3157
3158
3159
3160
3161 </dd>
3162
3163
3164
3165 <dt>
3166 <div class="nameContainer">
3167 <h4 class="name" id="getMeshID">
3168
3169 getMeshID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span>
3170 </h4>
3171
3172
3173 <div class="tag-source">
3174 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3441">line 3441</a>
3175 </div>
3176
3177 </div>
3178
3179
3180 </dt>
3181 <dd>
3182
3183
3184 <div class="description">
3185 <p>Get the configured Mesh ID of the wireless network.</p>
3186 </div>
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196 <dl class="details">
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218 </dl>
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230 <h5>Returns:</h5>
3231
3232
3233
3234 <table class="params">
3235 <thead>
3236 <tr>
3237
3238 <th>Type</th>
3239 <th class="last">Description</th>
3240 </tr>
3241 </thead>
3242 <tbody>
3243
3244 <tr>
3245
3246 <td class="type">
3247
3248 null
3249 |
3250
3251 string
3252
3253
3254 </td>
3255 <td class="description last">Returns the configured mesh ID value or <code>null</code> when this network
3256 is not in mesh mode.</td>
3257 </tr>
3258
3259 </tbody>
3260 </table>
3261
3262
3263
3264
3265 </dd>
3266
3267
3268
3269 <dt>
3270 <div class="nameContainer">
3271 <h4 class="name" id="getMode">
3272
3273 getMode<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
3274 </h4>
3275
3276
3277 <div class="tag-source">
3278 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3416">line 3416</a>
3279 </div>
3280
3281 </div>
3282
3283
3284 </dt>
3285 <dd>
3286
3287
3288 <div class="description">
3289 <p>Get the configured operation mode of the wireless network.</p>
3290 </div>
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300 <dl class="details">
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322 </dl>
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334 <h5>Returns:</h5>
3335
3336
3337
3338 <table class="params">
3339 <thead>
3340 <tr>
3341
3342 <th>Type</th>
3343 <th class="last">Description</th>
3344 </tr>
3345 </thead>
3346 <tbody>
3347
3348 <tr>
3349
3350 <td class="type">
3351
3352 string
3353
3354
3355 </td>
3356 <td class="description last">Returns the configured operation mode. Possible values are:
3357 <ul>
3358 <li><code>ap</code> - Master (Access Point) mode</li>
3359 <li><code>sta</code> - Station (client) mode</li>
3360 <li><code>adhoc</code> - Ad-Hoc (IBSS) mode</li>
3361 <li><code>mesh</code> - Mesh (IEEE 802.11s) mode</li>
3362 <li><code>monitor</code> - Monitor mode</li>
3363 </ul></td>
3364 </tr>
3365
3366 </tbody>
3367 </table>
3368
3369
3370
3371
3372 </dd>
3373
3374
3375
3376 <dt>
3377 <div class="nameContainer">
3378 <h4 class="name" id="getName">
3379
3380 getName<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
3381 </h4>
3382
3383
3384 <div class="tag-source">
3385 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3489">line 3489</a>
3386 </div>
3387
3388 </div>
3389
3390
3391 </dt>
3392 <dd>
3393
3394
3395 <div class="description">
3396 <p>Get the configuration ID of this wireless network.</p>
3397 </div>
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407 <dl class="details">
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429 </dl>
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441 <h5>Returns:</h5>
3442
3443
3444
3445 <table class="params">
3446 <thead>
3447 <tr>
3448
3449 <th>Type</th>
3450 <th class="last">Description</th>
3451 </tr>
3452 </thead>
3453 <tbody>
3454
3455 <tr>
3456
3457 <td class="type">
3458
3459 string
3460
3461
3462 </td>
3463 <td class="description last">Returns the corresponding UCI section ID of the network.</td>
3464 </tr>
3465
3466 </tbody>
3467 </table>
3468
3469
3470
3471
3472 </dd>
3473
3474
3475
3476 <dt>
3477 <div class="nameContainer">
3478 <h4 class="name" id="getNetwork">
3479
3480 getNetwork<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>}</span>
3481 </h4>
3482
3483
3484 <div class="tag-source">
3485 <a href="network.js.html">network.js</a>, <a href="network.js.html#line4008">line 4008</a>
3486 </div>
3487
3488 </div>
3489
3490
3491 </dt>
3492 <dd>
3493
3494
3495 <div class="description">
3496 <p>Get the primary logical interface this wireless network is attached to.</p>
3497 </div>
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507 <dl class="details">
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529 </dl>
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541 <h5>Returns:</h5>
3542
3543
3544
3545 <table class="params">
3546 <thead>
3547 <tr>
3548
3549 <th>Type</th>
3550 <th class="last">Description</th>
3551 </tr>
3552 </thead>
3553 <tbody>
3554
3555 <tr>
3556
3557 <td class="type">
3558
3559 null
3560 |
3561
3562 <a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>
3563
3564
3565 </td>
3566 <td class="description last">Returns a <code>Network.Protocol</code> instance representing the logical
3567 interface or <code>null</code> if this network is not attached to any logical
3568 interface.</td>
3569 </tr>
3570
3571 </tbody>
3572 </table>
3573
3574
3575
3576
3577 </dd>
3578
3579
3580
3581 <dt>
3582 <div class="nameContainer">
3583 <h4 class="name" id="getNetworkNames">
3584
3585 getNetworkNames<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.&lt;string>}</span>
3586 </h4>
3587
3588
3589 <div class="tag-source">
3590 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3465">line 3465</a>
3591 </div>
3592
3593 </div>
3594
3595
3596 </dt>
3597 <dd>
3598
3599
3600 <div class="description">
3601 <p>Get the names of the logical interfaces this wireless network is
3602 attached to.</p>
3603 </div>
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613 <dl class="details">
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635 </dl>
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647 <h5>Returns:</h5>
3648
3649
3650
3651 <table class="params">
3652 <thead>
3653 <tr>
3654
3655 <th>Type</th>
3656 <th class="last">Description</th>
3657 </tr>
3658 </thead>
3659 <tbody>
3660
3661 <tr>
3662
3663 <td class="type">
3664
3665 Array.&lt;string>
3666
3667
3668 </td>
3669 <td class="description last">Returns an array of logical interface names.</td>
3670 </tr>
3671
3672 </tbody>
3673 </table>
3674
3675
3676
3677
3678 </dd>
3679
3680
3681
3682 <dt>
3683 <div class="nameContainer">
3684 <h4 class="name" id="getNetworks">
3685
3686 getNetworks<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>
3687 </h4>
3688
3689
3690 <div class="tag-source">
3691 <a href="network.js.html">network.js</a>, <a href="network.js.html#line4019">line 4019</a>
3692 </div>
3693
3694 </div>
3695
3696
3697 </dt>
3698 <dd>
3699
3700
3701 <div class="description">
3702 <p>Get the logical interfaces this wireless network is attached to.</p>
3703 </div>
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713 <dl class="details">
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735 </dl>
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747 <h5>Returns:</h5>
3748
3749
3750
3751 <table class="params">
3752 <thead>
3753 <tr>
3754
3755 <th>Type</th>
3756 <th class="last">Description</th>
3757 </tr>
3758 </thead>
3759 <tbody>
3760
3761 <tr>
3762
3763 <td class="type">
3764
3765 Array.&lt;<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>
3766
3767
3768 </td>
3769 <td class="description last">Returns an array of <code>Network.Protocol</code> instances representing the
3770 logical interfaces this wireless network is attached to.</td>
3771 </tr>
3772
3773 </tbody>
3774 </table>
3775
3776
3777
3778
3779 </dd>
3780
3781
3782
3783 <dt>
3784 <div class="nameContainer">
3785 <h4 class="name" id="getNoise">
3786
3787 getNoise<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span>
3788 </h4>
3789
3790
3791 <div class="tag-source">
3792 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3887">line 3887</a>
3793 </div>
3794
3795 </div>
3796
3797
3798 </dt>
3799 <dd>
3800
3801
3802 <div class="description">
3803 <p>Query the current radio noise floor.</p>
3804 </div>
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814 <dl class="details">
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836 </dl>
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848 <h5>Returns:</h5>
3849
3850
3851
3852 <table class="params">
3853 <thead>
3854 <tr>
3855
3856 <th>Type</th>
3857 <th class="last">Description</th>
3858 </tr>
3859 </thead>
3860 <tbody>
3861
3862 <tr>
3863
3864 <td class="type">
3865
3866 number
3867
3868
3869 </td>
3870 <td class="description last">Returns the radio noise floor in dBm as reported by <code>ubus</code> runtime
3871 information or <code>0</code> if it cannot be determined.</td>
3872 </tr>
3873
3874 </tbody>
3875 </table>
3876
3877
3878
3879
3880 </dd>
3881
3882
3883
3884 <dt>
3885 <div class="nameContainer">
3886 <h4 class="name" id="getShortName">
3887
3888 getShortName<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
3889 </h4>
3890
3891
3892 <div class="tag-source">
3893 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3977">line 3977</a>
3894 </div>
3895
3896 </div>
3897
3898
3899 </dt>
3900 <dd>
3901
3902
3903 <div class="description">
3904 <p>Get a short description string for this wireless network.</p>
3905 </div>
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915 <dl class="details">
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937 </dl>
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949 <h5>Returns:</h5>
3950
3951
3952
3953 <table class="params">
3954 <thead>
3955 <tr>
3956
3957 <th>Type</th>
3958 <th class="last">Description</th>
3959 </tr>
3960 </thead>
3961 <tbody>
3962
3963 <tr>
3964
3965 <td class="type">
3966
3967 string
3968
3969
3970 </td>
3971 <td class="description last">Returns a string describing this network, consisting of the
3972 active operation mode, followed by either the SSID, BSSID or
3973 internal network ID, depending on which information is available.</td>
3974 </tr>
3975
3976 </tbody>
3977 </table>
3978
3979
3980
3981
3982 </dd>
3983
3984
3985
3986 <dt>
3987 <div class="nameContainer">
3988 <h4 class="name" id="getSignal">
3989
3990 getSignal<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|number}</span>
3991 </h4>
3992
3993
3994 <div class="tag-source">
3995 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3876">line 3876</a>
3996 </div>
3997
3998 </div>
3999
4000
4001 </dt>
4002 <dd>
4003
4004
4005 <div class="description">
4006 <p>Query the current wireless signal.</p>
4007 </div>
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017 <dl class="details">
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039 </dl>
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051 <h5>Returns:</h5>
4052
4053
4054
4055 <table class="params">
4056 <thead>
4057 <tr>
4058
4059 <th>Type</th>
4060 <th class="last">Description</th>
4061 </tr>
4062 </thead>
4063 <tbody>
4064
4065 <tr>
4066
4067 <td class="type">
4068
4069 null
4070 |
4071
4072 number
4073
4074
4075 </td>
4076 <td class="description last">Returns the wireless signal in dBm as reported by <code>ubus</code> runtime
4077 information or <code>null</code> if it cannot be determined.</td>
4078 </tr>
4079
4080 </tbody>
4081 </table>
4082
4083
4084
4085
4086 </dd>
4087
4088
4089
4090 <dt>
4091 <div class="nameContainer">
4092 <h4 class="name" id="getSignalLevel">
4093
4094 getSignalLevel<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span>
4095 </h4>
4096
4097
4098 <div class="tag-source">
4099 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3936">line 3936</a>
4100 </div>
4101
4102 </div>
4103
4104
4105 </dt>
4106 <dd>
4107
4108
4109 <div class="description">
4110 <p>Calculate the current signal.</p>
4111 </div>
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121 <dl class="details">
4122
4123
4124
4125
4126
4127
4128
4129 <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd>
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145 </dl>
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157 <h5>Returns:</h5>
4158
4159
4160
4161 <table class="params">
4162 <thead>
4163 <tr>
4164
4165 <th>Type</th>
4166 <th class="last">Description</th>
4167 </tr>
4168 </thead>
4169 <tbody>
4170
4171 <tr>
4172
4173 <td class="type">
4174
4175 number
4176
4177
4178 </td>
4179 <td class="description last">Returns the calculated signal level, which is the difference between
4180 noise and signal (SNR), divided by 5.</td>
4181 </tr>
4182
4183 </tbody>
4184 </table>
4185
4186
4187
4188
4189 </dd>
4190
4191
4192
4193 <dt>
4194 <div class="nameContainer">
4195 <h4 class="name" id="getSignalPercent">
4196
4197 getSignalPercent<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span>
4198 </h4>
4199
4200
4201 <div class="tag-source">
4202 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3959">line 3959</a>
4203 </div>
4204
4205 </div>
4206
4207
4208 </dt>
4209 <dd>
4210
4211
4212 <div class="description">
4213 <p>Calculate the current signal quality percentage.</p>
4214 </div>
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224 <dl class="details">
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246 </dl>
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258 <h5>Returns:</h5>
4259
4260
4261
4262 <table class="params">
4263 <thead>
4264 <tr>
4265
4266 <th>Type</th>
4267 <th class="last">Description</th>
4268 </tr>
4269 </thead>
4270 <tbody>
4271
4272 <tr>
4273
4274 <td class="type">
4275
4276 number
4277
4278
4279 </td>
4280 <td class="description last">Returns the calculated signal quality in percent. The value is
4281 calculated from the <code>quality</code> and <code>quality_max</code> indicators reported
4282 by <code>ubus</code> runtime state.</td>
4283 </tr>
4284
4285 </tbody>
4286 </table>
4287
4288
4289
4290
4291 </dd>
4292
4293
4294
4295 <dt>
4296 <div class="nameContainer">
4297 <h4 class="name" id="getSSID">
4298
4299 getSSID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span>
4300 </h4>
4301
4302
4303 <div class="tag-source">
4304 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3427">line 3427</a>
4305 </div>
4306
4307 </div>
4308
4309
4310 </dt>
4311 <dd>
4312
4313
4314 <div class="description">
4315 <p>Get the configured SSID of the wireless network.</p>
4316 </div>
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326 <dl class="details">
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348 </dl>
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360 <h5>Returns:</h5>
4361
4362
4363
4364 <table class="params">
4365 <thead>
4366 <tr>
4367
4368 <th>Type</th>
4369 <th class="last">Description</th>
4370 </tr>
4371 </thead>
4372 <tbody>
4373
4374 <tr>
4375
4376 <td class="type">
4377
4378 null
4379 |
4380
4381 string
4382
4383
4384 </td>
4385 <td class="description last">Returns the configured SSID value or <code>null</code> when this network is
4386 in mesh mode.</td>
4387 </tr>
4388
4389 </tbody>
4390 </table>
4391
4392
4393
4394
4395 </dd>
4396
4397
4398
4399 <dt>
4400 <div class="nameContainer">
4401 <h4 class="name" id="getTXPower">
4402
4403 getTXPower<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|number}</span>
4404 </h4>
4405
4406
4407 <div class="tag-source">
4408 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3909">line 3909</a>
4409 </div>
4410
4411 </div>
4412
4413
4414 </dt>
4415 <dd>
4416
4417
4418 <div class="description">
4419 <p>Query the current radio TX power.</p>
4420 </div>
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430 <dl class="details">
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452 </dl>
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464 <h5>Returns:</h5>
4465
4466
4467
4468 <table class="params">
4469 <thead>
4470 <tr>
4471
4472 <th>Type</th>
4473 <th class="last">Description</th>
4474 </tr>
4475 </thead>
4476 <tbody>
4477
4478 <tr>
4479
4480 <td class="type">
4481
4482 null
4483 |
4484
4485 number
4486
4487
4488 </td>
4489 <td class="description last">Returns the wireless network transmit power in dBm as reported by
4490 <code>ubus</code> runtime information or <code>null</code> if it cannot be determined.</td>
4491 </tr>
4492
4493 </tbody>
4494 </table>
4495
4496
4497
4498
4499 </dd>
4500
4501
4502
4503 <dt>
4504 <div class="nameContainer">
4505 <h4 class="name" id="getTXPowerOffset">
4506
4507 getTXPowerOffset<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span>
4508 </h4>
4509
4510
4511 <div class="tag-source">
4512 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3924">line 3924</a>
4513 </div>
4514
4515 </div>
4516
4517
4518 </dt>
4519 <dd>
4520
4521
4522 <div class="description">
4523 <p>Query the radio TX power offset.</p>
4524 <p>Some wireless radios have a fixed power offset, e.g. due to the
4525 use of external amplifiers.</p>
4526 </div>
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536 <dl class="details">
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558 </dl>
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570 <h5>Returns:</h5>
4571
4572
4573
4574 <table class="params">
4575 <thead>
4576 <tr>
4577
4578 <th>Type</th>
4579 <th class="last">Description</th>
4580 </tr>
4581 </thead>
4582 <tbody>
4583
4584 <tr>
4585
4586 <td class="type">
4587
4588 number
4589
4590
4591 </td>
4592 <td class="description last">Returns the wireless network transmit power offset in dBm as reported
4593 by <code>ubus</code> runtime information or <code>0</code> if there is no offset, or if it
4594 cannot be determined.</td>
4595 </tr>
4596
4597 </tbody>
4598 </table>
4599
4600
4601
4602
4603 </dd>
4604
4605
4606
4607 <dt>
4608 <div class="nameContainer">
4609 <h4 class="name" id="getWifiDevice">
4610
4611 getWifiDevice<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|<a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>}</span>
4612 </h4>
4613
4614
4615 <div class="tag-source">
4616 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3529">line 3529</a>
4617 </div>
4618
4619 </div>
4620
4621
4622 </dt>
4623 <dd>
4624
4625
4626 <div class="description">
4627 <p>Get the corresponding wifi radio device.</p>
4628 </div>
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638 <dl class="details">
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660 </dl>
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672 <h5>Returns:</h5>
4673
4674
4675
4676 <table class="params">
4677 <thead>
4678 <tr>
4679
4680 <th>Type</th>
4681 <th class="last">Description</th>
4682 </tr>
4683 </thead>
4684 <tbody>
4685
4686 <tr>
4687
4688 <td class="type">
4689
4690 null
4691 |
4692
4693 <a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>
4694
4695
4696 </td>
4697 <td class="description last">Returns a <code>Network.WifiDevice</code> instance representing the corresponding
4698 wifi radio device or <code>null</code> if the related radio device could not be
4699 found.</td>
4700 </tr>
4701
4702 </tbody>
4703 </table>
4704
4705
4706
4707
4708 </dd>
4709
4710
4711
4712 <dt>
4713 <div class="nameContainer">
4714 <h4 class="name" id="getWifiDeviceName">
4715
4716 getWifiDeviceName<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span>
4717 </h4>
4718
4719
4720 <div class="tag-source">
4721 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3517">line 3517</a>
4722 </div>
4723
4724 </div>
4725
4726
4727 </dt>
4728 <dd>
4729
4730
4731 <div class="description">
4732 <p>Get the name of the corresponding wifi radio device.</p>
4733 </div>
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743 <dl class="details">
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765 </dl>
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777 <h5>Returns:</h5>
4778
4779
4780
4781 <table class="params">
4782 <thead>
4783 <tr>
4784
4785 <th>Type</th>
4786 <th class="last">Description</th>
4787 </tr>
4788 </thead>
4789 <tbody>
4790
4791 <tr>
4792
4793 <td class="type">
4794
4795 null
4796 |
4797
4798 string
4799
4800
4801 </td>
4802 <td class="description last">Returns the name of the radio device this network is configured on
4803 or <code>null</code> if it cannot be determined.</td>
4804 </tr>
4805
4806 </tbody>
4807 </table>
4808
4809
4810
4811
4812 </dd>
4813
4814
4815
4816 <dt>
4817 <div class="nameContainer">
4818 <h4 class="name" id="isClientDisconnectSupported">
4819
4820 isClientDisconnectSupported<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
4821 </h4>
4822
4823
4824 <div class="tag-source">
4825 <a href="network.js.html">network.js</a>, <a href="network.js.html#line4055">line 4055</a>
4826 </div>
4827
4828 </div>
4829
4830
4831 </dt>
4832 <dd>
4833
4834
4835 <div class="description">
4836 <p>Check whether this wifi network supports deauthenticating clients.</p>
4837 </div>
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847 <dl class="details">
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869 </dl>
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881 <h5>Returns:</h5>
4882
4883
4884
4885 <table class="params">
4886 <thead>
4887 <tr>
4888
4889 <th>Type</th>
4890 <th class="last">Description</th>
4891 </tr>
4892 </thead>
4893 <tbody>
4894
4895 <tr>
4896
4897 <td class="type">
4898
4899 boolean
4900
4901
4902 </td>
4903 <td class="description last">Returns <code>true</code> when this wifi network instance supports forcibly
4904 deauthenticating clients, otherwise <code>false</code>.</td>
4905 </tr>
4906
4907 </tbody>
4908 </table>
4909
4910
4911
4912
4913 </dd>
4914
4915
4916
4917 <dt>
4918 <div class="nameContainer">
4919 <h4 class="name" id="isDisabled">
4920
4921 isDisabled<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
4922 </h4>
4923
4924
4925 <div class="tag-source">
4926 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3401">line 3401</a>
4927 </div>
4928
4929 </div>
4930
4931
4932 </dt>
4933 <dd>
4934
4935
4936 <div class="description">
4937 <p>Checks whether this wireless network is disabled.</p>
4938 </div>
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948 <dl class="details">
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970 </dl>
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982 <h5>Returns:</h5>
4983
4984
4985
4986 <table class="params">
4987 <thead>
4988 <tr>
4989
4990 <th>Type</th>
4991 <th class="last">Description</th>
4992 </tr>
4993 </thead>
4994 <tbody>
4995
4996 <tr>
4997
4998 <td class="type">
4999
5000 boolean
5001
5002
5003 </td>
5004 <td class="description last">Returns <code>true</code> when the wireless radio is marked as disabled in <code>ubus</code>
5005 runtime state or when the <code>disabled</code> option is set in the corresponding
5006 UCI configuration.</td>
5007 </tr>
5008
5009 </tbody>
5010 </table>
5011
5012
5013
5014
5015 </dd>
5016
5017
5018
5019 <dt>
5020 <div class="nameContainer">
5021 <h4 class="name" id="isUp">
5022
5023 isUp<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
5024 </h4>
5025
5026
5027 <div class="tag-source">
5028 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3550">line 3550</a>
5029 </div>
5030
5031 </div>
5032
5033
5034 </dt>
5035 <dd>
5036
5037
5038 <div class="description">
5039 <p>Check whether the radio network is up.</p>
5040 <p>This function actually queries the up state of the related radio
5041 device and assumes this network to be up as well when the parent
5042 radio is up. This is due to the fact that OpenWrt does not control
5043 virtual interfaces individually but within one common hostapd
5044 instance.</p>
5045 </div>
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055 <dl class="details">
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077 </dl>
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089 <h5>Returns:</h5>
5090
5091
5092
5093 <table class="params">
5094 <thead>
5095 <tr>
5096
5097 <th>Type</th>
5098 <th class="last">Description</th>
5099 </tr>
5100 </thead>
5101 <tbody>
5102
5103 <tr>
5104
5105 <td class="type">
5106
5107 boolean
5108
5109
5110 </td>
5111 <td class="description last">Returns <code>true</code> when the network is up, else <code>false</code>.</td>
5112 </tr>
5113
5114 </tbody>
5115 </table>
5116
5117
5118
5119
5120 </dd>
5121
5122
5123
5124 <dt>
5125 <div class="nameContainer">
5126 <h4 class="name" id="set">
5127
5128 set<span class="signature">(opt, val)</span>
5129 </h4>
5130
5131
5132 <div class="tag-source">
5133 <a href="network.js.html">network.js</a>, <a href="network.js.html#line3389">line 3389</a>
5134 </div>
5135
5136 </div>
5137
5138
5139 </dt>
5140 <dd>
5141
5142
5143 <div class="description">
5144 <p>Set the given UCI option of this network to the given value.</p>
5145 </div>
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155 <table class="params">
5156 <thead>
5157 <tr>
5158
5159 <th>Name</th>
5160
5161
5162 <th>Type</th>
5163
5164
5165
5166 <th class="last">Description</th>
5167 </tr>
5168 </thead>
5169
5170 <tbody>
5171
5172
5173 <tr>
5174
5175 <td class="name"><code>opt</code></td>
5176
5177
5178 <td class="type">
5179
5180
5181 <span class="param-type">string</span>
5182
5183
5184
5185 </td>
5186
5187
5188
5189 <td class="description last">
5190
5191 <p>The name of the UCI option to set.</p></td>
5192 </tr>
5193
5194
5195
5196 <tr>
5197
5198 <td class="name"><code>val</code></td>
5199
5200
5201 <td class="type">
5202
5203
5204 <span class="param-type">null</span>
5205 |
5206
5207 <span class="param-type">string</span>
5208 |
5209
5210 <span class="param-type">Array.&lt;string></span>
5211
5212
5213
5214 </td>
5215
5216
5217
5218 <td class="description last">
5219
5220 <p>The value to set or <code>null</code> to remove the given option from the
5221 configuration.</p></td>
5222 </tr>
5223
5224
5225 </tbody>
5226 </table>
5227
5228
5229
5230 <dl class="details">
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252 </dl>
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266 </dd>
5267
5268 </dl>
5269
5270
5271
5272
5273
5274
5275
5276 </article>
5277
5278 </section>
5279
5280
5281
5282
5283
5284
5285
5286 <footer>
5287 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)
5288 </footer>
5289 </div>
5290 </div>
5291 <script>prettyPrint();</script>
5292 <script src="scripts/jaguar.js"></script>
5293 </body>
5294 </html>